Class CredentialValidationResult
- java.lang.Object
-
- jakarta.security.enterprise.identitystore.CredentialValidationResult
-
public class CredentialValidationResult extends Object
CredentialValidationResult
is the result from an attempt to validate an instance ofCredential
.
-
-
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, Set<String> groups)
Constructor for a VALID result.CredentialValidationResult(String callerName)
Constructor for a VALID result.CredentialValidationResult(String storeId, CallerPrincipal callerPrincipal, String callerDn, String callerUniqueId, Set<String> groups)
Constructor for a VALID result.CredentialValidationResult(String storeId, String callerName, String callerDn, String callerUniqueId, Set<String> groups)
Constructor for a VALID result.CredentialValidationResult(String callerName, Set<String> groups)
Constructor for a VALID result.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getCallerDn()
Return the CallerPrincipal for the validated credential.Set<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.String
getCallerUniqueId()
Return a string that uniquely identifies this caller within the identity store (since the Principal name used may not be unique).String
getIdentityStoreId()
Return the unique ID of the identity store used to validate the credentials.CredentialValidationResult.Status
getStatus()
Determines the validation status.
-
-
-
Field Detail
-
INVALID_RESULT
public static final CredentialValidationResult INVALID_RESULT
-
NOT_VALIDATED_RESULT
public static final CredentialValidationResult NOT_VALIDATED_RESULT
-
-
Constructor Detail
-
CredentialValidationResult
public CredentialValidationResult(String callerName)
Constructor for a VALID result.- Parameters:
callerName
- Name of the validated caller
-
CredentialValidationResult
public CredentialValidationResult(CallerPrincipal callerPrincipal)
Constructor for a VALID result.- Parameters:
callerPrincipal
- CallerPrincipal of validated caller
-
CredentialValidationResult
public CredentialValidationResult(String callerName, Set<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, Set<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(String storeId, String callerName, String callerDn, String callerUniqueId, Set<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(String storeId, CallerPrincipal callerPrincipal, String callerDn, String callerUniqueId, Set<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 Detail
-
getStatus
public CredentialValidationResult.Status getStatus()
Determines the validation status.- Returns:
- The validation status
-
getIdentityStoreId
public 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
public CallerPrincipal getCallerPrincipal()
Return the CallerPrincipal for the validated credential.- Returns:
- The CallerPrincipal.
-
getCallerUniqueId
public 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 String getCallerDn()
Return the CallerPrincipal for the validated credential.- Returns:
- The CallerPrincipal.
-
-