org.sandev.basics.structs
Class ServerDeclarationStruct

java.lang.Object
  org.sandev.basics.structs.ServerDeclarationStruct

Direct Known Subclasses:

ServerDeclaration

public class ServerDeclarationStruct
extends java.lang.Object

A ServerDeclaration represents a system which is available for execution of sand nodes. These declarations form the "hardware" part of the overall deployment configuration in abbreviated form. Most details are left to sandman. To make offline development possible, sandman has a runtime switch to launch the entire configuration on the local machine, ignoring the servers specified in the configuration.

To avoid duplicating information used internally by sandman, the servername is used as a lookup key into the available servers.

summary fields: servername
This message has the following verb forms: query collection

Field Summary

protected java.lang.String	description Additional descriptive information useful for identifying this server.
protected java.lang.String	serverID A unique identifier for this server.
protected java.lang.String	servername The name of the server for SAND Configuration purposes.

Constructor Summary

ServerDeclarationStruct()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

servername

protected java.lang.String servername

The name of the server for SAND Configuration purposes.

declared default value: ""
the values for this field are unique.
declared invalid value: "SANDEV_INVALID_SERVERNAME"
Length in characters, normal: 20 max: 128

description

protected java.lang.String description

Additional descriptive information useful for identifying this server. Optional.

declared default value: ""
declared invalid value: "SANDEV_INVALID_DESCRIPTION"
Length in characters, normal: 255 max: 4096

serverID

protected java.lang.String serverID

A unique identifier for this server. When determining which nodes out of a configuration should be loaded for a particular machine, the SAND environment checks the ID of the machine it is running on against this value.

If the SAND_SERVERID environment variable is set, then its value is compared with this value. If the SAND_SERVERID is not set, then the current IP Address is compared with this value. If the direct IP address comparison fails, an attempt is made to convert this value to an IP address through DNS lookup and the comparison is retried.

The startup process logs a message if it finds no matching server identification. This is not an error, as the system may be dynamically reconfigured for load balancing or other purposes at runtime.

The IP address is the most direct specification, but is impractical for a pool of identical webservers. By giving all the webservers the same SAND_SERVERID value, they are effectively one logical server in the deployment configuration.

For more information on advanced configuration options, contact Structs And Node Development Services

declared default value: ""
declared invalid value: "SANDEV_INVALID_SERVERID"
Length in characters, normal: 30 max: 80

Constructor Detail

ServerDeclarationStruct

public ServerDeclarationStruct()