org.opensaml.soap.soap11.profile.impl

Class AddSOAPFault

java.lang.Object

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

org.opensaml.profile.action.AbstractProfileAction

org.opensaml.soap.soap11.profile.impl.AddSOAPFault

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 AddSOAPFault
extends AbstractProfileAction

Action that builds a SOAP 1.1 Fault object in the outbound message context.

Options allow for the creation of a FaultString either explicitly, or via lookup strategy.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AddSOAPFault.FaultCodeMappingFunction A default method to map event IDs to faultcode QName based on EventContext.

Field Summary

Fields

Modifier and Type	Field and Description
private javax.xml.namespace.QName	defaultFaultCode Default fault codes to insert.
private boolean	detailedErrors Whether to include detailed status information.
private com.google.common.base.Predicate<ProfileRequestContext>	detailedErrorsCondition Predicate determining whether detailed error information is permitted.
private com.google.common.base.Function<ProfileRequestContext,javax.xml.namespace.QName>	faultCodeLookupStrategy Optional method to obtain fault code.
private java.lang.String	faultString A default fault string to include.
private com.google.common.base.Function<ProfileRequestContext,java.lang.String>	faultStringLookupStrategy Optional method to obtain a fault string.
private org.slf4j.Logger	log Class logger.

Constructor Summary

Constructors

Constructor and Description
AddSOAPFault() Constructor.

Method Summary

Modifier and Type	Method and Description
private void	buildFaultString(Fault fault, java.lang.String message) Build and attach FaultString element.
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	setFaultCode(javax.xml.namespace.QName code) Set the default faultcode to insert.
void	setFaultCodeLookupStrategy(com.google.common.base.Function<ProfileRequestContext,javax.xml.namespace.QName> strategy) Set the optional strategy used to obtain a faultcode to include.
void	setFaultString(java.lang.String message) Set a default faultstring to use in the event that error detail is off, or no specific message is obtained.
void	setFaultStringLookupStrategy(com.google.common.base.Function<ProfileRequestContext,java.lang.String> strategy) Set the optional strategy used to obtain a faultstring 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

Field Detail

log

@Nonnull
private org.slf4j.Logger log

Class logger.

detailedErrorsCondition

@Nonnull
private com.google.common.base.Predicate<ProfileRequestContext> detailedErrorsCondition

Predicate determining whether detailed error information is permitted.

faultCodeLookupStrategy

@Nullable
private com.google.common.base.Function<ProfileRequestContext,javax.xml.namespace.QName> faultCodeLookupStrategy

Optional method to obtain fault code.

faultStringLookupStrategy

@Nullable
private com.google.common.base.Function<ProfileRequestContext,java.lang.String> faultStringLookupStrategy

Optional method to obtain a fault string.

defaultFaultCode

@Nonnull
 @NonnullElements
private javax.xml.namespace.QName defaultFaultCode

Default fault codes to insert.

faultString

@Nullable
private java.lang.String faultString

A default fault string to include.

detailedErrors

private boolean detailedErrors

Whether to include detailed status information.

Constructor Detail

AddSOAPFault

public AddSOAPFault()

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

setFaultCodeLookupStrategy

public void setFaultCodeLookupStrategy(@Nullable
                                       com.google.common.base.Function<ProfileRequestContext,javax.xml.namespace.QName> strategy)

Set the optional strategy used to obtain a faultcode to include.

Parameters:

strategy - strategy used to obtain faultcode

setFaultStringLookupStrategy

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

Set the optional strategy used to obtain a faultstring to include.

Parameters:

strategy - strategy used to obtain a fault string

setFaultCode

public void setFaultCode(@Nonnull
                         javax.xml.namespace.QName code)

Set the default faultcode to insert.

Parameters:

code - faultcode

setFaultString

public void setFaultString(@Nullable
                           java.lang.String message)

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

Parameters:

message - default faultstring

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

buildFaultString

private void buildFaultString(@Nonnull
                              Fault fault,
                              @Nonnull @NotEmpty
                              java.lang.String message)

Build and attach FaultString element.

Parameters:

fault - the element to attach to

message - the message to set