org.figure8.join.core.messaging
Interface JMSConsumerBeanManager

All Known Implementing Classes:

DefaultJMSConsumerBeanManager

public interface JMSConsumerBeanManager

This is an interface definition of a manager of JMS consumers. It allows consumers lifecycle operations (creation, retrieval, update & remove) and also their activation / deactivation process control.

Version:

$Revision: 1.2 $

Author:

Laurent Broudoux

Method Summary

JMSConsumerBeanInfo	getConsumerBeanInfo(java.lang.String name) Retrieve the info object having the spoecified name.
java.util.List	getConsumerBeanInfos() Retrieve the info object corresponding to available JMSConsumerBeans.
void	removeConsumerBeanInfo(JMSConsumerBeanInfo info) Remove a JMSConsumerBean infos from datastore.
void	saveConsumerBeanInfo(JMSConsumerBeanInfo info) Save a JMSConsumerBean infos within datastore.
void	startConsumers() Starts all the already saved and registered consumers.
void	stopConsumers() Stop all the already saved and registered consumers.

Method Detail

saveConsumerBeanInfo

void saveConsumerBeanInfo(JMSConsumerBeanInfo info)
                          throws DuplicateEntityException,
                                 InfrastructureException

Save a JMSConsumerBean infos within datastore. This method should also control the status of eventually existing consumers, depending on active attribute of the info bean.

Parameters:

info - The info on a JMSConsumerBean to save

Throws:

DuplicateEntityException - if another consumer with same name already exists.

InfrastructureException - if wrapped JCA container cannot activate consumer.

removeConsumerBeanInfo

void removeConsumerBeanInfo(JMSConsumerBeanInfo info)

Remove a JMSConsumerBean infos from datastore. This method should also stop existing consumer instances before removing the related informations.

Parameters:

info - The info on a JMSConsumerBean to remove

getConsumerBeanInfo

JMSConsumerBeanInfo getConsumerBeanInfo(java.lang.String name)

Retrieve the info object having the spoecified name.

Parameters:

name - Name of the consumer bean info object to retrieve

Returns:

The JMSConsumerBeanInfo having this name, or null if none

getConsumerBeanInfos

java.util.List getConsumerBeanInfos()

Retrieve the info object corresponding to available JMSConsumerBeans.

Returns:

A List of org.figure8.join.core.messaging.JMSConsumerBeanInfo

startConsumers

void startConsumers()
                    throws InfrastructureException

Starts all the already saved and registered consumers. This method should be called on startup.

Throws:

InfrastructureException - if wrapped JCA container cannot activate consumer.

stopConsumers

void stopConsumers()

Stop all the already saved and registered consumers. This method should be called on shutdown.