jms-factories.dtd (SAP Library

jms-factories.dtd

Definition

A document type definition (DTD) used for producing XML files for Java Message Service (JMS) ConnectionFactory creation. It contains properties that the system uses to initialize a connection factory.

Structure

The jms-factories.dtd has the following structure:

This graphic is explained in the accompanying text

The use of each element is explained in detail as follows:

<!--

Jms-factories is the root element for this deployment descriptor. It contains information about the properties of the factory to be created and the name of the application to which it is associated.

-->

<!ELEMENT jms-factories (application-name?, connection-factory+)>

<!--

Application-name element defines the name of the application to which you associate the JMS ConnectionFactory. If the jms-factories.xml file is included in the archive file (EAR) of the application, this tag is ignored. If you deploy a standalone ConnectionFactory, the application name you specify is a formal name used for the configuration where the ConnectionFactory is stored; therefore, you can specify any name.

Used in: jms-factories

-->

<!ELEMENT application-name (#PCDATA)>

<!--

Connection-factory element contains information about the connection factory to be created. This includes: description (optional), name of used library (optional), unique alias, type (optional), name, either context factory type or object factory type, client ID, username (optional), and password (optional).

Used in: jms-factories

-->

<!ELEMENT connection-factory (description?, library-name?, alias*, connection-factory-type?, factory-name, (context-factory-type|object-factory-type), client-id, user-name?, password?)>

<!--

Library-name element specifies the name of the JMS library that is used to create the ConnectionFactory. You need this element if you use an external JMS provider instead of the JMS Provider Service in the SAP J2EE Engine.

Used in: connection-factory

Example: <library-name>SonicDriver</library-name>

-->

<!ELEMENT library-name (#PCDATA)>

<!--

Description element provides details about the connection factory. This element is optional.

Used in: connection-factory

Example: <description>An example for a JMS ConnectionFactory.</description>

-->

<!ELEMENT description (#PCDATA)>

<!--

Alias element specifies a short identifier used to refer to a particular ConnectionFactory object. You can assign multiple aliases to a single instance of ConnectionFactory. These are used for lookup operations from different applications.

Used in: connection-factory

Example: <alias>myFactory</alias>

-->

<!ELEMENT alias (#PCDATA)>

<!--

Connection-factory-type element specifies if the factory is Queue- or TopicConnectionFactory.

Used in: connection-factory

Example: <connection-factory-type>QueueConnectionFactory</connection-factory-type >

-->

<!ELEMENT connection-factory-type (#PCDATA)>

<!--

Factory-name element specifies the name of the connection factory to be created.

Used in: connection-factory

Example: <factory-name>myConnectionFactory</factory-name>

-->

<!ELEMENT factory-name (#PCDATA)>

<!--

Client-id element specifies an ID that is used for client identification. This is an optional element. If you do not specify a client ID, the system applies the client ID of the underlying connection factory from the JMS provider.

Used in: connection-factory

-->

<!ELEMENT client-id (#PCDATA)>

<!--

User-name element specifies username used by the JMS provider security. It is assigned to the connections created by this ConnectionFactory unless you specify another user and password for a connection.

Used in: connection-factory

Example: <user-name>Administrator<user-name>

-->

<!ELEMENT user-name (#PCDATA)>

<!--

Password element specifies a password that corresponds to the specified username.

Used in: connection-factory

-->

<!ELEMENT password (#PCDATA)>

<!--

Use this element if the JMS Provider uses J2EE Engine naming system.

Context-factory-type contains information about the context factory that is used if the JMS Provider is bound in Naming. This includes: the name of the connection factory obtained with lookup operation, JNDI InitialContext factory, URL of the provider, and security-related information.

Used in: connection-factory

Example:

<context-factory-type>

<link-factory-name>

jmsfactory/default/new_conn_factory

</link-factory-name>

<initial-context-factory>

com.sap.engine.services.jndi.InitialContextFactoryImpl

</initial-context-factory>

<provider-url>

localhost

</provider-url>

<security-principal>

Administrator

</security-principal>

</context-factory-type>

-->

<!ELEMENT context-factory-type (link-factory-name, initial-context-factory, provider-url, security-principal, security-credentials, properties*)>

<!--

Link-factory-name element specifies the name of the ConnectionFactory that is obtained with a lookup operation in Naming.

Used in: context-factory-type

Example: <link-factory-name>jmsfactory/default/new_conn_factory</link-factory-name>

-->

<!ELEMENT link-factory-name (#PCDATA)>

<!--

Initial-context-factory element specifies the class that is used to provide initial naming context.

Used in: context-factory-type

Example: <initial-context-factory>com.sap.engine.services.jndi.InitialContextFactoryImpl</initial-context-factory>

-->

<!ELEMENT initial-context-factory (#PCDATA)>

<!--

Provider-url element specifies the URL of the JMS Provider. You can specify it with the name of the host or by its IP.

Used in: context-factory-type

Example: <provider-url>localhost</provider-url>

-->

<!ELEMENT provider-url (#PCDATA)>

<!--

Security-principal element specifies the entity that is to be authenticated when establishing a connection.

Used in: context-factory-type

Example: <security-principal>Administrator</security-principal>

-->

<!ELEMENT security-principal (#PCDATA)>

<!--

Security-credentials element specifies the credentials that are used for authentication of the security-principal.

Used in: context-factory-type

-->

<!ELEMENT security-credentials (#PCDATA)>

<!--

Properties element contains the properties (as key-value pairs) that are passed to the initial naming context.

Used in: context-factory-type, object-factory-type

-->

<!ELEMENT properties (property+)>

<!--

Property element defines a single property of the naming context as a key-value pair.

Used in: properties

-->

<!ELEMENT property (property-name,property-value)>

<!--

Property-name element specifies the name of the naming context property.

Used in: property

-->

<!ELEMENT property-name (#PCDATA)>

<!--

Property-value element specifies the value of the naming context property.

Used in: property

-->

<!ELEMENT property-value (#PCDATA)>

<!—

Use this element if you obtain the JMS Provider from the ObjectFactory.

Object-factory-type element contains information for the object factory that is used to obtain the JMS provider, if the provider is not bound in the Naming. This information includes the name, the class name, and the properties of the object factory.

Used in: connection-factory

Example:

progress.message.jclient.AdministeredObjectFactory

<class-name>

progress.message.jclient.xa.XATopicConnectionFactory

</class-name>

</object-factory-type>

-->

<!ELEMENT object-factory-type (object-factory-name, class-name, properties+)>

<!--

Object-factory-name element specifies the name of the object factory to be used.

Used in: object-factory-type

Example: <object-factory-name> progress.message.jclient.AdministeredObjectFactory<object-factory-name>

-->

<!ELEMENT object-factory-name (#PCDATA)>

<!--

Class-name element specifies the class name of the object factory to be used.

Used in: object-factory-type

Example: <class-name> progress.message.jclient.xa.XATopicConnectionFactory</class-name>

-->

<!ELEMENT class-name (#PCDATA)>