public class MAppProperties
extends java.lang.Object
MApp
application manager.
Before creating the MApp
application manager, applications create an
instance of MAppProperties
and set the application name, version,
banner information, and information about the location of the adapter instance
description object.
Applications can then call the constructor for MApp
using
the specified MAppProperties
instance.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
AERVMSG
The value for AE RV message format.
|
static java.lang.String |
APPINFO
Application banner information to be associated with the
MApp to be
created. |
static java.lang.String |
APPNAME
Application name to be associated with the
MApp
to be created. |
static java.lang.String |
APPVERSION
Application version to be associated with the
MApp to be created. |
static java.lang.String |
CONFIGURL
Adapter instance description object located inside the
TIBCO Repository instance for this
MApp . |
static java.lang.String |
HMANAME |
static java.lang.String |
INSTANCEID
The property name for the adapter instance ID.
|
static java.lang.String |
JMS_CLIENTID_PREFIX |
static java.lang.String |
JMSRECONNECTCOUNT
Property name for specifying JMS reconnection number of attempts
|
static java.lang.String |
JMSRECONNECTDELAY
Property name for specifying JMS delay between number of reconnection attempts
|
static java.lang.String |
MESSAGEFORMAT
The property name for the default message format of the adapter
instance.
|
static java.lang.String |
PASSWORD
The property name of the repository password used by the adapter instance.
|
static java.lang.String |
PLUGIN |
static java.lang.String |
PROPFILE
The property name of property file for the adapter instance.
|
static java.lang.String |
RECONNECTCOUNT
Deprecated.
|
static java.lang.String |
RECONNECTDELAY
Deprecated.
|
static java.lang.String |
REPLYTIMEOUT |
static java.lang.String |
REPOURL
The property name of the TIBCO Repository instance
used by the adapter instance.
|
static java.lang.String |
SECOMPONENTNAME |
static java.lang.String |
SERVICEUNITNAME |
static java.lang.String |
USERNAME
The property name of the repository username used by the adapter instance.
|
static java.lang.String |
XMLAMXMSG
The value for XML AMX message format.
|
static java.lang.String |
XMLJMSMSG
The value for XML JMS message format.
|
static java.lang.String |
XMLRVMSG
The value for XML RV message format.
|
static java.lang.String |
XSDGENERATION
Property name for switching XSD generation on
or off for the adapter instance.
|
static java.lang.String |
XSDGENERATIONOFF
The value for switching XSD generation off.
|
static java.lang.String |
XSDGENERATIONON
The value for switching XSD generation on.
|
Constructor and Description |
---|
MAppProperties(java.lang.String appName,
java.lang.String appVersion,
java.lang.String appInfo,
java.lang.String configURL,
java.lang.String[] cmdLineArgs)
Constructor.
|
MAppProperties(java.lang.String appName,
java.lang.String appVersion,
java.lang.String appInfo,
java.lang.String configURL,
java.lang.String repoURL,
java.lang.String[] cmdLineArgs)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
boolean |
containsClientVar(java.lang.String p_clientVar) |
java.lang.String |
get(java.lang.String propName)
Return a specified property.
|
java.util.Enumeration |
getAllClientVariables() |
java.lang.String |
getAppInfo()
Return the banner information for this
MApp instance,
as specified by the MAppProperties constructor. |
java.lang.String |
getAppInstanceId()
Return the instance ID for this
MApp instance. |
java.lang.String |
getAppName()
Return the name for this
MApp instance as specified by
the MAppProperties constructor. |
java.lang.String |
getAppVersion()
Return the version of this
MApp instance as specified by
the MAppProperties constructor. |
java.lang.String |
getClientVarValue(java.lang.String key) |
java.lang.String |
getCmdlineArg(java.lang.String tag)
Assuming the command-line arguments are in the form
-tag value, pull out
the value associated with the given tag. |
java.lang.String[] |
getCmdlineArgs()
Return the command-line arguments specified for this
MApp instance. |
java.lang.String |
getConfigURL()
Return the value defined on the command line (
tag=system:configurl ),
if any, takes precedence over what passed in through the
constructor of this object. |
java.lang.String |
getConfigUrlPrefix()
Internal use only -DONt DOCUMENT
|
java.lang.String |
getMetadataURL()
Deprecated.
from SDK 3.0, this method always returns null.
|
java.lang.String |
getRepoURL()
Return the value defined on the command line (
tag=system:repourl ),
if any, takes precedence over what passed in through the
constructor of this object. |
java.lang.String |
getRvEmbeddedTicket()
Retrieve the embedded ticket for this
MApp . |
boolean |
isBanner() |
boolean |
isPerformanceMonitorOn() |
void |
set(java.lang.String propName,
java.lang.String propValue)
Set the specified property name with the value specified by property value.
|
void |
setAppInstanceId(java.lang.String instId)
Internal use only -DONt DOCUMENT
|
void |
setClientVariable(java.lang.String variable,
java.lang.String value) |
void |
setConfigURL(java.lang.String configurl)
Set the URL for the adapter instance description object inside the
TIBCO Repository for this adapter instance.
|
void |
setConfigUrlPrefix(java.lang.String prefix)
Internal use only -DONt DOCUMENT
|
void |
setRepoURL(java.lang.String repourl)
Set the URL for the TIBCO Repository instance associated with this adapter instance.
|
void |
setRvEmbeddedTicket(java.lang.String tix)
Specially-licensed third-party developers can use another form of this method.
|
void |
showBanner(boolean bshowBanner) |
public static final java.lang.String USERNAME
public static final java.lang.String PASSWORD
public static final java.lang.String PROPFILE
public static final java.lang.String CONFIGURL
MApp
.public static final java.lang.String REPOURL
public static final java.lang.String INSTANCEID
public static final java.lang.String APPVERSION
MApp
to be created.public static final java.lang.String APPINFO
MApp
to be
created. This information is only displayed if the startup/banner attribute is set
to true (the default) in the adapter instance description object.public static final java.lang.String APPNAME
MApp
to be created. SDK will look for a repository object with this name under
the configURL location. This repository object (the adapter instance
description object) must exist for the SDK to be initialized correctly.public static final java.lang.String MESSAGEFORMAT
public static final java.lang.String AERVMSG
public static final java.lang.String XMLRVMSG
public static final java.lang.String XMLJMSMSG
public static final java.lang.String XMLAMXMSG
public static final java.lang.String XSDGENERATION
public static final java.lang.String RECONNECTCOUNT
public static final java.lang.String RECONNECTDELAY
public static final java.lang.String JMSRECONNECTCOUNT
public static final java.lang.String JMSRECONNECTDELAY
public static final java.lang.String REPLYTIMEOUT
public static final java.lang.String XSDGENERATIONON
public static final java.lang.String XSDGENERATIONOFF
public static final java.lang.String HMANAME
public static final java.lang.String PLUGIN
public static final java.lang.String JMS_CLIENTID_PREFIX
public static final java.lang.String SERVICEUNITNAME
public static final java.lang.String SECOMPONENTNAME
public MAppProperties(java.lang.String appName, java.lang.String appVersion, java.lang.String appInfo, java.lang.String configURL, java.lang.String[] cmdLineArgs) throws MException
MAppProperties
instance to hold
MApp
-specific information.appName
- Application name to be associated with the MApp
to be created. SDK will look for a repository object with this name under
the configURL location. This repository object (the adapter instance
description object) must exist for the SDK to be initialized correctly.appVersion
- Application version to be associated with the MApp
to be created.appInfo
- Application banner information to be associated with the MApp
to be
created. This information is only displayed if the startup/banner attribute is set
to true (the default) in the adapter instance description object.configURL
- Adapter instance description object located inside the
TIBCO Repository instance for this MApp
.cmdLineArgs
- Command-line arguments to be associated with the MApp
to be created.MException
public MAppProperties(java.lang.String appName, java.lang.String appVersion, java.lang.String appInfo, java.lang.String configURL, java.lang.String repoURL, java.lang.String[] cmdLineArgs) throws MException
MAppProperties
instance to hold
MApp
-specific information.appName
- Application name to be associated with the MApp
to be created. SDK will look for a repository object with this name under
the configURL location. This repository object (the adapter instance
description object) must exist for the SDK to be initialized correctly.appVersion
- Application version to be associated with the MApp
to be created.appInfo
- Application banner information to be associated with the MApp
to be
created. This information is only displayed if the startup/banner attribute is set
to true (the default) in the adapter instance description object.configURL
- Adapter instance description object located inside the
TIBCO Repository instance for this MApp
.repoURL
- URL for the TIBCO Repository instance that holds the information about this adapter.cmdLineArgs
- Command-line arguments to be associated with the MApp
to be created.MException
public java.lang.String getAppName()
MApp
instance as specified by
the MAppProperties
constructor.public java.lang.String getAppVersion()
MApp
instance as specified by
the MAppProperties
constructor.public java.lang.String getAppInfo()
MApp
instance,
as specified by the MAppProperties
constructor.public java.lang.String get(java.lang.String propName)
USERNAME
PASSWORD
INSTANCEID
REPOURL
CONFIGURL
APPVERSION
APPINFO
PROPFILE
public void set(java.lang.String propName, java.lang.String propValue)
propName
- Property name.propValue
- Property value.public java.lang.String getConfigURL()
tag=system:configurl
),
if any, takes precedence over what passed in through the
constructor of this object.public java.lang.String getRepoURL()
tag=system:repourl
),
if any, takes precedence over what passed in through the
constructor of this object.public java.lang.String getMetadataURL()
public java.lang.String[] getCmdlineArgs()
MApp
instance.public java.lang.String getCmdlineArg(java.lang.String tag)
-tag
value, pull out
the value associated with the given tag.
Return null if the specified tag is not found.public java.lang.String getAppInstanceId()
MApp
instance. The instance ID
value defined on the command line (tag=system:instanceid
), if any,
takes precedence over the value defined in the adapter instance description object.public void setConfigURL(java.lang.String configurl)
public void setRepoURL(java.lang.String repourl)
public java.lang.String getRvEmbeddedTicket()
MApp
.setRvEmbeddedTicket(String)
public void setRvEmbeddedTicket(java.lang.String tix)
To use this alternate form, developers must first purchase a special license ticket. This call embeds the special ticket in the program, so that end-users do not need to purchase TIBCO Rendezvous to use the program.
tix
- Embed this special license ticket in the program. When a program creates
a licensed transport, rvd does not need to read a license ticket from the license
ticket file (tibrv.tkt
). However, if rvd has already read a valid license ticket
from the ticket file when it started, it disregards this ticket.
Ordinary license tickets are not valid for this parameter.
getRvEmbeddedTicket()
public java.util.Enumeration getAllClientVariables()
public boolean containsClientVar(java.lang.String p_clientVar)
public java.lang.String getClientVarValue(java.lang.String key)
public void setClientVariable(java.lang.String variable, java.lang.String value)
public void setAppInstanceId(java.lang.String instId)
set the instance id
public void setConfigUrlPrefix(java.lang.String prefix)
set the default URL Prefix for repository
public java.lang.String getConfigUrlPrefix()
get the default URL Prefix for repository
public boolean isPerformanceMonitorOn()
public void showBanner(boolean bshowBanner)
public boolean isBanner()