com.oracle.webservices.api.jms

Annotation Type JMSTransportClient

@Target(value=TYPE)
@Retention(value=RUNTIME)
@Documented
@WebServiceFeatureAnnotation(id="com.oracle.webservices.api.jms.JMSTransportClientFeature",
                             bean=JMSTransportClientFeature.class)
public @interface JMSTransportClient

Configure SOAP over JMS.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	destinationName Specifies the JNDI name of the request queue
JMSDestinationType	destinationType Specifies destination type.
boolean	enabled Enable this feature.
String	jmsMessageHeader Specified via "name=value" pairs separated by the AMPERSAND sign, e.g., "JMSPriority=4"
String	jmsMessageProperty Specified via "name=value" pairs separated by the AMPERSAND sign, e.g., "JMSPriority=4"
String	jndiConnectionFactoryName Specifies the JNDI name of the connection factory that is used by the client runtime to establish a connection to the request queue.
String	jndiContextParameter Specifies additional properties, other than jndiURL, and jndiInitialContextFactory, which are needed to connect to the JNDI provider.
String	jndiInitialContextFactory specifying the name of the initial context factory class to use.
String	jndiURL Specifies the JNDI provider URL.
JMSMessageType	messageType Specifies the message type to use with the request message.
int	priority Specifies the JMS priority associated with the request and response message.
String	replyToName Specifies the JNDI name of the JMS destination to which the response message is sent.
String	targetService Used by the service implementation to dispatch the service request.
long	timeToLive Specifies the lifetime, in milliseconds, of the request message.

Element Detail

destinationName

public abstract String destinationName

Specifies the JNDI name of the request queue

Default:

"com.oracle.webservices.api.jms.RequestQueue"

destinationType

public abstract JMSDestinationType destinationType

Specifies destination type. QUEUE (default) or TOPIC. If the destination is a TOPIC, then either the destinationType property or the destinationType entry in activationConfig is required as TOPIC. If destinationType is defined as a top level annotation property as well as an entry in activationConfig, the former one take precedence. TODO: precedence is handled elsewhere, not by SOAP/JMS subsystem

Default:

com.oracle.webservices.api.jms.JMSDestinationType.QUEUE

enabled

public abstract boolean enabled

Enable this feature. Defaults to true.

Default:

true

jmsMessageHeader

public abstract String jmsMessageHeader

Specified via "name=value" pairs separated by the AMPERSAND sign, e.g., "JMSPriority=4"

Default:

""

jmsMessageProperty

public abstract String jmsMessageProperty

Specified via "name=value" pairs separated by the AMPERSAND sign, e.g., "JMSPriority=4"

Default:

""

jndiConnectionFactoryName

public abstract String jndiConnectionFactoryName

Specifies the JNDI name of the connection factory that is used by the client runtime to establish a connection to the request queue.

Default:

"com.oracle.webservices.api.jms.ConnectionFactory"

jndiContextParameter

public abstract String jndiContextParameter

Specifies additional properties, other than jndiURL, and jndiInitialContextFactory, which are needed to connect to the JNDI provider. Specified via "name=value" pairs separated by the AMPERSAND sign, e.g., "JMSPriority=4"

Default:

""

jndiInitialContextFactory

public abstract String jndiInitialContextFactory

specifying the name of the initial context factory class to use. This value maps to the java.naming.factory.initial property.

Default:

"weblogic.jndi.WLInitialContextFactory"

jndiURL

public abstract String jndiURL

Specifies the JNDI provider URL. This value maps to the java.naming.provider.url property.

Default:

"t3://localhost:7001"

messageType

public abstract JMSMessageType messageType

Specifies the message type to use with the request message. A value of BYTES indicates the javax.jms.BytesMessage object is used. A value of TEXT indicates javax.jms.TextMessage object is used. The default value is BYTES.

Default:

com.oracle.webservices.api.jms.JMSMessageType.BYTES

priority

public abstract int priority

Specifies the JMS priority associated with the request and response message. Specify this value as a positive integer from 0, the lowest priority, to 9, the highest priority. If this parameter is not specified, then the JMS-defined default value is used.

Default:

0

replyToName

public abstract String replyToName

Specifies the JNDI name of the JMS destination to which the response message is sent. Using this optional property enables the client to use a previously defined, permanent queue or topic rather than a temporary queue or topic, for receiving replies. The property is propagated as JMS header JMSReplyTo in the request message.

Default:

""

targetService

public abstract String targetService

Used by the service implementation to dispatch the service request. The targetService property populates the JMS message property SOAPJMS_targetService. Even though SOAPJMS_targetService is required JMS header, the soapjms:targetService is optional. If soapjms:targetService is not specified, the service name from the WSDL will be used to populate SOAPJMS_targetService. The targetService property value is the port component name of the SOAP/JMS web service.

Default:

""

timeToLive

public abstract long timeToLive

Specifies the lifetime, in milliseconds, of the request message. A value of 0 indicates an infinite lifetime. If this parameter is not specified, then the JMS-defined default value is used. On the service side, timeToLive also specifies expiration time for each MDB transaction.

Default:

180000L