Package org.apereo.cas.authentication
Interface AuthenticationHandlerExecutionResult
-
- All Superinterfaces:
java.io.Serializable
public interface AuthenticationHandlerExecutionResult extends java.io.SerializableThis isAuthenticationHandlerExecutionResultthat describes the result of an authentication attempt.- Since:
- 4.1.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description AuthenticationHandlerExecutionResultaddWarning(MessageDescriptor message)Add warning to authentication handler execution result.AuthenticationHandlerExecutionResultclearWarnings()Clear warnings from authentication handler execution result.CredentialMetaDatagetCredentialMetaData()Gets credential meta data.java.lang.StringgetHandlerName()Gets handler name.PrincipalgetPrincipal()Gets principal.java.util.List<MessageDescriptor>getWarnings()Gets warnings.
-
-
-
Method Detail
-
getHandlerName
java.lang.String getHandlerName()
Gets handler name.- Returns:
- the handler name
-
getCredentialMetaData
CredentialMetaData getCredentialMetaData()
Gets credential meta data.- Returns:
- the credential meta data
-
getPrincipal
Principal getPrincipal()
Gets principal.- Returns:
- the principal
-
getWarnings
java.util.List<MessageDescriptor> getWarnings()
Gets warnings.- Returns:
- the warnings
-
addWarning
AuthenticationHandlerExecutionResult addWarning(MessageDescriptor message)
Add warning to authentication handler execution result.- Parameters:
message- the message- Returns:
- the authentication handler execution result
-
clearWarnings
AuthenticationHandlerExecutionResult clearWarnings()
Clear warnings from authentication handler execution result.- Returns:
- the authentication handler execution result
-
-