Package org.apereo.cas.authentication

Class DefaultAuthenticationHandlerExecutionResult

java.lang.Object
org.apereo.cas.authentication.DefaultAuthenticationHandlerExecutionResult
All Implemented Interfaces:
Serializable, org.apereo.cas.authentication.AuthenticationHandlerExecutionResult
public class DefaultAuthenticationHandlerExecutionResult extends 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:

  • Constructor Summary

    Constructors
    Constructor
    Description
    DefaultAuthenticationHandlerExecutionResult()
     
    DefaultAuthenticationHandlerExecutionResult(String handlerName, org.apereo.cas.authentication.Credential credential, org.apereo.cas.authentication.principal.Principal principal, List<org.apereo.cas.authentication.MessageDescriptor> warnings)
    Creates a new DefaultAuthenticationHandlerExecutionResult instance.
    DefaultAuthenticationHandlerExecutionResult(String source, org.apereo.cas.authentication.principal.Principal principal)
     
    DefaultAuthenticationHandlerExecutionResult(org.apereo.cas.authentication.AuthenticationHandler source, org.apereo.cas.authentication.Credential credential)
     
    DefaultAuthenticationHandlerExecutionResult(org.apereo.cas.authentication.AuthenticationHandler source, org.apereo.cas.authentication.Credential credential, @NonNull List<org.apereo.cas.authentication.MessageDescriptor> warnings)
     
    DefaultAuthenticationHandlerExecutionResult(org.apereo.cas.authentication.AuthenticationHandler source, org.apereo.cas.authentication.Credential credential, org.apereo.cas.authentication.principal.Principal principal)
     
    DefaultAuthenticationHandlerExecutionResult(org.apereo.cas.authentication.AuthenticationHandler source, org.apereo.cas.authentication.Credential credential, org.apereo.cas.authentication.principal.Principal principal, @NonNull List<org.apereo.cas.authentication.MessageDescriptor> warnings)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.apereo.cas.authentication.AuthenticationHandlerExecutionResult
    addWarning(org.apereo.cas.authentication.MessageDescriptor message)
     
    org.apereo.cas.authentication.AuthenticationHandlerExecutionResult
    clearWarnings()
     
    boolean
    equals(Object o)
     
    org.apereo.cas.authentication.Credential
    getCredential()
    Credential meta data.
    String
    getHandlerName()
    The name of the authentication handler that successfully authenticated a credential.
    org.apereo.cas.authentication.principal.Principal
    getPrincipal()
    Resolved principal for authenticated credential.
    List<org.apereo.cas.authentication.MessageDescriptor>
    getWarnings()
    List of warnings issued by the authentication source while authenticating the credential.
    int
    hashCode()
     
    void
    setCredential(org.apereo.cas.authentication.Credential credential)
    Credential meta data.
    void
    setHandlerName(String handlerName)
    The name of the authentication handler that successfully authenticated a credential.
    void
    setPrincipal(org.apereo.cas.authentication.principal.Principal principal)
    Resolved principal for authenticated credential.
    void
    setWarnings(List<org.apereo.cas.authentication.MessageDescriptor> warnings)
    List of warnings issued by the authentication source while authenticating the credential.
    String
    toString()
     

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • DefaultAuthenticationHandlerExecutionResult

      public DefaultAuthenticationHandlerExecutionResult(org.apereo.cas.authentication.AuthenticationHandler source, org.apereo.cas.authentication.Credential credential)

    • DefaultAuthenticationHandlerExecutionResult

      public DefaultAuthenticationHandlerExecutionResult(org.apereo.cas.authentication.AuthenticationHandler source, org.apereo.cas.authentication.Credential credential, org.apereo.cas.authentication.principal.Principal principal)

    • DefaultAuthenticationHandlerExecutionResult

      public DefaultAuthenticationHandlerExecutionResult(org.apereo.cas.authentication.AuthenticationHandler source, org.apereo.cas.authentication.Credential credential, @NonNull @NonNull List<org.apereo.cas.authentication.MessageDescriptor> warnings)

    • DefaultAuthenticationHandlerExecutionResult

      public DefaultAuthenticationHandlerExecutionResult(org.apereo.cas.authentication.AuthenticationHandler source, org.apereo.cas.authentication.Credential credential, org.apereo.cas.authentication.principal.Principal principal, @NonNull @NonNull List<org.apereo.cas.authentication.MessageDescriptor> warnings)

    • DefaultAuthenticationHandlerExecutionResult

      public DefaultAuthenticationHandlerExecutionResult(String source, org.apereo.cas.authentication.principal.Principal principal)

    • DefaultAuthenticationHandlerExecutionResult

      public DefaultAuthenticationHandlerExecutionResult()

    • DefaultAuthenticationHandlerExecutionResult

      public DefaultAuthenticationHandlerExecutionResult(String handlerName, org.apereo.cas.authentication.Credential credential, org.apereo.cas.authentication.principal.Principal principal, List<org.apereo.cas.authentication.MessageDescriptor> warnings)
      Creates a new DefaultAuthenticationHandlerExecutionResult instance.
      Parameters:
      handlerName - The name of the authentication handler that successfully authenticated a credential.
      credential - Credential meta data.
      principal - Resolved principal for authenticated credential.
      warnings - List of warnings issued by the authentication source while authenticating the credential.

  • Method Details

    • addWarning

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

    • clearWarnings

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

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getHandlerName

      public String getHandlerName()
      The name of the authentication handler that successfully authenticated a credential.
      Specified by:
      getHandlerName in interface org.apereo.cas.authentication.AuthenticationHandlerExecutionResult

    • getCredential

      public org.apereo.cas.authentication.Credential getCredential()
      Credential meta data.
      Specified by:
      getCredential in interface org.apereo.cas.authentication.AuthenticationHandlerExecutionResult

    • getPrincipal

      public org.apereo.cas.authentication.principal.Principal getPrincipal()
      Resolved principal for authenticated credential.
      Specified by:
      getPrincipal in interface org.apereo.cas.authentication.AuthenticationHandlerExecutionResult

    • getWarnings

      public List<org.apereo.cas.authentication.MessageDescriptor> getWarnings()
      List of warnings issued by the authentication source while authenticating the credential.
      Specified by:
      getWarnings in interface org.apereo.cas.authentication.AuthenticationHandlerExecutionResult

    • setHandlerName

      public void setHandlerName(String handlerName)
      The name of the authentication handler that successfully authenticated a credential.

    • setCredential

      public void setCredential(org.apereo.cas.authentication.Credential credential)
      Credential meta data.

    • setPrincipal

      public void setPrincipal(org.apereo.cas.authentication.principal.Principal principal)
      Resolved principal for authenticated credential.

    • setWarnings

      public void setWarnings(List<org.apereo.cas.authentication.MessageDescriptor> warnings)
      List of warnings issued by the authentication source while authenticating the credential.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object