oracle.webservices.annotations.async

Annotation Type AsyncWebServiceResponseQueue

@Retention(value=RUNTIME)
@Target(value=TYPE)
public @interface AsyncWebServiceResponseQueue

The AsyncWebServiceResponseQueue annotation describes the JMS queue that will be used to store the asynchronous responses. Typically such messages will be sent immediately to the callback service at the client side. In case the client side listener is not up, the messages will be kept in this queue for retrying later. This annotation is applicable only to asynchronous web service implementation classes that are annotated with AsyncWebService annotation.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	connectionFactory The JNDI name of the QueueConnectionFactory used for response queue
boolean	enable The response queue to be used or not.
boolean	enableTransaction If transaction is to be used for the MDB that processes messages from this response queue.
int	messageProcessorInitialPoolSize The initial number of message processor instances in the pool to send the asynchronous responses.
int	messageProcessorMaxPoolSize The maximum number of message processor instances in the pool to send the asynchronous responses.
java.lang.String	messageProcessorPool Name of the common message processor pool.
java.lang.String	queue The JNDI name of the JMS queue where asynchronous responses will be saved for later processing

Element Detail

enable

public abstract boolean enable

The response queue to be used or not. If not enabled, response processing will be done by request-side MDB

Default:

true

connectionFactory

public abstract java.lang.String connectionFactory

The JNDI name of the QueueConnectionFactory used for response queue

Default:

""

queue

public abstract java.lang.String queue

The JNDI name of the JMS queue where asynchronous responses will be saved for later processing

Default:

""

enableTransaction

public abstract boolean enableTransaction

If transaction is to be used for the MDB that processes messages from this response queue.

Default:

false

messageProcessorInitialPoolSize

public abstract int messageProcessorInitialPoolSize

The initial number of message processor instances in the pool to send the asynchronous responses.

Default:

1

messageProcessorMaxPoolSize

public abstract int messageProcessorMaxPoolSize

The maximum number of message processor instances in the pool to send the asynchronous responses. Larger number will give you more throughput, but also may use more resources like threads and database connections etc.

Default:

16

messageProcessorPool

public abstract java.lang.String messageProcessorPool

Name of the common message processor pool. If not specified, the service will use the default application level pool of message processors. If specified then a common named pool of message processors is used. While assembling an application, the first reference of a new common pool name creates a new pool of message processors in the application. After that any new service can refer to the same pool name and so can use the same message processor pool. One application having multiple asynchronous services may have more than one named pool of message processors. Asynchronous services sharing the same pool may interfere with each others performance under heavy load condition, so it is recommended that services having operations that take similar execution time should be grouped together. If there is a mix of fast and slow operations, then the fast operation may get queued up behind slow ones causing more delay to fast operations. A possible set of groups could be "slow", "medium" and "fast". The pool name does not signify any thing. This feature is useful to conserve resources like MDB, threads and database connections depending on the type of queue used.

Returns:

Default:

""