Class PrincipalBearingCredential

  • All Implemented Interfaces:
    java.io.Serializable, org.apereo.cas.authentication.Credential, org.apereo.cas.authentication.CredentialMetaData

    public class PrincipalBearingCredential
    extends org.apereo.cas.authentication.credential.AbstractCredential
    Credential that bear the fully resolved and authenticated Principal, or an indication that there is no such Principal. These Credential are a mechanism to pass into CAS information about an authentication and Principal resolution that has already happened in layers in front of CAS, e.g. by means of a Java Servlet Filter or by means of container authentication in the servlet container or Apache layers. DO NOT accept these Credential from arbitrary web-service calls to CAS. Rather, the code constructing these Credential must be trusted to perform appropriate authentication before issuing these credentials.
    Since:
    3.0.0
    See Also:
    Serialized Form
    • Field Summary

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

        CREDENTIAL_TYPE_ATTRIBUTE, UNKNOWN_ID
    • Constructor Summary

      Constructors 
      Constructor Description
      PrincipalBearingCredential​(@NonNull org.apereo.cas.authentication.principal.Principal principal)
      Instantiates a new principal bearing credential.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getId()  
      • Methods inherited from class org.apereo.cas.authentication.credential.AbstractCredential

        equals, getCredentialClass, hashCode, isValid, toString, validate
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • PrincipalBearingCredential

        public PrincipalBearingCredential​(@NonNull
                                          @NonNull org.apereo.cas.authentication.principal.Principal principal)
        Instantiates a new principal bearing credential.
        Parameters:
        principal - the principal
    • Method Detail

      • getId

        public java.lang.String getId()