Package org.apereo.cas.authentication

Interface AuthenticationResultBuilder

All Superinterfaces:
Serializable
public interface AuthenticationResultBuilder extends Serializable
This is AuthenticationResultBuilder. It attempts to collect authentication objects and will put the computed finalized primary Authentication into AuthenticationResult. Concurrency semantics: implementations MUST be thread-safe. Instances of this class should never be declared as a field. Rather they should always be passed around to methods that need them.
Since:
4.2.0

  • Method Details

    • getAuthentications

      Set<Authentication> getAuthentications()
      Gets authentications.
      Returns:
      the authentications

    • getInitialAuthentication

      Optional<Authentication> getInitialAuthentication()
      Gets the initial authentication.
      Returns:
      the initial authentication

    • getInitialCredential

      Optional<Credential> getInitialCredential()
      Gets initial credential.
      Returns:
      the initial credential

    • collect

      AuthenticationResultBuilder collect(Authentication authentication)
      Collect authentication objects from any number of processed authentication transactions.
      Parameters:
      authentication - the authentication
      Returns:
      the authentication result builder

    • collect

      AuthenticationResultBuilder collect(Collection<Authentication> authentications)
      Collect authentication result builder.
      Parameters:
      authentications - the authentication
      Returns:
      the authentication result builder

    • collect

      AuthenticationResultBuilder collect(Credential... credential)
      Provided credentials immediately by the user.
      Parameters:
      credential - the credential
      Returns:
      the authentication context builder

    • build

      AuthenticationResult build(PrincipalElectionStrategy principalElectionStrategy) throws Throwable
      Build authentication result.
      Parameters:
      principalElectionStrategy - a principalElectionStrategy to use
      Returns:
      the authentication result
      Throws:
      Throwable - the throwable

    • build

      AuthenticationResult build(PrincipalElectionStrategy principalElectionStrategy, Service service) throws Throwable
      Build authentication result.
      Parameters:
      principalElectionStrategy - a principalElectionStrategy to use
      service - the service
      Returns:
      the authentication result
      Throws:
      Throwable - the throwable