com.opencloud.rhino.limiting

Interface LimiterManagementMBean

public interface LimiterManagementMBean

Defines the JMX interface used for managing the limiting sub-system.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_ID_PREFIX_RA_ENTITY
static String	ENDPOINT_ID_PREFIX_SERVICE_ENTITY
static String	MBEAN_NAME
static String	OBJECT_NAME The JMX Object Name of this MBean.
static String	RA_ENTITY_INPUT_ENDPOINT_NAME
static String	SYSTEM_INPUT_LIMITER_NAME

Method Summary

Modifier and Type	Method and Description
void	connectLimiterEndpoint(String limiterEndpointID, String limiterName) Connect a limiter to a limiter endpoint.
void	createLimiter(String type, String name) Create a limiter using the specified properties.
void	disconnectLimiterEndpoint(String limiterEndpointID) Disconnect a limiter from a limiter endpoint.
String	getHierarchySummary() Get a (multiline) string describing all limiter hierarchies and the connected endpoints.
String[]	getLimiterEndpoints() Get the set of endpoint IDs that identify all the endpoints in the SLEE.
TabularData	getLimiterEndpointsInfo() Returns a TabularData object containing two String columns: A "limiterendpoint" column containing the endpoint ID A "connected-limiter" column containing the name of the connected limiter, or null if the endpoint is not connected to a limiter This method operates only on limiter endpoints for the currently active namespace for the client connection.
String	getLimiterForEndpoint(String limiterEndpointID) Get the name of the limiter connected to the specified limiter endpoint This method operates only on limiter endpoints for the currently active namespace for the client connection.
ObjectName	getLimiterMBean(String name) Get the JMX ObjectName for a com.opencloud.rhino.limiting.LimiterMBean object for the specified limiter.
ObjectName	getLimiterRampUpMBean() Get the JMX ObjectName for a LimiterRampUpMBean object for the SystemInput limiter.
String[]	getLimiters() Get the set of limiter names that identify all the limiters in the SLEE.
ObjectName	getSystemInputLimiterMBean() Get the JMX ObjectName for a LimiterMBean object for the SystemInput limiter.
void	removeLimiter(String name) Remove a limiter.

Field Detail

ENDPOINT_ID_PREFIX_RA_ENTITY

static final String ENDPOINT_ID_PREFIX_RA_ENTITY

See Also:

Constant Field Values

ENDPOINT_ID_PREFIX_SERVICE_ENTITY

static final String ENDPOINT_ID_PREFIX_SERVICE_ENTITY

See Also:

Constant Field Values

MBEAN_NAME

static final String MBEAN_NAME

See Also:

Constant Field Values

RA_ENTITY_INPUT_ENDPOINT_NAME

static final String RA_ENTITY_INPUT_ENDPOINT_NAME

See Also:

Constant Field Values

SYSTEM_INPUT_LIMITER_NAME

static final String SYSTEM_INPUT_LIMITER_NAME

See Also:

Constant Field Values

OBJECT_NAME

static final String OBJECT_NAME

The JMX Object Name of this MBean.

See Also:

Constant Field Values

Method Detail

createLimiter

void createLimiter(String type,
                   String name)
            throws NullPointerException,
                   InvalidArgumentException,
                   ConfigurationException,
                   com.opencloud.util.exception.ValidationException,
                   LimitingManagementException

Create a limiter using the specified properties.

Parameters:

type - The type of the limiter to be created. Must be the name of a LimiterType constant.

name - The name of the limiter to be created

Throws:

NullPointerException

InvalidArgumentException

ConfigurationException

com.opencloud.util.exception.ValidationException

LimitingManagementException

removeLimiter

void removeLimiter(String name)
            throws NullPointerException,
                   InvalidArgumentException,
                   ConfigurationException,
                   LimitingManagementException

Remove a limiter.

Parameters:

name - The name of the limiter to be removed

Throws:

NullPointerException

InvalidArgumentException

ConfigurationException

LimitingManagementException

getLimiters

String[] getLimiters()
              throws ConfigurationException

Get the set of limiter names that identify all the limiters in the SLEE.

Returns:

an array of limiter names. An empty array is returned if there are no limiters.

Throws:

ConfigurationException

connectLimiterEndpoint

void connectLimiterEndpoint(String limiterEndpointID,
                            String limiterName)
                     throws NullPointerException,
                            InvalidArgumentException,
                            ConfigurationException,
                            ManagementException,
                            LimitingManagementException

Connect a limiter to a limiter endpoint.

This method operates only on limiter endpoints for the currently active namespace for the client connection. The appropriate namespace must therefore be selected before trying to manage any given limiter endpoint.

Parameters:

limiterEndpointID - The ID of the limiter endpoint to connect to

limiterName - The name of the limiter to be connected to the endpoint

Throws:

NullPointerException

InvalidArgumentException

ConfigurationException

ManagementException

LimitingManagementException

getLimiterForEndpoint

String getLimiterForEndpoint(String limiterEndpointID)
                      throws NullPointerException,
                             InvalidArgumentException,
                             ConfigurationException,
                             ManagementException

Get the name of the limiter connected to the specified limiter endpoint

This method operates only on limiter endpoints for the currently active namespace for the client connection. The appropriate namespace must therefore be selected before trying to manage any given limiter endpoint.

Parameters:

limiterEndpointID - The ID of the limiter endpoint

Returns:

The name of the limiter the endpoint is connected to (or null if it is not connected).

Throws:

NullPointerException

InvalidArgumentException

ConfigurationException

ManagementException

disconnectLimiterEndpoint

void disconnectLimiterEndpoint(String limiterEndpointID)
                        throws NullPointerException,
                               InvalidArgumentException,
                               ConfigurationException,
                               LimitingManagementException,
                               ManagementException

Disconnect a limiter from a limiter endpoint.

This method operates only on limiter endpoints for the currently active namespace for the client connection. The appropriate namespace must therefore be selected before trying to manage any given limiter endpoint.

Parameters:

limiterEndpointID - The ID of the limiter endpoint

Throws:

NullPointerException

InvalidArgumentException

ConfigurationException

LimitingManagementException

ManagementException

getLimiterEndpoints

String[] getLimiterEndpoints()
                      throws ConfigurationException,
                             ManagementException

Get the set of endpoint IDs that identify all the endpoints in the SLEE.

This method operates only on limiter endpoints for the currently active namespace for the client connection. The appropriate namespace must therefore be selected before trying to query limiter endpoints.

Returns:

an array of endpoint IDs. An empty array is returned if there are no endpoints.

Throws:

ConfigurationException

ManagementException

getLimiterEndpointsInfo

TabularData getLimiterEndpointsInfo()
                             throws ConfigurationException,
                                    ManagementException

Returns a TabularData object containing two String columns:

• A "limiterendpoint" column containing the endpoint ID

• A "connected-limiter" column containing the name of the connected limiter, or null if the endpoint is not connected to a limiter

This method operates only on limiter endpoints for the currently active namespace for the client connection. The appropriate namespace must therefore be selected before trying to query limiter endpoints.

Throws:

ConfigurationException

ManagementException

getLimiterMBean

ObjectName getLimiterMBean(String name)
                    throws NullPointerException,
                           InvalidArgumentException,
                           ConfigurationException,
                           ManagementException

Get the JMX ObjectName for a com.opencloud.rhino.limiting.LimiterMBean object for the specified limiter.

Parameters:

name - The name of the limiter

Returns:

a JMX ObjectName for a LimiterMBean object for the specified limiter.

Throws:

NullPointerException

InvalidArgumentException

ConfigurationException

ManagementException

getSystemInputLimiterMBean

ObjectName getSystemInputLimiterMBean()
                               throws NullPointerException,
                                      InvalidArgumentException,
                                      ConfigurationException,
                                      ManagementException

Get the JMX ObjectName for a LimiterMBean object for the SystemInput limiter.

Returns:

a JMX ObjectName for a LimiterMBean object for the SystemInput limiter.

Throws:

NullPointerException

InvalidArgumentException

ConfigurationException

ManagementException

getLimiterRampUpMBean

ObjectName getLimiterRampUpMBean()
                          throws ConfigurationException,
                                 ManagementException

Get the JMX ObjectName for a LimiterRampUpMBean object for the SystemInput limiter.

Returns:

a JMX ObjectName for a LimiterRampUpMBean object for the SystemInput limiter.

Throws:

ConfigurationException

ManagementException

getHierarchySummary

String getHierarchySummary()
                    throws ConfigurationException,
                           ManagementException

Get a (multiline) string describing all limiter hierarchies and the connected endpoints. The returned String is intended for display purpose, e.g. for printing to a terminal.

Returns:

a (multiline) string describing all limiter hierarchies and the connected endpoints.

Throws:

ConfigurationException

ManagementException