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
Modifier and Type Field Description

static String DEFAULT_AXIS2_XML

static String DEFAULT_CLIENT_REPO
- Fields inherited from class org.apache.synapse.mediators.AbstractMediator
  log, trace, traceState

Constructor Summary

Constructors
Constructor Description

CalloutMediator()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	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`	`getEndpointKey()`
`String`	`getInboundWsSecPolicyKey()`	Get the inbound security policy key.
`boolean`	`getInitClientOptions()`
`String`	`getOutboundWsSecPolicyKey()`	Get the outbound security policy key.
`String`	`getRequestKey()`
`SynapseXPath`	`getRequestXPath()`
`String`	`getServiceURL()`
`String`	`getTargetKey()`
`SynapseXPath`	`getTargetXPath()`
`String`	`getUseServerConfig()`
`String`	`getWsSecPolicyKey()`	Return the Rampart Security configuration policys' 'key' to be used (See Rampart)
`void`	`init(SynapseEnvironment synEnv)`	This method should implement the initialization of the implemented parts of the configuration.
`boolean`	`isSecurityOn()`	Is WS-Security turned on on this endpoint?
`boolean`	`isUseEnvelopeAsSource()`
`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`	`setComponentStatisticsId(ArtifactHolder holder)`
`void`	`setEndpoint(Endpoint endpoint)`	Set the defined endpoint
`void`	`setEndpointKey(String key)`
`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`	`setRequestKey(String requestKey)`
`void`	`setRequestXPath(SynapseXPath requestXPath)`
`void`	`setSecurityOn(boolean securityOn)`	Request that WS-Sec be turned on/off on this endpoint
`void`	`setServiceURL(String serviceURL)`
`void`	`setTargetKey(String targetKey)`
`void`	`setTargetXPath(SynapseXPath targetXPath)`
`void`	`setUseEnvelopeAsSource(boolean useEnvelopeAsSource)`
`void`	`setUseServerConfig(String useServerConfig)`
`void`	`setWsSecPolicyKey(String wsSecPolicyKey)`	Set the Rampart Security configuration policys' 'key' to be used (See Rampart)

Methods inherited from class org.apache.synapse.mediators.AbstractMediator
auditLog, auditWarn, configure, disableStatistics, disableTracing, divertMediationRoute, enableStatistics, enableTracing, getAspectConfiguration, getCommentsList, getDescription, getInputType, getLastSequenceFaultHandler, getLog, getMediatorName, getMediatorPosition, getOutputType, getRegisteredMediationFlowPoint, getShortDescription, getTraceState, getType, handleException, handleException, isBreakPoint, isContentAltering, isContentAware, isSkipEnabled, isStatisticsEnable, isTraceOn, isTraceOrDebugOn, isTracingEnabled, registerMediationFlowPoint, reportCloseStatistics, reportOpenStatistics, setBreakPoint, setCommentsList, setDescription, setEffectiveTraceState, setMediatorPosition, setShortDescription, setSkipEnabled, setTraceState, shouldCaptureTracing, shouldTrace, shouldTrace, traceOrDebug, traceOrDebugWarn, unregisterMediationFlowPoint

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_CLIENT_REPO
```
public static final String DEFAULT_CLIENT_REPO
```
    See Also:
    
    Constant Field Values
  - DEFAULT_AXIS2_XML
```
public static final String DEFAULT_AXIS2_XML
```
- 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)
```
  - getUseServerConfig
```
public String getUseServerConfig()
```
  - setUseServerConfig
```
public void setUseServerConfig(String useServerConfig)
```
  - 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)
```
  - setEndpointKey
```
public void setEndpointKey(String key)
```
  - getEndpointKey
```
public String getEndpointKey()
```
  - getInitClientOptions
```
public boolean getInitClientOptions()
```
  - setInitClientOptions
```
public void setInitClientOptions(boolean initClientOptions)
```
  - isUseEnvelopeAsSource
```
public boolean isUseEnvelopeAsSource()
```
  - setUseEnvelopeAsSource
```
public void setUseEnvelopeAsSource(boolean useEnvelopeAsSource)
```
  - isSecurityOn
```
public boolean isSecurityOn()
```
    Is WS-Security turned on on this endpoint?
    
    Returns:
    
    true if on
  - setSecurityOn
```
public void setSecurityOn(boolean securityOn)
```
    Request that WS-Sec be turned on/off on this endpoint
    
    Parameters:
    
    securityOn - a boolean flag indicating security is on or not
  - getWsSecPolicyKey
```
public String getWsSecPolicyKey()
```
    Return the Rampart Security configuration policys' 'key' to be used (See Rampart)
    
    Returns:
    
    the Rampart Security configuration policys' 'key' to be used (See Rampart)
  - setWsSecPolicyKey
```
public void setWsSecPolicyKey(String wsSecPolicyKey)
```
    Set the Rampart Security configuration policys' 'key' to be used (See Rampart)
    
    Parameters:
    
    wsSecPolicyKey - the Rampart Security configuration policys' '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
  - setComponentStatisticsId
```
public void setComponentStatisticsId(ArtifactHolder holder)
```
    Specified by:
    
    setComponentStatisticsId in interface Mediator
    
    Overrides:
    
    setComponentStatisticsId in class AbstractMediator

Modifier and Type	Field	Description
`static String`	`DEFAULT_AXIS2_XML`
`static String`	`DEFAULT_CLIENT_REPO`

Class CalloutMediator

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_CLIENT_REPO

DEFAULT_AXIS2_XML

Constructor Detail

CalloutMediator

Method Detail

mediate

init

destroy

getServiceURL

setServiceURL

getAction

setAction

getUseServerConfig

setUseServerConfig

getRequestKey

setRequestKey

setRequestXPath

setTargetXPath

getTargetKey

setTargetKey

getRequestXPath

getTargetXPath

getClientRepository

setClientRepository

getAxis2xml

setAxis2xml

setEndpointKey

getEndpointKey

getInitClientOptions

setInitClientOptions

isUseEnvelopeAsSource

setUseEnvelopeAsSource

isSecurityOn

setSecurityOn

getWsSecPolicyKey

setWsSecPolicyKey

getOutboundWsSecPolicyKey

setOutboundWsSecPolicyKey

getInboundWsSecPolicyKey

setInboundWsSecPolicyKey

getEndpoint

setEndpoint

setComponentStatisticsId