|
TIBCO Enterprise Message Service Version 4.3.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.tibco.tibjms.admin.ServerInfo
This class represents configuration parameters for a TIBCO Enterprise Message Service server. Changes made to this object will not take effect on the server until the changes are saved with a call to TibjmsAdmin.updateServer().
Field Summary | |
static short |
CLIENT_TRACE_FILTER_CLIENTID
|
static short |
CLIENT_TRACE_FILTER_CONNID
|
static short |
CLIENT_TRACE_FILTER_NONE
|
static short |
CLIENT_TRACE_FILTER_USER
|
static short |
CLIENT_TRACE_TARGET_NONE
|
static short |
CLIENT_TRACE_TARGET_STDERR
|
static short |
CLIENT_TRACE_TARGET_STDOUT
|
static int |
DETAIL_CONSUMERS
|
static int |
DETAIL_PRODUCERS
|
static int |
DETAIL_ROUTES
|
static int |
SERVER_ACTIVE
The server is currently active. |
static int |
SERVER_FT_STANDBY
The server is currently the fault tolerant standby. |
static int |
SERVER_STANDBY
Deprecated. |
static int |
USER_AUTH_LOCATION_LDAP
|
static int |
USER_AUTH_LOCATION_LOCAL
|
static int |
USER_AUTH_LOCATION_SYSTEM
|
Method Summary | |
void |
disableClientTracing()
Turn off client tracing, clearing all filtering settings. |
void |
enableClientTracing()
Enable client tracing with default settings. |
void |
enableClientTracing(short target,
short filterType,
java.lang.Object filterValue)
Enable client tracing with specific settings. |
java.lang.String |
getACLsFile()
Get the name and location of the configuration file containing the definitions of acls. |
long |
getAsyncDBSize()
Get the current size of the asynchronous message store. |
java.lang.String |
getBackupName()
Get the server name and host name of the backup server connected to this server. |
java.lang.String |
getBridgesFile()
Get the name and location of the configuration file containing the definitions of bridges. |
short |
getClientTraceFilterType()
Get the current filter type for client tracing. |
java.lang.Object |
getClientTraceFilterValue()
Get the value that clients must match in order to be traced. |
short |
getClientTraceTarget()
Get the current target for client tracing. |
java.lang.String |
getConfigFile()
Get the name and location of the main configuration file. |
int |
getConnectionCount()
Get the number of connections to the server. |
TraceInfo |
getConsoleTraceInfo()
Get the trace settings that determine what will be logged to the server's console window. |
int |
getDetailedStatistics()
Get the detailed statistics flags. |
long |
getDiskReadRate()
Get the rate at which messages are being read from the disk. |
long |
getDiskWriteRate()
Get the rate at which messages are being written to the disk. |
int |
getDurableCount()
Get the number of durable subscribers in the server. |
java.lang.String |
getDurablesFile()
Get the name and location of the configuration file containing the definitions of pre-configured durable subscribers. |
java.lang.String |
getFactoriesFile()
Get the name and location of the configuration file containing the definitions of connection factories. |
int |
getFaultTolerantActivation()
Get the length of time a backup server will wait for a heartbeat message before concluding that the active server has failed. |
boolean |
getFaultTolerantFailoverReread()
Indicates whether or not the secondary server will reread all the configuration files with the exception of the main file following a failover. |
int |
getFaultTolerantHeartbeat()
Get the period (in seconds) of the heartbeat messages sent by the active server. |
int |
getFaultTolerantReconnectTimeout()
Get the length of time a server which has just become the active server following a failover will wait for clients to reconnect before their state is removed from the shared state. |
SSLParams |
getFaultTolerantSSLParams()
Get the server's Fault Tolerant SSL parameters. |
java.lang.String |
getFaultTolerantURL()
Get the URL of the fault-tolerant server for this server. |
java.lang.String |
getGroupsFile()
Get the name and location of the configuration file containing the definitions of groups. |
long |
getInboundBytesRate()
Get the volume of inbound messages per second for the server as a whole. |
long |
getInboundMessageCount()
Get the number of inbound messages for the server. |
long |
getInboundMessageRate()
Get the number of inbound messages per second for the server as a whole. |
java.lang.String[] |
getListenPorts()
Get the server's listener ports. |
long |
getLogFileMaxSize()
Get the maximum allowed size of the log file. |
java.lang.String |
getLogFileName()
Get the log file name. |
long |
getLogFileSize()
Get the total size of the log file. |
TraceInfo |
getLogTraceInfo()
Get the trace settings that determine what will be logged in the server's log file. |
int |
getMaxConnections()
Get the maximum number of connections this server will allow. |
long |
getMaxMsgMemory()
Get the maximum allowed message memory. |
long |
getMaxStatisticsMemory()
Get the maximum amount of memory that will be allocated to collecting statistics. |
long |
getMessagePoolBlockSize()
Get the message pool block size setting. |
long |
getMessagePoolSize()
Get the message pool size setting. |
long |
getMsgMem()
Get the amount of memory in use to store messages. |
long |
getMsgMemPooled()
Get the amount of memory in use by the message pools. |
long |
getOutboundBytesRate()
Get the volume of outbound messages per second for the server as a whole. |
long |
getOutboundMessageCount()
Get the number of outbound messages for the server. |
long |
getOutboundMessageRate()
Get the number of outbound messages per second for the server as a whole. |
long |
getPendingMessageCount()
Get the total number of pending messages for this server. |
long |
getPendingMessageSize()
Get the total size of pending messages for this server. |
int |
getProcessId()
Get the current process id of the server. |
int |
getQueueCount()
Get the number of queues in the server. |
java.lang.String |
getQueuesFile()
Get the name and location of the configuration file containing the definitions of queues. |
long |
getRateInterval()
Get the statistics rate interval in milliseconds. |
long |
getReserveMemory()
Get the size of the reserve memory. |
int |
getRouteRecoverCount()
Get the route recover message count. |
long |
getRouteRecoverInterval()
Get the route recover interval in milliseconds. |
java.lang.String |
getRoutesFile()
Get the name and location of the configuration file containing the definitions of routes. |
java.lang.String |
getServerName()
Get the name of the server. |
long |
getServerRateInterval()
Get the server statistics rate interval in milliseconds. |
java.lang.String |
getSSLCertUserSpecname()
Get the username clients will use to connect to the server when their username is to be extracted from the CN field of their digital certificate. |
int |
getSSLDHSize()
Get the size of the Diffie-Hellman key used by the server for client communications. |
SSLParams |
getSSLParams()
Get the SSL parameters used by the server when communicating with SSL clients. |
long |
getStartTime()
Get the server start time. |
int |
getState()
Get the current state of the server. |
long |
getStatisticsCleanupInterval()
Get the statistics cleanup interval in milliseconds. |
long |
getStoreAsyncMinimum()
Get the minimum size of the server's asynchronous store file. |
java.lang.String |
getStoreDirectory()
Get the directory in which the server is storing its store files. |
long |
getStoreMinimum()
Get the minimum size of the server store files. |
long |
getStoreSyncMinimum()
Get the minimum size of the server's synchronous store file. |
long |
getSyncDBSize()
Get the current size of the synchronous message store. |
double |
getTibrvcmDefaultTTL()
Deprecated. As of EMS Version 3.1.0, please configure TIBCO Rendezvous import/export using the transports.conf file and query the corresponding TransportInfo object. |
java.lang.String |
getTibrvcmFile()
Get the name and location of the configuration file containing the definitions of pre-configured TIBCO Rendezvous Certified Messaging listeners. |
java.lang.String |
getTibrvcmLedger()
Deprecated. As of EMS Version 3.1.0, please configure TIBCO Rendezvous import/export using the transports.conf file and query the corresponding TransportInfo object. |
java.lang.String |
getTibrvcmName()
Deprecated. As of EMS Version 3.1.0, please configure TIBCO Rendezvous import/export using the transports.conf file and query the corresponding TransportInfo object. |
boolean |
getTibrvcmRequestOld()
Deprecated. As of EMS Version 3.1.0, please configure TIBCO Rendezvous import/export using the transports.conf file and query the corresponding TransportInfo object. |
boolean |
getTibrvcmSyncLedger()
Deprecated. As of EMS Version 3.1.0, please configure TIBCO Rendezvous import/export using the transports.conf file and query the corresponding TransportInfo object. |
java.lang.String |
getTibrvDaemon()
Deprecated. As of EMS Version 3.1.0, please configure TIBCO Rendezvous import/export using the transports.conf file and query the corresponding TransportInfo object. |
java.lang.String |
getTibrvNetwork()
Deprecated. As of EMS Version 3.1.0, please configure TIBCO Rendezvous import/export using the transports.conf file and query the corresponding TransportInfo object. |
java.lang.String |
getTibrvService()
Deprecated. As of EMS Version 3.1.0, please configure TIBCO Rendezvous import/export using the transports.conf file and query the corresponding TransportInfo object. |
int |
getTopicCount()
Get the number of topics in the server. |
java.lang.String |
getTopicsFile()
Get the name and location of the configuration file containing the definitions of topics. |
java.lang.String |
getTransportsFile()
Get the name and location of the configuration file containing the definitions of external transports. |
long |
getUpTime()
Get the server uptime. |
java.lang.String |
getURL()
Get the URL that should be used to contact this server. |
int[] |
getUserAuthLocations()
Returns an array indicating where users will be authenticated. |
java.lang.String |
getUsersFile()
Get the name and location of the configuration file containing the definitions of users. |
VersionInfo |
getVersionInfo()
Get the version of TIBCO Enterprise Message Service that the server binary is from. |
boolean |
isAuthorizationEnabled()
Indicates whether or not authorization of user credentials and permissions is enabled. |
boolean |
isClientTraceEnabled()
Indicates whether or not client tracing has been enabled. |
boolean |
isEvaluation()
Indicates whether the server binary is an evaluation copy or a fully licensed one. |
boolean |
isFlowControlEnabled()
Indicates whether or not flow control is enabled. |
boolean |
isFSyncEnabled()
Indicates whether or not the fsync mode is used by the server when writing data to its store file. |
boolean |
isMessageSwappingEnabled()
Indicates whether or not server message swapping is enabled. |
boolean |
isRoutingEnabled()
Indicates whether or not routing of messages between servers is enabled. |
boolean |
isSSLRequireClientCert()
Indicates whether or not the server will only accept SSL clients that have certificates. |
boolean |
isSSLUserCertUsername()
Indicates whether or not the client's username is always extracted from the CN field of the client's digital certificate. |
boolean |
isStatisticsEnabled()
Indicates whether or not statistics is enabled. |
boolean |
isStoreCRCEnabled()
Indicates whether or not the server uses CRC verification when reading data from the store files. |
boolean |
isStoreTruncateEnabled()
Indicates whether or no the server will attempt to truncate the store files when possible. |
boolean |
isTibrvBridgeEnabled()
Deprecated. As of EMS Version 3.1.0, please configure TIBCO Rendezvous import/export using the transports.conf file. |
boolean |
isTibrvcmEnabled()
Deprecated. As of EMS Version 3.1.0, please configure TIBCO Rendezvous import/export using the transports.conf file. |
boolean |
isTibrvTransportsEnabled()
Indicates whether or not bridging to and from transports of type tibrv and tibrvcm is enabled. |
boolean |
isTibssTransportsEnabled()
Indicates whether or not bridging to and from SmartSockets transports is enabled. |
boolean |
isTrackCorrelationIds()
Indicates whether or not tracking messages by correlation ID is enabled. |
boolean |
isTrackMsgIds()
Indicates whether or not tracking messages by message ID is enabled. |
void |
setAuthorizationEnabled(boolean authorization)
Endable or disable the verification of user credentials and permissions on secure destinations. |
void |
setConsoleTraceInfo(TraceInfo conTraceInfo)
Set the trace settings that determine what will be logged to the server's console. |
void |
setDetailedStatistics(int flags)
Enables or disables gathering of detailed statistics for various types of objects. |
void |
setFTSSLPassword(java.lang.String ftSSLPassword)
Set the new private key or PKCS12 file password for fault-tolerant SSL connection. |
void |
setLogTraceInfo(TraceInfo logTraceInfo)
Set the trace settings that determine what will be logged in the server's log file. |
void |
setMaxMsgMemory(long maxMsgMemory)
Set the maximum allowed message memory. |
void |
setMaxStatisticsMemory(long bytes)
Set the maximum memory allocated to gathering detailed statistics. |
void |
setMessageSwappingEnabled(boolean enabled)
Enable or disable server message swapping. |
void |
setPassword(java.lang.String password)
Set the new server password. |
void |
setRateInterval(long value)
Set the statistics rate interval. |
void |
setServerRateInterval(long value)
Set the server statistics rate interval. |
void |
setSSLPassword(java.lang.String sslPassword)
Set the new server's private key or PKCS12 file password. |
void |
setStatisticsCleanupInterval(long value)
Set the statistics cleanup interval. |
void |
setStatisticsEnabled(boolean enabled)
Enables or disables statistics gathering for each producer, consumer, routed server and other. |
void |
setTrackCorrelationIds(boolean trackCorIds)
Enable or disable tracking messages by correlation ID. |
void |
setTrackMsgIds(boolean trackMsgIds)
Enable or disable tracking messages by message ID. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int SERVER_STANDBY
public static final int SERVER_FT_STANDBY
public static final int SERVER_ACTIVE
public static final int DETAIL_PRODUCERS
public static final int DETAIL_CONSUMERS
public static final int DETAIL_ROUTES
public static final short CLIENT_TRACE_TARGET_NONE
public static final short CLIENT_TRACE_TARGET_STDOUT
public static final short CLIENT_TRACE_TARGET_STDERR
public static final short CLIENT_TRACE_FILTER_NONE
public static final short CLIENT_TRACE_FILTER_USER
public static final short CLIENT_TRACE_FILTER_CLIENTID
public static final short CLIENT_TRACE_FILTER_CONNID
public static final int USER_AUTH_LOCATION_LDAP
public static final int USER_AUTH_LOCATION_SYSTEM
public static final int USER_AUTH_LOCATION_LOCAL
Method Detail |
public java.lang.String getConfigFile()
public java.lang.String getUsersFile()
public java.lang.String getGroupsFile()
public java.lang.String getTopicsFile()
public java.lang.String getQueuesFile()
public java.lang.String getACLsFile()
public java.lang.String getFactoriesFile()
public java.lang.String getRoutesFile()
public java.lang.String getBridgesFile()
public java.lang.String getTransportsFile()
public java.lang.String getTibrvcmFile()
public java.lang.String getDurablesFile()
public long getRouteRecoverInterval()
public int getRouteRecoverCount()
public long getServerRateInterval()
public long getRateInterval()
public long getStatisticsCleanupInterval()
public boolean isStatisticsEnabled()
public int getDetailedStatistics()
public long getMaxStatisticsMemory()
public void setServerRateInterval(long value) throws java.lang.IllegalArgumentException
value
- the interval rate in milliseconds, this value can not be set
to less than 1 second.
java.lang.IllegalArgumentException
- if value is less than 1 second.public void setRateInterval(long value) throws java.lang.IllegalArgumentException
value
- the interval rate in milliseconds. If value is 0, this
disables collecting the message rate for producers, consumers and
destinations.
java.lang.IllegalArgumentException
- if value is negative.public void setStatisticsCleanupInterval(long value) throws java.lang.IllegalArgumentException
value
- new cleanup interval in milliseconds. If 0 it disables cleanup.
java.lang.IllegalArgumentException
- if value is negative.public void setStatisticsEnabled(boolean enabled)
enabled
- true if the gathering of statistics for each producer,
consumer, routed server, etc. is to be enabled or false if it is to be
disabled.public void setDetailedStatistics(int flags) throws java.lang.IllegalArgumentException
flags
- any combination of DETAIL_PRODUCERS, DETAIL_CONSUMERS and
DETAIL_ROUTES flags combined by the bitwise OR operator (|). If flags
is 0, gathering of all detailed statistics is disabled.
java.lang.IllegalArgumentException
- if value contains invalid flags.public void setMaxStatisticsMemory(long bytes) throws java.lang.IllegalArgumentException
bytes
- the maximum number of bytes of memory that will be allocated
to gathering detailed statistics. If bytes is 0 then this indicates no
limit.
java.lang.IllegalArgumentException
- if bytes is less than 64KB.public java.lang.String getServerName()
public java.lang.String getLogFileName()
public long getLogFileMaxSize()
public java.lang.String[] getListenPorts()
public java.lang.String getBackupName()
public int getProcessId()
public int getState()
public VersionInfo getVersionInfo()
public boolean isEvaluation()
public java.lang.String getURL()
public java.lang.String getFaultTolerantURL()
public int getFaultTolerantHeartbeat()
public int getFaultTolerantActivation()
public int getFaultTolerantReconnectTimeout()
public boolean getFaultTolerantFailoverReread()
public long getStartTime()
public long getUpTime()
public boolean isTibrvTransportsEnabled()
public boolean isTibssTransportsEnabled()
public boolean isTibrvBridgeEnabled()
public java.lang.String getTibrvService()
public java.lang.String getTibrvNetwork()
public java.lang.String getTibrvDaemon()
public boolean isTibrvcmEnabled()
public java.lang.String getTibrvcmName()
public java.lang.String getTibrvcmLedger()
public boolean getTibrvcmSyncLedger()
public boolean getTibrvcmRequestOld()
public double getTibrvcmDefaultTTL()
public boolean isAuthorizationEnabled()
public int[] getUserAuthLocations()
USER_AUTH_LOCATION_LDAP
,
USER_AUTH_LOCATION_SYSTEM
or USER_AUTH_LOCATION_LOCAL
. The
order of the array is the order in which the server uses them for authentication.
public boolean isRoutingEnabled()
public boolean isFlowControlEnabled()
public java.lang.String getStoreDirectory()
public long getStoreMinimum()
public long getStoreSyncMinimum()
public long getStoreAsyncMinimum()
public boolean isStoreTruncateEnabled()
public boolean isStoreCRCEnabled()
public int getMaxConnections()
public void setAuthorizationEnabled(boolean authorization)
authorization
- true if authorization is to be enabled, false if it
is to be disabled.public TraceInfo getLogTraceInfo()
public void setLogTraceInfo(TraceInfo logTraceInfo)
logTraceInfo
- a TraceInfo object representing the new settings.public TraceInfo getConsoleTraceInfo()
public void setConsoleTraceInfo(TraceInfo conTraceInfo)
conTraceInfo
- a TraceInfo object representing the new settings.public boolean isClientTraceEnabled()
public short getClientTraceTarget()
public short getClientTraceFilterType()
public java.lang.Object getClientTraceFilterValue()
public void disableClientTracing()
public void enableClientTracing()
public void enableClientTracing(short target, short filterType, java.lang.Object filterValue) throws java.lang.IllegalArgumentException
target
- target for client tracing, must be either
CLIENT_TRACE_TARGET_STDOUT or CLIENT_TRACE_TARGET_STDERR.filterType
- type of filter to be applied, either
CLIENT_TRACE_FILTER_NONE for no filtering or one of
CLIENT_TRACE_FILTER_USER, CLIENT_TRACE_FILTER_CLIENTID or
CLIENT_TRACE_FILTER_CONNID.filterValue
- value a client needs to match for client tracing to
be enabled. For CLIENT_TRACE_FILTER_USER and
CLIENT_TRACE_FILTER_CLIENTID this must be a String, for
CLIENT_TRACE_FILTER_CONNID must be a Long.
java.lang.IllegalArgumentException
- if target or filterType are not valid
or the type of filterValue does not match the type required for the
given filterType.public int getQueueCount()
public int getTopicCount()
public int getDurableCount()
public int getConnectionCount()
public long getPendingMessageCount()
public long getPendingMessageSize()
public long getInboundMessageCount()
public long getOutboundMessageCount()
public long getInboundMessageRate()
public long getOutboundMessageRate()
public long getInboundBytesRate()
public long getOutboundBytesRate()
public long getLogFileSize()
public long getSyncDBSize()
public long getAsyncDBSize()
public long getMsgMem()
public long getMsgMemPooled()
public long getDiskReadRate()
public long getDiskWriteRate()
public SSLParams getSSLParams()
public int getSSLDHSize()
public boolean isSSLRequireClientCert()
public boolean isSSLUserCertUsername()
public java.lang.String getSSLCertUserSpecname()
public SSLParams getFaultTolerantSSLParams()
public boolean isTrackCorrelationIds()
public void setTrackCorrelationIds(boolean trackCorIds)
trackCorIds
- true if tracking by correlation ID it to be enabled,
or false if it is to be disabled.public boolean isTrackMsgIds()
public void setTrackMsgIds(boolean trackMsgIds)
trackMsgIds
- true if tracking by message ID it to be enabled,
or false if it is to be disabled.public void setPassword(java.lang.String password)
password
- the new password.public void setSSLPassword(java.lang.String sslPassword)
sslPassword
- the new private key or PKCS12 file password.public void setFTSSLPassword(java.lang.String ftSSLPassword)
ftSSLPassword
- the new private key or PKCS12 file password.public long getMaxMsgMemory()
public void setMaxMsgMemory(long maxMsgMemory) throws java.lang.IllegalArgumentException
maxMsgMemory
- the new maximum allowed message memory in bytes. If
0 is specified then memory limit is reset to unlimited.
java.lang.IllegalArgumentException
- if maxMsgMemory is less than 64KB.public long getReserveMemory()
public long getMessagePoolBlockSize()
public long getMessagePoolSize()
public boolean isMessageSwappingEnabled()
public void setMessageSwappingEnabled(boolean enabled)
enabled
- true if message swapping is to be enabled, or false if it
is to be disabled.public boolean isFSyncEnabled()
public java.lang.String toString()
|
TIBCO Enterprise Message Service Version 4.3.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |