org.mule.transport.tcp

Class TcpMessageRequester

java.lang.Object

org.mule.transport.AbstractTransportMessageHandler

org.mule.transport.AbstractMessageRequester

org.mule.transport.tcp.TcpMessageRequester

All Implemented Interfaces:

Disposable, Initialisable, Lifecycle, LifecycleStateEnabled, Startable, Stoppable, Connectable, MessageRequester, MessageRequesting

public class TcpMessageRequester
extends AbstractMessageRequester

Request transformed Mule events from TCP.

Field Summary

Fields inherited from class org.mule.transport.AbstractTransportMessageHandler

connected, defaultMessageInfoMapping, endpoint, lifecycleManager, logger, muleMessageFactory, retryTemplate

Fields inherited from interface org.mule.api.lifecycle.Initialisable

PHASE_NAME

Fields inherited from interface org.mule.api.lifecycle.Startable

PHASE_NAME

Fields inherited from interface org.mule.api.lifecycle.Stoppable

PHASE_NAME

Fields inherited from interface org.mule.api.lifecycle.Disposable

PHASE_NAME

Fields inherited from interface org.mule.api.transport.MessageRequesting

REQUEST_NO_WAIT, REQUEST_WAIT_INDEFINITELY

Constructor Summary

Constructors

Constructor and Description
TcpMessageRequester(InboundEndpoint endpoint)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doConnect()
protected void	doDisconnect()
protected void	doDispose()
protected MuleMessage	doRequest(long timeout) Make a specific request to the underlying transport
RetryContext	validateConnection(RetryContext retryContext) Test whether the connector is able to connect to its resource(s).

Methods inherited from class org.mule.transport.AbstractMessageRequester

applyInboundTransformers, createLifecycleManager, getEndpoint, getRequesterName, getWorkManager, initialise, request

Methods inherited from class org.mule.transport.AbstractTransportMessageHandler

activate, connect, connectHandler, createMuleMessage, createMuleMessage, createMuleMessage, createMuleMessageFactory, createNullMuleMessage, disconnect, dispose, disposeAndLogException, doInitialise, doStart, doStartHandler, doStop, getConnectEventId, getConnectionDescription, getConnector, getLifecycleState, initializeMessageFactory, initializeRetryPolicy, isConnected, isDoThreading, isStarted, isStarting, isStopped, isStopping, passivate, setEndpoint, start, stop, toString, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.api.transport.MessageRequester

activate, createMuleMessage, createMuleMessage, getConnector, passivate, validate

Methods inherited from interface org.mule.api.transport.Connectable

connect, disconnect, getConnectionDescription, isConnected

Methods inherited from interface org.mule.api.lifecycle.Startable

start

Methods inherited from interface org.mule.api.lifecycle.Stoppable

stop

Methods inherited from interface org.mule.api.lifecycle.Disposable

dispose

Methods inherited from interface org.mule.api.lifecycle.LifecycleStateEnabled

getLifecycleState

Constructor Detail

TcpMessageRequester

public TcpMessageRequester(InboundEndpoint endpoint)

Method Detail

doRequest

protected MuleMessage doRequest(long timeout)
                         throws Exception

Make a specific request to the underlying transport

Specified by:

doRequest in class AbstractMessageRequester

Parameters:

timeout - the maximum time the operation should block before returning. The call should return immediately if there is data available. If no data becomes available before the timeout elapses, null will be returned

Returns:

the result of the request wrapped in a MuleMessage object. Null will be returned if no data was available

Throws:

Exception - if the call to the underlying protocal cuases an exception

doDispose

protected void doDispose()

Overrides:

doDispose in class AbstractTransportMessageHandler

doConnect

protected void doConnect()
                  throws Exception

Overrides:

doConnect in class AbstractTransportMessageHandler

Throws:

Exception

doDisconnect

protected void doDisconnect()
                     throws Exception

Overrides:

doDisconnect in class AbstractTransportMessageHandler

Throws:

Exception

validateConnection

public RetryContext validateConnection(RetryContext retryContext)

Description copied from interface: Connectable

Test whether the connector is able to connect to its resource(s). This will allow a retry policy to go into effect in the case of failure. Implementations must call either:

• RetryContext.setOk() when no problems found (or no validation required).
• RetryContext.setFailed(Throwable) with a root cause for a connection failure.

Callers should then check for RetryContext.isOk(). The failure, if any, will be provided via the RetryContext.getLastFailure().

Specified by:

validateConnection in interface Connectable

Overrides:

validateConnection in class AbstractTransportMessageHandler

Returns:

same retry context with status info set and any failures populated