Skip to content

Commit 318077e

Browse files
CopilotAvery-Dunn
andcommitted
Add Javadoc comments to public classes missing documentation
Co-authored-by: Avery-Dunn <62066438+Avery-Dunn@users.noreply.github.com>
1 parent 3179169 commit 318077e

11 files changed

Lines changed: 48 additions & 2 deletions

msal4j-sdk/src/main/java/com/microsoft/aad/msal4j/AppTokenProviderParameters.java

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,10 @@
55

66
import java.util.Set;
77

8-
/// The authentication parameters provided to the app token provider callback.
8+
/**
9+
* Represents the authentication parameters provided to an external app token provider callback.
10+
* Contains information about the requested scopes, correlation ID, and claims for token acquisition.
11+
*/
912
public class AppTokenProviderParameters {
1013

1114
/// Specifies which scopes to request.

msal4j-sdk/src/main/java/com/microsoft/aad/msal4j/AuthenticationErrorMessage.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33

44
package com.microsoft.aad.msal4j;
55

6+
/**
7+
* Contains constant error messages used throughout the authentication process.
8+
* Provides standardized error messaging for common authentication scenarios.
9+
*/
610
public class AuthenticationErrorMessage {
711

812
/**

msal4j-sdk/src/main/java/com/microsoft/aad/msal4j/AuthorizationRequestUrlParameters.java

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,13 @@ public class AuthorizationRequestUrlParameters {
4040

4141
Logger log = LoggerFactory.getLogger(AuthorizationRequestUrlParameters.class);
4242

43+
/**
44+
* Creates a new builder for authorization request URL parameters.
45+
*
46+
* @param redirectUri the redirect URI where the authorization response will be sent
47+
* @param scopes the set of scopes to request for the access token
48+
* @return a new Builder instance
49+
*/
4350
public static Builder builder(String redirectUri,
4451
Set<String> scopes) {
4552

msal4j-sdk/src/main/java/com/microsoft/aad/msal4j/CIAMAuthority.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@
66
import java.net.MalformedURLException;
77
import java.net.URL;
88

9+
/**
10+
* Represents a Customer Identity and Access Management (CIAM) authority for Azure AD B2C scenarios.
11+
* CIAM authorities are used for customer-facing applications and identity management.
12+
*/
913
public class CIAMAuthority extends Authority {
1014

1115
public static final String CIAM_HOST_SEGMENT = ".ciamlogin.com";

msal4j-sdk/src/main/java/com/microsoft/aad/msal4j/CustomJWTAuthentication.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@
1414

1515
import java.util.*;
1616

17+
/**
18+
* Custom JWT-based client authentication implementation for OAuth 2.0 client authentication.
19+
* This class handles authentication using client assertions based on JWT tokens.
20+
*/
1721
public class CustomJWTAuthentication extends ClientAuthentication {
1822
private ClientAssertion clientAssertion;
1923

msal4j-sdk/src/main/java/com/microsoft/aad/msal4j/ManagedIdentityErrorResponse.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@
55

66
import com.fasterxml.jackson.annotation.JsonProperty;
77

8+
/**
9+
* Represents an error response from a managed identity token request.
10+
* Contains error details, correlation ID, and error descriptions for debugging purposes.
11+
*/
812
public class ManagedIdentityErrorResponse {
913

1014
@JsonProperty("message")

msal4j-sdk/src/main/java/com/microsoft/aad/msal4j/ManagedIdentityId.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@
33

44
package com.microsoft.aad.msal4j;
55

6+
/**
7+
* Represents the identifier for a managed identity in Azure.
8+
* A managed identity provides Azure services with an automatically managed identity in Azure AD.
9+
* This class supports both system-assigned and user-assigned managed identities.
10+
*/
611
public class ManagedIdentityId {
712

813
private String userAssignedId;

msal4j-sdk/src/main/java/com/microsoft/aad/msal4j/ManagedIdentitySourceType.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33

44
package com.microsoft.aad.msal4j;
55

6+
/**
7+
* Enumeration of managed identity source types used to identify the specific
8+
* Azure service or infrastructure component providing the managed identity token endpoint.
9+
*/
610
public enum ManagedIdentitySourceType {
711
// Default.
812
NONE,

msal4j-sdk/src/main/java/com/microsoft/aad/msal4j/OSHelper.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
package com.microsoft.aad.msal4j;
22

3+
/**
4+
* Utility class for operating system detection and OS-specific operations.
5+
* Provides methods to identify the current operating system (Windows, macOS, Linux).
6+
*/
37
public class OSHelper {
48
enum OSType{
59
MAC,

msal4j-sdk/src/main/java/com/microsoft/aad/msal4j/OidcAuthority.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@
66
import java.net.MalformedURLException;
77
import java.net.URL;
88

9+
/**
10+
* Represents an OpenID Connect (OIDC) authority that handles authentication and token issuance.
11+
* This authority type supports the standard OIDC discovery process.
12+
*/
913
public class OidcAuthority extends Authority {
1014
//Part of the OpenIdConnect standard, this is appended to the authority to create the endpoint that has OIDC metadata
1115
private static final String WELL_KNOWN_OPENID_CONFIGURATION = ".well-known/openid-configuration";

0 commit comments

Comments
 (0)