com.tibco.rta
Enum ConfigProperty

java.lang.Object
  java.lang.Enum<ConfigProperty>
      com.tibco.rta.ConfigProperty

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ConfigProperty>

public enum ConfigProperty
extends java.lang.Enum<ConfigProperty>

An enumeration of the client API configuration properties.

Enum Constant Summary

ASYNC_RESULT_DISPATCHER_MAX_POOL_SIZE
The thread pool used for dispatching results from outbound queue to clients.

ASYNC_RESULT_DISPATCHER_POOL_TIMEOUT
The thread pool used for dispatching results from outbound queue to clients has an idle timeout in milliseconds.

CONNECTION_PASSWORD
Password for metric engine.

CONNECTION_USERNAME
Username for metric engine.

FACT_BATCH_EXPIRY
If batch size condition is not met, the amount of time in seconds to wait to flush residual facts.

FACT_BATCH_SIZE
Number of facts to batch before publishing to the server.

FACT_EVICTION_ENABLED
Enable/Disable async eviction of facts once queue depth is full.

FACT_EVICTION_FREQUENCY
Delay in milliseconds for eviction thread to run.

FACT_QUEUE_DEPTH
Queue depth for the internal queue for batching facts.

HEARTBEAT_INTERVAL
Time interval in milliseconds used by named client sessions to send heartbeat.

JMS_INBOUND_QUERY_QUEUE
Queue name on JMS to perform snapshot query operations.

JMS_INBOUND_QUEUE
Queue name on JMS to perform sync/async operations.

JMS_OUTBOUND_QUEUE
Queue name on JMS for client to receive notifications from metric engine.

JMS_PROVIDER_JNDI_FACTORY
Context factory class for the JMS provider.

JMS_PROVIDER_JNDI_URL
JMS JNDI URL.

JMS_QUEUE_CONN_FACTORY
Queue connection factory name.

LOG_MANAGER
Specify external log manager impl.

LOG_MANAGER_CLASS_NAME
Specify external log manager impl class.

NUM_RETRIES_CONNECTION_ESTABLISH
Maximum retries for a for establishing connection to transport provider if any.

NUM_RETRIES_FACT_OPS
Maximum retries for a synchronous operation in case it fails.

NUM_RETRIES_SYNC_OPS
Maximum retries for a synchronous operation in case it fails.

PING_INTERVAL
Time interval in milliseconds used for ping with the server.

RETRY_WAIT_INTERVAL
Time in milliseconds to wait before retrying the operation

SYNC_JMS_MESSAGE_EXPIRY
Time in milliseconds for JMS provider to keep a message before it expires.

SYNC_RESPONSE_TIMEOUT
Time in milliseconds to wait for rta engine to wait for server to send response for a sync operation like query registration.

TASK_MANAGER_THREAD_KEEPALIVE_TIME
Keep alive time in seconds for task manager threads.

TASK_MANAGER_THREADPOOL_SIZE
Minimum number of threads to be used for fact publishing per session.

TRANSPORT_HTTP_HOSTNAME
Server hostname property for HTTP transport.

TRANSPORT_HTTP_PORT
Server port for HTTP transport.

TRANSPORT_TYPE
TRANSPORT TYPE :: JMS, HTTP, TCP

Method Summary

static ConfigProperty	getByPropertyName(java.lang.String propertyName)
DataType	getDataType()
com.tibco.rta.property.PropertyAtom<?>	getDefaultValue()
java.lang.String	getPropertyName()
java.lang.Object	getValue(java.util.Map<?,?> props)
java.lang.Object	getValue(java.util.Properties props)
static ConfigProperty	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ConfigProperty[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TASK_MANAGER_THREADPOOL_SIZE

@DataType(dataType=INTEGER,
          defaultValue="5")
public static final ConfigProperty TASK_MANAGER_THREADPOOL_SIZE

Minimum number of threads to be used for fact publishing per session.

TASK_MANAGER_THREAD_KEEPALIVE_TIME

@DataType(dataType=INTEGER,
          defaultValue="60")
public static final ConfigProperty TASK_MANAGER_THREAD_KEEPALIVE_TIME

Keep alive time in seconds for task manager threads. When this time elapses, idle threads will be timed out.

TRANSPORT_TYPE

@Internal
@DataType(dataType=STRING,
          defaultValue="JMS")
public static final ConfigProperty TRANSPORT_TYPE

TRANSPORT TYPE :: JMS, HTTP, TCP

TRANSPORT_HTTP_HOSTNAME

@Internal
@DataType(dataType=STRING,
          defaultValue="localhost")
public static final ConfigProperty TRANSPORT_HTTP_HOSTNAME

Server hostname property for HTTP transport.

TRANSPORT_HTTP_PORT

@Internal
@DataType(dataType=INTEGER,
          defaultValue="4448")
public static final ConfigProperty TRANSPORT_HTTP_PORT

Server port for HTTP transport.

FACT_QUEUE_DEPTH

@DataType(dataType=INTEGER,
          defaultValue="1000")
public static final ConfigProperty FACT_QUEUE_DEPTH

Queue depth for the internal queue for batching facts.

FACT_BATCH_SIZE

@DataType(dataType=INTEGER,
          defaultValue="1")
public static final ConfigProperty FACT_BATCH_SIZE

Number of facts to batch before publishing to the server.

FACT_EVICTION_ENABLED

@DataType(dataType=BOOLEAN,
          defaultValue="true")
public static final ConfigProperty FACT_EVICTION_ENABLED

Enable/Disable async eviction of facts once queue depth is full. True by default. If disabled, eviction is done by thread putting the fact.

Disabling this may result in more facts being lost if fact batch size is on the higher side and put rate is much more than the consumption rate.

FACT_EVICTION_FREQUENCY

@DataType(dataType=INTEGER,
          defaultValue="100")
public static final ConfigProperty FACT_EVICTION_FREQUENCY

Delay in milliseconds for eviction thread to run. Only used if #FACT_EVICTION_ENABLED is set to true.

FACT_BATCH_EXPIRY

@DataType(dataType=INTEGER,
          defaultValue="5")
public static final ConfigProperty FACT_BATCH_EXPIRY

If batch size condition is not met, the amount of time in seconds to wait to flush residual facts.

PING_INTERVAL

@Internal
@DataType(dataType=LONG,
          defaultValue="1000L")
public static final ConfigProperty PING_INTERVAL

Time interval in milliseconds used for ping with the server.

HEARTBEAT_INTERVAL

@DataType(dataType=LONG,
          defaultValue="10000L")
public static final ConfigProperty HEARTBEAT_INTERVAL

Time interval in milliseconds used by named client sessions to send heartbeat.

CONNECTION_USERNAME

@Mandatory
@DataType(dataType=STRING,
          defaultValue="admin")
public static final ConfigProperty CONNECTION_USERNAME

Username for metric engine.

CONNECTION_PASSWORD

@DataType(dataType=STRING,
          defaultValue="")
public static final ConfigProperty CONNECTION_PASSWORD

Password for metric engine.

NUM_RETRIES_SYNC_OPS

@DataType(dataType=INTEGER,
          defaultValue="3")
public static final ConfigProperty NUM_RETRIES_SYNC_OPS

Maximum retries for a synchronous operation in case it fails. Default is 3 times.

NUM_RETRIES_FACT_OPS

@DataType(dataType=INTEGER,
          defaultValue="2147483647")
public static final ConfigProperty NUM_RETRIES_FACT_OPS

Maximum retries for a synchronous operation in case it fails. Default is 3 times.

NUM_RETRIES_CONNECTION_ESTABLISH

@DataType(dataType=INTEGER,
          defaultValue="2147483647")
public static final ConfigProperty NUM_RETRIES_CONNECTION_ESTABLISH

Maximum retries for a for establishing connection to transport provider if any. Default is 0x7fffffff times.

RETRY_WAIT_INTERVAL

@DataType(dataType=LONG,
          defaultValue="10000L")
public static final ConfigProperty RETRY_WAIT_INTERVAL

Time in milliseconds to wait before retrying the operation

SYNC_RESPONSE_TIMEOUT

@DataType(dataType=LONG,
          defaultValue="10000L")
public static final ConfigProperty SYNC_RESPONSE_TIMEOUT

Time in milliseconds to wait for rta engine to wait for server to send response for a sync operation like query registration.

SYNC_JMS_MESSAGE_EXPIRY

@DataType(dataType=LONG,
          defaultValue="300000L")
public static final ConfigProperty SYNC_JMS_MESSAGE_EXPIRY

Time in milliseconds for JMS provider to keep a message before it expires.

LOG_MANAGER_CLASS_NAME

@DataType(dataType=STRING,
          defaultValue="com.tibco.rta.log.impl.DefaultLogManager")
public static final ConfigProperty LOG_MANAGER_CLASS_NAME

Specify external log manager impl class.

Please refer

com.tibco.rta.log.LogManager, com.tibco.rta.log.LogManagerFactory

LOG_MANAGER

@DataType(dataType=OBJECT,
          defaultValue="")
public static final ConfigProperty LOG_MANAGER

Specify external log manager impl. Either #LOG_MANAGER_CLASS_NAME or #LOG_MANAGER should be used.

Please refer

com.tibco.rta.log.LogManager, com.tibco.rta.log.LogManagerFactory

JMS_PROVIDER_JNDI_URL

@DataType(dataType=STRING,
          defaultValue="tibjmsnaming://localhost:7222")
public static final ConfigProperty JMS_PROVIDER_JNDI_URL

JMS JNDI URL.

JMS_PROVIDER_JNDI_FACTORY

@DataType(dataType=STRING,
          defaultValue="com.tibco.tibjms.naming.TibjmsInitialContextFactory")
public static final ConfigProperty JMS_PROVIDER_JNDI_FACTORY

Context factory class for the JMS provider.

JMS_QUEUE_CONN_FACTORY

@DataType(dataType=STRING,
          defaultValue="SPMQueueConnectionFactory")
public static final ConfigProperty JMS_QUEUE_CONN_FACTORY

Queue connection factory name. Needs to be pre-created.

JMS_INBOUND_QUEUE

@DataType(dataType=STRING,
          defaultValue="spm.inbound.queue")
public static final ConfigProperty JMS_INBOUND_QUEUE

Queue name on JMS to perform sync/async operations.

JMS_INBOUND_QUERY_QUEUE

@DataType(dataType=STRING,
          defaultValue="spm.inbound.query.queue")
public static final ConfigProperty JMS_INBOUND_QUERY_QUEUE

Queue name on JMS to perform snapshot query operations.

JMS_OUTBOUND_QUEUE

@DataType(dataType=STRING,
          defaultValue="spm.outbound.queue")
public static final ConfigProperty JMS_OUTBOUND_QUEUE

Queue name on JMS for client to receive notifications from metric engine.

ASYNC_RESULT_DISPATCHER_MAX_POOL_SIZE

@DataType(dataType=INTEGER,
          defaultValue="64")
public static final ConfigProperty ASYNC_RESULT_DISPATCHER_MAX_POOL_SIZE

The thread pool used for dispatching results from outbound queue to clients. For instance streaming queries/commands.

ASYNC_RESULT_DISPATCHER_POOL_TIMEOUT

@DataType(dataType=LONG,
          defaultValue="300000L")
public static final ConfigProperty ASYNC_RESULT_DISPATCHER_POOL_TIMEOUT

The thread pool used for dispatching results from outbound queue to clients has an idle timeout in milliseconds.

Method Detail

values

public static ConfigProperty[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ConfigProperty c : ConfigProperty.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ConfigProperty valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getPropertyName

public java.lang.String getPropertyName()

getByPropertyName

public static ConfigProperty getByPropertyName(java.lang.String propertyName)

getDataType

public DataType getDataType()

getDefaultValue

public com.tibco.rta.property.PropertyAtom<?> getDefaultValue()

getValue

public java.lang.Object getValue(java.util.Properties props)

getValue

public java.lang.Object getValue(java.util.Map<?,?> props)