org.jboss.jca.core.spi.rar

Interface ResourceAdapterRepository

public interface ResourceAdapterRepository

The SPI for the resource adapter repository

Author:

Jesper Pedersen

Method Summary

Methods

Modifier and Type	Method and Description
Endpoint	getEndpoint(String uniqueId) Get an endpoint representation for a resource adapter
List<MessageListener>	getMessageListeners(String uniqueId) Get a list of message listeners supported for a resource adapter
javax.resource.spi.ResourceAdapter	getResourceAdapter(String uniqueId) Get the resource adapter instance based on the unique id
Set<String>	getResourceAdapters() Get the resource adapters unique ids registered
Set<String>	getResourceAdapters(Class<?> messageListenerType) Get the resource adapters unique ids registered which has the specified message listener type
String	registerResourceAdapter(javax.resource.spi.ResourceAdapter ra) Register a resource adapter
void	unregisterResourceAdapter(String key) Unregister a resource adapter

Method Detail

registerResourceAdapter

String registerResourceAdapter(javax.resource.spi.ResourceAdapter ra)

Register a resource adapter

Parameters:

ra - The resource adapter instance

Returns:

The unique id for the resource adapter

unregisterResourceAdapter

void unregisterResourceAdapter(String key)
                               throws NotFoundException

Unregister a resource adapter

Parameters:

key - The key for the resource adapter instance

Throws:

NotFoundException - Thrown if the unique id isn't registered

getResourceAdapter

javax.resource.spi.ResourceAdapter getResourceAdapter(String uniqueId)
                                                      throws NotFoundException

Get the resource adapter instance based on the unique id

Parameters:

uniqueId - An unique id that represents the deployment

Returns:

The resource adapter

Throws:

NotFoundException - Thrown if the unique id isn't registered

getResourceAdapters

Set<String> getResourceAdapters()

Get the resource adapters unique ids registered

Returns:

The unique ids

getResourceAdapters

Set<String> getResourceAdapters(Class<?> messageListenerType)

Get the resource adapters unique ids registered which has the specified message listener type

Parameters:

messageListenerType - The message listener type

Returns:

The unique ids

getEndpoint

Endpoint getEndpoint(String uniqueId)
                     throws NotFoundException

Get an endpoint representation for a resource adapter

Parameters:

uniqueId - An unique id that represents the deployment

Returns:

The endpoint

Throws:

NotFoundException - Thrown if the unique id isn't registered

getMessageListeners

List<MessageListener> getMessageListeners(String uniqueId)
                                          throws NotFoundException,
                                                 InstantiationException,
                                                 IllegalAccessException

Get a list of message listeners supported for a resource adapter

Parameters:

uniqueId - An unique id that represents the deployment

Returns:

The list of message listeners

Throws:

NotFoundException - Thrown if the unique id isn't registered

InstantiationException - Thrown if an object couldn't created

IllegalAccessException - Thrown if object access is inaccessible