com.sssw.rts.adminapi
Interface AgiAdmLBElement

All Superinterfaces:

AgiAdmElementBase, AgiAdmPropertyBag

All Known Subinterfaces:

AgiAdmCluster, AgiAdmClusterServer, AgiAdmLBClusterEnv, AgiAdmLBContainer

public interface AgiAdmLBElement

extends AgiAdmPropertyBag, AgiAdmElementBase

Implemented by objects that represent the "front line" items in the load balancing realm, such as Cache Managers, Cluster Servers, Dispatchers, and Load Managers. These items are located within the "container" ones, such as Cache Manager Groups, Clusters, etc.

Field Summary

static String	CACHE_MGR The Cache Manager type of a load balancing element.
static String	CLUSTER_SERVER Deprecated. Use AgiAdmClusterServer.CLUSTER_SERVER. The Cluster Server type of a load balancing element.
static String	DISPATCHER The Dispatcher type of a load balancing element.
static String	LOAD_MGR The Load Manager type of a load balancing element.
static String	PROP_HOST The Host property of a load balancing element.
static String	PROP_HTTP_PORT The HTTP port number the Dispatcher is listening on.
static String	PROP_HTTPS_PORT_DSA The HTTPS port number the Dispatcher is listening on (DSA).
static String	PROP_HTTPS_PORT_RSA The HTTPS port number the Dispatcher is listening on (RSA).
static String	PROP_ID The ID property of a load balancing element.
static String	PROP_OLD_HOST The old host name property of a load balancing element.
static String	PROP_OLD_PORT The old port property of a load balancing element.
static String	PROP_PORT The Port property of a load balancing element.
static String	PROP_WEIGHT The Weight property of a load balancing element.

Methods implemented from interface com.sssw.rts.adminapi.AgiAdmPropertyBag

getProperties, getProperty, setProperties, setProperty

Methods implemented from interface com.sssw.rts.adminapi.AgiAdmElementBase

delete, getName, getType

Field Detail

PROP_ID

public static final String PROP_ID

The ID property of a load balancing element. Value type: Integer.

This property is valid for AgiAdmLBContainers (that inherit from AgiAdmLBElement).

PROP_HOST

public static final String PROP_HOST

The Host property of a load balancing element. Value type: String.

This property is not valid for AgiAdmLBContainers even though they inherit from AgiAdmLBElement.

See Also:

AgiAdmLBElement.PROP_OLD_HOST

PROP_OLD_HOST

public static final String PROP_OLD_HOST

The old host name property of a load balancing element. Value type: Integer.

This property is valid and should be used for load balancing elements of type AgiAdmLBElement.DISPATCHER or AgiAdmLBElement.LOAD_MGR only.

You must supply this property when using the setProperties or setProperty method to change the PROP_HOST property. In order for the SilverStream server to contact the dispatcher or load manager and successfully change the host value to the new one, it needs to know the old host name value.

For example:

 child.setProperty(AgiAdmLBElement.PROP_OLD_HOST, m_lmOriginalHost);
 child.setProperty(AgiAdmLBElement.PROP_HOST, host);
 

See Also:

AgiAdmLBElement.PROP_HOST

PROP_PORT

public static final String PROP_PORT

The Port property of a load balancing element. Value type: Integer.

This property is not valid for AgiAdmLBContainers even though they inherit from AgiAdmLBElement.

See Also:

AgiAdmLBElement.PROP_OLD_PORT

PROP_OLD_PORT

public static final String PROP_OLD_PORT

The old port property of a load balancing element. Value type: Integer.

This property is valid and should be used for load balancing elements of type AgiAdmLBElement.DISPATCHER or AgiAdmLBElement.LOAD_MGR only.

You must supply this property when using the setProperties or setProperty method to change the PROP_PORT property. In order for the SilverStream server to contact the dispatcher or load manager and successfully change the port value to the new one, it needs to know the old port value.

For example:

 child.setProperty(AgiAdmLBElement.PROP_OLD_PORT, m_lmOriginalPort);
 child.setProperty(AgiAdmLBElement.PROP_PORT, port);
 

See Also:

AgiAdmLBElement.PROP_PORT

PROP_WEIGHT

public static final String PROP_WEIGHT

The Weight property of a load balancing element. Value type: Integer.

This property is not valid for AgiAdmLBContainers even though they inherit from AgiAdmLBElement. It is only valid for Cluster Servers.

CACHE_MGR

public static final String CACHE_MGR

The Cache Manager type of a load balancing element.

CLUSTER_SERVER

public static final String CLUSTER_SERVER

Deprecated. Use AgiAdmClusterServer.CLUSTER_SERVER.

The Cluster Server type of a load balancing element.

LOAD_MGR

public static final String LOAD_MGR

The Load Manager type of a load balancing element.

DISPATCHER

public static final String DISPATCHER

The Dispatcher type of a load balancing element.

PROP_HTTP_PORT

public static final String PROP_HTTP_PORT

The HTTP port number the Dispatcher is listening on. This property is only applicable to Dispatchers, and is optional. Value type: Integer.

Usage: in getProperty, setProperty

PROP_HTTPS_PORT_RSA

public static final String PROP_HTTPS_PORT_RSA

The HTTPS port number the Dispatcher is listening on (RSA). This property is only applicable to Dispatchers, and is optional. Value type: Integer.

Usage: in getProperty, setProperty

PROP_HTTPS_PORT_DSA

public static final String PROP_HTTPS_PORT_DSA

The HTTPS port number the Dispatcher is listening on (DSA). This property is only applicable to Dispatchers, and is optional. Value type: Integer.

Usage: in getProperty, setProperty