public interface LimiterManagementMBean
Defines the JMX interface used for managing the limiting sub-system.
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 |
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. |
ObjectName |
getLimiterRampUpMBean(String name)
Get the JMX ObjectName for a
LimiterRampUpMBean object for the specified 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.
|
static final String ENDPOINT_ID_PREFIX_RA_ENTITY
static final String ENDPOINT_ID_PREFIX_SERVICE_ENTITY
static final String MBEAN_NAME
static final String RA_ENTITY_INPUT_ENDPOINT_NAME
static final String SYSTEM_INPUT_LIMITER_NAME
static final String OBJECT_NAME
The JMX Object Name of this MBean.
void createLimiter(String type, String name) throws NullPointerException, InvalidArgumentException, ConfigurationException, com.opencloud.util.exception.ValidationException, LimitingManagementException
Create a limiter using the specified properties.
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 createdNullPointerException
InvalidArgumentException
ConfigurationException
com.opencloud.util.exception.ValidationException
LimitingManagementException
void removeLimiter(String name) throws NullPointerException, InvalidArgumentException, ConfigurationException, LimitingManagementException
Remove a limiter.
name
- The name of the limiter to be removedNullPointerException
InvalidArgumentException
ConfigurationException
LimitingManagementException
String[] getLimiters() throws ConfigurationException
Get the set of limiter names that identify all the limiters in the SLEE.
ConfigurationException
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.
limiterEndpointID
- The ID of the limiter endpoint to connect tolimiterName
- The name of the limiter to be connected to the endpointNullPointerException
InvalidArgumentException
ConfigurationException
ManagementException
LimitingManagementException
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.
limiterEndpointID
- The ID of the limiter endpointNullPointerException
InvalidArgumentException
ConfigurationException
ManagementException
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.
limiterEndpointID
- The ID of the limiter endpointNullPointerException
InvalidArgumentException
ConfigurationException
LimitingManagementException
ManagementException
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.
ConfigurationException
ManagementException
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.
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.
name
- The name of the limiterLimiterMBean
object for the specified limiter.NullPointerException
InvalidArgumentException
ConfigurationException
ManagementException
ObjectName getSystemInputLimiterMBean() throws NullPointerException, InvalidArgumentException, ConfigurationException, ManagementException
Get the JMX ObjectName for a LimiterMBean
object for the SystemInput limiter.
LimiterMBean
object for the SystemInput limiter.NullPointerException
InvalidArgumentException
ConfigurationException
ManagementException
ObjectName getLimiterRampUpMBean() throws ConfigurationException, ManagementException
Get the JMX ObjectName for a LimiterRampUpMBean
object for the SystemInput limiter.
LimiterRampUpMBean
object for the SystemInput limiter.ConfigurationException
ManagementException
ObjectName getLimiterRampUpMBean(String name) throws InvalidArgumentException, ConfigurationException, ManagementException
Get the JMX ObjectName for a LimiterRampUpMBean
object for the specified limiter.
LimiterRampUpMBean
object for the specified limiter.ConfigurationException
ManagementException
InvalidArgumentException
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.
ConfigurationException
ManagementException