org.sapia.ubik.rmi
Interface Consts

All Known Subinterfaces:

Consts

All Known Implementing Classes:

JNDIServerHelper, RemoteInitialContextFactory

public interface Consts

This class conveniently holds constants that correspond to the system properties that can be define to influence Ubik RMI's runtime behavior.

Author:

Yanick Duchesne

Copyright:

Copyright © 2002-2003 Sapia Open Source Software. All Rights Reserved.

License:

Read the license.txt file of the jar or visit the license page at the Sapia OSS web site

Field Summary

static java.lang.String	ALLOW_CODE_DOWNLOAD Specifies if dynamic code download is allows in this VM (true) or not (false) - system property name: ubik.rmi.code-download.enabled.
static java.lang.String	CALLBACK_ENABLED Specifies if call-back should be used (true) or not (false) - system property name: ubik.rmi.callback.enabled.
static java.lang.String	CLIENT_CALLBACK_TIMEOUT Specifies the timeout (in millis) of client callbacks (the delay after which the latter tracks the OIDs whose corresponding remote reference are null (which means that they have locally been dereferenced).
static java.lang.String	CLIENT_GC_BATCHSIZE Specifies the size of the batch of OIDs that will be sent to remote servers by the client GC.
static java.lang.String	CLIENT_GC_INTERVAL Interval (in millis) at which the client distributed garbage collector wakes up - system property name: ubik.rmi.client.gc.interval.
static java.lang.String	CLIENT_GC_THRESHOLD Specifies the number of remote references at which clients will start invoking the JVM's garbage collector explicitely (a number equal to or lower than 0 means that no threshold is to be taken into account - this property will then have no effect).
static java.lang.String	DEFAULT_DOMAIN The default domain.
static java.lang.String	DEFAULT_MCAST_ADDR The default multicast address.
static int	DEFAULT_MCAST_PORT The default multicast port.
static java.lang.String	IP_PATTERN_KEY This constant corresponds to the 'ubik.rmi.address-pattern' property key.
static java.lang.String	JMX_ENABLED Determines if Ubik's JMX beans should be registered with the platform's MBeanServer - system property: ubik.rmi.stats.enabled.
static java.lang.String	LOG_LEVEL Defines the logging verbosity; must be one of the following: debug, info, warning, error - system property name: ubik.rmi.log.level.
static java.lang.String	MARSHALLING This constant corresponds to the 'ubik.rmi.marshalling' property key.
static java.lang.String	MCAST_ADDR_KEY This constant corresponds to the 'ubik.rmi.naming.mcast.address' property key.
static java.lang.String	MCAST_BUFSIZE_KEY This constant corresponds to the 'ubik.rmi.naming.mcast.bufsize' property key.
static java.lang.String	MCAST_HEARTBEAT_INTERVAL This constant corresponds to the 'ubik.rmi.naming.mcast.heartbeat.interval' property key.
static java.lang.String	MCAST_HEARTBEAT_TIMEOUT This constant corresponds to the 'ubik.rmi.naming.mcast.heartbeat.timeout' property key.
static java.lang.String	MCAST_PORT_KEY This constant corresponds to the 'ubik.rmi.naming.mcast.post' property key.
static java.lang.String	OBJECT_TABLE_INITCAPACITY This constant corresponds to the system property that defines the initial capacity of the hashmap used by the ObjectTable to keep remote objects - system property: ubik.rmi.object-table.initial-capacity.
static java.lang.String	OBJECT_TABLE_LOAD_FACTOR This constant corresponds to the system property that defines the load factor of the hashmap used by the ObjectTable to keep remote objects - system property: ubik.rmi.object-table.load-factor.
static java.lang.String	SERVER_CALLBACK_MAX_THREADS Specifies the maximum number of threads that process method invocation callbacks - system property name: code>ubik.rmi.server.callback.max-threads.
static java.lang.String	SERVER_GC_INTERVAL Interval (in millis) at which the server-side distributed garbage collector wakes up - system property name: ubik.rmi.server.gc.interval.
static java.lang.String	SERVER_GC_TIMEOUT Delay (in millis) after which clients that have not performed a "ping" are considered down - system property name: ubik.rmi.server.gc.timeout.
static java.lang.String	SERVER_MAX_THREADS Specifies the maximum number of processing server threads - system property name: ubik.rmi.server.max-threads.
static java.lang.String	SERVER_RESET_INTERVAL This constant corresponds to the ubik.rmi.server.reset-interval system property, which defines at which interval (in millis) the ObjectOutputStream and ObjectInputStream resets occur.
static java.lang.String	STATS_DUMP_INTERVAL Determines the interval at which Ubik stats must be dumped - system property: ubik.rmi.stats.dump.interval.
static java.lang.String	STATS_ENABLED Determines if statistics should be turned on - system property: ubik.rmi.stats.enabled.
static java.lang.String	TRANSPORT_PROVIDER This constant corresponds to the system property that prefixes the configured TransportProviders to plug into the TransportManager.
static java.lang.String	TRANSPORT_TYPE Specifies the "transport type" to use.
static java.lang.String	UBIK_DOMAIN_NAME This constant corresponds to the property that identifies ubik's JNDI domain.

Field Detail

UBIK_DOMAIN_NAME

static final java.lang.String UBIK_DOMAIN_NAME

This constant corresponds to the property that identifies ubik's JNDI domain. (the property is ubik.jndi.domain).

See Also:

Constant Field Values

DEFAULT_MCAST_ADDR

static final java.lang.String DEFAULT_MCAST_ADDR

The default multicast address.

See Also:

Constant Field Values

DEFAULT_MCAST_PORT

static final int DEFAULT_MCAST_PORT

The default multicast port.

See Also:

Constant Field Values

DEFAULT_DOMAIN

static final java.lang.String DEFAULT_DOMAIN

The default domain.

See Also:

Constant Field Values

IP_PATTERN_KEY

static final java.lang.String IP_PATTERN_KEY

This constant corresponds to the 'ubik.rmi.address-pattern' property key. The property should be used to specify a regular expression based upon which the address of this host is chosen (if this host has more than one network interfaces).

See Also:

Localhost, Constant Field Values

MCAST_PORT_KEY

static final java.lang.String MCAST_PORT_KEY

This constant corresponds to the 'ubik.rmi.naming.mcast.post' property key. It is used to bind a multicast port value in a properties/map instance.

See Also:

Constant Field Values

MCAST_ADDR_KEY

static final java.lang.String MCAST_ADDR_KEY

This constant corresponds to the 'ubik.rmi.naming.mcast.address' property key. It is used to bind a multicast address value in a properties/map instance.

See Also:

Constant Field Values

MCAST_BUFSIZE_KEY

static final java.lang.String MCAST_BUFSIZE_KEY

This constant corresponds to the 'ubik.rmi.naming.mcast.bufsize' property key. It is used to set the size of buffers that handle UDP datagrams. A too small value may result in multicast events not being sent/received. Defaults to 5kb.

See Also:

Constant Field Values

MCAST_HEARTBEAT_TIMEOUT

static final java.lang.String MCAST_HEARTBEAT_TIMEOUT

This constant corresponds to the 'ubik.rmi.naming.mcast.heartbeat.timeout' property key. It is used to determine the interval (in millis) after which nodes that haven't sent a heartbeat are considered down (defaults to 30000).

See Also:

Constant Field Values

MCAST_HEARTBEAT_INTERVAL

static final java.lang.String MCAST_HEARTBEAT_INTERVAL

This constant corresponds to the 'ubik.rmi.naming.mcast.heartbeat.interval' property key. It is used to determine the interval (in millis) at which nodes send their heartbeat to the other nodes (defaults to 20000).

The value of this property should consistent with the value given to the heartbeat timeout: it should not be more.

See Also:

Constant Field Values

MARSHALLING

static final java.lang.String MARSHALLING

This constant corresponds to the 'ubik.rmi.marshalling' property key. If the property's value is true, then the Ubik RMI runtime will wrap remote method invocation parameters in org.sapia.ubik.rmi.transport.MarshalledObject instances prior sending the parameters over the wire.

See Also:

Constant Field Values

LOG_LEVEL

static final java.lang.String LOG_LEVEL

Defines the logging verbosity; must be one of the following: debug, info, warning, error - system property name: ubik.rmi.log.level. Defaults to "error".

See Also:

Constant Field Values

CALLBACK_ENABLED

static final java.lang.String CALLBACK_ENABLED

Specifies if call-back should be used (true) or not (false) - system property name: ubik.rmi.callback.enabled. Defaults to "false".

See Also:

Constant Field Values

ALLOW_CODE_DOWNLOAD

static final java.lang.String ALLOW_CODE_DOWNLOAD

Specifies if dynamic code download is allows in this VM (true) or not (false) - system property name: ubik.rmi.code-download.enabled. Defaults to "false".

See Also:

Constant Field Values

SERVER_GC_INTERVAL

static final java.lang.String SERVER_GC_INTERVAL

Interval (in millis) at which the server-side distributed garbage collector wakes up - system property name: ubik.rmi.server.gc.interval. Defaults to 10 secs.

See Also:

Constant Field Values

SERVER_GC_TIMEOUT

static final java.lang.String SERVER_GC_TIMEOUT

Delay (in millis) after which clients that have not performed a "ping" are considered down - system property name: ubik.rmi.server.gc.timeout. Defaults to 30 secs.

See Also:

Constant Field Values

SERVER_MAX_THREADS

static final java.lang.String SERVER_MAX_THREADS

Specifies the maximum number of processing server threads - system property name: ubik.rmi.server.max-threads. No maximum is defined by default.

See Also:

Constant Field Values

SERVER_CALLBACK_MAX_THREADS

static final java.lang.String SERVER_CALLBACK_MAX_THREADS

Specifies the maximum number of threads that process method invocation callbacks - system property name: code>ubik.rmi.server.callback.max-threads. Defaults to 5.

See Also:

Constant Field Values

SERVER_RESET_INTERVAL

static final java.lang.String SERVER_RESET_INTERVAL

This constant corresponds to the ubik.rmi.server.reset-interval system property, which defines at which interval (in millis) the ObjectOutputStream and ObjectInputStream resets occur. System property: ubik.rmi.server.reset-interval.

See Also:

Constant Field Values

CLIENT_GC_INTERVAL

static final java.lang.String CLIENT_GC_INTERVAL

Interval (in millis) at which the client distributed garbage collector wakes up - system property name: ubik.rmi.client.gc.interval. Defaults to 10 seconds.

See Also:

Constant Field Values

CLIENT_GC_BATCHSIZE

static final java.lang.String CLIENT_GC_BATCHSIZE

Specifies the size of the batch of OIDs that will be sent to remote servers by the client GC. The latter tracks the OIDs whose corresponding remote reference are null (when means that they have locally been dereferenced) - system property: ubik.rmi.client.gc.batch.size.

See Also:

Constant Field Values

CLIENT_GC_THRESHOLD

static final java.lang.String CLIENT_GC_THRESHOLD

Specifies the number of remote references at which clients will start invoking the JVM's garbage collector explicitely (a number equal to or lower than 0 means that no threshold is to be taken into account - this property will then have no effect). This property is used to force client GC's to run regularly, so that unreachable remote references on the client side are dereferenced on the server side. System property: ubik.rmi.client.gc.threshold.

See Also:

Constant Field Values

CLIENT_CALLBACK_TIMEOUT

static final java.lang.String CLIENT_CALLBACK_TIMEOUT

Specifies the timeout (in millis) of client callbacks (the delay after which the latter tracks the OIDs whose corresponding remote reference are null (which means that they have locally been dereferenced). The client GC indirectly interacts with the VM's GC. All OIDs whose corresponding remote reference has been locally GC'ed are sent to the originating server (in batches whose size corresponds to the property defined by this constant).

See Also:

Constant Field Values

OBJECT_TABLE_LOAD_FACTOR

static final java.lang.String OBJECT_TABLE_LOAD_FACTOR

This constant corresponds to the system property that defines the load factor of the hashmap used by the ObjectTable to keep remote objects - system property: ubik.rmi.object-table.load-factor.

See Also:

Constant Field Values

OBJECT_TABLE_INITCAPACITY

static final java.lang.String OBJECT_TABLE_INITCAPACITY

This constant corresponds to the system property that defines the initial capacity of the hashmap used by the ObjectTable to keep remote objects - system property: ubik.rmi.object-table.initial-capacity.

See Also:

Constant Field Values

TRANSPORT_TYPE

static final java.lang.String TRANSPORT_TYPE

Specifies the "transport type" to use. Property name: ubik.rmi.transport.type

See Also:

Hub.exportObject(Object, java.util.Properties), Constant Field Values

STATS_ENABLED

static final java.lang.String STATS_ENABLED

Determines if statistics should be turned on - system property: ubik.rmi.stats.enabled. Value must be true or false (if not set, same effect as false).

See Also:

Constant Field Values

STATS_DUMP_INTERVAL

static final java.lang.String STATS_DUMP_INTERVAL

Determines the interval at which Ubik stats must be dumped - system property: ubik.rmi.stats.dump.interval. Note: this property will only be taken into account if stats are enabled - see STATS_ENABLED. Value must be in seconds. If it is set to 0 or less, or not set, no dump will occur. Otherwise, stats dump will be done to stdout.

See Also:

Constant Field Values

JMX_ENABLED

static final java.lang.String JMX_ENABLED

Determines if Ubik's JMX beans should be registered with the platform's MBeanServer - system property: ubik.rmi.stats.enabled. Value must be true or false (if not set, same effect as false).

See Also:

Constant Field Values

TRANSPORT_PROVIDER

static final java.lang.String TRANSPORT_PROVIDER

This constant corresponds to the system property that prefixes the configured TransportProviders to plug into the TransportManager. When it initializes, the latter indeed looks for all system properties starting with the ubik.rmi.transport.provider prefix. This prefix must be suffixed with an arbitrary value - so that multiple provider definitions do not overwrite each other. The property's value is the name of the transport provider's class. For example, given the org.sapia.ubik.rmi.server.transport.socket.SocketTransportProvider class, the property could be: ubik.rmi.transport.provider.socket; the associated value would be the above-mentioned class name.

At initialization, the TransportManager will dynamically instantiate all providers that have been thus defined and register them internally.

See Also:

TransportProvider.getTransportType(), TransportManager, TransportProvider, SocketTransportProvider, Constant Field Values