org.jboss.resourceadapters.api

Interface ResourceadapterDescriptor

All Superinterfaces:

Descriptor, DescriptorNamespace<ResourceadapterDescriptor>

All Known Implementing Classes:

ResourceadapterDescriptorImpl

public interface ResourceadapterDescriptor
extends Descriptor, DescriptorNamespace<ResourceadapterDescriptor>

This deployment descriptor provides the functionalities as described in the specification

Example:

ResourceadapterDescriptor descriptor = Descriptors.create(ResourceadapterDescriptor.class);

Method Summary

Modifier and Type	Method and Description
ResourceAdapterType<ResourceadapterDescriptor>	createResourceAdapter() Creates a new resource-adapter element
List<ResourceAdapterType<ResourceadapterDescriptor>>	getAllResourceAdapter() Returns all resource-adapter elements
ResourceAdapterType<ResourceadapterDescriptor>	getOrCreateResourceAdapter() If not already created, a new resource-adapter element will be created and returned.
ResourceadapterDescriptor	removeAllResourceAdapter() Removes all resource-adapter elements

Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.Descriptor

exportAsString, exportTo, getDescriptorName

Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.DescriptorNamespace

addDefaultNamespaces, addNamespace, getNamespaces, removeAllNamespaces

Method Detail

getOrCreateResourceAdapter

ResourceAdapterType<ResourceadapterDescriptor> getOrCreateResourceAdapter()

If not already created, a new resource-adapter element will be created and returned. Otherwise, the first existing resource-adapter element will be returned.

Returns:

the instance defined for the element resource-adapter

createResourceAdapter

ResourceAdapterType<ResourceadapterDescriptor> createResourceAdapter()

Creates a new resource-adapter element

Returns:

the new created instance of ResourceAdapterType

getAllResourceAdapter

List<ResourceAdapterType<ResourceadapterDescriptor>> getAllResourceAdapter()

Returns all resource-adapter elements

Returns:

list of resource-adapter

removeAllResourceAdapter

ResourceadapterDescriptor removeAllResourceAdapter()

Removes all resource-adapter elements

Returns:

the current instance of ResourceAdapterType