public class MessagingClientFactory extends Object
Modifier and Type | Method and Description |
---|---|
static MessagingClient |
createMessagingClient(Map<String,Object> parameters)
Create a MessagingClient instance.
|
static MessagingEJBClient |
createMessagingEJBClient()
Create an EJB (SessionBean) instance of
MessagingClient . |
static 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.
|
public static MessagingClient createMessagingClient(Map<String,Object> parameters) throws MessagingException
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:
ApplicationInfo.APPLICATION_NAME
.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.MessagingConstants.MESSAGE_LISTENER_THREADS
and
MessagingConstants.STATUS_LISTENER_THREADS
. UserTransaction
.Listener
): by setting the
MessagingConstants.LISTENER_TRANSACTED_MODE
parameter. Boolean.TRUE (default value) results in a created
transaction before the listener callback. The transaction will be
committed unless an Exception (or
ListenerException
with retriable==true) is thrown by the application. Setting the
parameter to Boolean.FALSE means that the listener callback would
be done without a transaction, that is, only a single delivery
would occur, regardless of any Exception. MessagingConstants.LISTENER_ACKNOWLEDGEMENT_MODE
parameter has been deprecated and replaced by the
LISTENER_TRANSACTED_MODE
parameter.
parameters
- A set of configuration properties for the instance being
created.MessagingException
public static MessagingEJBClient createMessagingEJBClient() throws MessagingException
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)
.MessagingClient
.MessagingException
- if there is an error while looking up or creating the
MessagingClient EJB instance.public static MessagingEJBClient createMessagingEJBClient(ApplicationInfo applicationInfo) throws MessagingException
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.applicationInfo
- the application infoMessagingClient
.MessagingException
- if there is an error while looking up or creating the
MessagingClient EJB instance.public static void remove(MessagingClient clientInstance)
clientInstance
- the client instance to remove.Copyright © 2009,2013 Oracle and/or its affiliates. All rights reserved.