...

Overview

The Geronimo deployment plan for a resource adapter, which is usually packaged as a JAR file, is called "Deploying a resource adapter in Geronimo requires a Geronimo plan. This may be an external plan or may be packed in the resource adapter rar file (NOT a jar file inside the rar file) as "META-INF/geronimo-ra.xml". The geronimo-ra.xml deployment plan is used in conjunction with the ra.xml Java EE deployment plan to deploy JCA connector JARRAR(s) to the Geronimo application server. The geronimo-ra.xml deployment plan is an optional file, but is typically used when deploying a resource adapter JAR file. It is used to specify a moduleId for the deployed module, any third party dependencies, a description for the JCA adapter, an administration object, outbound connection pooling parameters, overridden config-properties, admin objects such as jms destinations, and additional GBeans..

Packaging

The geronimo-ra.xml deployment plan can be packaged as follows:

...

The geronimo-ra.xml deployment plan is defined by the geronimo-connector-1.2.xsd schema located in the <geronimo_home>/schema/ subdirectory of the main Geronimo installation directory. The geronimo-connector-1.2.xsd schema is briefly described here:

http://geronimo.apache.org/schemas-2.1/docs/geronimo-connector-1.2.xsd.html^{Image Removed}

Schema top-level elements

The root XML element in the geronimo-connector-1.2.xsd schema is the <connector> element. The top-level XML elements of the <connector> root element are described in the sections below. The deployment plan should always use the Connector namespace, and it typically requires elements from Geronimo System namespace. A typical deployment for geronimo-ra.xml can be presented as follows:

...

...

<sys:environment>

The <sys:environment> XML element uses the Geronimo System namespace, which is used to specify the common elements for common libraries and module-scoped services, and is described here:

• http://geronimo.apache.org/schemas-2.1/docs/geronimo-module-1.2.xsd.html^{Image Removed}

The <sys:environment> element contains the following elements:

...

An example geronimo-ra.xml file is shown below using the <sys:environment> elements:

...

<resourceadapter>

The <resourceadapter> uses the Geronimo default namespace for a geronimo-ra.xml file that is described here:

• http://geronimo.apache.org/schemas-2.1/docs/geronimo-connector-1.2.xsd.html^{Image Removed}

This element is used to define a single JDBC connector or JMS connection factory. The <resourceadapter-instance> element provides resource adapter instance specific information like configuration properties and workmanager implementation. The <outboundresource-adapter> specifies information about an outbound resource adapter. The information includes fully qualified names of classes and interfaces required as part of the connector architecture specified contracts for connection management, level of transaction support provided, one or more authentication mechanisms supported and additional required security permissions. If there is no authentication mechanism specified as part of the resource adapter element, then the resource adapter does not support any standard security contract. The application server ignores the security part of the system contracts in this case.

...

<adminobject>

The <adminobject> uses the Geronimo default namespace for a geronimo-ra.xml file that is described here:

• http://geronimo.apache.org/schemas-2.1/docs/geronimo-connector-1.2.xsd.html^{Image Removed}

This element can be used to define a JMS topic or queue. The <adminobject> contains the following elements:

• The <adminobject-interface> element is used to specify the fully qualified name of the implemented Java interface of the admin object. One example of this is javax.jms.Topic.
  
  
• The <adminobject-class> element specifies the full qualified name of the Java class of the admin object.
  
  
• The <adminobject-intstance> element contains the configuration for this specific instance of the administered object type, with a unique name, and values for any configuration properties necessary for that administered object type. Two elements for defining the instance of the admin object are provided. The <message-destination-name> element can be referred to by other deployment plans by using the <naming:message-destination> element. This is also used as a unique object name of the GBean for the instance. The <config-property-setting> specifies the set of properties for the admin object instance.

...

...

<sys:service>

The <sys:service> element uses the Geronimo deployment namespace described here:

• http://geronimo.apache.org/schemas-2.1/docs/geronimo-module-1.2.xsd.html^{Image Removed}

It is used to define GBean(s) that are configured and deployed with the connector module. These additional Geronimo services will be deployed when the application is deployed (and stopped when the application is stopped). Normally, the implementation classes for these services are included at the server level and referenced using a dependency element.