Index (Rhino 2.5 Rate Limiting API)

C D E F G I L M O Q R S T U V

C

com.opencloud.rhino.configmanager.exceptions - package com.opencloud.rhino.configmanager.exceptions
com.opencloud.rhino.limiting - package com.opencloud.rhino.limiting
ConfigurationException - Exception in com.opencloud.rhino.configmanager.exceptions
ConfigurationException() - Constructor for exception com.opencloud.rhino.configmanager.exceptions.ConfigurationException
ConfigurationException(String) - Constructor for exception com.opencloud.rhino.configmanager.exceptions.ConfigurationException
ConfigurationException(String, Throwable) - Constructor for exception com.opencloud.rhino.configmanager.exceptions.ConfigurationException
ConfigurationException(Throwable) - Constructor for exception com.opencloud.rhino.configmanager.exceptions.ConfigurationException
connectLimiterEndpoint(String, String) - Method in interface com.opencloud.rhino.limiting.LimiterManagementMBean: Connect a limiter to a limiter endpoint.
createIDForRAEntity(String, String) - Static method in class com.opencloud.rhino.limiting.EndpointIDUtil
createIDForService(ServiceID, SbbID, String) - Static method in class com.opencloud.rhino.limiting.EndpointIDUtil
createLimiter(String, String) - Method in interface com.opencloud.rhino.limiting.LimiterManagementMBean: Create a limiter using the specified properties.

D

disableRampUp() - Method in interface com.opencloud.rhino.limiting.LimiterRampUpMBean: Disable incremental growth in the allowed rate of the SystemInput limiter and set the allowed rate to the maximum rate.
disconnectLimiterEndpoint(String) - Method in interface com.opencloud.rhino.limiting.LimiterManagementMBean: Disconnect a limiter from a limiter endpoint.

E

enableRampUp(double, double, int) - Method in interface com.opencloud.rhino.limiting.LimiterRampUpMBean: Enable incremental growth in the allowed rate of the SystemInput limiter (Tip: ramp up will only be effective when the "SystemInput" limiter is not bypassed)
ENDPOINT_ID_PREFIX_RA_ENTITY - Static variable in interface com.opencloud.rhino.limiting.LimiterManagementMBean
ENDPOINT_ID_PREFIX_SERVICE_ENTITY - Static variable in interface com.opencloud.rhino.limiting.LimiterManagementMBean
EndpointIDUtil - Class in com.opencloud.rhino.limiting
EndpointIDUtil() - Constructor for class com.opencloud.rhino.limiting.EndpointIDUtil

F

forceUseUnit() - Method in interface com.opencloud.rhino.limiting.RateLimiterEndpoint: Consumes one unit of work.
forceUseUnits(int) - Method in interface com.opencloud.rhino.limiting.RateLimiterEndpoint: Consumes the given number of units of work.

G

getChildLimiters() - Method in interface com.opencloud.rhino.limiting.LimiterMBean: Get the names of all limiters for which this limiter is their parent.
getConfigSummary() - Method in interface com.opencloud.rhino.limiting.LimiterMBean: Get the default and per node configuration values stored for this limiter.
getConnectedEndPoints() - Method in interface com.opencloud.rhino.limiting.LimiterMBean: Get the IDs of the limiter endpoints connected to this limiter.
getDepthDefault() - Method in interface com.opencloud.rhino.limiting.RateLimiterMBean: Get the default "depth" of this limiter (depth is the number of time units' worth of work capacity can be stored by the rate limiter).
getDepthForNode(int[]) - Method in interface com.opencloud.rhino.limiting.RateLimiterMBean: Get the per-node "depth" of this limiter on the specified nodes (depth is the number of time units' worth of work capacity can be stored by the rate limiter).
getEventsPerIncrement() - Method in interface com.opencloud.rhino.limiting.LimiterRampUpMBean: Get the number of events which must be processed before Rhino will add "RateIncrement" to the allowed rate.
getHierarchySummary() - Method in interface com.opencloud.rhino.limiting.LimiterManagementMBean: Get a (multiline) string describing all limiter hierarchies and the connected endpoints.
getImplType() - Method in enum com.opencloud.rhino.limiting.LimiterEndpointType: Get the interface implemented by limiter endpoints of this type.
getInfoSummary(int[]) - Method in interface com.opencloud.rhino.limiting.LimiterMBean: Get a summary of the configuration of this limiter on the specified nodes (as derived from default and per node settings).
getLimiterEndpoints() - Method in interface com.opencloud.rhino.limiting.LimiterManagementMBean: Get the set of endpoint IDs that identify all the endpoints in the SLEE.
getLimiterEndpointsInfo() - Method in interface com.opencloud.rhino.limiting.LimiterManagementMBean: 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
getLimiterForEndpoint(String) - Method in interface com.opencloud.rhino.limiting.LimiterManagementMBean: Get the name of the limiter connected to the specified limiter endpoint
getLimiterMBean(String) - Method in interface com.opencloud.rhino.limiting.LimiterManagementMBean: Get the JMX ObjectName for a com.opencloud.rhino.limiting.LimiterMBean object for the specified limiter.
getLimiterRampUpMBean() - Method in interface com.opencloud.rhino.limiting.LimiterManagementMBean: Get the JMX ObjectName for a LimiterRampUpMBean object for the SystemInput limiter.
getLimiters() - Method in interface com.opencloud.rhino.limiting.LimiterManagementMBean: Get the set of limiter names that identify all the limiters in the SLEE.
getMaxRateDefault() - Method in interface com.opencloud.rhino.limiting.RateLimiterMBean: Get the default maximum number of units which can be consumed per time unit by this limiter, eg "100" for a rate of 100 per second.
getMaxRateForNode(int[]) - Method in interface com.opencloud.rhino.limiting.RateLimiterMBean: Get the per-node maximum number of units which can be consumed per time unit by this limiter on the specified nodes, eg "100" for a rate of 100 per second.
getMaxSaturationDefault() - Method in interface com.opencloud.rhino.limiting.QueueSaturationLimiterMBean: Get the default maximum amount of saturation allowed in the queue, as a percentage, before this limiter will reject work.
getMaxSaturationForNode(int[]) - Method in interface com.opencloud.rhino.limiting.QueueSaturationLimiterMBean: Get the per-node maximum amount of saturation allowed in the queue on the specified nodes, as a percentage, before this limiter will reject work.
getMillisecondsPerUnit() - Method in enum com.opencloud.rhino.limiting.TimeUnit
getName() - Method in interface com.opencloud.rhino.limiting.LimiterMBean: Get the name of this limiter.
getParent() - Method in interface com.opencloud.rhino.limiting.LimiterMBean: Get the name of the parent of this limiter (or null if no parent is set).
getRateIncrement() - Method in interface com.opencloud.rhino.limiting.LimiterRampUpMBean: Get the amount added to the allowed rate if Rhino is successfully processing work.
getStartRate() - Method in interface com.opencloud.rhino.limiting.LimiterRampUpMBean: Get the initial rate allowed by the SystemInput limiter.
getSystemInputLimiterMBean() - Method in interface com.opencloud.rhino.limiting.LimiterManagementMBean: Get the JMX ObjectName for a LimiterMBean object for the SystemInput limiter.
getTimeUnit() - Method in interface com.opencloud.rhino.limiting.RateLimiterMBean: Get the type of time unit to be used by this limiter when setting the rate, eg the "seconds" in a rate of 100 per second.
getType() - Method in interface com.opencloud.rhino.limiting.LimiterMBean: Get the type of this limiter.

I

isBypassedDefault() - Method in interface com.opencloud.rhino.limiting.LimiterMBean: Get the default "bypassed" property for this limiter (if bypassed is true this limiter will delegate all decisions to its parent or if the is no parent will allow all useUnit/s()).
isBypassedForNode(int[]) - Method in interface com.opencloud.rhino.limiting.LimiterMBean: Get the per-node "bypassed" property for this limiter on the specified nodes (if bypassed is true this limiter will delegate all decisions to its parent or if the is no parent will allow all useUnit/s()).
isEnabled() - Method in interface com.opencloud.rhino.limiting.LimiterRampUpMBean: Test if the ramp up is enabled.

L

LimiterEndpoint - Interface in com.opencloud.rhino.limiting: Marker interface for all types of limiter endpoint.
LimiterEndpointType - Enum in com.opencloud.rhino.limiting
LimiterManagementMBean - Interface in com.opencloud.rhino.limiting: Defines the JMX interface used for managing the limiting sub-system.
LimiterMBean - Interface in com.opencloud.rhino.limiting: Defines the base JMX interface for controlling a single limiter.
LimiterRampUpMBean - Interface in com.opencloud.rhino.limiting: The LimiterRampUpMBean interface provides methods to configure ramp up of the "SystemInput" limiter.
LimiterType - Enum in com.opencloud.rhino.limiting
LimitingManagementException - Exception in com.opencloud.rhino.limiting: Exception type thrown by the limiting management MBeans for admin operations which are invalid.
LimitingManagementException(String, Throwable) - Constructor for exception com.opencloud.rhino.limiting.LimitingManagementException
LimitingManagementException(String) - Constructor for exception com.opencloud.rhino.limiting.LimitingManagementException

M

MBEAN_NAME - Static variable in interface com.opencloud.rhino.limiting.LimiterManagementMBean

O

OBJECT_NAME - Static variable in interface com.opencloud.rhino.limiting.LimiterManagementMBean: The JMX Object Name of this MBean.

Q

QueueSaturationLimiterMBean - Interface in com.opencloud.rhino.limiting: Defines the JMX interface for controlling a single queue saturation limiter.

R

RA_ENTITY_INPUT_ENDPOINT_NAME - Static variable in interface com.opencloud.rhino.limiting.LimiterManagementMBean
RateLimiterEndpoint - Interface in com.opencloud.rhino.limiting: A limiter endpoint that can be (administratively) connected to a Rate Limiter or a Queue Saturation Limiter.
RateLimiterMBean - Interface in com.opencloud.rhino.limiting: Defines the JMX interface for controlling a single rate limiter.
removeLimiter(String) - Method in interface com.opencloud.rhino.limiting.LimiterManagementMBean: Remove a limiter.

S

setBypassedDefault(boolean) - Method in interface com.opencloud.rhino.limiting.LimiterMBean: Set the default "bypassed" property for this limiter (if bypassed is true this limiter will delegate all decisions to its parent or if the is no parent will allow all useUnit/s()).
setBypassedForNode(boolean[], int[]) - Method in interface com.opencloud.rhino.limiting.LimiterMBean: Set the per-node "bypassed" property for this limiter on the specified nodes (if bypassed is true this limiter will delegate all decisions to its parent or if the is no parent will allow all useUnit/s()).
setDepthDefault(double) - Method in interface com.opencloud.rhino.limiting.RateLimiterMBean: Set the default "depth" of this limiter (depth is the number of time units' worth of work capacity can be stored by the rate limiter).
setDepthForNode(double[], int[]) - Method in interface com.opencloud.rhino.limiting.RateLimiterMBean: Set the per-node "depth" of this limiter on the specified nodes (depth is the number of time units' worth of work capacity can be stored by the rate limiter).
setMaxRateDefault(double) - Method in interface com.opencloud.rhino.limiting.RateLimiterMBean: Set the default maximum number of units which can be consumed per time unit by this limiter, eg "100" for a rate of 100 per second.
setMaxRateForNode(double[], int[]) - Method in interface com.opencloud.rhino.limiting.RateLimiterMBean: Set the per-node maximum number of units which can be consumed per time unit by this limiter on the specified nodes, eg "100" for a rate of 100 per second.
setMaxSaturationDefault(double) - Method in interface com.opencloud.rhino.limiting.QueueSaturationLimiterMBean: Set the default maximum amount of saturation allowed in the queue, as a percentage, before this limiter will reject work (the range of valid values is from "0" to "100").
setMaxSaturationForNode(double[], int[]) - Method in interface com.opencloud.rhino.limiting.QueueSaturationLimiterMBean: Set the per-node maximum amount of saturation allowed in the queue on the specified nodes, as a percentage, before this limiter will reject work (the range of valid values is from "0" to "100").
setParent(String) - Method in interface com.opencloud.rhino.limiting.LimiterMBean: Set the specified limiter as the parent of this limiter.
setTimeUnit(String) - Method in interface com.opencloud.rhino.limiting.RateLimiterMBean: Set the type of time unit to be used by this limiter when setting the rate, eg the "seconds" in a rate of 100 per second.
SYSTEM_INPUT_LIMITER_NAME - Static variable in interface com.opencloud.rhino.limiting.LimiterManagementMBean

T

TimeUnit - Enum in com.opencloud.rhino.limiting: An emumeration of time units, used when setting a limiter's rate.

U

useDefaultConfig(int[]) - Method in interface com.opencloud.rhino.limiting.LimiterMBean: Removes any node specific configuration settings for the limiter on the given node(s), causing the nodes to use the cluster wide settings.
useUnit() - Method in interface com.opencloud.rhino.limiting.RateLimiterEndpoint: Requests one unit of work.
useUnits(int) - Method in interface com.opencloud.rhino.limiting.RateLimiterEndpoint: Requests the given number of units of work.

V

valueOf(String) - Static method in enum com.opencloud.rhino.limiting.LimiterEndpointType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.opencloud.rhino.limiting.LimiterType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.opencloud.rhino.limiting.TimeUnit: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.opencloud.rhino.limiting.LimiterEndpointType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.opencloud.rhino.limiting.LimiterType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.opencloud.rhino.limiting.TimeUnit: Returns an array containing the constants of this enum type, in the order they are declared.

C D E F G I L M O Q R S T U V