net.timewalker.ffmq4.local

Class FFMQEngine

java.lang.Object

net.timewalker.ffmq4.local.FFMQEngine

All Implemented Interfaces:

FFMQEngineMBean

public final class FFMQEngine
extends Object
implements FFMQEngineMBean

Implementation of the core FFMQ engine.

Typically created by an FFMQServer instance, but can also be created manually to be embedded directly in the using application JVM.

Constructor Summary

Constructors

Constructor and Description
FFMQEngine(String name, Settings engineSettings) Constructor
FFMQEngine(String name, Settings engineSettings, FFMQEngineListener listener) Constructor

Method Summary

Modifier and Type	Method and Description
protected void	checkDeployed() Check that the engine is running
LocalQueue	createQueue(QueueDefinition queueDef) Deploy a new queue on this engine
LocalQueue	createTemporaryQueue(String queueName) Deploy a new temporary queue on this engine
LocalTopic	createTemporaryTopic(String topicName) Deploy a new temporary topic on this engine
LocalTopic	createTopic(TopicDefinition topicDef) Create a new topic
void	deleteQueue(String queueName) Undeploy a queue
void	deleteQueue(String queueName, boolean force) Undeploy a queue
void	deleteTopic(String topicName) Undeploy a topic
void	deploy()
AsyncTaskManager	getDeliveryAsyncTaskManager() Get the engine async.
static FFMQEngine	getDeployedInstance(String name) Get a deployed engine instance by name
DestinationDefinitionProvider	getDestinationDefinitionProvider()
DestinationTemplateProvider	getDestinationTemplateProvider() Get the destination template provider associated to this engine
AsyncTaskManager	getDiskIOAsyncTaskManager() Get the engine async.
LocalQueue	getLocalQueue(String queueName) Get a local queue by name
LocalTopic	getLocalTopic(String topicName) Get a local topic by name
String	getName() Get the engine name
AsyncTaskManager	getNotificationAsyncTaskManager() Get the engine async.
FFMQEngineSetup	getSetup() Get the engine setup
TemplateMappingProvider	getTemplateMappingProvider() Get the template mapping provider associated to this engine
boolean	isDeployed() Test if the engine is deployed
boolean	isSecurityEnabled() Test if security checks are enabled on that engine
boolean	localQueueExists(String queueName) Test if a local queue exists by name
boolean	localTopicExists(String topicName) Test if a local topic exists by name
javax.jms.Connection	openConnection(String userName, String password, String clientID) Open a new connection
javax.jms.QueueConnection	openQueueConnection(String userName, String password, String clientID) Open a new queue connection
javax.jms.TopicConnection	openTopicConnection(String userName, String password, String clientID) Open a new topic connection
void	resetAllStatistics() Reset all engine statistics (queues and topics stats)
void	subscribe(String clientID, String subscriptionName)
void	undeploy()
void	unsubscribe(String clientID, String subscriptionName) Unsubscribe a durable subscriber from all related topics

Methods inherited from class java.lang.Object

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

Constructor Detail

FFMQEngine

public FFMQEngine(String name,
                  Settings engineSettings)
           throws FFMQException

Constructor

Throws:

FFMQException - on configuration error

FFMQEngine

public FFMQEngine(String name,
                  Settings engineSettings,
                  FFMQEngineListener listener)
           throws FFMQException

Constructor

Throws:

FFMQException - on configuration error

Method Detail

getDeployedInstance

public static FFMQEngine getDeployedInstance(String name)
                                      throws javax.jms.JMSException

Get a deployed engine instance by name

Throws:

javax.jms.JMSException

getName

public String getName()

Description copied from interface: FFMQEngineMBean

Get the engine name

Specified by:

getName in interface FFMQEngineMBean

Returns:

the name

checkDeployed

protected void checkDeployed()
                      throws javax.jms.JMSException

Check that the engine is running

Throws:

javax.jms.JMSException

isDeployed

public boolean isDeployed()

Description copied from interface: FFMQEngineMBean

Test if the engine is deployed

Specified by:

isDeployed in interface FFMQEngineMBean

isSecurityEnabled

public boolean isSecurityEnabled()

Description copied from interface: FFMQEngineMBean

Test if security checks are enabled on that engine

Specified by:

isSecurityEnabled in interface FFMQEngineMBean

deploy

public void deploy()
            throws javax.jms.JMSException

Throws:

javax.jms.JMSException

getDestinationTemplateProvider

public DestinationTemplateProvider getDestinationTemplateProvider()

Get the destination template provider associated to this engine

Returns:

the destination template provider associated to this engine

getTemplateMappingProvider

public TemplateMappingProvider getTemplateMappingProvider()

Get the template mapping provider associated to this engine

Returns:

the template mapping provider associated to this engine

getSetup

public FFMQEngineSetup getSetup()

Get the engine setup

undeploy

public void undeploy()

openConnection

public javax.jms.Connection openConnection(String userName,
                                           String password,
                                           String clientID)
                                    throws javax.jms.JMSException

Open a new connection

Throws:

javax.jms.JMSException

openQueueConnection

public javax.jms.QueueConnection openQueueConnection(String userName,
                                                     String password,
                                                     String clientID)
                                              throws javax.jms.JMSException

Open a new queue connection

Throws:

javax.jms.JMSException

openTopicConnection

public javax.jms.TopicConnection openTopicConnection(String userName,
                                                     String password,
                                                     String clientID)
                                              throws javax.jms.JMSException

Open a new topic connection

Throws:

javax.jms.JMSException

createTemporaryQueue

public LocalQueue createTemporaryQueue(String queueName)
                                throws javax.jms.JMSException

Deploy a new temporary queue on this engine

Throws:

javax.jms.JMSException

createQueue

public LocalQueue createQueue(QueueDefinition queueDef)
                       throws javax.jms.JMSException

Deploy a new queue on this engine

Throws:

javax.jms.JMSException

createTemporaryTopic

public LocalTopic createTemporaryTopic(String topicName)
                                throws javax.jms.JMSException

Deploy a new temporary topic on this engine

Throws:

javax.jms.JMSException

createTopic

public LocalTopic createTopic(TopicDefinition topicDef)
                       throws javax.jms.JMSException

Create a new topic

Throws:

javax.jms.JMSException

deleteQueue

public void deleteQueue(String queueName)
                 throws javax.jms.JMSException

Undeploy a queue

Throws:

javax.jms.JMSException

deleteQueue

public void deleteQueue(String queueName,
                        boolean force)
                 throws javax.jms.JMSException

Undeploy a queue

Throws:

javax.jms.JMSException

deleteTopic

public void deleteTopic(String topicName)
                 throws javax.jms.JMSException

Undeploy a topic

Throws:

javax.jms.JMSException

getLocalQueue

public LocalQueue getLocalQueue(String queueName)
                         throws javax.jms.JMSException

Get a local queue by name

Throws:

javax.jms.JMSException

localQueueExists

public boolean localQueueExists(String queueName)
                         throws javax.jms.JMSException

Test if a local queue exists by name

Throws:

javax.jms.JMSException

getLocalTopic

public LocalTopic getLocalTopic(String topicName)
                         throws javax.jms.JMSException

Get a local topic by name

Throws:

javax.jms.JMSException

localTopicExists

public boolean localTopicExists(String topicName)
                         throws javax.jms.JMSException

Test if a local topic exists by name

Throws:

javax.jms.JMSException

subscribe

public void subscribe(String clientID,
                      String subscriptionName)
               throws javax.jms.JMSException

Throws:

javax.jms.JMSException

unsubscribe

public void unsubscribe(String clientID,
                        String subscriptionName)
                 throws javax.jms.JMSException

Unsubscribe a durable subscriber from all related topics

Throws:

javax.jms.JMSException

getNotificationAsyncTaskManager

public AsyncTaskManager getNotificationAsyncTaskManager()
                                                 throws javax.jms.JMSException

Get the engine async. notification task manager

Returns:

the engine async. notification task manager

Throws:

javax.jms.JMSException

getDeliveryAsyncTaskManager

public AsyncTaskManager getDeliveryAsyncTaskManager()
                                             throws javax.jms.JMSException

Get the engine async. delivery task manager

Returns:

the engine async. delivery task manager

Throws:

javax.jms.JMSException

getDiskIOAsyncTaskManager

public AsyncTaskManager getDiskIOAsyncTaskManager()
                                           throws javax.jms.JMSException

Get the engine async. disk I/O task manager

Returns:

the engine async. disk I/O task manager

Throws:

javax.jms.JMSException

getDestinationDefinitionProvider

public DestinationDefinitionProvider getDestinationDefinitionProvider()

Returns:

the destinationDefinitionProvider

resetAllStatistics

public void resetAllStatistics()

Description copied from interface: FFMQEngineMBean

Reset all engine statistics (queues and topics stats)

Specified by:

resetAllStatistics in interface FFMQEngineMBean