com.sssw.rts.adminapi
Interface AgiAdmStatContainer

All Superinterfaces:

AgiAdmContainerBase, AgiAdmElementBase, AgiAdmStatElement

public interface AgiAdmStatContainer

extends AgiAdmStatElement, AgiAdmContainerBase

Implemented by objects that represent containers such as servers, databases, directories, etc. that contain other statitistics entities. Instances of AgiAdmStatContainer can also provide aggregate statistics.

See Also:

AgiAdmStatElement, AgiAdmContainer

Field Summary

static String	CLUSTER The element type for the 'cluster' statistic container element.
static String	DATABASE The element type for the 'database' statistic container element.
static String	DATABASES The element type for the 'databases' statistic container element.
static String	EJB The element type for the 'EJB' statistic container element.
static String	EJB_JAR The element type for the 'EJB JAR' statistic container element.
static int	GET_CHILDREN_SORTED A flag value to be used in the getChildren method.
static String	OBJECTS The element type for the 'application (business) objects' statistic container element.
static String	SERVER The element type for the 'server' statistic container element.
static String	SESSIONS The element type for the 'sessions' statistic container element.
static String	THREADS The element type for the 'threads' statistic container element.

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

EJB_HOME, OBJECT, SESSION, THREAD

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

GET_CHILDREN_DFLT

Method Summary

Enumeration	getChildren(int options, String subtype) Enumerate children of the given container.
String[]	getChildSubtypes() Enumerate the subtypes of children.

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

getPath, getStatCount, getStatInfo, getStatInfo, getStatInfos, getStatInfos

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

addChild, getChild, getChildren

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

delete, getName, getType

Field Detail

CLUSTER

public static final String CLUSTER

The element type for the 'cluster' statistic container element.

Children: elements of type AgiAdmStatContainer.SERVER.

Usage: getType, getStatElement

SERVER

public static final String SERVER

The element type for the 'server' statistic container element.

Children: AgiAdmStatContainer.DATABASES, SESSIONS, and THREADS.

Usage: getType, getStatElement

SESSIONS

public static final String SESSIONS

The element type for the 'sessions' statistic container element.

Children: elements of type AgiAdmStatElement.SESSION.

Usage: getType, getStatElement

THREADS

public static final String THREADS

The element type for the 'threads' statistic container element.

Children: elements of type AgiAdmStatElement.THREAD.

Usage: getType, getStatElement

DATABASES

public static final String DATABASES

The element type for the 'databases' statistic container element.

Children: elements of type AgiAdmStatContainer.DATABASE.

Usage: getType, getStatElement

DATABASE

public static final String DATABASE

The element type for the 'database' statistic container element.

Children: AgiAdmStatContainer.EJB and AgiAdmStatContainer.OBJECTS.

Usage: getType, getStatElement

EJB

public static final String EJB

The element type for the 'EJB' statistic container element.

Children: elements of type AgiAdmStatContainer.EJB_JAR.

Usage: getType, getStatElement

OBJECTS

public static final String OBJECTS

The element type for the 'application (business) objects' statistic container element.

Children: elements of type AgiAdmStatElement.OBJECT.

Usage: getType, getStatElement

EJB_JAR

public static final String EJB_JAR

The element type for the 'EJB JAR' statistic container element.

Children: elements of type AgiAdmStatElement.EJB_HOME.

Usage: getType, getStatElement

GET_CHILDREN_SORTED

public static final int GET_CHILDREN_SORTED

A flag value to be used in the getChildren method. Tells the method to return its results sorted. The sorting is done in the ascending order.

Method Detail

getChildSubtypes

public String[] getChildSubtypes()
                          throws AgoUnrecoverableSystemException,
                                 AgoSecurityException

Enumerate the subtypes of children.

Returns:

a string array where each member is a child subtype.

Usage:

The array may be null, which means no subtypes defined for the given container.

getChildren

public Enumeration getChildren(int options,
                               String subtype)
                        throws AgoUnrecoverableSystemException,
                               AgoSecurityException

Enumerate children of the given container.

Parameters:

options - flags

subtype - filter; specifies a particular subtype of children the caller is interested in

Returns:

an Enumeration where each element is a stat element whose subtype is 'subtype'.