public class AddStatusToResponse extends AbstractProfileAction
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.
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 and Description |
---|
AddStatusToResponse()
Constructor.
|
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.
|
doPostExecute, doPostExecute, execute, getHttpServletRequest, getHttpServletResponse, getLogPrefix, setHttpServletRequest, setHttpServletResponse
destroy, doDestroy, doInitialize, initialize, isDestroyed, isInitialized
public void setDetailedErrorsCondition(@Nonnull com.google.common.base.Predicate<ProfileRequestContext> condition)
condition
- predicate for detailed errors conditionpublic void setStatusCodesLookupStrategy(@Nullable com.google.common.base.Function<ProfileRequestContext,List<QName>> strategy)
strategy
- strategy used to obtain status codespublic void setStatusMessageLookupStrategy(@Nullable com.google.common.base.Function<ProfileRequestContext,String> strategy)
strategy
- strategy used to obtain a status messagepublic 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 setStatusCodes(@Nonnull @NonnullElements List<QName> codes)
codes
- list of status code values to insertpublic void setStatusMessage(@Nullable String message)
message
- default status messageprotected 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 AbstractProfileAction
profileRequestContext
- the current IdP profile request contextprotected void doExecute(@Nonnull ProfileRequestContext profileRequestContext)
doExecute
in class AbstractProfileAction
profileRequestContext
- the current IdP profile request contextCopyright © 2016. All rights reserved.