org.openspaces.esb.mule.queue

Class OpenSpacesQueueConnector

java.lang.Object

org.mule.transport.AbstractConnector

org.openspaces.esb.mule.queue.OpenSpacesQueueConnector

All Implemented Interfaces:

EventListener, javax.resource.spi.work.WorkListener, org.mule.api.lifecycle.Disposable, org.mule.api.lifecycle.Initialisable, org.mule.api.lifecycle.Lifecycle, org.mule.api.lifecycle.LifecycleStateEnabled, org.mule.api.lifecycle.Startable, org.mule.api.lifecycle.Stoppable, org.mule.api.NameableObject, org.mule.api.NamedObject, org.mule.api.transport.Connectable, org.mule.api.transport.Connector, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class OpenSpacesQueueConnector
extends org.mule.transport.AbstractConnector
implements org.springframework.context.ApplicationContextAware

An OS queue connector. Holding the actual GigaSpace instance that will be used to communicate with the Space by the dispatcher, receiver, and requestor.

If the giga space reference is defined (setGigaSpace(String), will use it to find the GigaSpace instance defined. If it is not defined, will try to get GigaSpace instances from Spring and if there is only one defined, will used it.

Also holds other attributes related to the written and read entry. Such as if the entry will be a fifo one, and if it will be persisted.

Author:

kimchy

Field Summary

Fields

Modifier and Type	Field and Description
static String	OS_QUEUE

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

Constructors

Constructor and Description
OpenSpacesQueueConnector(org.mule.api.MuleContext context)

Method Summary

Modifier and Type	Method and Description
protected void	doConnect()
protected void	doDisconnect()
protected void	doDispose()
protected void	doInitialise()
protected void	doStart()
protected void	doStop()
org.springframework.context.ApplicationContext	getApplicationContext()
Integer	getBatchSize()
String	getGigaSpace() Returns the GigaSpace bean id reference to be retrieved from Spring.
GigaSpace	getGigaSpaceObj()
String	getProtocol()
protected org.mule.api.transport.MessageReceiver	getReceiverByEndpoint(org.mule.api.endpoint.EndpointURI endpointUri)
long	getTimeout() The timeout waiting for a message on the queue in milliseconds.
boolean	isFifo() Should the entries written to the virtualized queue be fifo or not.
boolean	isPersistent() Should the entries written to the Space will be persistent to a backend storage or not.
boolean	isResponseEnabled()
OpenSpacesQueueObject	newQueueEntry(String queueName) Creates a new entry to put in the queue
OpenSpacesQueueObject	newQueueTemplate(String queueName) Creates a new template for querying the queue
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext) Injected by Spring.
void	setBatchSize(Integer batchSize)
void	setFifo(boolean fifo) Should the entries written to the virtualized queue be fifo or not.
void	setGigaSpace(String gigaSpaceRef) Sets the GigaSpace bean id reference to be retrieved from Spring.
void	setPersistent(boolean persistent) Should the entries written to the Space will be persistent to a backend storage or not.
void	setTimeout(long timeout) The timeout waiting for a message on the queue in milliseconds.

Methods inherited from class org.mule.transport.AbstractConnector

borrowDispatcher, clearDispatchers, clearRequesters, configureDispatcherPool, connect, createDefaultRedeliveryPolicy, createDispatcherMessageProcessor, createMuleMessageFactory, createOperationResource, createReceiver, createScheduler, destroyReceiver, disconnect, dispose, disposeReceivers, disposeWorkManagers, doUnregisterListener, fireNotification, getCanonicalURI, getConnectEventId, getConnectionDescription, getDefaultExchangePattern, getDefaultInboundTransformers, getDefaultOutboundTransformers, getDefaultResponseTransformers, getDispatcherFactory, getDispatcherPoolFactory, getDispatcherThreadingProfile, getDispatcherWorkManager, getInboundExchangePatterns, getLifecycleState, getMaxDispatchersActive, getMaxRequestersActive, getMaxTotalDispatchers, getMuleContext, getMuleMessageFactory, getName, getNumberOfConcurrentTransactedReceivers, getOperationResourceFactory, 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, 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 java.lang.Object

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

Field Detail

OS_QUEUE

public static final String OS_QUEUE

See Also:

Constant Field Values

Constructor Detail

OpenSpacesQueueConnector

public OpenSpacesQueueConnector(org.mule.api.MuleContext context)

Method Detail

getProtocol

public String getProtocol()

Specified by:

getProtocol in interface org.mule.api.transport.Connector

Returns:

the openspaces protocol name.

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Injected by Spring. The application context to get the GigaSpace instance from.

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException

setGigaSpace

public void setGigaSpace(String gigaSpaceRef)

Sets the GigaSpace bean id reference to be retrieved from Spring. If not defined, will try to get all the GigaSpace instances from Spring, and if there is only one, will use it.

getGigaSpace

public String getGigaSpace()

Returns the GigaSpace bean id reference to be retrieved from Spring. If not defined, will try to get all the GigaSpace instances from Spring, and if there is only one, will use it.

isFifo

public boolean isFifo()

Should the entries written to the virtualized queue be fifo or not. Defaults to false.

setFifo

public void setFifo(boolean fifo)

Should the entries written to the virtualized queue be fifo or not. Defaults to false.

isPersistent

public boolean isPersistent()

Should the entries written to the Space will be persistent to a backend storage or not. Defaults to false (as many times a backup space is enough).

setPersistent

public void setPersistent(boolean persistent)

Should the entries written to the Space will be persistent to a backend storage or not. Defaults to false (as many times a backup space is enough).

getTimeout

public long getTimeout()

The timeout waiting for a message on the queue in milliseconds. Defaults to 1000.

setTimeout

public void setTimeout(long timeout)

The timeout waiting for a message on the queue in milliseconds. Defaults to 1000.

getBatchSize

public Integer getBatchSize()

setBatchSize

public void setBatchSize(Integer batchSize)

doInitialise

protected void doInitialise()
                     throws org.mule.api.lifecycle.InitialisationException

Specified by:

doInitialise in class org.mule.transport.AbstractConnector

Throws:

org.mule.api.lifecycle.InitialisationException

doDispose

protected void doDispose()

Specified by:

doDispose in class org.mule.transport.AbstractConnector

doStart

protected void doStart()
                throws org.mule.api.MuleException

Specified by:

doStart in class org.mule.transport.AbstractConnector

Throws:

org.mule.api.MuleException

doStop

protected void doStop()
               throws org.mule.api.MuleException

Specified by:

doStop in class org.mule.transport.AbstractConnector

Throws:

org.mule.api.MuleException

doConnect

protected void doConnect()
                  throws Exception

Specified by:

doConnect in class org.mule.transport.AbstractConnector

Throws:

Exception

doDisconnect

protected void doDisconnect()
                     throws Exception

Specified by:

doDisconnect in class org.mule.transport.AbstractConnector

Throws:

Exception

getApplicationContext

public org.springframework.context.ApplicationContext getApplicationContext()

getGigaSpaceObj

public GigaSpace getGigaSpaceObj()

getReceiverByEndpoint

protected org.mule.api.transport.MessageReceiver getReceiverByEndpoint(org.mule.api.endpoint.EndpointURI endpointUri)
                                                                throws org.mule.api.endpoint.EndpointException

Throws:

org.mule.api.endpoint.EndpointException

newQueueTemplate

public OpenSpacesQueueObject newQueueTemplate(String queueName)

Creates a new template for querying the queue

Returns:

OpenSpacesQueueObject

newQueueEntry

public OpenSpacesQueueObject newQueueEntry(String queueName)

Creates a new entry to put in the queue

Returns:

OpenSpacesQueueObject

isResponseEnabled

public boolean isResponseEnabled()

Specified by:

isResponseEnabled in interface org.mule.api.transport.Connector

Overrides:

isResponseEnabled in class org.mule.transport.AbstractConnector