org.opensaml.saml.saml1.profile.impl

Class AddStatusToResponse

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

org.opensaml.profile.action.AbstractProfileAction

org.opensaml.saml.saml1.profile.impl.AddStatusToResponse

All Implemented Interfaces:

net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.InitializableComponent, ProfileAction

public class AddStatusToResponse
extends AbstractProfileAction

Action that sets Status content in a Response obtained from a lookup strategy, typically from the outbound message context.

If the message already contains status information, this action will overwrite it.

Options allows for the creation of a StatusMessage either explicitly, or via lookup strategy.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AddStatusToResponse.StatusCodeMappingFunction A default method to map event IDs to SAML 1 StatusCode QNames based on EventContext.

Constructor Summary

Constructors

Constructor and Description
AddStatusToResponse() Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	doExecute(ProfileRequestContext profileRequestContext) Performs this action.
protected boolean	doPreExecute(ProfileRequestContext profileRequestContext) Called prior to execution, actions may override this method to perform pre-processing for a request.
void	setDetailedErrorsCondition(com.google.common.base.Predicate<ProfileRequestContext> condition) Set the predicate used to determine the detailed errors condition.
void	setResponseLookupStrategy(com.google.common.base.Function<ProfileRequestContext,Response> strategy) Set the strategy used to locate the Response to operate on.
void	setStatusCodes(List<QName> codes) Set the default list of status code values to insert, ordered such that the top level code is first and every other code will be nested inside the previous one.
void	setStatusCodesLookupStrategy(com.google.common.base.Function<ProfileRequestContext,List<QName>> strategy) Set the optional strategy used to obtain status codes to include.
void	setStatusMessage(String message) Set a default status message to use in the event that error detail is off, or no specific message is obtained.
void	setStatusMessageLookupStrategy(com.google.common.base.Function<ProfileRequestContext,String> strategy) Set the optional strategy used to obtain a status message to include.

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, doInitialize, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

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

initialize, isInitialized

Constructor Detail

AddStatusToResponse

public AddStatusToResponse()

Constructor.

Method Detail

setDetailedErrorsCondition

public void setDetailedErrorsCondition(@Nonnull
                                       com.google.common.base.Predicate<ProfileRequestContext> condition)

Set the predicate used to determine the detailed errors condition.

Parameters:

condition - predicate for detailed errors condition

setStatusCodesLookupStrategy

public void setStatusCodesLookupStrategy(@Nullable
                                         com.google.common.base.Function<ProfileRequestContext,List<QName>> strategy)

Set the optional strategy used to obtain status codes to include.

Parameters:

strategy - strategy used to obtain status codes

setStatusMessageLookupStrategy

public void setStatusMessageLookupStrategy(@Nullable
                                           com.google.common.base.Function<ProfileRequestContext,String> strategy)

Set the optional strategy used to obtain a status message to include.

Parameters:

strategy - strategy used to obtain a status message

setResponseLookupStrategy

public void setResponseLookupStrategy(@Nonnull
                                      com.google.common.base.Function<ProfileRequestContext,Response> strategy)

Set the strategy used to locate the Response to operate on.

Parameters:

strategy - strategy used to locate the Response to operate on

setStatusCodes

public void setStatusCodes(@Nonnull @NonnullElements
                           List<QName> codes)

Set the default list of status code values to insert, ordered such that the top level code is first and every other code will be nested inside the previous one.

Parameters:

codes - list of status code values to insert

setStatusMessage

public void setStatusMessage(@Nullable
                             String message)

Set a default status message to use in the event that error detail is off, or no specific message is obtained.

Parameters:

message - default status message

doPreExecute

protected boolean doPreExecute(@Nonnull
                               ProfileRequestContext profileRequestContext)

Called prior to execution, actions may override this method to perform pre-processing for a request.

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.

Overrides:

doPreExecute in class AbstractProfileAction

Parameters:

profileRequestContext - the current IdP profile request context

Returns:

true iff execution should proceed

doExecute

protected void doExecute(@Nonnull
                         ProfileRequestContext profileRequestContext)

Performs this action. Actions must override this method to perform their work.

Overrides:

doExecute in class AbstractProfileAction

Parameters:

profileRequestContext - the current IdP profile request context