Package org.apereo.cas.authentication.rest

Class SurrogateAuthenticationRestHttpRequestCredentialFactory

  • All Implemented Interfaces:
    org.apereo.cas.rest.factory.RestHttpRequestCredentialFactory, org.springframework.core.Ordered
    public class SurrogateAuthenticationRestHttpRequestCredentialFactory
extends org.apereo.cas.rest.factory.UsernamePasswordRestHttpRequestCredentialFactory
    This is SurrogateAuthenticationRestHttpRequestCredentialFactory.
    Since:
    6.2.0

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String REQUEST_HEADER_SURROGATE_PRINCIPAL
      Header to be extracted from the request that indicates the surrogate/substitute principal name.

      • Fields inherited from interface org.springframework.core.Ordered

        HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

      • Fields inherited from interface org.apereo.cas.rest.factory.RestHttpRequestCredentialFactory

        PARAMETER_PASSWORD, PARAMETER_USERNAME

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected SurrogateUsernamePasswordCredential extractCredential​(javax.servlet.http.HttpServletRequest request, java.util.List<org.apereo.cas.authentication.Credential> credentials)
      Extract credential surrogate username password.
      java.util.List<org.apereo.cas.authentication.Credential> fromRequest​(javax.servlet.http.HttpServletRequest request, org.springframework.util.MultiValueMap<java.lang.String,​java.lang.String> requestBody)  
      int getOrder()  

      • Methods inherited from class org.apereo.cas.rest.factory.UsernamePasswordRestHttpRequestCredentialFactory

        setOrder

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

      • Methods inherited from interface org.apereo.cas.rest.factory.RestHttpRequestCredentialFactory

        fromAuthentication

    • Field Detail

      • REQUEST_HEADER_SURROGATE_PRINCIPAL

        public static final java.lang.String REQUEST_HEADER_SURROGATE_PRINCIPAL
        Header to be extracted from the request that indicates the surrogate/substitute principal name.
        See Also:
        Constant Field Values

    • Constructor Detail

      • SurrogateAuthenticationRestHttpRequestCredentialFactory

        public SurrogateAuthenticationRestHttpRequestCredentialFactory()

    • Method Detail

      • extractCredential

        protected SurrogateUsernamePasswordCredential extractCredential​(javax.servlet.http.HttpServletRequest request,
                                                                java.util.List<org.apereo.cas.authentication.Credential> credentials)
                                                         throws java.lang.Exception
        Extract credential surrogate username password.
        Parameters:
        request - the request
        credentials - the credentials
        Returns:
        the surrogate username password credential
        Throws:
        java.lang.Exception - the exception

      • getOrder

        public int getOrder()
        Specified by:
        getOrder in interface org.springframework.core.Ordered
        Specified by:
        getOrder in interface org.apereo.cas.rest.factory.RestHttpRequestCredentialFactory
        Overrides:
        getOrder in class org.apereo.cas.rest.factory.UsernamePasswordRestHttpRequestCredentialFactory

      • fromRequest

        public java.util.List<org.apereo.cas.authentication.Credential> fromRequest​(javax.servlet.http.HttpServletRequest request,
                                                                            org.springframework.util.MultiValueMap<java.lang.String,​java.lang.String> requestBody)
        Specified by:
        fromRequest in interface org.apereo.cas.rest.factory.RestHttpRequestCredentialFactory
        Overrides:
        fromRequest in class org.apereo.cas.rest.factory.UsernamePasswordRestHttpRequestCredentialFactory