Package org.opensaml.saml.saml1.profile.impl

Class AddSubjectConfirmationToSubjects

  • 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
    public class AddSubjectConfirmationToSubjects
extends org.opensaml.profile.action.AbstractProfileAction
    Action that builds SubjectConfirmation and adds it to the Subject of all the statements in all the assertions found in a Response. The message to update is returned by a lookup strategy, by default the message returned by InOutOperationContext.getOutboundMessageContext().

    No assertions or statements will be created by this action, but if no Subject exists in the statements found, it will be created.

    Event:
    EventIds.PROCEED_EVENT_ID, EventIds.INVALID_MSG_CTX

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private boolean artifactProfile
      Flag indicating whether the outbound message is being issued via the Artifact profile.
      private org.opensaml.saml.common.SAMLObjectBuilder<org.opensaml.saml.saml1.core.SubjectConfirmation> confirmationBuilder
      Builder for SubjectConfirmation objects.
      private org.opensaml.saml.common.SAMLObjectBuilder<org.opensaml.saml.saml1.core.ConfirmationMethod> confirmationMethodBuilder
      Builder for ConfirmationMethod objects.
      private Collection<String> confirmationMethods
      Methods to add.
      private Logger log
      Class logger.
      private boolean overwriteExisting
      Flag controlling whether to overwrite an existing confirmation.
      private org.opensaml.saml.saml1.core.Response response
      Response to modify.
      private Function<org.opensaml.profile.context.ProfileRequestContext,​org.opensaml.saml.saml1.core.Response> responseLookupStrategy
      Strategy used to locate the Response to operate on.
      private org.opensaml.saml.common.SAMLObjectBuilder<org.opensaml.saml.saml1.core.Subject> subjectBuilder
      Builder for Subject objects.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      private org.opensaml.saml.saml1.core.SubjectConfirmation cloneConfirmation​(org.opensaml.saml.saml1.core.SubjectConfirmation confirmation)
      Create an efficient field-wise copy of a SubjectConfirmation.
      protected void doExecute​(org.opensaml.profile.context.ProfileRequestContext profileRequestContext)
      protected void doInitialize()
      protected boolean doPreExecute​(org.opensaml.profile.context.ProfileRequestContext profileRequestContext)
      private org.opensaml.saml.saml1.core.Subject getStatementSubject​(org.opensaml.saml.saml1.core.SubjectStatement statement)
      Get the subject to which the confirmation will be added.
      void setMethods​(Collection<String> methods)
      Set the confirmation methods to use.
      void setOverwriteExisting​(boolean flag)
      Set whether to overwrite any existing SubjectConfirmation objects found.
      void setResponseLookupStrategy​(Function<org.opensaml.profile.context.ProfileRequestContext,​org.opensaml.saml.saml1.core.Response> strategy)
      Set the strategy used to locate the Response to operate on.

      • 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 Logger log
        Class logger.

      • subjectBuilder

        @Nonnull
private final org.opensaml.saml.common.SAMLObjectBuilder<org.opensaml.saml.saml1.core.Subject> subjectBuilder
        Builder for Subject objects.

      • confirmationBuilder

        @Nonnull
private final org.opensaml.saml.common.SAMLObjectBuilder<org.opensaml.saml.saml1.core.SubjectConfirmation> confirmationBuilder
        Builder for SubjectConfirmation objects.

      • confirmationMethodBuilder

        @Nonnull
private final org.opensaml.saml.common.SAMLObjectBuilder<org.opensaml.saml.saml1.core.ConfirmationMethod> confirmationMethodBuilder
        Builder for ConfirmationMethod objects.

      • overwriteExisting

        private boolean overwriteExisting
        Flag controlling whether to overwrite an existing confirmation.

      • responseLookupStrategy

        @Nonnull
private Function<org.opensaml.profile.context.ProfileRequestContext,​org.opensaml.saml.saml1.core.Response> responseLookupStrategy
        Strategy used to locate the Response to operate on.

      • confirmationMethods

        @Nonnull
@NonnullElements
private Collection<String> confirmationMethods
        Methods to add.

      • response

        @Nullable
private org.opensaml.saml.saml1.core.Response response
        Response to modify.

      • artifactProfile

        private boolean artifactProfile
        Flag indicating whether the outbound message is being issued via the Artifact profile.

    • Constructor Detail

      • AddSubjectConfirmationToSubjects

        public AddSubjectConfirmationToSubjects()
        Constructor.

    • Method Detail

      • setOverwriteExisting

        public void setOverwriteExisting​(boolean flag)
        Set whether to overwrite any existing SubjectConfirmation objects found.
        Parameters:
        flag - true iff the action should overwrite any existing objects

      • setResponseLookupStrategy

        public void setResponseLookupStrategy​(@Nonnull
                                      Function<org.opensaml.profile.context.ProfileRequestContext,​org.opensaml.saml.saml1.core.Response> strategy)
        Set the strategy used to locate the Response to operate on.
        Parameters:
        strategy - strategy used to locate the Response to operate on

      • setMethods

        public void setMethods​(@Nonnull @NonnullElements
                       Collection<String> methods)
        Set the confirmation methods to use.
        Parameters:
        methods - confirmation methods to use

      • 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

      • doPreExecute

        protected boolean doPreExecute​(@Nonnull
                               org.opensaml.profile.context.ProfileRequestContext profileRequestContext)
        Overrides:
        doPreExecute in class org.opensaml.profile.action.AbstractProfileAction

      • doExecute

        protected void doExecute​(@Nonnull
                         org.opensaml.profile.context.ProfileRequestContext profileRequestContext)
        Overrides:
        doExecute in class org.opensaml.profile.action.AbstractProfileAction

      • getStatementSubject

        @Nonnull
private org.opensaml.saml.saml1.core.Subject getStatementSubject​(@Nonnull
                                                                 org.opensaml.saml.saml1.core.SubjectStatement statement)
        Get the subject to which the confirmation will be added.
        Parameters:
        statement - the statement being modified
        Returns:
        the subject to which the confirmation will be added

      • cloneConfirmation

        @Nonnull
private org.opensaml.saml.saml1.core.SubjectConfirmation cloneConfirmation​(@Nonnull
                                                                           org.opensaml.saml.saml1.core.SubjectConfirmation confirmation)
        Create an efficient field-wise copy of a SubjectConfirmation.
        Parameters:
        confirmation - the object to clone
        Returns:
        the copy