Package org.apereo.cas.authentication

Class DefaultAuthenticationHandlerExecutionResult

  • All Implemented Interfaces:
    java.io.Serializable, org.apereo.cas.authentication.AuthenticationHandlerExecutionResult
    public class DefaultAuthenticationHandlerExecutionResult
extends java.lang.Object
implements org.apereo.cas.authentication.AuthenticationHandlerExecutionResult
    Contains information about a successful authentication produced by an AuthenticationHandler. Handler results are naturally immutable since they contain sensitive information that should not be modified outside the AuthenticationHandler that produced it.
    Since:
    4.0.0
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      DefaultAuthenticationHandlerExecutionResult​(org.apereo.cas.authentication.AuthenticationHandler source, org.apereo.cas.authentication.CredentialMetaData metaData)  
      DefaultAuthenticationHandlerExecutionResult​(org.apereo.cas.authentication.AuthenticationHandler source, org.apereo.cas.authentication.CredentialMetaData metaData, @NonNull java.util.List<org.apereo.cas.authentication.MessageDescriptor> warnings)  
      DefaultAuthenticationHandlerExecutionResult​(org.apereo.cas.authentication.AuthenticationHandler source, org.apereo.cas.authentication.CredentialMetaData metaData, org.apereo.cas.authentication.principal.Principal p)  
      DefaultAuthenticationHandlerExecutionResult​(org.apereo.cas.authentication.AuthenticationHandler source, org.apereo.cas.authentication.CredentialMetaData metaData, org.apereo.cas.authentication.principal.Principal p, @NonNull java.util.List<org.apereo.cas.authentication.MessageDescriptor> warnings)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      org.apereo.cas.authentication.AuthenticationHandlerExecutionResult addWarning​(org.apereo.cas.authentication.MessageDescriptor message)  
      org.apereo.cas.authentication.AuthenticationHandlerExecutionResult clearWarnings()  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

      • Methods inherited from interface org.apereo.cas.authentication.AuthenticationHandlerExecutionResult

        getCredentialMetaData, getHandlerName, getPrincipal, getWarnings

    • Constructor Detail

      • DefaultAuthenticationHandlerExecutionResult

        public DefaultAuthenticationHandlerExecutionResult​(org.apereo.cas.authentication.AuthenticationHandler source,
                                                   org.apereo.cas.authentication.CredentialMetaData metaData)

      • DefaultAuthenticationHandlerExecutionResult

        public DefaultAuthenticationHandlerExecutionResult​(org.apereo.cas.authentication.AuthenticationHandler source,
                                                   org.apereo.cas.authentication.CredentialMetaData metaData,
                                                   org.apereo.cas.authentication.principal.Principal p)

      • DefaultAuthenticationHandlerExecutionResult

        public DefaultAuthenticationHandlerExecutionResult​(org.apereo.cas.authentication.AuthenticationHandler source,
                                                   org.apereo.cas.authentication.CredentialMetaData metaData,
                                                   @NonNull
                                                   @NonNull java.util.List<org.apereo.cas.authentication.MessageDescriptor> warnings)

      • DefaultAuthenticationHandlerExecutionResult

        public DefaultAuthenticationHandlerExecutionResult​(org.apereo.cas.authentication.AuthenticationHandler source,
                                                   org.apereo.cas.authentication.CredentialMetaData metaData,
                                                   org.apereo.cas.authentication.principal.Principal p,
                                                   @NonNull
                                                   @NonNull java.util.List<org.apereo.cas.authentication.MessageDescriptor> warnings)

    • Method Detail

      • addWarning

        public org.apereo.cas.authentication.AuthenticationHandlerExecutionResult addWarning​(org.apereo.cas.authentication.MessageDescriptor message)
        Specified by:
        addWarning in interface org.apereo.cas.authentication.AuthenticationHandlerExecutionResult

      • clearWarnings

        public org.apereo.cas.authentication.AuthenticationHandlerExecutionResult clearWarnings()
        Specified by:
        clearWarnings in interface org.apereo.cas.authentication.AuthenticationHandlerExecutionResult