org.opensaml.soap.wsaddressing.messaging.impl

Class AddRelatesToHandler

java.lang.Object

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

org.opensaml.messaging.handler.AbstractMessageHandler<MessageType>

org.opensaml.soap.messaging.AbstractHeaderGeneratingMessageHandler

org.opensaml.soap.wsaddressing.messaging.impl.AddRelatesToHandler

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.messaging.handler.MessageHandler

public class AddRelatesToHandler
extends AbstractHeaderGeneratingMessageHandler

Handler implementation that adds a wsa:RelatesTo header to the outbound SOAP envelope.

Field Summary

Fields

Modifier and Type	Field and Description
private Logger	log Logger.
private String	relatesToURI The effective RelatesTo URI value to use.
private org.opensaml.messaging.context.navigate.ContextDataLookupFunction<org.opensaml.messaging.context.MessageContext,String>	relatesToURILookup Optional lookup function for obtaining the RelatesTo URI value.
private String	relationshipType The effective RelatesTo RelationshipType attribute value to use.

Constructor Summary

Constructors

Constructor and Description
AddRelatesToHandler()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doInvoke(org.opensaml.messaging.context.MessageContext messageContext)
protected boolean	doPreInvoke(org.opensaml.messaging.context.MessageContext messageContext)
org.opensaml.messaging.context.navigate.ContextDataLookupFunction<org.opensaml.messaging.context.MessageContext,String>	getRelatesToURILookup() Get the function for looking up the RelatesTo URI value.
String	getRelationshipType() Get the RelatesTo RelationshipType attribute value to use.
void	setRelatesToURILookup(org.opensaml.messaging.context.navigate.ContextDataLookupFunction<org.opensaml.messaging.context.MessageContext,String> lookup) Set the function for looking up the RelatesTo URI value.
void	setRelationshipType(String value) Set the RelatesTo RelationshipType attribute value to use.

Methods inherited from class org.opensaml.soap.messaging.AbstractHeaderGeneratingMessageHandler

decorateGeneratedHeader, getEffectiveTargetNode, isEffectiveMustUnderstand, setMustUnderstand, setMustUnderstandStrategy, setTargetNode, setTargetNodeStrategy

Methods inherited from class org.opensaml.messaging.handler.AbstractMessageHandler

doPostInvoke, doPostInvoke, getActivationCondition, getLogPrefix, invoke, setActivationCondition

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

private Logger log

Logger.

relatesToURILookup

private org.opensaml.messaging.context.navigate.ContextDataLookupFunction<org.opensaml.messaging.context.MessageContext,String> relatesToURILookup

Optional lookup function for obtaining the RelatesTo URI value.

relatesToURI

private String relatesToURI

The effective RelatesTo URI value to use.

relationshipType

private String relationshipType

The effective RelatesTo RelationshipType attribute value to use.

Constructor Detail

AddRelatesToHandler

public AddRelatesToHandler()

Method Detail

getRelatesToURILookup

public org.opensaml.messaging.context.navigate.ContextDataLookupFunction<org.opensaml.messaging.context.MessageContext,String> getRelatesToURILookup()

Get the function for looking up the RelatesTo URI value.

Returns:

the lookup function

setRelatesToURILookup

public void setRelatesToURILookup(org.opensaml.messaging.context.navigate.ContextDataLookupFunction<org.opensaml.messaging.context.MessageContext,String> lookup)

Set the function for looking up the RelatesTo URI value.

Parameters:

lookup - the lookup function

getRelationshipType

public String getRelationshipType()

Get the RelatesTo RelationshipType attribute value to use.

Returns:

the relationship type

setRelationshipType

public void setRelationshipType(String value)

Set the RelatesTo RelationshipType attribute value to use.

Parameters:

value - the relationship type

doPreInvoke

protected boolean doPreInvoke(@Nonnull
                  org.opensaml.messaging.context.MessageContext messageContext)
                       throws org.opensaml.messaging.handler.MessageHandlerException

Overrides:

doPreInvoke in class AbstractHeaderGeneratingMessageHandler

Throws:

org.opensaml.messaging.handler.MessageHandlerException

doInvoke

protected void doInvoke(org.opensaml.messaging.context.MessageContext messageContext)
                 throws org.opensaml.messaging.handler.MessageHandlerException

Specified by:

doInvoke in class org.opensaml.messaging.handler.AbstractMessageHandler

Throws:

org.opensaml.messaging.handler.MessageHandlerException