Package org.opensaml.profile.context

Class ProfileRequestContext

  • All Implemented Interfaces:
    Iterable<org.opensaml.messaging.context.BaseContext>
    @ThreadSafe
public final class ProfileRequestContext
extends org.opensaml.messaging.context.InOutOperationContext
    Context that holds the ongoing state of a profile request.

    • Nested Class Summary

      • Nested classes/interfaces inherited from class org.opensaml.messaging.context.BaseContext

        org.opensaml.messaging.context.BaseContext.ContextSetNoRemoveIteratorDecorator

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String ANONYMOUS_PROFILE_ID
      Profile ID if not overridden.
      static String BINDING_KEY
      ID under which this context is stored, for example, within maps or sessions.
      private boolean browserProfile
      Whether the current profile request is browser-based.
      private String loggingId
      Logging label for the profile/operation/function .
      private String profileId
      Unique identifier for the profile/operation/function of the current request.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      String getLoggingId()
      Get the logging ID of the profile used by the current request.
      String getProfileId()
      Get the ID of the profile used by the current request.
      boolean isBrowserProfile()
      Get whether the current profile request is browser-based (defaults to false).
      void setBrowserProfile​(boolean browser)
      Set whether the current profile request is browser-based.
      void setLoggingId​(String id)
      Set the logging ID of the profile used by the current request.
      void setProfileId​(String id)
      Set the ID of the profile used by the current request.

      • Methods inherited from class org.opensaml.messaging.context.InOutOperationContext

        getInboundMessageContext, getOutboundMessageContext, setInboundMessageContext, setOutboundMessageContext

      • Methods inherited from class org.opensaml.messaging.context.BaseContext

        addSubcontext, addSubcontext, clearSubcontexts, containsSubcontext, createSubcontext, getParent, getSubcontext, getSubcontext, getSubcontext, getSubcontext, iterator, removeSubcontext, removeSubcontext, setParent

    • Field Detail

      • BINDING_KEY

        public static final String BINDING_KEY
        ID under which this context is stored, for example, within maps or sessions.
        See Also:
        Constant Field Values

      • profileId

        private String profileId
        Unique identifier for the profile/operation/function of the current request.

      • loggingId

        private String loggingId
        Logging label for the profile/operation/function .

      • browserProfile

        private boolean browserProfile
        Whether the current profile request is browser-based.

    • Constructor Detail

      • ProfileRequestContext

        public ProfileRequestContext()
        Constructor.

    • Method Detail

      • getProfileId

        @Nonnull
@NotEmpty
public String getProfileId()
        Get the ID of the profile used by the current request.
        Returns:
        ID of the profile used by the current request

      • setProfileId

        public void setProfileId​(@Nullable
                         String id)
        Set the ID of the profile used by the current request.
        Parameters:
        id - ID of the profile used by the current request

      • getLoggingId

        @Nonnull
@NotEmpty
public String getLoggingId()
        Get the logging ID of the profile used by the current request.

        The logging ID is used for audit logging and may be used for other logging-related functions such as in diagnostic contexts.

        Returns:
        ID of the profile used for logging

      • setLoggingId

        public void setLoggingId​(@Nullable
                         String id)
        Set the logging ID of the profile used by the current request.

        The logging ID is used for audit logging and may be used for other logging-related functions such as in diagnostic contexts.

        Parameters:
        id - ID of the profile used for logging

      • isBrowserProfile

        public boolean isBrowserProfile()
        Get whether the current profile request is browser-based (defaults to false).
        Returns:
        whether the current profile request is browser-based

      • setBrowserProfile

        public void setBrowserProfile​(boolean browser)
        Set whether the current profile request is browser-based.
        Parameters:
        browser - whether the current profile request is browser-based