Package net.shibboleth.idp.authn.impl

Class ExtractRemoteUser

  • All Implemented Interfaces:
    net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.InitializableComponent, org.opensaml.profile.action.ProfileAction, Aware, MessageSource, MessageSourceAware, Action
    public class ExtractRemoteUser
extends net.shibboleth.idp.authn.AbstractExtractionAction
    An action that extracts an asserted user identity from the incoming request, creates a UsernameContext, and attaches it to the AuthenticationContext.
    Event:
    EventIds.PROCEED_EVENT_ID, AuthnEventIds.NO_CREDENTIALS
    Precondition:
    ProfileRequestContext.getSubcontext(AuthenticationContext.class, false) != null
    Postcondition:
    If getHttpServletRequest() != null, the content of either the getRemoteUser() method or a designated header or attribute will be attached via a UsernameContext.

    • Constructor Summary

      Constructors 
      Constructor Description
      ExtractRemoteUser()
      Constructor.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void doExecute​(org.opensaml.profile.context.ProfileRequestContext profileRequestContext, net.shibboleth.idp.authn.context.AuthenticationContext authenticationContext)
      protected void doInitialize()
      void setCheckAttributes​(Collection<String> attributes)
      Set the list of request attributes to check for an identity.
      void setCheckHeaders​(Collection<String> headers)
      Set the list of request headers to check for an identity.
      void setCheckRemoteUser​(boolean flag)
      Set whether to check REMOTE_USER for an identity.

      • Methods inherited from class net.shibboleth.idp.authn.AbstractExtractionAction

        applyTransforms, setLowercase, setTransforms, setTrim, setUppercase

      • Methods inherited from class net.shibboleth.idp.authn.AbstractAuthenticationAction

        doExecute, doPreExecute, doPreExecute, setAuthenticationContextLookupStrategy

      • Methods inherited from class net.shibboleth.idp.profile.AbstractProfileAction

        doExecute, execute, getMessage, getMessage, getMessage, getProfileContextLookupStrategy, getRequestContext, getResult, setMessageSource, setProfileContextLookupStrategy

      • Methods inherited from class org.opensaml.profile.action.AbstractConditionalProfileAction

        getActivationCondition, setActivationCondition

      • Methods inherited from class org.opensaml.profile.action.AbstractProfileAction

        doPostExecute, doPostExecute, execute, getHttpServletRequest, getHttpServletResponse, getLogPrefix, setHttpServletRequest, setHttpServletResponse

      • Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

        destroy, doDestroy, initialize, isDestroyed, isInitialized

      • Methods inherited from interface net.shibboleth.utilities.java.support.component.InitializableComponent

        initialize, isInitialized

    • Field Detail

      • log

        @Nonnull
private final org.slf4j.Logger log
        Class logger.

      • checkRemoteUser

        private boolean checkRemoteUser
        Whether to check REMOTE_USER for an identity. Defaults to true.

      • checkAttributes

        @Nonnull
@NonnullElements
private Collection<String> checkAttributes
        List of request attributes to check for an identity.

      • checkHeaders

        @Nonnull
@NonnullElements
private Collection<String> checkHeaders
        List of request headers to check for an identity.

    • Constructor Detail

      • ExtractRemoteUser

        public ExtractRemoteUser()
        Constructor.

    • Method Detail

      • setCheckRemoteUser

        public void setCheckRemoteUser​(boolean flag)
        Set whether to check REMOTE_USER for an identity.
        Parameters:
        flag - value to set

      • setCheckAttributes

        public void setCheckAttributes​(@Nonnull @NonnullElements
                               Collection<String> attributes)
        Set the list of request attributes to check for an identity.
        Parameters:
        attributes - list of request attributes to check

      • setCheckHeaders

        public void setCheckHeaders​(@Nonnull @NonnullElements
                            Collection<String> headers)
        Set the list of request headers to check for an identity.
        Parameters:
        headers - list of request headers to check

      • doInitialize

        protected void doInitialize()
                     throws net.shibboleth.utilities.java.support.component.ComponentInitializationException
        Overrides:
        doInitialize in class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent
        Throws:
        net.shibboleth.utilities.java.support.component.ComponentInitializationException

      • doExecute

        protected void doExecute​(@Nonnull
                         org.opensaml.profile.context.ProfileRequestContext profileRequestContext,
                         @Nonnull
                         net.shibboleth.idp.authn.context.AuthenticationContext authenticationContext)
        Overrides:
        doExecute in class net.shibboleth.idp.authn.AbstractAuthenticationAction