org.mule.transport.servlet
Class ServletConnector

java.lang.Object
  org.mule.transport.AbstractConnector
      org.mule.transport.servlet.ServletConnector

All Implemented Interfaces:

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

Direct Known Subclasses:

AjaxServletConnector

public class ServletConnector
extends AbstractConnector

ServletConnector is a channel adapter between Mule and a servlet engine. It allows the MuleReceiverServlet to look up components interested in requests it receives via the servlet container.

See Also:

MuleReceiverServlet

Field Summary

static String	CHARACTER_ENCODING_PROPERTY_KEY This property name is used to store the character encoding of the HttpServletRequest to the MuleMessage
static String	CONTENT_TYPE_PROPERTY_KEY This property name is used to store the content type of the HttpServletRequest to the MuleMessage
static String	PARAMETER_MAP_PROPERTY_KEY This property name is used to store a Map containing all request parameters to the MuleMessage.
static String	PARAMETER_PROPERTY_PREFIX This prefix is used to store parameters from the incoming HttpServletRequest to the MuleMessage.
static String	SERVLET
protected String	servletUrl
static String	SESSION_ID_PROPERTY_KEY This property name is used to store the session id HttpServletRequest to the MuleMessage

Fields inherited from class org.mule.transport.AbstractConnector

createMultipleTransactedReceivers, DEFAULT_NUM_CONCURRENT_TX_RECEIVERS, dispatcherFactory, dispatcherPoolFactory, dispatchers, initialStateStopped, lifecycleManager, logger, 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

Constructor Summary

ServletConnector(MuleContext context)

Method Summary

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	getProtocol()
protected Object	getReceiverKey(FlowConstruct flowConstruct, InboundEndpoint endpoint) The method determines the key used to store the receiver against.
Map<Object,MessageReceiver>	getReceivers() Getter for property 'receivers'.
String	getServletUrl()
boolean	isUseCachedHttpServletRequest()
void	setServletUrl(String servletUrl)
void	setUseCachedHttpServletRequest(boolean useCachedHttpServletRequest)

Methods inherited from class org.mule.transport.AbstractConnector

clearDispatchers, clearRequesters, configureDispatcherPool, connect, createDefaultRedeliveryPolicy, createDispatcherMessageProcessor, createMuleMessageFactory, createOperationResource, createReceiver, createScheduler, destroyReceiver, disconnect, dispose, disposeReceivers, disposeWorkManagers, doUnregisterListener, fireNotification, getConnectEventId, getConnectionDescription, getDefaultExchangePattern, getDefaultInboundTransformers, getDefaultOutboundTransformers, getDefaultResponseTransformers, getDispatcherFactory, getDispatcherPoolFactory, getDispatcherThreadingProfile, getDispatcherWorkManager, getInboundExchangePatterns, getLifecycleState, getMaxDispatchersActive, getMaxRequestersActive, getMaxTotalDispatchers, getMuleContext, getMuleMessageFactory, getName, getNumberOfConcurrentTransactedReceivers, getOperationResourceFactory, getOutboundExchangePatterns, getOutputStream, getReceiver, getReceivers, getReceiverThreadingProfile, getReceiverWorkManager, getReplyToHandler, getRequesterFactory, getRequesterThreadingProfile, getRequesterWorkManager, getRetryPolicyTemplate, getScheduler, getServiceDescriptor, getServiceOverrides, getSessionHandler, getSupportedProtocols, getTransactionalResource, handleWorkException, initFromServiceDescriptor, initialise, initialiseFromUrl, initWorkManagers, isConnected, isConnecting, isCreateMultipleTransactedReceivers, isDisposed, isEnableMessageEvents, isInitialised, isInitialStateStopped, isResponseEnabled, isStarted, isStarting, isStopped, isStopping, isValidateConnections, lookupReceiver, registerListener, registerSupportedMetaProtocol, registerSupportedProtocol, registerSupportedProtocolWithoutPrefix, request, request, 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 java.lang.Object

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

Field Detail

SERVLET

public static final String SERVLET

See Also:

Constant Field Values

SESSION_ID_PROPERTY_KEY

public static final String SESSION_ID_PROPERTY_KEY

This property name is used to store the session id HttpServletRequest to the MuleMessage

See Also:

Constant Field Values

CHARACTER_ENCODING_PROPERTY_KEY

public static final String CHARACTER_ENCODING_PROPERTY_KEY

This property name is used to store the character encoding of the HttpServletRequest to the MuleMessage

See Also:

Constant Field Values

CONTENT_TYPE_PROPERTY_KEY

public static final String CONTENT_TYPE_PROPERTY_KEY

This property name is used to store the content type of the HttpServletRequest to the MuleMessage

See Also:

Constant Field Values

PARAMETER_PROPERTY_PREFIX

public static final String PARAMETER_PROPERTY_PREFIX

This prefix is used to store parameters from the incoming HttpServletRequest to the MuleMessage.

See Also:

Constant Field Values

PARAMETER_MAP_PROPERTY_KEY

public static final String PARAMETER_MAP_PROPERTY_KEY

This property name is used to store a Map containing all request parameters to the MuleMessage.

See Also:

Constant Field Values

servletUrl

protected String servletUrl

Constructor Detail

ServletConnector

public ServletConnector(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

getProtocol

public String getProtocol()

Returns:

the primary protocol name for endpoints of this connector

getReceivers

public Map<Object,MessageReceiver> getReceivers()

Description copied from class: AbstractConnector

Getter for property 'receivers'.

Overrides:

getReceivers in class AbstractConnector

Returns:

Value for property 'receivers'.

getServletUrl

public String getServletUrl()

setServletUrl

public void setServletUrl(String servletUrl)

getReceiverKey

protected Object getReceiverKey(FlowConstruct flowConstruct,
                                InboundEndpoint endpoint)

Description copied from class: AbstractConnector

The method determines the key used to store the receiver against.

Overrides:

getReceiverKey in class AbstractConnector

Parameters:

flowConstruct - the service for which the endpoint is being registered

endpoint - the endpoint being registered for the service

Returns:

the key to store the newly created receiver against

isUseCachedHttpServletRequest

public boolean isUseCachedHttpServletRequest()

setUseCachedHttpServletRequest

public void setUseCachedHttpServletRequest(boolean useCachedHttpServletRequest)