oracle.sdp.messaging
Class MessagingClientFactory

java.lang.Object
  oracle.sdp.messaging.MessagingClientFactory

public class MessagingClientFactory
extends java.lang.Object

A Factory class for creating Messaging Clients to send and receive messages.

Since:

11.0.0

Method Summary

static MessagingClient	createMessagingClient(Map<java.lang.String,java.lang.Object> parameters) Create a MessagingClient instance.
static oracle.sdp.messaging.MessagingEJBClient	createMessagingEJBClient() Create an EJB (SessionBean) instance of MessagingClient.
static oracle.sdp.messaging.MessagingEJBClient	createMessagingEJBClient(ApplicationInfo applicationInfo) Create an EJB (SessionBean) instance of MessagingClient using specified application info.
static void	remove(MessagingClient clientInstance) Remove this Messaging Client instance.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createMessagingClient

public static MessagingClient createMessagingClient(Map<java.lang.String,java.lang.Object> parameters)
                                             throws MessagingException

Create a MessagingClient instance. Instances created using this method are not thread safe, and client applications are responsible for ensuring synchronized access to instances where required. When a client application is done using an instance created using this method, the instance should be released using the remove(MessagingClient) method. In typical use, no parameters need to be specified for a client application to be functional. Some parameters are useful to override default behavior:

• By default the client will be identified by its deployment name. This identifier can be overridden by specifying a value for key ApplicationInfo.APPLICATION_NAME.
• By default the client's resources will be available to any application with the same application name and any security principal. This behavior can be overridden by specifying a value for key ApplicationInfo.SDPM_SECURITY_PRINCIPAL. If a security principal is specified, then all subsequent requests involving the application's resources (messages, access points, etc.) must be made using the same security principal.
• When listeners are used to receive messages or statuses asynchronously, the number of listener worker threads can be controlled by specifying values for keys MessagingConstants.MESSAGE_LISTENER_THREADS and MessagingConstants.STATUS_LISTENER_THREADS.
• When receiving messages, the reliability mode can be controlled by specifying values for keys MessagingConstants.RECEIVE_ACKNOWLEDGEMENT_MODE (synchronous receiving) and MessagingConstants.LISTENER_ACKNOWLEDGEMENT_MODE (asynchronous receiving).

Parameters:

properties - A set of configuration properties for the instance being created.

Returns:

A MessagingClient instance configured according to the specified properties.

Throws:

MessagingException

Since:

11.1.1.3.0

createMessagingEJBClient

public static oracle.sdp.messaging.MessagingEJBClient createMessagingEJBClient()
                                                                        throws MessagingException

Create an EJB (SessionBean) instance of MessagingClient. This factory method searches your application's JNDI context for Messaging specific environment properties that specify the application name, instance name, etc. To programatically set the application info, use createMessagingEJBClient(ApplicationInfo).

Returns:

an EJB (SessionBean) instance of MessagingClient.

Throws:

MessagingException - if there is an error while looking up or creating the MessagingClient EJB instance.

createMessagingEJBClient

public static oracle.sdp.messaging.MessagingEJBClient createMessagingEJBClient(ApplicationInfo applicationInfo)
                                                                        throws MessagingException

Create an EJB (SessionBean) instance of MessagingClient using specified application info. If certain required fields are not set in the applicationInfo, this factory method searches your application's JNDI Context for appropriate environment properties.

Parameters:

applicationInfo - the application info

Returns:

an EJB (SessionBean) instance of MessagingClient.

Throws:

MessagingException - if there is an error while looking up or creating the MessagingClient EJB instance.

remove

public static void remove(MessagingClient clientInstance)

Remove this Messaging Client instance. Releases any resources used by this instance.

Parameters:

clientInstance - the client instance to remove.