TIBCO Enterprise Message Service
Version 4.3.0

com.tibco.tibjms.admin
Class ServerInfo

java.lang.Object
  extended bycom.tibco.tibjms.admin.ServerInfo

public class ServerInfo
extends java.lang.Object

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

SERVER_STANDBY

public static final int SERVER_STANDBY
Deprecated.  

Internal status code that will never be returned.

See Also:
Constant Field Values

SERVER_FT_STANDBY

public static final int SERVER_FT_STANDBY
The server is currently the fault tolerant standby.

Since:
Version 4.2
See Also:
Constant Field Values

SERVER_ACTIVE

public static final int SERVER_ACTIVE
The server is currently active.

See Also:
Constant Field Values

DETAIL_PRODUCERS

public static final int DETAIL_PRODUCERS
See Also:
Constant Field Values

DETAIL_CONSUMERS

public static final int DETAIL_CONSUMERS
See Also:
Constant Field Values

DETAIL_ROUTES

public static final int DETAIL_ROUTES
See Also:
Constant Field Values

CLIENT_TRACE_TARGET_NONE

public static final short CLIENT_TRACE_TARGET_NONE
See Also:
Constant Field Values

CLIENT_TRACE_TARGET_STDOUT

public static final short CLIENT_TRACE_TARGET_STDOUT
See Also:
Constant Field Values

CLIENT_TRACE_TARGET_STDERR

public static final short CLIENT_TRACE_TARGET_STDERR
See Also:
Constant Field Values

CLIENT_TRACE_FILTER_NONE

public static final short CLIENT_TRACE_FILTER_NONE
See Also:
Constant Field Values

CLIENT_TRACE_FILTER_USER

public static final short CLIENT_TRACE_FILTER_USER
See Also:
Constant Field Values

CLIENT_TRACE_FILTER_CLIENTID

public static final short CLIENT_TRACE_FILTER_CLIENTID
See Also:
Constant Field Values

CLIENT_TRACE_FILTER_CONNID

public static final short CLIENT_TRACE_FILTER_CONNID
See Also:
Constant Field Values

USER_AUTH_LOCATION_LDAP

public static final int USER_AUTH_LOCATION_LDAP
See Also:
Constant Field Values

USER_AUTH_LOCATION_SYSTEM

public static final int USER_AUTH_LOCATION_SYSTEM
See Also:
Constant Field Values

USER_AUTH_LOCATION_LOCAL

public static final int USER_AUTH_LOCATION_LOCAL
See Also:
Constant Field Values
Method Detail

getConfigFile

public java.lang.String getConfigFile()
Get the name and location of the main configuration file.

Returns:
the name (including full path) of the main configuration file.

getUsersFile

public java.lang.String getUsersFile()
Get the name and location of the configuration file containing the definitions of users.

Returns:
the name (including full path) of the users file.

getGroupsFile

public java.lang.String getGroupsFile()
Get the name and location of the configuration file containing the definitions of groups.

Returns:
the name (including full path) of the groups file.

getTopicsFile

public java.lang.String getTopicsFile()
Get the name and location of the configuration file containing the definitions of topics.

Returns:
the name (including full path) of the topics file.

getQueuesFile

public java.lang.String getQueuesFile()
Get the name and location of the configuration file containing the definitions of queues.

Returns:
the name (including full path) of the queues file.

getACLsFile

public java.lang.String getACLsFile()
Get the name and location of the configuration file containing the definitions of acls.

Returns:
the name (including full path) of the acls file.

getFactoriesFile

public java.lang.String getFactoriesFile()
Get the name and location of the configuration file containing the definitions of connection factories.

Returns:
the name (including full path) of the factories file.

getRoutesFile

public java.lang.String getRoutesFile()
Get the name and location of the configuration file containing the definitions of routes.

Returns:
the name (including full path) of the routes file.

getBridgesFile

public java.lang.String getBridgesFile()
Get the name and location of the configuration file containing the definitions of bridges.

Returns:
the name (including full path) of the bridges file.

getTransportsFile

public java.lang.String getTransportsFile()
Get the name and location of the configuration file containing the definitions of external transports.

Returns:
the name (including full path) of the transports file.

getTibrvcmFile

public java.lang.String getTibrvcmFile()
Get the name and location of the configuration file containing the definitions of pre-configured TIBCO Rendezvous Certified Messaging listeners.

Returns:
the name (including full path) of the tibrvcm file.

getDurablesFile

public java.lang.String getDurablesFile()
Get the name and location of the configuration file containing the definitions of pre-configured durable subscribers.

Returns:
the name (including full path) of the durables file.

getRouteRecoverInterval

public long getRouteRecoverInterval()
Get the route recover interval in milliseconds.

Returns:
the route recover interval in milliseconds.
Since:
Version 4.2

getRouteRecoverCount

public int getRouteRecoverCount()
Get the route recover message count.

Returns:
the route recover message count.
Since:
Version 4.3

getServerRateInterval

public long getServerRateInterval()
Get the server statistics rate interval in milliseconds.

Returns:
the server statistics rate interval in milliseconds.

getRateInterval

public long getRateInterval()
Get the statistics rate interval in milliseconds.

Returns:
the statistics rate interval in milliseconds.

getStatisticsCleanupInterval

public long getStatisticsCleanupInterval()
Get the statistics cleanup interval in milliseconds.

Returns:
the statistics cleanup interval in milliseconds.

isStatisticsEnabled

public boolean isStatisticsEnabled()
Indicates whether or not statistics is enabled.

Returns:
true if statistics is enabled, false otherwise.

getDetailedStatistics

public int getDetailedStatistics()
Get the detailed statistics flags.

Returns:
the detailed statistics flags.

getMaxStatisticsMemory

public long getMaxStatisticsMemory()
Get the maximum amount of memory that will be allocated to collecting statistics.

Returns:
the maximum statistics memory in bytes.

setServerRateInterval

public void setServerRateInterval(long value)
                           throws java.lang.IllegalArgumentException
Set the server statistics rate interval. The value is rounded to nearest second. Serverwide statistics are always collected.

Parameters:
value - the interval rate in milliseconds, this value can not be set to less than 1 second.
Throws:
java.lang.IllegalArgumentException - if value is less than 1 second.

setRateInterval

public void setRateInterval(long value)
                     throws java.lang.IllegalArgumentException
Set the statistics rate interval. The value is rounded to nearest second. If the value is set to 0, this disables collecting the message rate for producers, consumers and destinations.

Parameters:
value - the interval rate in milliseconds. If value is 0, this disables collecting the message rate for producers, consumers and destinations.
Throws:
java.lang.IllegalArgumentException - if value is negative.

setStatisticsCleanupInterval

public void setStatisticsCleanupInterval(long value)
                                  throws java.lang.IllegalArgumentException
Set the statistics cleanup interval. Value is rounded to nearest second. If the interval is set to 0, it disables removing inactive destinations from the detailed statistics collected for producers, consumers and destinations.

Parameters:
value - new cleanup interval in milliseconds. If 0 it disables cleanup.
Throws:
java.lang.IllegalArgumentException - if value is negative.

setStatisticsEnabled

public void setStatisticsEnabled(boolean enabled)
Enables or disables statistics gathering for each producer, consumer, routed server and other. This parameter has no effect on the serverwide rates gathering, which is performed regardless of this parameter.

Parameters:
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.

setDetailedStatistics

public void setDetailedStatistics(int flags)
                           throws java.lang.IllegalArgumentException
Enables or disables gathering of detailed statistics for various types of objects.

Parameters:
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.
Throws:
java.lang.IllegalArgumentException - if value contains invalid flags.

setMaxStatisticsMemory

public void setMaxStatisticsMemory(long bytes)
                            throws java.lang.IllegalArgumentException
Set the maximum memory allocated to gathering detailed statistics. The maximum must at least 64KB.

Parameters:
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.
Throws:
java.lang.IllegalArgumentException - if bytes is less than 64KB.

getServerName

public java.lang.String getServerName()
Get the name of the server.

Returns:
the name of the server.

getLogFileName

public java.lang.String getLogFileName()
Get the log file name.

Returns:
the log file name or null if log file not set.

getLogFileMaxSize

public long getLogFileMaxSize()
Get the maximum allowed size of the log file.

Returns:
the maximum allowed size of the log file in bytes.

getListenPorts

public java.lang.String[] getListenPorts()
Get the server's listener ports.

Returns:
an array of server listen ports.

getBackupName

public java.lang.String getBackupName()
Get the server name and host name of the backup server connected to this server.

Returns:
the server name and host name of the backup server in the form server-name@host-name. Returns null if this is not an active server or there is no backup server connected to this server.

getProcessId

public int getProcessId()
Get the current process id of the server.

Returns:
the server process id.

getState

public int getState()
Get the current state of the server. Can return one of the constants:
SERVER_FT_STANDBY - server is in fault tolerant standby mode
SERVER_ACTIVE - active server

Returns:
the server state.

getVersionInfo

public VersionInfo getVersionInfo()
Get the version of TIBCO Enterprise Message Service that the server binary is from.

Returns:
the VersionInfo object representing the server's version.

isEvaluation

public boolean isEvaluation()
Indicates whether the server binary is an evaluation copy or a fully licensed one.

Returns:
true if software is evaluation release, false otherwise.

getURL

public java.lang.String getURL()
Get the URL that should be used to contact this server.

Returns:
the URL in String form.

getFaultTolerantURL

public java.lang.String getFaultTolerantURL()
Get the URL of the fault-tolerant server for this server. This is same as set by the ft_active parameter in the server configuration file.

Returns:
the URL in String form or null if fault-tolerant server is not specified.

getFaultTolerantHeartbeat

public int getFaultTolerantHeartbeat()
Get the period (in seconds) of the heartbeat messages sent by the active server.

Returns:
the heartbeat period in seconds.

getFaultTolerantActivation

public int getFaultTolerantActivation()
Get the length of time a backup server will wait for a heartbeat message before concluding that the active server has failed.

Returns:
the activation interval in seconds.

getFaultTolerantReconnectTimeout

public 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.

Returns:
the reconnect timeout interval in seconds.

getFaultTolerantFailoverReread

public 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.

Returns:
true if the configuration will be reread following failover, false otherwise.

getStartTime

public long getStartTime()
Get the server start time.

Returns:
the server start time in milliseconds

getUpTime

public long getUpTime()
Get the server uptime. Uptime is how long this invocation of the server has been running.

Returns:
the server uptime in milliseconds.

isTibrvTransportsEnabled

public boolean isTibrvTransportsEnabled()
Indicates whether or not bridging to and from transports of type tibrv and tibrvcm is enabled. If this is not enabled then, even though transports of this type may be defined in the transports.conf file, messages will not be exported to or imported from those transports.

Returns:
true if TIBCO Rendezvous bridge is enabled, false otherwise.

isTibssTransportsEnabled

public boolean isTibssTransportsEnabled()
Indicates whether or not bridging to and from SmartSockets transports is enabled. If this is not enabled then, even though transports of this type may be defined in the transports.conf file, messages will not be exported to or imported from those transports.

Returns:
true if TIBCO SmartSockets bridge is enabled, false otherwise.

isTibrvBridgeEnabled

public boolean isTibrvBridgeEnabled()
Deprecated. As of EMS Version 3.1.0, please configure TIBCO Rendezvous import/export using the transports.conf file.

Indicates whether or not bridging to and from TIBCO Rendezvous is enabled.

Returns:
true if TIBCO Rendezvous bridge is enabled, false otherwise.

getTibrvService

public 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.

Get the EMS server's TIBCO Rendezvous service parameter.

Returns:
the service parameter.

getTibrvNetwork

public 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.

Get the EMS server's TIBCO Rendezvous network parameter.

Returns:
the network parameter.

getTibrvDaemon

public 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.

Get the EMS server's TIBCO Rendezvous daemon parameter.

Returns:
the daemon parameter

isTibrvcmEnabled

public boolean isTibrvcmEnabled()
Deprecated. As of EMS Version 3.1.0, please configure TIBCO Rendezvous import/export using the transports.conf file.

Indicates whether or not bridging to and from TIBCO Rendezvous Certified Messaging is enabled.

Returns:
true if TIBCO Rendezvous Certified Messaging is enabled, false otherwise.

getTibrvcmName

public 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.

Get the certified messaging name used by this server when participating in TIBCO Rendezvous Certified Messaging.

Returns:
the certified messaging name used by this server.

getTibrvcmLedger

public 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.

Get the name of the ledger file used by this server for TIBCO Rendezvous Certified Messaging.

Returns:
the name of the ledger file or null if the ledger file is not set and Rendezvous certified messages are only stored in memory.

getTibrvcmSyncLedger

public 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.

Indicates whether or not the EMS server is to use a synchronous ledger file when participating in TIBCO Rendezvous Certified Messaging. If the ledger is synchronous the EMS server will perform synchronous updates to the TIBCO Rendezvous Certified Messaging ledger file. This can slow the performance of importing certified messages but reduces the risk of duplicate delivery following a server failure.

Returns:
true if Tibrvcm should use synchronous ledger, false otherwise.

getTibrvcmRequestOld

public 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.

Indicates whether or not TIBCO Rendezvous Certified Messages that were sent by certified senders while the EMS server was not running should be requested when the EMS server starts up.

Returns:
true if old messages are to be requested, false otherwise.

getTibrvcmDefaultTTL

public 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.

Get the default time-to-live for TIBCO Rendezvous Certified Messages sent by this server to TIBCO Rendezvous clients.

Returns:
the time-to-live in seconds, or 0 if messages don't expire.

isAuthorizationEnabled

public boolean isAuthorizationEnabled()
Indicates whether or not authorization of user credentials and permissions is enabled.

Returns:
true if authorization is enabled, false otherwise.

getUserAuthLocations

public int[] getUserAuthLocations()
Returns an array indicating where users will be authenticated. Each element of the array will be equal to either 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.

Returns:
the array or null if not defined.
Since:
Version 4.2

isRoutingEnabled

public boolean isRoutingEnabled()
Indicates whether or not routing of messages between servers is enabled.

Returns:
true if routing is enabled, false otherwise.

isFlowControlEnabled

public boolean isFlowControlEnabled()
Indicates whether or not flow control is enabled. Flow control involves limiting the rate of publication of messages when receivers are unable to keep up with the publisher(s). For a destination to be flow controlled, isFlowControlEnabled() must be true and a getFlowControlMaxBytes() must return a non-zero value.

Returns:
true if flow control is enabled, false otherwise.

getStoreDirectory

public java.lang.String getStoreDirectory()
Get the directory in which the server is storing its store files.

Returns:
the server store files directory.

getStoreMinimum

public long getStoreMinimum()
Get the minimum size of the server store files.

Returns:
the minimum size in bytes or 0 if no minimum is set.

getStoreSyncMinimum

public long getStoreSyncMinimum()
Get the minimum size of the server's synchronous store file.

Returns:
the minimum size in bytes or 0 if no minimum is set.

getStoreAsyncMinimum

public long getStoreAsyncMinimum()
Get the minimum size of the server's asynchronous store file.

Returns:
the minimum size in bytes or 0 if no minimum is set.

isStoreTruncateEnabled

public boolean isStoreTruncateEnabled()
Indicates whether or no the server will attempt to truncate the store files when possible.

Returns:
true if the server will truncate the store files, false otherwise.

isStoreCRCEnabled

public boolean isStoreCRCEnabled()
Indicates whether or not the server uses CRC verification when reading data from the store files.

Returns:
true if the server does use CRC verification, false otherwise.

getMaxConnections

public int getMaxConnections()
Get the maximum number of connections this server will allow.

Returns:
the maximum number of connections or zero if not set.

setAuthorizationEnabled

public void setAuthorizationEnabled(boolean authorization)
Endable or disable the verification of user credentials and permissions on secure destinations.

Parameters:
authorization - true if authorization is to be enabled, false if it is to be disabled.

getLogTraceInfo

public TraceInfo getLogTraceInfo()
Get the trace settings that determine what will be logged in the server's log file. This method does not copy the TraceInfo object. Therefore, to modify the trace settings, one needs to modify the TraceInfo object returned by this method and save the ServerInfo object.

Returns:
a TraceInfo object representing the current log trace settings.

setLogTraceInfo

public void setLogTraceInfo(TraceInfo logTraceInfo)
Set the trace settings that determine what will be logged in the server's log file. This replaces any existing log trace settings.

Parameters:
logTraceInfo - a TraceInfo object representing the new settings.

getConsoleTraceInfo

public TraceInfo getConsoleTraceInfo()
Get the trace settings that determine what will be logged to the server's console window. This method does not copy the TraceInfo object. Therefore, to modify the trace settings, one needs to modify the TraceInfo object returned by this method and save the ServerInfo object.

Returns:
a TraceInfo object representing the current console trace settings.

setConsoleTraceInfo

public void setConsoleTraceInfo(TraceInfo conTraceInfo)
Set the trace settings that determine what will be logged to the server's console. This replaces any existing console trace settings.

Parameters:
conTraceInfo - a TraceInfo object representing the new settings.

isClientTraceEnabled

public boolean isClientTraceEnabled()
Indicates whether or not client tracing has been enabled.

Returns:
true if client tracing is enabled, false otherwise.

getClientTraceTarget

public short getClientTraceTarget()
Get the current target for client tracing.

Returns:
CLIENT_TRACE_TARGET_NONE if client tracing is not enabled, CLIENT_TRACE_TARGET_STDOUT if client tracing is enabled and is directed to stdout and CLIENT_TRACE_TARGET_STDERR if client tracing is enabled and is directed to stderr.

getClientTraceFilterType

public short getClientTraceFilterType()
Get the current filter type for client tracing. If a filter is set then only clients that match the value for the filter will be traced.

Returns:
CLIENT_TRACE_FILTER_NONE if client tracing is not enabled or no filter is set, CLIENT_TRACE_FILTER_USER if only clients with a matching user are to be traced, CLIENT_TRACE_FILTER_CLIENTID if only clients with a matching client id are to be traced and CLIENT_TRACE_FILTER_CONNID if only clients with a matching client id are to be traced.

getClientTraceFilterValue

public java.lang.Object getClientTraceFilterValue()
Get the value that clients must match in order to be traced. If the filtering is by user or client id then the object returned is a String. If the filtering is by connection id then the object returned is a Long. If there is no filtering or client tracing is not enabled then null is returned.

Returns:
the value a client must match in order to be traced.

disableClientTracing

public void disableClientTracing()
Turn off client tracing, clearing all filtering settings.


enableClientTracing

public void enableClientTracing()
Enable client tracing with default settings. Default settings are that the target is stderr and there is no filtering.


enableClientTracing

public void enableClientTracing(short target,
                                short filterType,
                                java.lang.Object filterValue)
                         throws java.lang.IllegalArgumentException
Enable client tracing with specific settings.

Parameters:
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.
Throws:
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.

getQueueCount

public int getQueueCount()
Get the number of queues in the server.

Returns:
the number of queues.

getTopicCount

public int getTopicCount()
Get the number of topics in the server.

Returns:
the number of topics.

getDurableCount

public int getDurableCount()
Get the number of durable subscribers in the server.

Returns:
the number of durable subscribers.

getConnectionCount

public int getConnectionCount()
Get the number of connections to the server.

Returns:
the number of connections.

getPendingMessageCount

public long getPendingMessageCount()
Get the total number of pending messages for this server.

Returns:
the number of pending messages.

getPendingMessageSize

public long getPendingMessageSize()
Get the total size of pending messages for this server.

Returns:
the size of pending messages.

getInboundMessageCount

public long getInboundMessageCount()
Get the number of inbound messages for the server.

Returns:
the number of inbound messages.

getOutboundMessageCount

public long getOutboundMessageCount()
Get the number of outbound messages for the server.

Returns:
the number of outbound messages

getInboundMessageRate

public long getInboundMessageRate()
Get the number of inbound messages per second for the server as a whole.

Returns:
the inbound message rate.

getOutboundMessageRate

public long getOutboundMessageRate()
Get the number of outbound messages per second for the server as a whole.

Returns:
the outbound message rate.

getInboundBytesRate

public long getInboundBytesRate()
Get the volume of inbound messages per second for the server as a whole.

Returns:
the inbound rate in bytes per second rate.

getOutboundBytesRate

public long getOutboundBytesRate()
Get the volume of outbound messages per second for the server as a whole.

Returns:
the outbound rate in bytes per second rate.

getLogFileSize

public long getLogFileSize()
Get the total size of the log file.

Returns:
the size of the log file or 0 if log file is not set.

getSyncDBSize

public long getSyncDBSize()
Get the current size of the synchronous message store.

Returns:
the size in bytes.

getAsyncDBSize

public long getAsyncDBSize()
Get the current size of the asynchronous message store.

Returns:
the size in bytes.

getMsgMem

public long getMsgMem()
Get the amount of memory in use to store messages.

Returns:
the size in bytes.

getMsgMemPooled

public long getMsgMemPooled()
Get the amount of memory in use by the message pools.

Returns:
the size in bytes.

getDiskReadRate

public long getDiskReadRate()
Get the rate at which messages are being read from the disk.

Returns:
the in bytes per second.

getDiskWriteRate

public long getDiskWriteRate()
Get the rate at which messages are being written to the disk.

Returns:
the in bytes per second.

getSSLParams

public SSLParams getSSLParams()
Get the SSL parameters used by the server when communicating with SSL clients.

Returns:
the SSL parameters if set, null otherwise.

getSSLDHSize

public int getSSLDHSize()
Get the size of the Diffie-Hellman key used by the server for client communications.

Returns:
the size in bits.

isSSLRequireClientCert

public boolean isSSLRequireClientCert()
Indicates whether or not the server will only accept SSL clients that have certificates.

Returns:
true if clients are required to have certificates, false otherwise.

isSSLUserCertUsername

public boolean isSSLUserCertUsername()
Indicates whether or not the client's username is always extracted from the CN field of the client's digital certificate.

Returns:
true if the client's username is to be extracted, false otherwise.

getSSLCertUserSpecname

public 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.

Returns:
the username if set, null otherwise.

getFaultTolerantSSLParams

public SSLParams getFaultTolerantSSLParams()
Get the server's Fault Tolerant SSL parameters. These are the parameters that the server uses to connect to its Fault Tolerant partner.

Returns:
the FT SSL parameters if set, null otherwise.

isTrackCorrelationIds

public boolean isTrackCorrelationIds()
Indicates whether or not tracking messages by correlation ID is enabled.

Returns:
true if tracking messages by correlation ID is enabled, false otherwise.

setTrackCorrelationIds

public void setTrackCorrelationIds(boolean trackCorIds)
Enable or disable tracking messages by correlation ID.

Parameters:
trackCorIds - true if tracking by correlation ID it to be enabled, or false if it is to be disabled.

isTrackMsgIds

public boolean isTrackMsgIds()
Indicates whether or not tracking messages by message ID is enabled.

Returns:
true if tracking messages by message ID is enabled, false otherwise.

setTrackMsgIds

public void setTrackMsgIds(boolean trackMsgIds)
Enable or disable tracking messages by message ID.

Parameters:
trackMsgIds - true if tracking by message ID it to be enabled, or false if it is to be disabled.

setPassword

public void setPassword(java.lang.String password)
Set the new server password.

Parameters:
password - the new password.

setSSLPassword

public void setSSLPassword(java.lang.String sslPassword)
Set the new server's private key or PKCS12 file password.

Parameters:
sslPassword - the new private key or PKCS12 file password.

setFTSSLPassword

public void setFTSSLPassword(java.lang.String ftSSLPassword)
Set the new private key or PKCS12 file password for fault-tolerant SSL connection.

Parameters:
ftSSLPassword - the new private key or PKCS12 file password.

getMaxMsgMemory

public long getMaxMsgMemory()
Get the maximum allowed message memory.

Returns:
the maximum allowed message memory in bytes, or 0 if no limit is set.

setMaxMsgMemory

public void setMaxMsgMemory(long maxMsgMemory)
                     throws java.lang.IllegalArgumentException
Set the maximum allowed message memory. Lowering this value will not immediately free memory occupied by messages.

Parameters:
maxMsgMemory - the new maximum allowed message memory in bytes. If 0 is specified then memory limit is reset to unlimited.
Throws:
java.lang.IllegalArgumentException - if maxMsgMemory is less than 64KB.

getReserveMemory

public long getReserveMemory()
Get the size of the reserve memory.

Returns:
the size of the reserve memory in bytes, or zero if not enabled.
Since:
Version 4.2

getMessagePoolBlockSize

public long getMessagePoolBlockSize()
Get the message pool block size setting.

Returns:
the value of the setting, or zero if not enabled.
Since:
Version 4.2

getMessagePoolSize

public long getMessagePoolSize()
Get the message pool size setting.

Returns:
the value of the setting, or zero if not enabled.
Since:
Version 4.2

isMessageSwappingEnabled

public boolean isMessageSwappingEnabled()
Indicates whether or not server message swapping is enabled.

Returns:
true if server message swapping is enabled, false otherwise.

setMessageSwappingEnabled

public void setMessageSwappingEnabled(boolean enabled)
Enable or disable server message swapping.

Parameters:
enabled - true if message swapping is to be enabled, or false if it is to be disabled.

isFSyncEnabled

public boolean isFSyncEnabled()
Indicates whether or not the fsync mode is used by the server when writing data to its store file. On most platforms this is not the most efficient way to write to the store file.

Returns:
true if fsync is enabled, false otherwise.

toString

public java.lang.String toString()

TIBCO Enterprise Message Service
Version 4.3.0

Copyright © TIBCO Software Inc. All rights reserved