org.apache.servicemix.eip.patterns
Class WireTap

java.lang.Object
  org.apache.servicemix.common.endpoints.AbstractEndpoint
      org.apache.servicemix.common.endpoints.SimpleEndpoint
          org.apache.servicemix.common.endpoints.ProviderEndpoint
              org.apache.servicemix.eip.EIPEndpoint
                  org.apache.servicemix.eip.patterns.WireTap

All Implemented Interfaces:

Endpoint

public class WireTap
extends EIPEndpoint

A WireTap component can be used to forward a copy of the input message to a listener. This component implements the WireTap pattern. It can handle all 4 standard MEPs, but will only send an In-Only MEP to the listener. In addition, this component is fully asynchronous and uses an exchange store to provide full HA and recovery for clustered / persistent flows.

Version:

$Revision: 376451 $

Author:

gnodet

Field Summary

Fields inherited from class org.apache.servicemix.eip.EIPEndpoint

lockManager, store, storeFactory, timerManager, wsdlExchangeTarget, wsdlResource

Fields inherited from class org.apache.servicemix.common.endpoints.SimpleEndpoint

logger

Fields inherited from class org.apache.servicemix.common.endpoints.AbstractEndpoint

definition, description, endpoint, interfaceName, service, serviceUnit

Constructor Summary

WireTap()

Method Summary

ExchangeTarget	getFaultListener()
ExchangeTarget	getInListener()
ExchangeTarget	getOutListener()
ExchangeTarget	getTarget()
boolean	isCopyProperties()
protected void	processAsync(javax.jbi.messaging.MessageExchange exchange)
protected void	processSync(javax.jbi.messaging.MessageExchange exchange)
void	setCopyProperties(boolean copyProperties) If copyProperties is true, properties on the in message will be copied to the out / fault message before it is sent.
void	setFaultListener(ExchangeTarget faultListener) The listener destination for fault messages
void	setInListener(ExchangeTarget inListener) The listener destination for in messages
void	setOutListener(ExchangeTarget outListener) The listener destination for out messages
void	setTarget(ExchangeTarget target) The main target destination which will receive the exchange
void	validate()

Methods inherited from class org.apache.servicemix.eip.EIPEndpoint

chooseFirstEndpointWithDescriptor, copyAttachments, copyProperties, getDefinition, getDefinitionFromDescription, getDefinitionFromWsdlExchangeTarget, getDefinitionFromWsdlResource, getDescription, getDescriptionForExchangeTarget, getEndpointsForExchangeTarget, getLockManager, getStore, getStoreFactory, getTimerManager, getWsdlExchangeTarget, getWsdlResource, process, setLockManager, setStore, setStoreFactory, setTimerManager, setWsdlExchangeTarget, setWsdlResource, start, stop

Methods inherited from class org.apache.servicemix.common.endpoints.ProviderEndpoint

activate, deactivate, getRole, processInOnly, processInOut

Methods inherited from class org.apache.servicemix.common.endpoints.SimpleEndpoint

done, fail, getChannel, getContext, getExchangeFactory, send, sendSync

Methods inherited from class org.apache.servicemix.common.endpoints.AbstractEndpoint

getEndpoint, getInterfaceName, getKey, getService, getServiceUnit, isExchangeOkay, prepareExchange, setDefinition, setDescription, setEndpoint, setInterfaceName, setService, setServiceUnit, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

WireTap

public WireTap()

Method Detail

getTarget

public ExchangeTarget getTarget()

Returns:

Returns the target.

setTarget

public void setTarget(ExchangeTarget target)

The main target destination which will receive the exchange

Parameters:

target - The target to set.

getFaultListener

public ExchangeTarget getFaultListener()

Returns:

Returns the faultListener.

setFaultListener

public void setFaultListener(ExchangeTarget faultListener)

The listener destination for fault messages

Parameters:

faultListener - The faultListener to set.

getInListener

public ExchangeTarget getInListener()

Returns:

Returns the inListener.

setInListener

public void setInListener(ExchangeTarget inListener)

The listener destination for in messages

Parameters:

inListener - The inListener to set.

getOutListener

public ExchangeTarget getOutListener()

Returns:

Returns the outListener.

setOutListener

public void setOutListener(ExchangeTarget outListener)

The listener destination for out messages

Parameters:

outListener - The outListener to set.

isCopyProperties

public boolean isCopyProperties()

Returns:

the copyProperties

setCopyProperties

public void setCopyProperties(boolean copyProperties)

If copyProperties is true, properties on the in message will be copied to the out / fault message before it is sent.

Parameters:

copyProperties - the copyProperties to set

validate

public void validate()
              throws javax.jbi.management.DeploymentException

Specified by:

validate in interface Endpoint

Overrides:

validate in class AbstractEndpoint

Throws:

javax.jbi.management.DeploymentException

processSync

protected void processSync(javax.jbi.messaging.MessageExchange exchange)
                    throws java.lang.Exception

Specified by:

processSync in class EIPEndpoint

Throws:

java.lang.Exception

processAsync

protected void processAsync(javax.jbi.messaging.MessageExchange exchange)
                     throws java.lang.Exception

Specified by:

processAsync in class EIPEndpoint

Throws:

java.lang.Exception