Module com.zeroc.icegrid

Package com.zeroc.IceGrid

Class ServerDescriptor

java.lang.Object

com.zeroc.Ice.Value

com.zeroc.IceGrid.CommunicatorDescriptor

com.zeroc.IceGrid.ServerDescriptor

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

IceBoxDescriptor

public class ServerDescriptor
extends CommunicatorDescriptor

Describes an Ice server.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
String	activation	The server activation mode.
String	activationTimeout	The activation timeout.
boolean	allocatable	Specifies if the server is allocatable.
boolean	applicationDistrib	Specifies if the server depends on the application distribution.
String	deactivationTimeout	The deactivation timeout.
DistributionDescriptor	distrib	The distribution descriptor.
List<String>	envs	The server environment variables.
String	exe	The path of the server executable.
String	iceVersion	The Ice version used by this server.
String	id	The server ID.
List<String>	options	The command line options to pass to the server executable.
String	pwd	The path to the server working directory.
String	user	The user account used to run the server.

Fields inherited from class com.zeroc.IceGrid.CommunicatorDescriptor

adapters, dbEnvs, description, logs, propertySet

Constructor Summary

Constructors

Constructor	Description
ServerDescriptor()	Constructs a ServerDescriptor.
ServerDescriptor(List<AdapterDescriptor> adapters, PropertySetDescriptor propertySet, DbEnvDescriptor[] dbEnvs, String[] logs, String description, String id, String exe, String iceVersion, String pwd, List<String> options, List<String> envs, String activation, String activationTimeout, String deactivationTimeout, boolean applicationDistrib, DistributionDescriptor distrib, boolean allocatable, String user)	Constructs a ServerDescriptor with values for all its fields.

Method Summary

Modifier and Type	Method	Description
ServerDescriptor	clone()	Returns a copy of the object.
String	ice_id()	Returns the Slice type ID of the most-derived interface supported by this object.
static String	ice_staticId()	Gets the type ID of the associated Slice interface.

Methods inherited from class com.zeroc.Ice.Value

ice_getSlicedData, ice_postUnmarshal, ice_preMarshal

Methods inherited from class java.lang.Object

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

Field Details

id

public String id

The server ID.

exe

public String exe

The path of the server executable.

iceVersion

public String iceVersion

The Ice version used by this server. This is only required if backward compatibility with servers using old Ice versions is needed (otherwise the registry assumes the server is using the same Ice version as the registry itself). For example "3.7.5".

pwd

public String pwd

The path to the server working directory.

options

public List<String> options

The command line options to pass to the server executable.

envs

public List<String> envs

The server environment variables.

activation

public String activation

The server activation mode. Possible values are "on-demand" and "manual".

activationTimeout

public String activationTimeout

The activation timeout. It's an integer (in string format) that represents the number of seconds to wait for activation.

deactivationTimeout

public String deactivationTimeout

The deactivation timeout. It's an integer (in string format) that represents the number of seconds to wait for deactivation.

applicationDistrib

public boolean applicationDistrib

Specifies if the server depends on the application distribution.

distrib

public DistributionDescriptor distrib

The distribution descriptor.

allocatable

public boolean allocatable

Specifies if the server is allocatable.

user

public String user

The user account used to run the server.

Constructor Details

ServerDescriptor

public ServerDescriptor()

Constructs a ServerDescriptor.

ServerDescriptor

public ServerDescriptor(List<AdapterDescriptor> adapters,
 PropertySetDescriptor propertySet,
 DbEnvDescriptor[] dbEnvs,
 String[] logs,
 String description,
 String id,
 String exe,
 String iceVersion,
 String pwd,
 List<String> options,
 List<String> envs,
 String activation,
 String activationTimeout,
 String deactivationTimeout,
 boolean applicationDistrib,
 DistributionDescriptor distrib,
 boolean allocatable,
 String user)

Constructs a ServerDescriptor with values for all its fields.

Parameters:

adapters - The indirect object adapters.

propertySet - The property set.

dbEnvs - The database environments.

logs - The path of each log file.

description - A description of this descriptor.

id - The server ID.

exe - The path of the server executable.

iceVersion - The Ice version used by this server.

pwd - The path to the server working directory.

options - The command line options to pass to the server executable.

envs - The server environment variables.

activation - The server activation mode.

activationTimeout - The activation timeout.

deactivationTimeout - The deactivation timeout.

applicationDistrib - Specifies if the server depends on the application distribution.

distrib - The distribution descriptor.

allocatable - Specifies if the server is allocatable.

user - The user account used to run the server.

Method Details

clone

public ServerDescriptor clone()

Description copied from class: Value

Returns a copy of the object. The cloned object contains field-for-field copies of the state.

Overrides:

clone in class CommunicatorDescriptor

Returns:

The cloned object.

ice_staticId

public static String ice_staticId()

Gets the type ID of the associated Slice interface.

Returns:

the string "::IceGrid::ServerDescriptor"

ice_id

public String ice_id()

Returns the Slice type ID of the most-derived interface supported by this object.

Overrides:

ice_id in class CommunicatorDescriptor

Returns:

The return value is always ::Ice::Object.