org.mule.transport.vm

Class VMConnector

java.lang.Object

org.mule.AbstractAnnotatedObject

org.mule.transport.AbstractConnector

org.mule.transport.vm.VMConnector

All Implemented Interfaces:

EventListener, javax.resource.spi.work.WorkListener, AnnotatedObject, Disposable, Initialisable, Lifecycle, LifecycleStateEnabled, Startable, Stoppable, NameableObject, NamedObject, Connectable, Connector

public class VMConnector
extends AbstractConnector

VMConnector A simple endpoint wrapper to allow a Mule service to

be accessed from an endpoint

Field Summary

Fields

Modifier and Type	Field and Description
static String	VM

Fields inherited from class org.mule.transport.AbstractConnector

connecting, createMultipleTransactedReceivers, DEFAULT_CONTEXT_START_TIMEOUT, DEFAULT_NUM_CONCURRENT_TX_RECEIVERS, dispatcherFactory, dispatcherPoolFactory, dispatchers, initialStateStopped, lifecycleManager, logger, MULE_CONTEXT_START_TIMEOUT_SYSTEM_PROPERTY, muleContext, muleMessageFactory, name, numberOfConcurrentTransactedReceivers, PROPERTY_POLLING_FREQUENCY, receivers, requesterFactory, requesters, serviceDescriptor, serviceOverrides, sessionHandler, startOnConnect

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

INT_VALUE_NOT_SET

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

PHASE_NAME

Fields inherited from interface org.mule.api.AnnotatedObject

PROPERTY_NAME

Constructor Summary

Constructors

Constructor and Description
VMConnector(MuleContext context)

Method Summary

Methods

Modifier and Type	Method and Description
protected <T> T	createOperationResource(ImmutableEndpoint endpoint)
MessageReceiver	createReceiver(FlowConstruct flowConstruct, InboundEndpoint endpoint) Create a Message receiver for this connector
protected void	doConnect() Template method where any connections should be made for the connector
protected void	doDisconnect() Template method where any connected resources used by the connector should be disconnected
protected void	doDispose() Template method to perform any work when destroying the connectoe
protected void	doInitialise()
protected void	doStart() Template method to perform any work when starting the connectoe
protected void	doStop() Template method to perform any work when stopping the connectoe
String	getCanonicalURI(EndpointURI uri) This implementation returns the default canonical representation with an added query param specifying the connector name
protected <T> T	getOperationResourceFactory()
String	getProtocol()
QueueManager	getQueueManager()
QueueProfile	getQueueProfile()
int	getQueueTimeout()
protected MessageReceiver	getReceiverByEndpoint(EndpointURI endpointUri)
boolean	isResponseEnabled()
void	setQueueProfile(QueueProfile queueProfile)
void	setQueueTimeout(int queueTimeout)

Methods inherited from class org.mule.transport.AbstractConnector

borrowDispatcher, clearDispatchers, clearRequesters, configureDispatcherPool, connect, connectConnectorAndReceivers, createDefaultRedeliveryPolicy, createDispatcherMessageProcessor, createMuleMessageFactory, createScheduler, destroyReceiver, disconnect, dispose, disposeReceivers, disposeWorkManagers, doUnregisterListener, fireNotification, fireNotification, getConnectEventId, getConnectionDescription, getDefaultExchangePattern, getDefaultInboundTransformers, getDefaultOutboundTransformers, getDefaultResponseTransformers, getDispatcherFactory, getDispatcherPoolFactory, getDispatcherThreadingProfile, getDispatcherWorkManager, getInboundExchangePatterns, getLifecycleState, getMaxDispatchersActive, getMaxRequestersActive, getMaxTotalDispatchers, getMuleContext, getMuleMessageFactory, getName, getNumberOfConcurrentTransactedReceivers, getOutboundExchangePatterns, getOutputStream, getReceiver, getReceiverKey, getReceivers, getReceivers, getReceiverThreadingProfile, getReceiverWorkManager, getReplyToHandler, getRequesterFactory, getRequesterThreadingProfile, getRequesterWorkManager, getRetryPolicyTemplate, getScheduler, getServiceDescriptor, getServiceOverrides, getSessionHandler, getSupportedProtocols, getTransactionalResource, handleWorkException, initFromServiceDescriptor, initialise, initialiseFromUrl, initWorkManagers, isConnected, isConnecting, isCreateMultipleTransactedReceivers, isDisposed, isEnableMessageEvents, isEnableMessageEvents, isInitialised, isInitialStateStopped, isStarted, isStarting, isStopped, isStopping, isValidateConnections, lookupReceiver, registerListener, registerSupportedMetaProtocol, registerSupportedProtocol, registerSupportedProtocolWithoutPrefix, request, request, returnDispatcher, setConnected, setConnecting, setCreateMultipleTransactedReceivers, setDispatcherFactory, setDispatcherPoolFactory, setDispatcherPoolMaxWait, setDispatcherPoolWhenExhaustedAction, setDispatcherThreadingProfile, setDynamicNotification, setInitialStateStopped, setMaxDispatchersActive, setMaxRequestersActive, setName, setNumberOfConcurrentTransactedReceivers, setReceiverThreadingProfile, setRequesterFactory, setRequesterPoolMaxWait, setRequesterPoolWhenExhaustedAction, setRequesterThreadingProfile, setRetryPolicyTemplate, setServiceOverrides, setSessionHandler, setSupportedProtocols, setupDispatchReturn, setupRequestReturn, setValidateConnections, shutdownScheduler, start, startAfterConnect, stop, supportsProtocol, toString, unregisterListener, unregisterSupportedProtocol, updateCachedNotificationHandler, validateConnection, workAccepted, workCompleted, workRejected, workStarted

Methods inherited from class org.mule.AbstractAnnotatedObject

getAnnotation, getAnnotations, setAnnotations

Methods inherited from class java.lang.Object

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

Field Detail

VM

public static final String VM

See Also:

Constant Field Values

Constructor Detail

VMConnector

public VMConnector(MuleContext context)

Method Detail

doInitialise

protected void doInitialise()
                     throws InitialisationException

Specified by:

doInitialise in class AbstractConnector

Throws:

InitialisationException

doDispose

protected void doDispose()

Description copied from class: AbstractConnector

Template method to perform any work when destroying the connectoe

Specified by:

doDispose in class AbstractConnector

doConnect

protected void doConnect()
                  throws Exception

Description copied from class: AbstractConnector

Template method where any connections should be made for the connector

Specified by:

doConnect in class AbstractConnector

Throws:

Exception

doDisconnect

protected void doDisconnect()
                     throws Exception

Description copied from class: AbstractConnector

Template method where any connected resources used by the connector should be disconnected

Specified by:

doDisconnect in class AbstractConnector

Throws:

Exception

doStart

protected void doStart()
                throws MuleException

Description copied from class: AbstractConnector

Template method to perform any work when starting the connectoe

Specified by:

doStart in class AbstractConnector

Throws:

MuleException - if the method fails

doStop

protected void doStop()
               throws MuleException

Description copied from class: AbstractConnector

Template method to perform any work when stopping the connectoe

Specified by:

doStop in class AbstractConnector

Throws:

MuleException - if the method fails

createReceiver

public MessageReceiver createReceiver(FlowConstruct flowConstruct,
                             InboundEndpoint endpoint)
                               throws Exception

Description copied from class: AbstractConnector

Create a Message receiver for this connector

Overrides:

createReceiver in class AbstractConnector

Parameters:

flowConstruct - the service that will receive events from this receiver, the listener

endpoint - the endpoint that defies this inbound communication

Returns:

an instance of the message receiver defined in this connectors' TransportServiceDescriptor initialised using the service and endpoint.

Throws:

Exception - if there is a problem creating the receiver. This exception really depends on the underlying transport, thus any exception could be thrown

getProtocol

public String getProtocol()

Returns:

the primary protocol name for endpoints of this connector

getCanonicalURI

public String getCanonicalURI(EndpointURI uri)

This implementation returns the default canonical representation with an added query param specifying the connector name

Specified by:

getCanonicalURI in interface Connector

Overrides:

getCanonicalURI in class AbstractConnector

Parameters:

uri - a not null EndpointURI

Returns:

the canonical representation of the given uri as a String

getQueueProfile

public QueueProfile getQueueProfile()

setQueueProfile

public void setQueueProfile(QueueProfile queueProfile)

getReceiverByEndpoint

protected MessageReceiver getReceiverByEndpoint(EndpointURI endpointUri)
                                         throws EndpointException

Throws:

EndpointException

isResponseEnabled

public boolean isResponseEnabled()

Specified by:

isResponseEnabled in interface Connector

Overrides:

isResponseEnabled in class AbstractConnector

getQueueTimeout

public int getQueueTimeout()

setQueueTimeout

public void setQueueTimeout(int queueTimeout)

getQueueManager

public QueueManager getQueueManager()

createOperationResource

protected <T> T createOperationResource(ImmutableEndpoint endpoint)
                             throws MuleException

Overrides:

createOperationResource in class AbstractConnector

Throws:

MuleException

getOperationResourceFactory

protected <T> T getOperationResourceFactory()

Overrides:

getOperationResourceFactory in class AbstractConnector