Class CredentialValidationResult
java.lang.Object
jakarta.security.enterprise.identitystore.CredentialValidationResult
public class CredentialValidationResult
extends java.lang.Object
CredentialValidationResult
is the result from an attempt to
validate an instance of Credential
.-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
CredentialValidationResult.Status
-
Field Summary
Fields Modifier and Type Field Description static CredentialValidationResult
INVALID_RESULT
static CredentialValidationResult
NOT_VALIDATED_RESULT
-
Constructor Summary
Constructors Constructor Description CredentialValidationResult(CallerPrincipal callerPrincipal)
Constructor for a VALID result.CredentialValidationResult(CallerPrincipal callerPrincipal, java.util.Set<java.lang.String> groups)
Constructor for a VALID result.CredentialValidationResult(java.lang.String callerName)
Constructor for a VALID result.CredentialValidationResult(java.lang.String storeId, CallerPrincipal callerPrincipal, java.lang.String callerDn, java.lang.String callerUniqueId, java.util.Set<java.lang.String> groups)
Constructor for a VALID result.CredentialValidationResult(java.lang.String storeId, java.lang.String callerName, java.lang.String callerDn, java.lang.String callerUniqueId, java.util.Set<java.lang.String> groups)
Constructor for a VALID result.CredentialValidationResult(java.lang.String callerName, java.util.Set<java.lang.String> groups)
Constructor for a VALID result. -
Method Summary
Modifier and Type Method Description java.lang.String
getCallerDn()
Return the CallerPrincipal for the validated credential.java.util.Set<java.lang.String>
getCallerGroups()
Determines the set of groups that the specified Caller is in, based on the associated identity store.CallerPrincipal
getCallerPrincipal()
Return the CallerPrincipal for the validated credential.java.lang.String
getCallerUniqueId()
Return a string that uniquely identifies this caller within the identity store (since the Principal name used may not be unique).java.lang.String
getIdentityStoreId()
Return the unique ID of the identity store used to validate the credentials.CredentialValidationResult.Status
getStatus()
Determines the validation status.
-
Field Details
-
Constructor Details
-
CredentialValidationResult
public CredentialValidationResult(java.lang.String callerName)Constructor for a VALID result.- Parameters:
callerName
- Name of the validated caller
-
CredentialValidationResult
Constructor for a VALID result.- Parameters:
callerPrincipal
- CallerPrincipal of validated caller
-
CredentialValidationResult
public CredentialValidationResult(java.lang.String callerName, java.util.Set<java.lang.String> groups)Constructor for a VALID result.- Parameters:
callerName
- Name of the validated callergroups
- Groups associated with the caller from the identity store
-
CredentialValidationResult
public CredentialValidationResult(CallerPrincipal callerPrincipal, java.util.Set<java.lang.String> groups)Constructor for a VALID result.- Parameters:
callerPrincipal
- CallerPrincipal of validated callergroups
- Groups associated with the caller from the identity store
-
CredentialValidationResult
public CredentialValidationResult(java.lang.String storeId, java.lang.String callerName, java.lang.String callerDn, java.lang.String callerUniqueId, java.util.Set<java.lang.String> groups)Constructor for a VALID result.- Parameters:
storeId
- Identity store unique IDcallerName
- Name of the validated callercallerDn
- Caller's LDAP DN (distinguished name)callerUniqueId
- Caller's unique identifier from the identity storegroups
- Groups associated with the caller from the identity store
-
CredentialValidationResult
public CredentialValidationResult(java.lang.String storeId, CallerPrincipal callerPrincipal, java.lang.String callerDn, java.lang.String callerUniqueId, java.util.Set<java.lang.String> groups)Constructor for a VALID result.- Parameters:
storeId
- Identity store unique IDcallerPrincipal
- CallerPrincipal of validated callercallerDn
- Caller's LDAP DN (distinguished name)callerUniqueId
- Caller's unique identifier from the identity storegroups
- Groups associated with the caller from the identity store
-
-
Method Details
-
getStatus
Determines the validation status.- Returns:
- The validation status
-
getIdentityStoreId
public java.lang.String getIdentityStoreId()Return the unique ID of the identity store used to validate the credentials.- Returns:
- String identifying the external store used to validate credentials.
-
getCallerPrincipal
Return the CallerPrincipal for the validated credential.- Returns:
- The CallerPrincipal.
-
getCallerUniqueId
public java.lang.String getCallerUniqueId()Return a string that uniquely identifies this caller within the identity store (since the Principal name used may not be unique).- Returns:
- Caller's unique identifier.
-
getCallerDn
public java.lang.String getCallerDn()Return the CallerPrincipal for the validated credential.- Returns:
- The CallerPrincipal.
-
getCallerGroups
public java.util.Set<java.lang.String> getCallerGroups()Determines the set of groups that the specified Caller is in, based on the associated identity store.- Returns:
- The set of groups that the specified Caller is in, or empty if none.
-