public class AddSubjectConfirmationToSubjects extends AbstractProfileAction
SubjectConfirmation and adds it to the Subject of 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 will be created by this action, but if no Subject exists in
the assertions found, it will be cretaed.
An associated SubjectConfirmationData will be built to spec based on a set of
lookup functions that optionally provide various attributes. They have appropriate defaults
for the simple use case of a bearer SSO assertion but need to be overridden for other cases.
| Modifier and Type | Field and Description |
|---|---|
private com.google.common.base.Function<ProfileRequestContext,java.lang.String> |
addressLookupStrategy
Optional strategy to obtain value for
SubjectConfirmationData.getAddress(). |
private SAMLObjectBuilder<SubjectConfirmation> |
confirmationBuilder
Builder for SubjectConfirmation objects.
|
private SAMLObjectBuilder<SubjectConfirmationData> |
confirmationDataBuilder
Builder for SubjectConfirmation objects.
|
private java.lang.String |
confirmationMethod
Method to add.
|
private com.google.common.base.Function<ProfileRequestContext,java.lang.String> |
inResponseToLookupStrategy
Optional strategy to obtain value for
SubjectConfirmationData.getInResponseTo(). |
private com.google.common.base.Function<ProfileRequestContext,java.lang.Long> |
lifetimeLookupStrategy
Optional strategy to obtain value for
SubjectConfirmationData.getNotOnOrAfter(). |
private org.slf4j.Logger |
log
Class logger.
|
private boolean |
overwriteExisting
Flag controlling whether to overwrite existing confirmations.
|
private com.google.common.base.Function<ProfileRequestContext,java.lang.String> |
recipientLookupStrategy
Optional strategy to obtain value for
SubjectConfirmationData.getRecipient(). |
private Response |
response
Response to modify.
|
private com.google.common.base.Function<ProfileRequestContext,Response> |
responseLookupStrategy
Strategy used to locate the
Response to operate on. |
private SAMLObjectBuilder<Subject> |
subjectBuilder
Builder for Subject objects.
|
| Constructor and Description |
|---|
AddSubjectConfirmationToSubjects()
Constructor.
|
| Modifier and Type | Method and Description |
|---|---|
private SubjectConfirmation |
cloneConfirmation(SubjectConfirmation confirmation)
Create an efficient field-wise copy of a
SubjectConfirmation. |
protected void |
doExecute(ProfileRequestContext profileRequestContext)
Performs this action.
|
protected void |
doInitialize() |
protected boolean |
doPreExecute(ProfileRequestContext profileRequestContext)
Called prior to execution, actions may override this method to perform pre-processing for a request.
|
private Subject |
getAssertionSubject(Assertion assertion)
Get the subject to which the confirmation will be added.
|
void |
setAddressLookupStrategy(com.google.common.base.Function<ProfileRequestContext,java.lang.String> strategy)
Set the strategy used to obtain value for
SubjectConfirmationData.getAddress(). |
void |
setInResponseToLookupStrategy(com.google.common.base.Function<ProfileRequestContext,java.lang.String> strategy)
Set the strategy used to obtain value for
SubjectConfirmationData.getInResponseTo(). |
void |
setLifetimeLookupStrategy(com.google.common.base.Function<ProfileRequestContext,java.lang.Long> strategy)
Set the strategy used to obtain value for
SubjectConfirmationData.getNotOnOrAfter(). |
void |
setMethod(java.lang.String method)
Set the confirmation method to use.
|
void |
setOverwriteExisting(boolean flag)
Set whether to overwrite any existing
SubjectConfirmation objects found. |
void |
setRecipientLookupStrategy(com.google.common.base.Function<ProfileRequestContext,java.lang.String> strategy)
Set the strategy used to obtain value for
SubjectConfirmationData.getRecipient(). |
void |
setResponseLookupStrategy(com.google.common.base.Function<ProfileRequestContext,Response> strategy)
Set the strategy used to locate the
Response to operate on. |
doPostExecute, doPostExecute, execute, getHttpServletRequest, getHttpServletResponse, getLogPrefix, setHttpServletRequest, setHttpServletResponsedestroy, doDestroy, initialize, isDestroyed, isInitialized@Nonnull private final org.slf4j.Logger log
@Nonnull private final SAMLObjectBuilder<Subject> subjectBuilder
@Nonnull private final SAMLObjectBuilder<SubjectConfirmation> confirmationBuilder
@Nonnull private final SAMLObjectBuilder<SubjectConfirmationData> confirmationDataBuilder
private boolean overwriteExisting
@Nonnull private com.google.common.base.Function<ProfileRequestContext,Response> responseLookupStrategy
Response to operate on.@Nullable private com.google.common.base.Function<ProfileRequestContext,java.lang.String> addressLookupStrategy
SubjectConfirmationData.getAddress().@Nullable private com.google.common.base.Function<ProfileRequestContext,java.lang.String> inResponseToLookupStrategy
SubjectConfirmationData.getInResponseTo().@Nullable private com.google.common.base.Function<ProfileRequestContext,java.lang.String> recipientLookupStrategy
SubjectConfirmationData.getRecipient().@Nullable private com.google.common.base.Function<ProfileRequestContext,java.lang.Long> lifetimeLookupStrategy
SubjectConfirmationData.getNotOnOrAfter().@NonnullAfterInit private java.lang.String confirmationMethod
@Nullable private Response response
public AddSubjectConfirmationToSubjects()
public void setOverwriteExisting(boolean flag)
SubjectConfirmation objects found.flag - true iff the action should overwrite any existing objectspublic void setResponseLookupStrategy(@Nonnull
com.google.common.base.Function<ProfileRequestContext,Response> strategy)
Response to operate on.strategy - strategy used to locate the Response to operate onpublic void setAddressLookupStrategy(@Nullable
com.google.common.base.Function<ProfileRequestContext,java.lang.String> strategy)
SubjectConfirmationData.getAddress().strategy - lookup strategypublic void setInResponseToLookupStrategy(@Nullable
com.google.common.base.Function<ProfileRequestContext,java.lang.String> strategy)
SubjectConfirmationData.getInResponseTo().strategy - lookup strategypublic void setRecipientLookupStrategy(@Nullable
com.google.common.base.Function<ProfileRequestContext,java.lang.String> strategy)
SubjectConfirmationData.getRecipient().strategy - lookup strategypublic void setLifetimeLookupStrategy(@Nullable
com.google.common.base.Function<ProfileRequestContext,java.lang.Long> strategy)
SubjectConfirmationData.getNotOnOrAfter().strategy - lookup strategypublic void setMethod(@Nonnull @NotEmpty
java.lang.String method)
method - confirmation method to useprotected void doInitialize()
throws net.shibboleth.utilities.java.support.component.ComponentInitializationException
doInitialize in class net.shibboleth.utilities.java.support.component.AbstractInitializableComponentnet.shibboleth.utilities.java.support.component.ComponentInitializationExceptionprotected boolean doPreExecute(@Nonnull
ProfileRequestContext profileRequestContext)
If false is returned, execution will not proceed, and the action should attach an
EventContext to the context tree to signal how to continue with overall
workflow processing.
If returning successfully, the last step should be to return the result of the superclass version of this method.
doPreExecute in class AbstractProfileActionprofileRequestContext - the current IdP profile request contextprotected void doExecute(@Nonnull
ProfileRequestContext profileRequestContext)
doExecute in class AbstractProfileActionprofileRequestContext - the current IdP profile request context@Nonnull private Subject getAssertionSubject(@Nonnull Assertion assertion)
assertion - the assertion being modified@Nonnull private SubjectConfirmation cloneConfirmation(@Nonnull SubjectConfirmation confirmation)
SubjectConfirmation.confirmation - the object to clone