org.mule.providers
Class AbstractMessageDispatcherFactory

java.lang.Object
  org.mule.providers.AbstractMessageDispatcherFactory

All Implemented Interfaces:

UMOMessageDispatcherFactory

Direct Known Subclasses:

AxisMessageDispatcherFactory, AxisWsdlMessageDispatcherFactory, EjbMessageDispatcherFactory, FileMessageDispatcherFactory, FtpMessageDispatcherFactory, HttpClientMessageDispatcherFactory, JbiMessageDispatcherFactory, JdbcMessageDispatcherFactory, JmsMessageDispatcherFactory, MulticastMessageDispatcherFactory, ProcessMessageDispatcherFactory, QuartzMessageDispatcherFactory, RetrieveMessageDispatcherFactory, RmiMessageDispatcherFactory, SmtpMessageDispatcherFactory, StreamMessageDispatcherFactory, TcpMessageDispatcherFactory, UdpMessageDispatcherFactory, VMMessageDispatcherFactory, XFireMessageDispatcherFactory, XFireWsdlMessageDispatcherFactory, XmppMessageDispatcherFactory

public abstract class AbstractMessageDispatcherFactory

extends Object

implements UMOMessageDispatcherFactory

AbstractMessageDispatcherFactory is a base implementation of the UMOMessageDispatcherFactory interface for managing the lifecycle of message dispatchers.

See Also:

UMOMessageDispatcherFactory

Constructor Summary

AbstractMessageDispatcherFactory()

Method Summary

void	activate(UMOImmutableEndpoint endpoint, UMOMessageDispatcher dispatcher) Invoked before the given dispatcher is handed out to a client, but not after create(UMOImmutableEndpoint).
abstract UMOMessageDispatcher	create(UMOImmutableEndpoint endpoint) Creates a new message dispatcher instance, initialised with the passed endpoint.
void	destroy(UMOImmutableEndpoint endpoint, UMOMessageDispatcher dispatcher) Invoked when a dispatcher returned false for validate(UMOImmutableEndpoint, UMOMessageDispatcher).
boolean	isCreateDispatcherPerRequest() This default implementation of UMOMessageDispatcherFactory.isCreateDispatcherPerRequest() returns false, which means that dispatchers are pooled according to their lifecycle as described in UMOMessageDispatcher.
void	passivate(UMOImmutableEndpoint endpoint, UMOMessageDispatcher dispatcher) Invoked immediately before the given dispatcher is returned to its pool.
String	toString()
boolean	validate(UMOImmutableEndpoint endpoint, UMOMessageDispatcher dispatcher) Invoked after the dispatcher is returned from a client but before it is prepared for return to its pool via passivate(UMOImmutableEndpoint, UMOMessageDispatcher).

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractMessageDispatcherFactory

public AbstractMessageDispatcherFactory()

Method Detail

isCreateDispatcherPerRequest

public boolean isCreateDispatcherPerRequest()

This default implementation of UMOMessageDispatcherFactory.isCreateDispatcherPerRequest() returns false, which means that dispatchers are pooled according to their lifecycle as described in UMOMessageDispatcher.

Specified by:

isCreateDispatcherPerRequest in interface UMOMessageDispatcherFactory

Returns:

false by default, unless overwritten by a subclass.

create

public abstract UMOMessageDispatcher create(UMOImmutableEndpoint endpoint)
                                     throws UMOException

Description copied from interface: UMOMessageDispatcherFactory

Creates a new message dispatcher instance, initialised with the passed endpoint. The returned instance should be immediately useable.

Specified by:

create in interface UMOMessageDispatcherFactory

Parameters:

endpoint - the endoint for which this dispatcher should be created

Returns:

a properly created UMOMessageDispatcher for this transport

Throws:

UMOException - if the dispatcher cannot be created

activate

public void activate(UMOImmutableEndpoint endpoint,
                     UMOMessageDispatcher dispatcher)
              throws UMOException

Description copied from interface: UMOMessageDispatcherFactory

Invoked before the given dispatcher is handed out to a client, but not after UMOMessageDispatcherFactory.create(UMOImmutableEndpoint).

Specified by:

activate in interface UMOMessageDispatcherFactory

Parameters:

endpoint - the endpoint of the dispatcher

dispatcher - the dispatcher to be activated

Throws:

UMOException - if the dispatcher cannot be activated

destroy

public void destroy(UMOImmutableEndpoint endpoint,
                    UMOMessageDispatcher dispatcher)

Description copied from interface: UMOMessageDispatcherFactory

Invoked when a dispatcher returned false for UMOMessageDispatcherFactory.validate(UMOImmutableEndpoint, UMOMessageDispatcher).

Specified by:

destroy in interface UMOMessageDispatcherFactory

Parameters:

endpoint - the endpoint of the dispatcher

dispatcher - the dispatcher to be validated

passivate

public void passivate(UMOImmutableEndpoint endpoint,
                      UMOMessageDispatcher dispatcher)

Description copied from interface: UMOMessageDispatcherFactory

Invoked immediately before the given dispatcher is returned to its pool.

Specified by:

passivate in interface UMOMessageDispatcherFactory

Parameters:

endpoint - the endpoint of the dispatcher

dispatcher - the dispatcher to be passivated

validate

public boolean validate(UMOImmutableEndpoint endpoint,
                        UMOMessageDispatcher dispatcher)

Description copied from interface: UMOMessageDispatcherFactory

Invoked after the dispatcher is returned from a client but before it is prepared for return to its pool via UMOMessageDispatcherFactory.passivate(UMOImmutableEndpoint, UMOMessageDispatcher).

Specified by:

validate in interface UMOMessageDispatcherFactory

Parameters:

endpoint - the endpoint of the dispatcher

dispatcher - the dispatcher to be validated

Returns:

true if the dispatcher is valid for reuse, false otherwise.

toString

public String toString()