The element hierarchy of the ra.xml
deployment descriptor file is provided below. The number of occurrences that is allowed is listed in braces and follows the element name.
<connector> {1} <display-name> {0 or 1} <vendor-name {0 or 1} <eis-type> {1} <resourceadapter-version> {1} <resourceadapter> {1} <resourceadapter-class> {1} <config-property> {0 or more} <config-property-name> {1} <config-property-type> {1} <config-property-value {0 or 1} <outbound-resourceadapter> {1} <connection-definition> {1 or more} <managedconnectionfactory-class{1} <config-property> {0 or more} <config-property-name> {1} <config-property-type> {1} <config-property-value {0 or 1} <connectionfactory-interface> {1} <connectionfactory-impl-class> {1} <connection-interface> {1} <connection-impl-class> {1} <transaction-support> {1} <authentication-mechanism> {1} <authentication-mechanism-type> {1} <credential-interface> {1} <reauthentication-support> {1} <inbound-resourceadapter> {1} <messageadapter> {1} <messagelistener> {1} <messagelistener-type> {1} <activationspec> {1} <activationspec-class> {1} <required-config-property> {0 or more} <config-property-name> {1} <adminobject> {1 or more} <adminobject-interface> {1} <adminobject-class> {1} <config-property> {0 or more} <config-property-name> {1} <config-property-type> {1} <config-property-value {0 or 1}
The <activationspec>
child element of the <messagelistener>
element is used to specify an activation specification. The information includes fully qualified Java class name of an activation specification and a set of required configuration property names.
The <activationspec-class>
child element of the <activationspec>
element is used to specify the fully qualified Java class name of the activation specification class. This class must implement the javax.resource.spi.ActivationSpec
interface. The implementation of this class is required to be a JavaBean.
The <adminobject>
child element of the <resourceadapter>
element is used to specify information about an administered object. Administered objects are specific to a messaging style or message provider. This contains information on the Java type of the interface implemented by an administered object, its Java class name, and its configuration properties.
The <adminobject-class>
child element of the <adminobject>
element is used to specify the fully qualified name of the Java type of the interface implemented by an administered object.
The <adminobject-interface>
child element of the <adminobject>
element is used to specify the fully qualified name of the Java type of the interface implemented by an administered object.
The <authentication-mechanism>
child element of the <outbound-resourceadapter>
element specifies an authentication mechanism supported by the resource adapter.
The BasicPassword
mechanism type should support the javax.resource.spi.security.PasswordCredential
interface. The Kerbv5
mechanism type should support the org.ietf.jgss.GSSCredential
interface or the deprecated javax.resource.spi.security.GenericCredential
interface.
The <authentication-mechanism-type>
child element of the <authentication-mechanism>
element specifies the authentication mechanism. Values are:
BasicPassword
Kerbv5
The <config-property-name>
child element of the <config-property>
or <required-config-property>
element defines the name of a configuration property and is entered as a string. Valid names are specific to a resource adapter or administered object.
The <config-property-type>
child element of the <config-property> element
defines the data type of a configuration property value and is entered as a java.lang.String
.
The <config-property-value>
child element of the <config-property> element
defines the value of a configuration property and is entered as a string.
The <connection-definition>
child element of the <outbound-resourceadapter>
element defines the classes and interfaces required by the Java Connector Architecture specification to define connection factories.
The <connectionfactory-imlp-class>
child element of the <connection-definition>
element defines the fully qualified name of the ConnectionFactory class that implements resource adapter specific ConnectionFactory interface. See http://java.sun.com/xml/ns/javaee/connector_1_6.xsd
for more information.
The <config-property>
child element of the <resourceadapter>
element, <adminobject> element, and <connection-definition>
element that defines a conversation property for a resource adapter administered objects. A configuration property is defined in the same manner as it is defined in the standard connector deployment descriptor.
The <connectionfactory-interface>
child element of the <connection-definition>
element specifies the fully qualified name of the ConnectionFactory
interface supported by the resource adapter. See http://java.sun.com/xml/ns/javaee/connector_1_6.xsd
for more information.
The <connection-imlp-class>
child element of the <connection-definition>
element specifies the fully qualified name of the connection class that implements resource adapter specific connection interface. See http://java.sun.com/xml/ns/javaee/connector_1_6.xsd
for more information.
The <connection-interface>
child element of the <connection-definition>
element specifies the fully qualified name of the connection interface supported by the resource adapter.
The <connector>
element is the root element of the WebLogic JMS resource adapter deployment descriptor file, ra.xml
The <authentication-mechanism>
child element of the <outbound-resourceadapter>
element specifies the interface that the resource adapter implementation supports for the representation of the credentials.Values are:
javax.resource.spi.security.PasswordCredential
org.ietf.jgss.GSSCredential
javax.resource.spi.security.GenericCredential
The <display-name>
element is an optional element that specifies the JMS resource adapter display name, a short name that can be displayed by GUI tools.
The <eis-type>
element specifies the Enterprise Information System (EIS) resource as JMS for this deployment descriptor file.
The <inbound-resourceadapter>
child element of the <resourceadapter>
element is used to specify information about an inbound resource adapter. This contains information specific to the implementation of the resource adapter library as specified through the <messageadapter>
element.
The <managedconnectionfactory-class>
child element of the <connection-definition>
specifies the fully qualified name of the Java class that implements the javax.resource.spi.ManagedConnectionFactory
interface. This Java class is provided as part of resource adapter's implementation of connector architecture specified contracts. The implementation of this class is required to be a JavaBean. See http://java.sun.com/xml/ns/javaee/connector_1_6.xsd
for more information.
The <messageadapter>
child element of the <inbound-resourceadapter>
element is used to specify messaging capabilities of the resource adapter. This contains information specific to the implementation of the resource adapter library as specified through the <messagelistener>
element.
The <messagelistener>
child element of the <messageadapter>
element is used to specify the implementation of the message listener as specified through the <messagelistener-type>
element.
The <messagelistener-type>
child element of the <messageadapter>
element is used to specify the specific message listener supported by the messaging resource adapter. It contains information on the Java type of the message listener interface and an activation specification.
The <reauthentication-support>
child element of the <outbound-resourceadapter>
element specifies whether the resource adapter implementation supports re-authentication of existing managed connection instances. Vaues are true
or false
.
The <required-config-property>
child element of the <activationspec>
element is used to specify required properties.
The <resourceadapter>
element encompasses the configuration of a single resource adapter that is deployed to a foreign JMS provider.
The <resourceadapter-class>
child element of the <resourceadapter>
element specifies the JMS resource adapter implementation class.
The <resourceadapter-version>
element specifies the release version number for this deployment descriptor file.
The <outbound-resourceadapter>
child element of the <resourceadapter>
element defines the configuration that is used to connect to an Enterprise Information System (EIS) from a foreign application server. The configuration defines connection factories for the resource adapter.
The <transaction-support>
child element of the <outbound-resourceadapter>
element specifies the level of transaction support provided by the resource adapter. The value must be one of the following:
NoTransaction
LocalTransaction
XATransaction