Package org.apereo.cas.authentication.principal

Class ClientCredential

java.lang.Object
org.apereo.cas.authentication.credential.AbstractCredential
org.apereo.cas.authentication.principal.ClientCredential
All Implemented Interfaces:
Serializable, org.apereo.cas.authentication.Credential
public class ClientCredential extends org.apereo.cas.authentication.credential.AbstractCredential
This class represents client credentials and (after authentication) a user profile.
Since:
3.5.0
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    AUTHENTICATION_ATTRIBUTE_CLIENT_NAME
    The name of the client used to perform the authentication.
    static final String
    NOT_YET_AUTHENTICATED
    The prefix used when building an identifier for an unauthenticated user.

    Fields inherited from interface org.apereo.cas.authentication.Credential

    CREDENTIAL_TYPE_ATTRIBUTE, UNKNOWN_ID

  • Constructor Summary

    Constructors
    Constructor
    Description
    ClientCredential()
     
    ClientCredential(String clientName, org.pac4j.core.profile.UserProfile userProfile)
     
    ClientCredential(org.pac4j.core.credentials.Credentials credentials, String clientName)
     
    ClientCredential(org.pac4j.core.credentials.Credentials credentials, String clientName, boolean typedIdUsed, org.pac4j.core.profile.UserProfile userProfile)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getClientName()
    Name of the client that established the credential.
    org.pac4j.core.credentials.Credentials
    getCredentials()
    The internal credentials provided by the authentication at the provider.
    String
    getId()
     
    org.pac4j.core.profile.UserProfile
    getUserProfile()
     
    boolean
    isTypedIdUsed()
     
    void
    setTypedIdUsed(boolean typedIdUsed)
     
    void
    setUserProfile(org.pac4j.core.profile.UserProfile userProfile)
    The user profile after authentication.
    String
    toString()
     

    Methods inherited from class org.apereo.cas.authentication.credential.AbstractCredential

    equals, getCredentialMetadata, hashCode, isValid, setCredentialMetadata, validate

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • NOT_YET_AUTHENTICATED

      public static final String NOT_YET_AUTHENTICATED
      The prefix used when building an identifier for an unauthenticated user.
      See Also:

    • AUTHENTICATION_ATTRIBUTE_CLIENT_NAME

      public static final String AUTHENTICATION_ATTRIBUTE_CLIENT_NAME
      The name of the client used to perform the authentication.
      See Also:

  • Constructor Details

    • ClientCredential

      public ClientCredential(String clientName, org.pac4j.core.profile.UserProfile userProfile)

    • ClientCredential

      public ClientCredential()

    • ClientCredential

      public ClientCredential(org.pac4j.core.credentials.Credentials credentials, String clientName)

    • ClientCredential

      public ClientCredential(org.pac4j.core.credentials.Credentials credentials, String clientName, boolean typedIdUsed, org.pac4j.core.profile.UserProfile userProfile)

  • Method Details

    • getUserProfile

      public org.pac4j.core.profile.UserProfile getUserProfile()

    • getId

      public String getId()

    • toString

      public String toString()
      Overrides:
      toString in class org.apereo.cas.authentication.credential.AbstractCredential

    • setTypedIdUsed

      public void setTypedIdUsed(boolean typedIdUsed)

    • setUserProfile

      public void setUserProfile(org.pac4j.core.profile.UserProfile userProfile)
      The user profile after authentication.

    • getCredentials

      public org.pac4j.core.credentials.Credentials getCredentials()
      The internal credentials provided by the authentication at the provider.

    • getClientName

      public String getClientName()
      Name of the client that established the credential.

    • isTypedIdUsed

      public boolean isTypedIdUsed()