com.sun.sgs.impl.kernel
Class StandardProperties

java.lang.Object
  com.sun.sgs.impl.kernel.StandardProperties

public final class StandardProperties
extends Object

This class contains the standard property keys that the kernel looks for (and may provide) on startup.

When when the kernel starts, it is given an application Properties file. Any of the property keys identified here will set the associated behavior for that application. If no value is provided for a given key, then the default or system-provided value is used. Note that some keys are required to have values, specifically APP_NAME, APP_ROOT and APP_LISTENER.

Default values can be provided for all applications by using any of the properties specified in this class as a system property.

Nested Class Summary

static class	StandardProperties.ServiceNodeTypes An enumeration of the possible values to assign in the SERVICE_NODE_TYPES list.
static class	StandardProperties.StandardService An enumeration of the known, standard Services.

Field Summary

static String	APP_LISTENER A required key specifying the AppListener for the application.
static String	APP_NAME A required key specifying the name of the application.
static String	APP_ROOT A required key specifying the root directory for the application.
static String	AUTHENTICATORS An optional colon-separated key that specifies which IdentityAuthenticators to use for the application.
static String	CHANNEL_MANAGER An optional key specifying a specific class to use for the ChannelManager.
static String	CHANNEL_SERVICE An optional key specifying a specific class to use for the ChannelService.
static String	CLIENT_SESSION_SERVICE An optional key specifying a specific class to use for the ClientSessionService.
static String	DATA_MANAGER An optional key specifying a specific class to use for the DataManager.
static String	DATA_SERVICE An optional key specifying a specific class to use for the DataService.
static long	DEFAULT_SESSION_RELOCATION_TIMEOUT The default session relocation timeout, in milliseconds.
static String	MANAGERS An optional colon-separated key that specifies additional managers to use.
static String	NODE_MAPPING_SERVICE An optional key specifying a specific class to use for the NodeMappingService.
static String	NODE_TYPE An optional property that specifies the type of node being started.
static String	SERVER_HOST An optional property that specifies the default for the name of the host running the servers associated with services.
static String	SERVICE_NODE_TYPES An optional colon-separated key that specifies which node types each configured additional Service/Manager pair should be started on.
static String	SERVICES An optional colon-separated key that specifies additional services to use.
static String	SESSION_RELOCATION_TIMEOUT_PROPERTY The property for specifying the maximum length of time, in milliseconds, for a client session to relocate to a new node.
static String	SYSTEM_JMX_REMOTE_PORT An optional system property (this is not a Darkstar property) which enables remote JMX monitoring, and specifies the port JMX is listening on.
static String	TASK_MANAGER An optional key specifying a specific class to use for the TaskManager.
static String	TASK_SERVICE An optional key specifying a specific class to use for the TaskService.
static String	WATCHDOG_SERVICE An optional key specifying a specific class to use for the WatchdogService.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

APP_NAME

public static final String APP_NAME

A required key specifying the name of the application.

See Also:

Constant Field Values

APP_ROOT

public static final String APP_ROOT

A required key specifying the root directory for the application.

See Also:

Constant Field Values

APP_LISTENER

public static final String APP_LISTENER

A required key specifying the AppListener for the application.

See Also:

Constant Field Values

DATA_SERVICE

public static final String DATA_SERVICE

An optional key specifying a specific class to use for the DataService.

See Also:

Constant Field Values

DATA_MANAGER

public static final String DATA_MANAGER

An optional key specifying a specific class to use for the DataManager.

See Also:

Constant Field Values

NODE_MAPPING_SERVICE

public static final String NODE_MAPPING_SERVICE

An optional key specifying a specific class to use for the NodeMappingService.

See Also:

Constant Field Values

TASK_SERVICE

public static final String TASK_SERVICE

An optional key specifying a specific class to use for the TaskService.

See Also:

Constant Field Values

TASK_MANAGER

public static final String TASK_MANAGER

An optional key specifying a specific class to use for the TaskManager.

See Also:

Constant Field Values

WATCHDOG_SERVICE

public static final String WATCHDOG_SERVICE

An optional key specifying a specific class to use for the WatchdogService.

See Also:

Constant Field Values

CLIENT_SESSION_SERVICE

public static final String CLIENT_SESSION_SERVICE

An optional key specifying a specific class to use for the ClientSessionService.

See Also:

Constant Field Values

CHANNEL_SERVICE

public static final String CHANNEL_SERVICE

An optional key specifying a specific class to use for the ChannelService.

See Also:

Constant Field Values

CHANNEL_MANAGER

public static final String CHANNEL_MANAGER

An optional key specifying a specific class to use for the ChannelManager.

See Also:

Constant Field Values

SERVICES

public static final String SERVICES

An optional colon-separated key that specifies additional services to use. Services will be started in the order that they are specified in this list.

See Also:

Constant Field Values

MANAGERS

public static final String MANAGERS

An optional colon-separated key that specifies additional managers to use. This must contain the same number of classes as SERVICES. Each manager in this list will be paired with the corresponding Service from the SERVICES list. To specify a Service with no manager, leave the appropriate element in the list empty. E.g.:

    -DSERVICES=S1:S2:S3 -DMANAGERS=M1::M3
 

This specifies three Services where S2 has no associated manager.

See Also:

Constant Field Values

SERVICE_NODE_TYPES

public static final String SERVICE_NODE_TYPES

An optional colon-separated key that specifies which node types each configured additional Service/Manager pair should be started on. Each item in this list must be set to a value in StandardProperties.ServiceNodeTypes and is associated with the Service/Manager at the same respective index in the SERVICES and MANAGERS lists. If this property is omitted, all configured additional services will default to StandardProperties.ServiceNodeTypes.ALL.

See Also:

Constant Field Values

AUTHENTICATORS

public static final String AUTHENTICATORS

An optional colon-separated key that specifies which IdentityAuthenticators to use for the application. The order here is used to define order of precedence when authenticating an identity.

See Also:

Constant Field Values

NODE_TYPE

public static final String NODE_TYPE

An optional property that specifies the type of node being started. It must be set to a value in NodeType and defaults to singleNode. The value of this property may cause other property settings to be overridden.

In particular, setting this property to coreServerNode causes the following property to be set:

• com.sun.sgs.impl.service.data.DataServiceImpl.data.store.class set to com.sun.sgs.impl.service.data.store.net.DataStoreClient to indicate the multi-node data service should be used

The unit tests rely on the default not modifying any other properties.

See Also:

Constant Field Values

SERVER_HOST

public static final String SERVER_HOST

An optional property that specifies the default for the name of the host running the servers associated with services.

See Also:

Constant Field Values

SYSTEM_JMX_REMOTE_PORT

public static final String SYSTEM_JMX_REMOTE_PORT

An optional system property (this is not a Darkstar property) which enables remote JMX monitoring, and specifies the port JMX is listening on.

See Also:

Constant Field Values

SESSION_RELOCATION_TIMEOUT_PROPERTY

public static final String SESSION_RELOCATION_TIMEOUT_PROPERTY

The property for specifying the maximum length of time, in milliseconds, for a client session to relocate to a new node.

See Also:

Constant Field Values

DEFAULT_SESSION_RELOCATION_TIMEOUT

public static final long DEFAULT_SESSION_RELOCATION_TIMEOUT

The default session relocation timeout, in milliseconds.

See Also:

Constant Field Values