Package org.apereo.cas.authentication

Interface AuthenticationResult

All Superinterfaces:
Serializable
public interface AuthenticationResult extends Serializable
The AuthenticationResult is an abstraction representing final authentication outcome for any number of processed authentication transactions.

An authentication result carries the primary composite authentication event, collected from all authentication transactions. The principal and attributes associated with this authentication are also collected out of all authentication transactions.

Since:
4.2

  • Method Summary

    Modifier and Type
    Method
    Description
    Authentication
    getAuthentication()
    Obtains the finalized primary authentication for this result.
    Service
    getService()
    Gets the service for which this authentication result is relevant.
    boolean
    isCredentialProvided()
    Indicates whether the authentication event was established as part of user providing credentials.

  • Method Details

    • getAuthentication

      Authentication getAuthentication()
      Obtains the finalized primary authentication for this result.
      Returns:
      the authentication

    • getService

      Service getService()
      Gets the service for which this authentication result is relevant. The service MAY be null, as an authentication result in CAS can be established without providing a service/destination.
      Returns:
      the service

    • isCredentialProvided

      boolean isCredentialProvided()
      Indicates whether the authentication event was established as part of user providing credentials.
      Returns:
      true if credentials are provided. false is authn was established as part of SSO.