org.netbeans.modules.j2ee.deployment.plugins.spi.config

Interface MessageDestinationConfiguration

public interface MessageDestinationConfiguration

Configuration useful for managing module message destinations.

Implementation of this interface should be registered in the ModuleConfiguration lookup.

Since:

1.25

Method Summary

Methods

Modifier and Type	Method and Description
void	bindMdbToMessageDestination(String mdbName, String name, MessageDestination.Type type) Binds the message destination name with message-driven bean.
void	bindMessageDestinationReference(String referenceName, String connectionFactoryName, String destName, MessageDestination.Type type) Binds the message destination reference name with the corresponding message destination which is identified by the given name.
void	bindMessageDestinationReferenceForEjb(String ejbName, String ejbType, String referenceName, String connectionFactoryName, String destName, MessageDestination.Type type) Binds the message destination reference name with the corresponding message destination which is identified by the given name.
MessageDestination	createMessageDestination(String name, MessageDestination.Type type) Creates and saves a message destination in the module if it does not exist in the module yet.
String	findMessageDestinationName(String mdbName) Finds name of message destination which the given MDB listens to
Set<MessageDestination>	getMessageDestinations() Retrieves message destinations stored in the module.
boolean	supportsCreateMessageDestination() Tests whether a message destination creation is supported.

Method Detail

getMessageDestinations

Set<MessageDestination> getMessageDestinations()
                                               throws ConfigurationException

Retrieves message destinations stored in the module.

Returns:

set of message destinations

Throws:

ConfigurationException - if there is some problem with message destination configuration

supportsCreateMessageDestination

boolean supportsCreateMessageDestination()

Tests whether a message destination creation is supported.

Returns:

true if message destination creation is supported, false otherwise.

createMessageDestination

MessageDestination createMessageDestination(String name,
                                          MessageDestination.Type type)
                                            throws UnsupportedOperationException,
                                                   ConfigurationException

Creates and saves a message destination in the module if it does not exist in the module yet. Message destinations are considered to be equal if their JNDI names are equal.

Parameters:

name - name of the message destination

type - message destination type; the value is of org.netbeans.modules.j2ee.deployment.common.api.MessageDestination.Type type

Returns:

created message destination

Throws:

UnsupportedOperationException - if this opearation is not supported

ConfigurationException - if there is some problem with message destination configuration

bindMdbToMessageDestination

void bindMdbToMessageDestination(String mdbName,
                               String name,
                               MessageDestination.Type type)
                                 throws ConfigurationException

Binds the message destination name with message-driven bean.

Parameters:

mdbName - MDB name

name - name of the message destination

type - message destination type; the value is of

Throws:

ConfigurationException - if there is some problem with message destination configuration

findMessageDestinationName

String findMessageDestinationName(String mdbName)
                                  throws ConfigurationException

Finds name of message destination which the given MDB listens to

Parameters:

mdbName - MDB name

Returns:

message destination name

Throws:

ConfigurationException - if there is some problem with message destination configuration

bindMessageDestinationReference

void bindMessageDestinationReference(String referenceName,
                                   String connectionFactoryName,
                                   String destName,
                                   MessageDestination.Type type)
                                     throws ConfigurationException

Binds the message destination reference name with the corresponding message destination which is identified by the given name.

Parameters:

referenceName - reference name used to identify the message destination

connectionFactoryName - connection factory name

destName - name of the message destination

type - message destination type

Throws:

ConfigurationException - if there is some problem with message destination configuration

bindMessageDestinationReferenceForEjb

void bindMessageDestinationReferenceForEjb(String ejbName,
                                         String ejbType,
                                         String referenceName,
                                         String connectionFactoryName,
                                         String destName,
                                         MessageDestination.Type type)
                                           throws ConfigurationException

Binds the message destination reference name with the corresponding message destination which is identified by the given name. The reference is used within the EJB scope.

Parameters:

ejbName - EJB name

ejbType - EJB type - the possible values are org.netbeans.modules.j2ee.dd.api.ejb.EnterpriseBeans.SESSION, org.netbeans.modules.j2ee.dd.api.ejb.EnterpriseBeans.ENTITY and org.netbeans.modules.j2ee.dd.api.ejb.EnterpriseBeans.MESSAGE_DRIVEN

referenceName - reference name used to identify the message destination

connectionFactoryName - connection factory name

destName - name of the message destination

type - message destination type

Throws:

ConfigurationException - if there is some problem with message destination configuration