Schema Element / Attribute

Description

jms-resources

The root element of the XML schema.

application-name

Use this name if you want to deploy the jms-resources.xml as a standalone application via the Telnet command DEPLOY_JMS_RESOURCE from the JMSCONNECTOR group. If the jms-resources.xml is part of an EAR archive, then this name is ignored.

Used in: jms-resources

connection-factory

Defines the type of connection factory to use for the resources. The connection factory defines the JMS Connection Factory Object which can be later on used by the application. You can choose between the following types:

●      sap-local-factory-type

●      context-factory-type

●      object-factory-type

●      sjo-factory-type

Here you declare only a proxy to the real object.

Used in: jms-resources

Contains: name, sap-local-factory-type, alias, property, description, client-id

name

The connection factory name. Later on, this name if used in JNDI lookups. For example, if the name is My_Connection_Factory, then you look it up using java:comp/env/My_Connection_Factory.

Used in: connection-factory

sap-local-factory-type

This is the SAP JMS Provider vendor-specific connection factory type.

We recommend that you use this connection factory type.

Used in: connection-factory

Contains: type, virtual-provider, name, user-name, property

type

This is a switch that allows you to choose between the following types of connection factories:

●      javax.jms.ConnectionFactory

●      javax.jms.TopicConnectionFactory

●      javax.jms.QueueConnectionFactory

●      javax.jms.XAQueueConnectionFactory

●      javax.jms.XATopicConnectionFactory

●      javax.jms.XAConnectionFactory

Used in: sap-local-factory-type.

virtual-provider

The name of the JMS Virtual Provider (VP). If there is no such Virtual Provider, it is automatically created. If it is omitted, the default Virtual Provider is used.

Used in: sap-local-factory-type.

name

This is the name of the physical connection factory (the one created in the SAP JMS Provider). This element is optional. If you do not specify it, the name of the proxy factory is used.

Used in: sap-local-factory-type

user-name

A user name which is used when you create a connection from this connection factory with the createConnection() method.

Used in: sap-local-factory-type

password

This is the password that you use when you create a connection from this connection factory with the createConnection() method. It is used only if the <user-name> element is specified.

Used in: sap-local-factory-type

property

Additional properties that you can use with the JMS provider.

More information about the JMS provider specific properties:

Creating and Configuring JMS Resources and Resource References.

Used in: context-factory-type, object-factory-type, sap-local-factory-type, destination, jms-resources, connection-factory, sap-local-destination-type

Contains: description, config-property-name, config-property-value

description

Description of the additional property.

Used in: property

config-property-name

Name of the additional property.

Used in: property

config-property-value

Value of the additional property.

Used in: property

context-factory-type

Defines a connection factory which will be acquired by JNDI lookup.

Used in: connection-factory

initial-context-properties

The initial context properties.

Used in: context-factory-type

initial-context-factory

The class name of the javax.naming.spi.InitialContextFactory implementation.

Used in: initial-context-properties

provider-url

The URL for naming of the provider. If the provider is SAP, you do not have to use this tag.

Used in: initial-context-properties

security-principal

The user for the naming of the JMS Provider.

Used in: initial-context-properties

security-credentials

The password for the naming provider URL.

Used in: initial-context-properties.

link-factory-name

JNDI name of the physical connection factory. You should use the fully qualified name. For SAP JMS Provider it is jmsfactory/<virtualProviderName>/<factoryName>.

Used in: context-factory-type

user-name

A user name which is used when you create a connection from this connection factory with the createConnection() method.

Used in: context-factory-type, object-factory-type, sjo-factory-type, external-destination-type

password

This is the password that you use when you create a connection from this connection factory with the createConnection() method. It is used only if the <user-name> element is specified.

Used in: context-factory-type, object-factory-type, sjo-factory-type, external-destination-type

library-name

The name of a Java EE library. The client JAR file must be deployed on the AS Java as a library.

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

object-factory-type

The object connection factory type.

Used in: connection-factrory

object-factory-name

The fully qualified class name of the javax.naming.spi.InitialContextFactory implementation.

Used in: object-factory-type

class-name

The fully qualified class name of the object that you want to create. This is the class name of the connection factory.

Used in: object-factory-type

sjo-factory-type

The Serialized Java Object’s connection factory type.

Used in: connection-factory

sjo-file-name

The full path to the file with Serialized Java Object.

Used in: sjo-factory-type

alias

An additional name that can be used as an alias of the connection factory.

Used in: connection-factory.

description

Description of the connection factory.

Used in: connection-factory.

client-id

The client ID for the connection factory.

Used in: connection-factory.

destination

Information about the JMS destination(s) that you want to create. A proxy object to a physical connection is created. If used with sap-local-destination-type, then a new destination is created, otherwise the physical destination should be already created in the JMS Provider.

Used in: jms-resources.

Contains: name, type, sap-local-destination-type, property, description.

name

The name that will be used by the application to refer to the destination. Later on, this name is used in JNDI lookups. For example, if the name is My_Connection_Factory, then you look it up using java:comp/env/My_Connection_Factory.

Used in: destination.

type

The type of the destination. You can choose between:

●      sap-local-destination-type.

●      external-destination-type.

●      sjo-destination-type.

Used in: destination.

sap-local-destination-type

We recommend that you use this destination type. This is the SAP destination type.

Used in: connection-factory.

Contains: type, virtual-provider, name, user-name, property.

virtual-provider

The JMS Virtual Provider (VP) of the destination. It must be the same as the one defined in the <sap-local-factory-type>.

Used in: sap-local-destination-type.

name

This is the name of the physical connection factory (the one created in the SAP JMS Provider). This element is optional. If you do not specify it, the name of the proxy factory is used.

Used in: sap-local-destination-type.

external-destination-type

Used if you have an external destination.

Used in: destination

link-connection-factory

The name of the connection factory that is used to acquire this destination. The destination is acquired via javax.jms.Session.create(Queue/Topic) methods from the JMS API.

Used in: external-destination-type

link-destination

This is the name of the physical destination. If you do not specify it, the proxy destination name is used.

Used in: external-destination-type.

sjo-destination-type

The Serialized Java Object’s destination type.

Used in: destination

sjo-file-name

The fully qualified name of the Serialized Java Object class.

Used in: sjo-destination-type

description

A description of the destination.

Used in: destination.

saf-agent

A Store-and-Forward (SAF) Agent reliably transfers messages between clusters. It consumes messages from the local destination (defined in local-info) and forwards them to the specified remote destination (defined in remote-info).

More information: Using JMS Store and Forward

Used in: jms-resources

name

This is the name of the JMS SAF Agent.

Used in: saf-agent

local-info

This info contains information about the local (at the side of SAF Agent) JMS resources - the factory and the destination to which the messages will be sent by the local applications and from which the SAF Agent will consume the messages it will forward to the remote destination.

Used in: saf-agent

factory-name-ref

This is the name of the connection factory used to access the local destination. The SAF Agent consumes the messages sent to this destination and then reliably forwards them to the remote destination.

Used in: local-info

destination-name-ref

This is a complex type for remote destination-name-ref.

Used in: local-info

remote-info

This info contains information about the remote JMS SAF resources - the factory and the destination to which the messages will be forwarded.

 The factory is obtained from the destination and that is why it is not provided explicitly.

Used in: saf-agent

destination-name-ref

This is a complex type for remote destination-name-ref. This is a simple string element with one optional attribute that indicates whether this destination and its factory should be bound (that is visible) in the local JNDI tree.

Used in: remote-info

bindInLocalNaming

This is an attribute of the destination-name-ref tag and is used only in the remote-info. Indicates whether the SAF remote resources should be bound (that is visible) in the local JNDI tree.

Used in: destination-name-ref only under remote-info

message-selector

This is the message selector the SAF Agent will use to filter the messages from the local destination before forwarding them to the remote destination.

Used in: saf-agent

virtual-provider-properties

The properties of JMS Virtual Providers, related to JMS clustering, transactions, etc.

More information:

●      Configuring Transaction-Related JMS Connection Factory Properties

●      JMS Clustering and Failover

Used in: jms-resources

name

This is the name of the JMS Virtual Provider.

Used in: virtual-provider-properties