public class ApplicationInfo extends Properties implements Serializable
The recommended, declarative approach is via JNDI environment properties in the application's XML descriptor file (such as ejb-jar.xml, or application-client.xml, or web.xml). Simply copy/paste this snippet of XML in your application's XML descriptor (an understanding of J2EE application developoment/deployment is assumed) and replace all the tokens (starting and ending with "@") with appropriate values:
<!-- Messaging Client Application Info Environment Properties [BEGIN] --> <!-- The MessagingClientFactory.createMessagingEJBClient() uses these properties, if specified, to register the calling application's info with the Messaging Server. These values can also be overriden programmatically by setting the appropriate properties in ApplicationInfo - passed to MessagingClientFactory.createMessagingEJBClient(ApplicationInfo). --> <!-- Configure the Messaging Client Application Name / Instance Name --> <env-entry> <description> <![CDATA[The name of the application.]]> </description> <env-entry-name>sdpm/ApplicationName</env-entry-name> <env-entry-type>java.lang.String</env-entry-type> <env-entry-value>@ApplicationName@</env-entry-value> </env-entry> <env-entry> <description> <![CDATA[The name of the application instance. Access Points registered by an application are shared across all "instances" of the application.]]> </description> <env-entry-name>sdpm/ApplicationInstanceName</env-entry-name> <env-entry-type>java.lang.String</env-entry-type> <env-entry-value>@ApplicationInstanceName@</env-entry-value> </env-entry> <!-- (Optional) Configure the queue and listener info for asynchronous receiving of Message and Status. --> <env-entry> <description> <![CDATA[The Receiving Queues Information. The format for the queue info string (BNF notation) is: queuesInfo := queue-info *(";" queue-info) queue-info := queue-connection-factory-jndi-name ":" queue-jndi-name *("," queue-jndi-name) Note: "*(element)" means zero or more occurrences of element. Examples: * 1 queue connection factory with JNDI name "jms/MyQCF1" for 1 queue with JNDI name "jms/sdpm/MyQ1": jms/MyQCF1:jms/sdpm/MyQ1 * 1 queue connection factory with JNDI name "jms/MyQCF1" for 2 queues with JNDI names "jms/sdpm/MyQ1" and "jms/sdpm/MyQ2": jms/MyQCF1:jms/sdpm/MyQ1,jms/sdpm/MyQ2 * 1 queue connection factory with JNDI name "jms/MyQCF1" for 1 queue with JNDI name "jms/sdpm/MyQ1" and another queue connection factory with JNDI name "jms/MyQCF2" for a queue with JNDI name "jms/sdpm/MyQ2": jms/MyQCF1:jms/sdpm/MyQ1;jms/MyQCF2:jms/sdpm/MyQ2 ]]> </description> <env-entry-name>sdpm/ReceivingQueuesInfo</env-entry-name> <env-entry-type>java.lang.String</env-entry-type> <env-entry-value>@ReceivingQueuesInfo@</env-entry-value> </env-entry> <env-entry> <description> <![CDATA[Message Listener Session Bean JNDI Name]]> </description> <env-entry-name>sdpm/MessageListenerSessionBeanJNDIName</env-entry-name> <env-entry-type>java.lang.String</env-entry-type> <env-entry-value>@messagelistener.sessionbean.jndi.name@</env-entry-value> </env-entry> <env-entry> <description> <![CDATA[Message Listener Session Bean Home Class Full Name]]> </description> <env-entry-name>sdpm/MessageListenerSessionBeanHomeClassName</env-entry-name> <env-entry-type>java.lang.String</env-entry-type> <env-entry-value>@messagelistener.sessionbean.home.class.name@</env-entry-value> </env-entry> <env-entry> <description> <![CDATA[Status Listener Session Bean JNDI Name]]> </description> <env-entry-name>sdpm/StatusListenerSessionBeanJNDIName</env-entry-name> <env-entry-type>java.lang.String</env-entry-type> <env-entry-value>@statuslistener.sessionbean.jndi.name@</env-entry-value> </env-entry> <env-entry> <description> <![CDATA[Status Listener Session Bean Home Class Full Name]]> </description> <env-entry-name>sdpm/StatusListenerSessionBeanHomeClassName</env-entry-name> <env-entry-type>java.lang.String</env-entry-type> <env-entry-value>@statuslistener.sessionbean.home.class.name@</env-entry-value> </env-entry> <!-- Configure JNDI Properties to access Messaging Server. The Messaging Client EJB library uses these properties to access the JNDI naming context of the Messaging Server, as well as for the required security context to access the Messaging APIs on behalf of the application. These values can also be overriden programmatically by setting the appropriate properties in ApplicationInfo - passed to MessagingClientFactory.createMessagingEJBClient(ApplicationInfo). The default behavior of the EJB library, if these properties are not specified by the application, is to connect to the Messaging Server that is colocated on the same J2EE container using local/remote EJB access. --> <!-- Uncomment this section ONLY if the application is not colocated with the Messaging Server on the same J2EE container. --> <!-- <env-entry> <description> <![CDATA[The Messaging Client library uses the Messaging JNDI InitialFactory to connect to the JNDI naming context of the Messaging Server on behalf of the application. The default value of this property, if not set is "weblogic.jndi.WLInitialContextFactory".]]> </description> <env-entry-name>sdpm/JNDIInitialFactory</env-entry-name> <env-entry-type>java.lang.String</env-entry-type> <env-entry-value></env-entry-value> </env-entry> <env-entry> <description> <![CDATA[The Messaging Client library uses the Messaging JNDI Provider URL to access the JNDI naming context of the Messaging Server on behalf of the application. The default behavior, if this property is not set (left blank): On WebLogic Server: Use the default JNDI context. In general, the application must provide the JNDI Provider URL which is appropriate to the J2EE server installation: For standalone client connecting to a Messaging Server on WebLogic Server, the form is "t3://<host>:<port>" ]]> </description> <env-entry-name>sdpm/ServerJNDIProviderURL</env-entry-name> <env-entry-type>java.lang.String</env-entry-type> <env-entry-value></env-entry-value> </env-entry> <env-entry> <description> <![CDATA[The Messaging Client library uses the Messaging Security Principal to access the JNDI naming context of the Messaging Server, as well as for the required security context to access the Messaging APIs on behalf of the application. In general, the application must set the appropriate principal required to gain access to the Messaging Server's context and access the Messaging APIs. This property goes hand in hand with the Messaging Security Credentials. ]]> </description> <env-entry-name>sdpm/SecurityPrincipal</env-entry-name> <env-entry-type>java.lang.String</env-entry-type> <env-entry-value></env-entry-value> </env-entry> <env-entry> <description> <![CDATA[The Messaging Client library uses the Messaging Security Crendentials to access the JNDI naming context of the Messaging Server, as well as for the required security context to access the Messaging APIs on behalf of the application. In general, the application must set the appropriate credentials required to gain access to the Messaging Server's context and access the Messaging APIs. This property goes hand in hand with the Messaging Security Principal. ]]> </description> <env-entry-name>sdpm/SecurityCredentials</env-entry-name> <env-entry-type>java.lang.String</env-entry-type> <env-entry-value></env-entry-value> </env-entry> --> <!-- Messaging Client Application Info Environment Properties [END] -->
Modifier and Type | Field and Description |
---|---|
static String |
APPLICATION_INSTANCE_NAME |
static String |
APPLICATION_NAME |
static String |
DEFAULT_SDPM_JNDI_INITIAL_FACTORY |
static String |
DEFAULT_SDPM_JNDI_PROVIDER_URL
The default SDP Messaging Server JNDI Provider URL is empty.
|
static String |
DEFAULT_SDPM_SECURITY_CREDENTIALS |
static String |
DEFAULT_SDPM_SECURITY_PRINCIPAL |
static String |
DEFAULT_SERVER_NAME |
static String |
MESSAGE_LISTENER_SESSION_BEAN_HOME_CLASS_NAME |
static String |
MESSAGE_LISTENER_SESSION_BEAN_JNDI_NAME |
static String |
RECEIVING_QUEUES_INFO |
static String |
SDPM_JNDI_INITIAL_FACTORY |
static String |
SDPM_SECURITY_CREDENTIALS |
static String |
SDPM_SECURITY_PRINCIPAL |
static String |
SDPM_SERVER_JNDI_PROVIDER_URL |
static String |
STATUS_LISTENER_SESSION_BEAN_HOME_CLASS_NAME |
static String |
STATUS_LISTENER_SESSION_BEAN_JNDI_NAME |
static String |
VERSION |
defaults
Constructor and Description |
---|
ApplicationInfo()
Constructor
|
Modifier and Type | Method and Description |
---|---|
String |
getApplicationInstanceName() |
String |
getApplicationName() |
String |
getJNDIInitialFactory() |
String |
getMessageListenerSessionBeanHomeClassName() |
String |
getMessageListenerSessionBeanJNDIName() |
ArrayList<oracle.sdpinternal.messaging.config.QueueInfo> |
getReceivingQueues()
This getter is for Messaging-internal use.
|
String |
getReceivingQueuesInfo()
Get the receiving queues information.
|
String |
getSecurityCredentials() |
String |
getSecurityPrincipal() |
String |
getServerJNDIProviderURL() |
String |
getStatusListenerSessionBeanHomeClassName() |
String |
getStatusListenerSessionBeanJNDIName() |
void |
setApplicationInstanceName(String applicationInstanceName) |
void |
setApplicationName(String applicationName) |
void |
setJNDIInitialFactory(String initialFactory)
The Messaging Client library uses the JNDI InitialFactory to
connect to the JNDI naming context of the Messaging Server on
behalf of the application.
|
void |
setMessageListenerSessionBeanHomeClassName(String messageListenerSessionBeanHomeClassName) |
void |
setMessageListenerSessionBeanJNDIName(String messageListenerSessionBeanJNDIName) |
void |
setReceivingQueues(ArrayList<oracle.sdpinternal.messaging.config.QueueInfo> receivingQueues)
This setter is for Messaging-internal use.
|
void |
setReceivingQueuesInfo(String queuesInfo)
Set the receiving queues information.
|
void |
setSecurityCredentials(String securityCredentials)
The Messaging Client library uses the Messaging Security
Crendentials to access the JNDI naming context of the Messaging
Server, as well as for the required security context to access
the Messaging APIs on behalf of the application.
|
void |
setSecurityPrincipal(String securityPrincipal)
The Messaging Client library uses the Messaging Security
Principal to access the JNDI naming context of the Messaging
Server, as well as for the required security context to access
the Messaging APIs on behalf of the application.
|
void |
setServerJNDIProviderURL(String providerURL)
The Messaging Client library uses the Messaging Server JNDI
Provider URL to access the JNDI naming context of the Messaging
Server on behalf of the application.
|
void |
setStatusListenerSessionBeanHomeClassName(String statusListenerSessionBeanHomeClassName) |
void |
setStatusListenerSessionBeanJNDIName(String statusListenerSessionBeanJNDIName) |
String |
toString() |
getProperty, getProperty, list, list, load, load, loadFromXML, propertyNames, save, setProperty, store, store, storeToXML, storeToXML, stringPropertyNames
public static final String APPLICATION_NAME
public static final String APPLICATION_INSTANCE_NAME
public static final String RECEIVING_QUEUES_INFO
public static final String MESSAGE_LISTENER_SESSION_BEAN_JNDI_NAME
public static final String MESSAGE_LISTENER_SESSION_BEAN_HOME_CLASS_NAME
public static final String STATUS_LISTENER_SESSION_BEAN_JNDI_NAME
public static final String STATUS_LISTENER_SESSION_BEAN_HOME_CLASS_NAME
public static final String SDPM_SECURITY_PRINCIPAL
public static final String SDPM_SECURITY_CREDENTIALS
public static final String SDPM_JNDI_INITIAL_FACTORY
public static final String SDPM_SERVER_JNDI_PROVIDER_URL
public static final String VERSION
public static final String DEFAULT_SDPM_SECURITY_PRINCIPAL
public static final String DEFAULT_SDPM_SECURITY_CREDENTIALS
public static final String DEFAULT_SDPM_JNDI_INITIAL_FACTORY
public static final String DEFAULT_SERVER_NAME
public static final String DEFAULT_SDPM_JNDI_PROVIDER_URL
public String getApplicationInstanceName()
public void setApplicationInstanceName(String applicationInstanceName)
applicationInstanceName
- the applicationInstanceName to set.public String getApplicationName()
public void setApplicationName(String applicationName)
applicationName
- the applicationName to set.public String getJNDIInitialFactory()
public void setJNDIInitialFactory(String initialFactory)
initialFactory
- the JNDI InitialFactory to set.public String getServerJNDIProviderURL()
public void setServerJNDIProviderURL(String providerURL)
providerURL
- the Messaging Server JNDI Provider URL to set.public String getSecurityCredentials()
public void setSecurityCredentials(String securityCredentials)
securityCredentials
- the Messaging Security Credentials to set.setSecurityPrincipal(String)
public String getSecurityPrincipal()
public void setSecurityPrincipal(String securityPrincipal)
securityPrincipal
- the Messaging Security Principal to set.setSecurityCredentials(String)
public String getReceivingQueuesInfo()
public void setReceivingQueuesInfo(String queuesInfo)
The format for the queuesInfo string (BNF notation) is:
queue-info := queue-connection-factory-jndi-name ":" queue-jndi-name *("," queue-jndi-name)
Note: "*(element)" means zero or more occurrences of element.
queuesInfo := queue-info *(";" queue-info)
Examples:
jms/MyQCF1:jms/sdpm/MyQ1
jms/MyQCF1:jms/sdpm/MyQ1,jms/sdpm/MyQ2
jms/MyQCF1:jms/sdpm/MyQ1;jms/MyQCF2:jms/sdpm/MyQ2
queuesInfo
- the receivingQueuesInfo to set.public ArrayList<oracle.sdpinternal.messaging.config.QueueInfo> getReceivingQueues()
getReceivingQueuesInfo()
.public void setReceivingQueues(ArrayList<oracle.sdpinternal.messaging.config.QueueInfo> receivingQueues)
setReceivingQueuesInfo(String)
.receivingQueues
- the receivingQueues to set.public String getMessageListenerSessionBeanHomeClassName()
public void setMessageListenerSessionBeanHomeClassName(String messageListenerSessionBeanHomeClassName)
messageListenerSessionBeanHomeClassName
- the messageListenerSessionBeanHomeClassName to set.public String getMessageListenerSessionBeanJNDIName()
public void setMessageListenerSessionBeanJNDIName(String messageListenerSessionBeanJNDIName)
messageListenerSessionBeanJNDIName
- the messageListenerSessionBeanJNDIName to set.public String getStatusListenerSessionBeanHomeClassName()
public void setStatusListenerSessionBeanHomeClassName(String statusListenerSessionBeanHomeClassName)
statusListenerSessionBeanHomeClassName
- the statusListenerSessionBeanHomeClassName to set.public String getStatusListenerSessionBeanJNDIName()
public void setStatusListenerSessionBeanJNDIName(String statusListenerSessionBeanJNDIName)
statusListenerSessionBeanJNDIName
- the statusListenerSessionBeanJNDIName to set.Copyright © 2009,2013 Oracle and/or its affiliates. All rights reserved.