Package com.opencloud.rhino.monitoring.stats

Interface ResourceAdaptorStatsManager

public interface ResourceAdaptorStatsManager

StatsManager facilities available to resource adaptors

Field Summary

Fields

Modifier and Type	Field	Description
static String	CONFIG_PROPERTY_NAME

Method Summary

Modifier and Type	Method	Description
ParameterSet	getOrCreateParameterSet(ParameterSet parent, String name)	Get a child parameter set of the specified parent.
ParameterSet	getOrCreateParameterSet(ParameterSet parent, String name, String type)	Get a child parameter set for the specified parent.
ParameterSet	getRootParameterSet()	Get the root parameter set for the resource adaptor entity.
void	removeParameterSet(ParameterSet paramSet)	Remove a parameter set.

Field Detail

CONFIG_PROPERTY_NAME

static final String CONFIG_PROPERTY_NAME

See Also:

Constant Field Values

Method Detail

getRootParameterSet

ParameterSet getRootParameterSet()

Get the root parameter set for the resource adaptor entity.

Returns:

the root parameter set.

getOrCreateParameterSet

ParameterSet getOrCreateParameterSet(ParameterSet parent,
                                     String name)
                              throws NullPointerException,
                                     IllegalArgumentException,
                                     SLEEException

Get a child parameter set of the specified parent. If no such parameter set exists one will be created with the same parameter set type as the parent.

This is a non-transactional method.

Parameters:

parent - the parent parameter set.

name - the name of the child parameter set.

Returns:

a stats parameter set.

Throws:

NullPointerException - if parent or name is null.

IllegalArgumentException - if parent is not a parameter set created for the resource adaptor entity.

SLEEException - if a system-level failure occurs.

getOrCreateParameterSet

ParameterSet getOrCreateParameterSet(ParameterSet parent,
                                     String name,
                                     String type)
                              throws NullPointerException,
                                     UnknownStatsParameterSetException,
                                     UnknownStatsParameterTypeException,
                                     SLEEException

Get a child parameter set for the specified parent. If no such parameter set exists one will be created.

This is a non-transactional method.

Parameters:

parent - the parent parameter set.

name - the name of the child parameter set.

type - the type of the parameter set. The type must have been defined by the resource adaptor in its deployment descriptor.

Returns:

a stats parameter set.

Throws:

NullPointerException - if parent or name is null.

UnknownStatsParameterSetException - if parent is not a parameter set created for the resource adaptor entity.

UnknownStatsParameterTypeException - if type is not a stats parameter set type defined by the resource adaptor.

SLEEException - if a system-level failure occurs.

Since:

Rhino 1.4.5

removeParameterSet

void removeParameterSet(ParameterSet paramSet)
                 throws NullPointerException,
                        UnknownStatsParameterSetException,
                        SLEEException

Remove a parameter set. All child parameter sets of the specified parameter set are also removed. The root parameter set cannot be removed.

This is a non-transactional method.

Parameters:

paramSet - the parameter set to remove.

Throws:

NullPointerException - if paramSet is null.

UnknownStatsParameterSetException - if the specified parameter set is not a child of the root parameter set.

SLEEException - if a system-level failure occurs.

Since:

Rhino 1.4.5