org.jboss.jca.core.spi.mdr
Interface MetadataRepository

public interface MetadataRepository

The SPI for the metadata repository

Author:

Jesper Pedersen

Method Summary

org.jboss.jca.common.api.metadata.ironjacamar.IronJacamar	getIronJacamar(String uniqueId) Get the IronJacamar metadata for a resource adapter deployment
Map<String,List<String>>	getJndiMappings(String uniqueId) Get the JNDI mappings for a unique id
org.jboss.jca.common.api.metadata.ra.Connector	getResourceAdapter(String uniqueId) Get the metadata for a resource adapter
Set<String>	getResourceAdapters() Get the resource adapters unique ids registered
File	getRoot(String uniqueId) Get the root for a resource adapter deployment
boolean	hasJndiMappings(String uniqueId) Check if there exists JNDI mappings for a unique id
boolean	hasResourceAdapter(String uniqueId) Check if there exists a resource adapter for a unique id
void	registerJndiMapping(String uniqueId, String clz, String jndi) Register a JNDI mapping for a unique id
void	registerResourceAdapter(String uniqueId, File root, org.jboss.jca.common.api.metadata.ra.Connector md, org.jboss.jca.common.api.metadata.ironjacamar.IronJacamar ijmd) Register a resource adapter template
void	unregisterJndiMapping(String uniqueId, String clz, String jndi) Unregister a JNDI mapping for a unique id
void	unregisterResourceAdapter(String uniqueId) Unregister a resource adapter template

Method Detail

registerResourceAdapter

void registerResourceAdapter(String uniqueId,
                             File root,
                             org.jboss.jca.common.api.metadata.ra.Connector md,
                             org.jboss.jca.common.api.metadata.ironjacamar.IronJacamar ijmd)
                             throws AlreadyExistsException

Register a resource adapter template

Parameters:

uniqueId - An unique id that represents the deployment

root - The deployment root

md - The connector metadata

ijmd - The IronJacamar metadata

Throws:

AlreadyExistsException - Thrown if the unique id is already registered

unregisterResourceAdapter

void unregisterResourceAdapter(String uniqueId)
                               throws NotFoundException

Unregister a resource adapter template

Parameters:

uniqueId - An unique id that represents the deployment

Throws:

NotFoundException - Thrown if the unique id isn't registered

hasResourceAdapter

boolean hasResourceAdapter(String uniqueId)

Check if there exists a resource adapter for a unique id

Parameters:

uniqueId - An unique id that represents the deployment

Returns:

True if there is a resource adapter; otherwise false

getResourceAdapter

org.jboss.jca.common.api.metadata.ra.Connector getResourceAdapter(String uniqueId)
                                                                  throws NotFoundException

Get the metadata for a resource adapter

Parameters:

uniqueId - An unique id that represents the deployment

Returns:

The metadata

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

getRoot

File getRoot(String uniqueId)
             throws NotFoundException

Get the root for a resource adapter deployment

Parameters:

uniqueId - An unique id that represents the deployment

Returns:

The root

Throws:

NotFoundException - Thrown if the unique id isn't registered

getIronJacamar

org.jboss.jca.common.api.metadata.ironjacamar.IronJacamar getIronJacamar(String uniqueId)
                                                                         throws NotFoundException

Get the IronJacamar metadata for a resource adapter deployment

Parameters:

uniqueId - An unique id that represents the deployment

Returns:

The metadata

Throws:

NotFoundException - Thrown if the unique id isn't registered

registerJndiMapping

void registerJndiMapping(String uniqueId,
                         String clz,
                         String jndi)

Register a JNDI mapping for a unique id

Parameters:

uniqueId - An unique id that represents the deployment

clz - The fully qualified class name

jndi - The JNDI name

unregisterJndiMapping

void unregisterJndiMapping(String uniqueId,
                           String clz,
                           String jndi)
                           throws NotFoundException

Unregister a JNDI mapping for a unique id

Parameters:

uniqueId - An unique id that represents the deployment

clz - The fully qualified class name

jndi - The JNDI name

Throws:

NotFoundException - Thrown if the unique id isn't registered

hasJndiMappings

boolean hasJndiMappings(String uniqueId)

Check if there exists JNDI mappings for a unique id

Parameters:

uniqueId - An unique id that represents the deployment

Returns:

True if there are mappings; otherwise false

getJndiMappings

Map<String,List<String>> getJndiMappings(String uniqueId)
                                         throws NotFoundException

Get the JNDI mappings for a unique id

Parameters:

uniqueId - An unique id that represents the deployment

Returns:

The mappings

Throws:

NotFoundException - Thrown if the unique id isn't registered