com.sssw.rts.adminapi
Interface AgiAdmLBClusterEnv

All Superinterfaces:

AgiAdmChanges, AgiAdmContainerBase, AgiAdmElementBase, AgiAdmLBContainer, AgiAdmLBElement, AgiAdmPropertyBag

public interface AgiAdmLBClusterEnv

extends AgiAdmLBContainer

Implemented by objects that represent Cluster Environment profiles for configuring load balancing.

It contains the element type CLUSTER_ENV, which defines the Cluster Environment type of a Load Balancing Container. This interface also contains names of properties whose values can be retrieved and set using the getProperty and setProperty methods.

Field Summary

static String	CLUSTER_ENV The Cluster Environment type of a Load Balancing Container
static String	PROP_ACTIVE_CACHE_MGR_GROUP The name of the Active Cache Manager Group.
static String	PROP_ACTIVE_CACHE_MGR_GROUP_ID The ID of the active Cache Manager Group.
static String	PROP_ACTIVE_CLUSTER The name of the Active Cluster.
static String	PROP_ACTIVE_CLUSTER_ID The ID of the active Cluster.
static String	PROP_ACTIVE_DISP_GROUP The name of the Active Dispatcher Group.
static String	PROP_ACTIVE_DISPATCHER_GROUP_ID The ID of the active Dispatcher Group.
static String	PROP_ACTIVE_LOAD_MGR_GROUP The name of the Active Load Manager Group.
static String	PROP_ACTIVE_LOAD_MGR_GROUP_ID The ID of the active Load Manager Group.

Fields inherited from interface com.sssw.rts.adminapi.AgiAdmLBContainer

CACHE_MGR_GROUP, CLUSTER, DISP_GROUP, LOAD_MGR_GROUP, PROP_DATE_CREATED, PROP_DATE_LASTMOD, PROP_DISP_GROUP_ID

Fields inherited from interface com.sssw.rts.adminapi.AgiAdmLBElement

CACHE_MGR, CLUSTER_SERVER, DISPATCHER, LOAD_MGR, PROP_HOST, PROP_HTTP_PORT, PROP_HTTPS_PORT_DSA, PROP_HTTPS_PORT_RSA, PROP_ID, PROP_OLD_HOST, PROP_OLD_PORT, PROP_PORT, PROP_WEIGHT

Fields inherited from interface com.sssw.rts.adminapi.AgiAdmContainerBase

GET_CHILDREN_DFLT

Method Summary

boolean	isEmpty() Check to see if there are any elements within the Cluster Environment.
void	shutdown() Shut down the currently active cluster.

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

cancelChanges, saveChanges

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

addChild, getChild, getChildren

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

CLUSTER_ENV

public static final String CLUSTER_ENV

The Cluster Environment type of a Load Balancing Container

PROP_ACTIVE_CLUSTER

public static final String PROP_ACTIVE_CLUSTER

The name of the Active Cluster. Value type: String.

PROP_ACTIVE_CACHE_MGR_GROUP

public static final String PROP_ACTIVE_CACHE_MGR_GROUP

The name of the Active Cache Manager Group. Value type: String.

PROP_ACTIVE_LOAD_MGR_GROUP

public static final String PROP_ACTIVE_LOAD_MGR_GROUP

The name of the Active Load Manager Group. Value type: String.

PROP_ACTIVE_DISP_GROUP

public static final String PROP_ACTIVE_DISP_GROUP

The name of the Active Dispatcher Group. Value type: String.

PROP_ACTIVE_CLUSTER_ID

public static final String PROP_ACTIVE_CLUSTER_ID

The ID of the active Cluster. Value type: Integer.

PROP_ACTIVE_CACHE_MGR_GROUP_ID

public static final String PROP_ACTIVE_CACHE_MGR_GROUP_ID

The ID of the active Cache Manager Group. Value type: Integer.

PROP_ACTIVE_LOAD_MGR_GROUP_ID

public static final String PROP_ACTIVE_LOAD_MGR_GROUP_ID

The ID of the active Load Manager Group. Value type: Integer.

PROP_ACTIVE_DISPATCHER_GROUP_ID

public static final String PROP_ACTIVE_DISPATCHER_GROUP_ID

The ID of the active Dispatcher Group. Value type: Integer.

Method Detail

isEmpty

public boolean isEmpty()

Check to see if there are any elements within the Cluster Environment.

Returns:

true if the Cluster Environment is empty, false otherwise

Example:

 AgiAdmLBClusterEnv env = (AgiAdmLBClusterEnv)server.getElement
 	null, AgiAdmLBClusterEnv.CLUSTER_ENV, null);
 boolean isClusterEmpty = env.isEmpty();
 

shutdown

public void shutdown()
              throws AgoUnrecoverableSystemException,
                     AgoSecurityException

Shut down the currently active cluster.

Example:

 AgiAdmLBClusterEnv env = (AgiAdmLBClusterEnv)server.getElement
 	null, AgiAdmLBClusterEnv.CLUSTER_ENV, null);
 env.shutdown();