org.apache.synapse.mediators.builtin

Class CalloutMediator

java.lang.Object

org.apache.synapse.mediators.AbstractMediator

org.apache.synapse.mediators.builtin.CalloutMediator

All Implemented Interfaces:

AspectConfigurable, ManagedLifecycle, Mediator, SynapseArtifact

public class CalloutMediator
extends AbstractMediator
implements ManagedLifecycle

? ? ? ? ?

Field Summary

Fields inherited from class org.apache.synapse.mediators.AbstractMediator

log, trace, traceState

Constructor Summary

Constructors

Constructor and Description
CalloutMediator()

Method Summary

Modifier and Type	Method and Description
void	destroy() This method should implement the destroying of the implemented parts of the configuration.
String	getAction()
String	getAxis2xml()
String	getClientRepository()
Endpoint	getEndpoint() Get the defined endpoint
String	getInboundWsSecPolicyKey() Get the inbound security policy key.
String	getOutboundWsSecPolicyKey() Get the outbound security policy key.
String	getRequestKey()
SynapseXPath	getRequestXPath()
String	getServiceURL()
String	getTargetKey()
SynapseXPath	getTargetXPath()
String	getWsSecPolicyKey() Return the Rampart Security configuration policy's 'key' to be used
void	init(SynapseEnvironment synEnv) This method should implement the initialization of the implemented parts of the configuration.
boolean	isInitClientOptions()
boolean	isPassHeaders()
boolean	isSecurityOn() Is WS-Security turned on?
boolean	mediate(MessageContext synCtx) Invokes the mediator passing the current message for mediation.
void	setAction(String action)
void	setAxis2xml(String axis2xml)
void	setClientRepository(String clientRepository)
void	setEndpoint(Endpoint endpoint) Set the defined endpoint
void	setInboundWsSecPolicyKey(String inboundWsSecPolicyKey) Set the inbound security policy key.
void	setInitClientOptions(boolean initClientOptions)
void	setOutboundWsSecPolicyKey(String outboundWsSecPolicyKey) Set the outbound security policy key.This is used when we specify different policies for inbound and outbound.
void	setPassHeaders(boolean passHeaders)
void	setRequestKey(String requestKey)
void	setRequestXPath(SynapseXPath requestXPath)
void	setSecurityOn(boolean securityOn) Request that WS-Sec be turned on/off
void	setServiceURL(String serviceURL)
void	setTargetKey(String targetKey)
void	setTargetXPath(SynapseXPath targetXPath)
void	setWsSecPolicyKey(String wsSecPolicyKey) Set the Rampart Security configuration policy's 'key' to be used

Methods inherited from class org.apache.synapse.mediators.AbstractMediator

auditLog, auditWarn, configure, disableStatistics, enableStatistics, getAspectConfiguration, getDescription, getLog, getTraceState, getType, handleException, handleException, isContentAware, isStatisticsEnable, isTraceOn, isTraceOrDebugOn, setDescription, setEffectiveTraceState, setTraceState, shouldTrace, traceOrDebug, traceOrDebugWarn

Methods inherited from class java.lang.Object

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

Constructor Detail

CalloutMediator

public CalloutMediator()

Method Detail

mediate

public boolean mediate(MessageContext synCtx)

Description copied from interface: Mediator

Invokes the mediator passing the current message for mediation. Each mediator performs its mediation action, and returns true if mediation should continue, or false if further mediation should be aborted.

Specified by:

mediate in interface Mediator

Parameters:

synCtx - the current message for mediation

Returns:

true if further mediation should continue

init

public void init(SynapseEnvironment synEnv)

Description copied from interface: ManagedLifecycle

This method should implement the initialization of the implemented parts of the configuration.

Specified by:

init in interface ManagedLifecycle

Parameters:

synEnv - SynapseEnvironment to be used for initialization

destroy

public void destroy()

Description copied from interface: ManagedLifecycle

This method should implement the destroying of the implemented parts of the configuration.

Specified by:

destroy in interface ManagedLifecycle

getServiceURL

public String getServiceURL()

setServiceURL

public void setServiceURL(String serviceURL)

getAction

public String getAction()

setAction

public void setAction(String action)

getRequestKey

public String getRequestKey()

setRequestKey

public void setRequestKey(String requestKey)

setRequestXPath

public void setRequestXPath(SynapseXPath requestXPath)
                     throws org.jaxen.JaxenException

Throws:

org.jaxen.JaxenException

setTargetXPath

public void setTargetXPath(SynapseXPath targetXPath)
                    throws org.jaxen.JaxenException

Throws:

org.jaxen.JaxenException

getTargetKey

public String getTargetKey()

setTargetKey

public void setTargetKey(String targetKey)

getRequestXPath

public SynapseXPath getRequestXPath()

getTargetXPath

public SynapseXPath getTargetXPath()

getClientRepository

public String getClientRepository()

setClientRepository

public void setClientRepository(String clientRepository)

getAxis2xml

public String getAxis2xml()

setAxis2xml

public void setAxis2xml(String axis2xml)

isPassHeaders

public boolean isPassHeaders()

setPassHeaders

public void setPassHeaders(boolean passHeaders)

isInitClientOptions

public boolean isInitClientOptions()

setInitClientOptions

public void setInitClientOptions(boolean initClientOptions)

isSecurityOn

public boolean isSecurityOn()

Is WS-Security turned on?

Returns:

true if on

setSecurityOn

public void setSecurityOn(boolean securityOn)

Request that WS-Sec be turned on/off

Parameters:

securityOn - a boolean flag indicating security is on or not

getWsSecPolicyKey

public String getWsSecPolicyKey()

Return the Rampart Security configuration policy's 'key' to be used

Returns:

the Rampart Security configuration policy's 'key' to be used

setWsSecPolicyKey

public void setWsSecPolicyKey(String wsSecPolicyKey)

Set the Rampart Security configuration policy's 'key' to be used

Parameters:

wsSecPolicyKey - the Rampart Security configuration policy's 'key' to be used

getOutboundWsSecPolicyKey

public String getOutboundWsSecPolicyKey()

Get the outbound security policy key. This is used when we specify different policies for inbound and outbound.

Returns:

outbound security policy key

setOutboundWsSecPolicyKey

public void setOutboundWsSecPolicyKey(String outboundWsSecPolicyKey)

Set the outbound security policy key.This is used when we specify different policies for inbound and outbound.

Parameters:

outboundWsSecPolicyKey - outbound security policy key.

getInboundWsSecPolicyKey

public String getInboundWsSecPolicyKey()

Get the inbound security policy key. This is used when we specify different policies for inbound and outbound.

Returns:

inbound security policy key

setInboundWsSecPolicyKey

public void setInboundWsSecPolicyKey(String inboundWsSecPolicyKey)

Set the inbound security policy key. This is used when we specify different policies for inbound and outbound.

Parameters:

inboundWsSecPolicyKey - inbound security policy key.

getEndpoint

public Endpoint getEndpoint()

Get the defined endpoint

Returns:

endpoint

setEndpoint

public void setEndpoint(Endpoint endpoint)

Set the defined endpoint

Parameters:

endpoint - defined endpoint