org.ow2.cmi.admin
Interface CMIAdminMBean

public interface CMIAdminMBean

Definition of a MBean to monitor managers of cluster view. In the case of a manager at server-side, we can also configure it with this MBean.

Author:

The new CMI team

Method Summary

void	addPooltoEmpty(java.lang.String objectName) Adds the pool of the object with the given name of the list of pool that should be empty.
void	addServerToBlackList(java.lang.String serverName) Adds a server to the blacklist.
java.lang.String	getBusinessName(java.lang.String objectName) Returns the business interface name of an object bound with the given name (for ejb2 only).
java.lang.String	getClusterName(java.lang.String objectName) Returns the name of cluster for the object with the given name.
java.util.Set<java.lang.String>	getClusterNames() Returns the set of name of cluster.
java.lang.Integer	getDelayToRefresh() Returns the time between each update of the cluster view by clients.
java.lang.String	getItfName(java.lang.String objectName) Returns a name of interface of this object.
javax.management.remote.JMXServiceURL	getJMXServiceURL(java.lang.String protocolName)
java.util.Set<java.lang.String>	getListPropertiesNamesForPolicy(java.lang.String objectName) Returns the set of property names (for which value is a list) for the object with the given name.
java.util.List<java.lang.String>	getListPropertyForPolicy(java.lang.String objectName, java.lang.String propertyName) Returns the list of value of the property with the given name.
java.lang.Integer	getLoadFactor(java.lang.String serverRef) Returns the load-factor for the server with the given address.
java.lang.Integer	getMaxPoolSize(java.lang.String objectName) Returns the maximal size of pool of CMIReferenceable for a object with the given name.
java.lang.Integer	getMaxPoolWaiters(java.lang.String objectName) Returns the waiters of pool of CMIReferenceable for a object with the given name.
java.lang.Integer	getMinPoolSize(java.lang.String objectName) Returns the minimal size of pool of CMIReferenceable for a object with the given name.
java.lang.Integer	getNbClientsConnectedToProvider()
javax.management.ObjectName	getObjectName() Returns the ObjectName binded in the MBean Server.
java.util.Set<java.lang.String>	getObjectNames()
java.util.Set<java.lang.String>	getObjectNames(java.lang.String clusterName) Returns the set of object names included in the given cluster.
java.lang.String	getPolicyClassName(java.lang.String objectName) Returns the name of class of policy for the object with the given name.
java.lang.Long	getPoolTimeout(java.lang.String objectName) Returns the pool timeout of CMIReferenceable for a object with the given name.
java.util.Set<java.lang.String>	getPropertiesNamesForPolicy(java.lang.String objectName) Returns the set of property names for the object with the given name.
java.lang.String	getPropertyForPolicy(java.lang.String objectName, java.lang.String propertyName) Returns the value of the property with the given name, from a policy instance associated to the object instance.
java.util.Set<java.lang.String>	getProtocols()
java.lang.String	getRefOnLocalRegistry(java.lang.String protocolName)
java.util.Set<java.lang.String>	getServerObjectsForProtocol(java.lang.String serverUrl, java.lang.String protocolName) Gets objects hosted on a given server started with a given protocol.
java.util.List<java.lang.String>	getServerRefs(java.lang.String objectName) Returns a list of String representing a ServerRef for an object with the given name.
java.util.List<java.lang.String>	getServerRefs(java.lang.String objectName, java.lang.String protocolName) Returns a list of String representing a ServerRef for an object with the given name and protocol.
java.util.Set<java.lang.String>	getServerRefsForProtocol(java.lang.String protocolName)
java.lang.Object	getStaticPropertyForPolicy(java.lang.String objectName, java.lang.String propertyName) Returns the value of the property with the given name, retrieved from clustering metadatas.
java.lang.String	getStrategyClassName(java.lang.String objectName) Returns the name of class of strategy for the object with the given name.
boolean	isPoolToEmpty(java.lang.String objectName) Returns true if the pool for object with the given name should be empty.
boolean	isReplicated(java.lang.String objectName)
boolean	isServerBlackListed(java.lang.String serverName) Returns true the server with the given reference if blacklisted.
void	removePoolToEmpty(java.lang.String objectName) Removes the pool of the object with the given name of the list of pool that should be empty.
void	removeServerFromBlackList(java.lang.String serverName) Removes a server from the blacklist.
java.util.Map<java.lang.String,java.util.Set<java.lang.String>>	retrieveAvailablePoliciesAndStrategies() Gets available load balancing policies and strategies.
void	setAlgorithmForPolicy(java.lang.String objectName, java.lang.String policyClassName, java.lang.String strategyClassName, java.util.Map<java.lang.String,java.lang.Object> properties) Sets the algorithm of load-balancing for the object with the given name.
void	setDelayToRefresh(java.lang.Integer delay) Sets the time between each update of the cluster view by clients.
void	setListPropertyForPolicy(java.lang.String objectName, java.lang.String propertyName, java.util.List<java.lang.String> propertyValues) Sets a property for a given object.
void	setLoadFactor(java.lang.String serverRef, java.lang.String loadFactor) Sets the load-factor for the server with the given address.
void	setMaxPoolSize(java.lang.String objectName, java.lang.Integer maxPoolSize) Sets the maximal size of pool of CMIReferenceable for a object with the given name.
void	setMaxPoolWaiters(java.lang.String objectName, java.lang.Integer maxPoolWaiters) Sets the max waiters of pool of CMIReferenceable for a object with the given name.
void	setMinPoolSize(java.lang.String objectName, java.lang.Integer minPoolSize) Sets the minimal size of pool of CMIReferenceable for a object with the given name.
void	setPolicyClassName(java.lang.String objectName, java.lang.String policyClassName) Sets a new policy for a given object.
void	setPoolTimeout(java.lang.String objectName, java.lang.Long poolTimeout) Sets the pool timeout of CMIReferenceable for a object with the given name.
void	setPropertiesForPolicy(java.lang.String objectName, java.util.Map<java.lang.String,java.lang.Object> properties) Sets the properties for a given object.
void	setPropertyForPolicy(java.lang.String objectName, java.lang.String propertyName, java.lang.String propertyValue) Sets a property for a given object.
void	setStaticPropertyForPolicy(java.lang.String objectName, java.lang.String propertyName, java.lang.String propertyValue) Sets a property on policy class of a given object(not object instance).
void	setStrategyClassName(java.lang.String objectName, java.lang.String strategyClassName) Sets a new strategy for a given object.

Method Detail

getObjectName

javax.management.ObjectName getObjectName()

Returns the ObjectName binded in the MBean Server.

Returns:

the ObjectName binded in the MBean Server

getJMXServiceURL

javax.management.remote.JMXServiceURL getJMXServiceURL(java.lang.String protocolName)
                                                       throws java.lang.IllegalArgumentException,
                                                              java.lang.UnsupportedOperationException

Parameters:

protocolName - a name of protocol

Returns:

the JMX service URL to access to this MBean

Throws:

java.lang.IllegalArgumentException - if no object is bound with the given name

java.lang.UnsupportedOperationException - if the used manager is at client-side

getProtocols

java.util.Set<java.lang.String> getProtocols()

Returns:

the protocols registered in the manager

getRefOnLocalRegistry

java.lang.String getRefOnLocalRegistry(java.lang.String protocolName)
                                       throws java.lang.IllegalArgumentException,
                                              java.lang.UnsupportedOperationException

Parameters:

protocolName - a name of protocol

Returns:

the reference on the local registry for the given protocol

Throws:

java.lang.IllegalArgumentException - if the given protocol name doesn't exist

java.lang.UnsupportedOperationException - if the used manager is at client-side

getItfName

java.lang.String getItfName(java.lang.String objectName)
                            throws java.lang.IllegalArgumentException,
                                   java.lang.UnsupportedOperationException

Returns a name of interface of this object.

Parameters:

objectName - a name of object

Returns:

a name of interface of this object

Throws:

java.lang.IllegalArgumentException - if no object is bound with the given name

java.lang.UnsupportedOperationException - if the used manager is at client-side

getBusinessName

java.lang.String getBusinessName(java.lang.String objectName)
                                 throws java.lang.IllegalArgumentException,
                                        java.lang.UnsupportedOperationException

Returns the business interface name of an object bound with the given name (for ejb2 only). If the object is not an ejb2, null is returned.

Parameters:

objectName - a name of object

Returns:

the business interface name of an object bound with the given name

Throws:

java.lang.IllegalArgumentException - if none object has the given name

java.lang.UnsupportedOperationException - if the used manager is at client-side

isReplicated

boolean isReplicated(java.lang.String objectName)
                     throws java.lang.IllegalArgumentException

Parameters:

objectName - a name of object

Returns:

true if the object with the given name is replicated

Throws:

java.lang.IllegalArgumentException - if none object has the given name

getServerRefsForProtocol

java.util.Set<java.lang.String> getServerRefsForProtocol(java.lang.String protocolName)
                                                         throws java.lang.IllegalArgumentException,
                                                                java.lang.UnsupportedOperationException

Parameters:

protocolName - a name of protocol

Returns:

the set of references on server connected to this server

Throws:

java.lang.IllegalArgumentException - if the given protocol name doesn't exist

java.lang.UnsupportedOperationException - if the used manager is at client-side

getObjectNames

java.util.Set<java.lang.String> getObjectNames()

Returns:

the set of clustered object names

getPolicyClassName

java.lang.String getPolicyClassName(java.lang.String objectName)
                                    throws java.lang.IllegalArgumentException

Returns the name of class of policy for the object with the given name.

Parameters:

objectName - name of the object

Returns:

the name of class of policy for the object with the given name

Throws:

java.lang.IllegalArgumentException - if none object has the given name

setPolicyClassName

void setPolicyClassName(java.lang.String objectName,
                        java.lang.String policyClassName)
                        throws java.lang.IllegalArgumentException,
                               java.lang.UnsupportedOperationException,
                               java.lang.ClassNotFoundException

Sets a new policy for a given object.

Parameters:

objectName - a name of object

policyClassName - a name of class of policy

Throws:

java.lang.IllegalArgumentException - if none object has the given name

java.lang.UnsupportedOperationException - if the used manager is at client-side

java.lang.ClassNotFoundException - if the class is missing

getStrategyClassName

java.lang.String getStrategyClassName(java.lang.String objectName)
                                      throws java.lang.IllegalArgumentException

Returns the name of class of strategy for the object with the given name.

Parameters:

objectName - name of the object

Returns:

the name of class of strategy for the object with the given name

Throws:

java.lang.IllegalArgumentException - if none object has the given name

setStrategyClassName

void setStrategyClassName(java.lang.String objectName,
                          java.lang.String strategyClassName)
                          throws java.lang.IllegalArgumentException,
                                 java.lang.UnsupportedOperationException,
                                 java.lang.ClassNotFoundException

Sets a new strategy for a given object.

Parameters:

objectName - a name of object

strategyClassName - a name of class of strategy

Throws:

java.lang.IllegalArgumentException - if none object has the given name

java.lang.UnsupportedOperationException - if the used manager is at client-side

java.lang.ClassNotFoundException - if the class is missing

getPropertiesNamesForPolicy

java.util.Set<java.lang.String> getPropertiesNamesForPolicy(java.lang.String objectName)
                                                            throws java.lang.IllegalArgumentException

Returns the set of property names for the object with the given name.

Parameters:

objectName - a name of object

Returns:

the set of property names for the object with the given name

Throws:

java.lang.IllegalArgumentException - if none object has the given name

getListPropertiesNamesForPolicy

java.util.Set<java.lang.String> getListPropertiesNamesForPolicy(java.lang.String objectName)
                                                                throws java.lang.IllegalArgumentException

Returns the set of property names (for which value is a list) for the object with the given name.

Parameters:

objectName - a name of object

Returns:

the set of property names for the object with the given name

Throws:

java.lang.IllegalArgumentException - if none object has the given name

getPropertyForPolicy

java.lang.String getPropertyForPolicy(java.lang.String objectName,
                                      java.lang.String propertyName)
                                      throws java.lang.IllegalArgumentException

Returns the value of the property with the given name, from a policy instance associated to the object instance.

Parameters:

objectName - a name of object

propertyName - a name of property

Returns:

the value of the property with the given name, or null if there is not property for this name

Throws:

java.lang.IllegalArgumentException - if none object has the given name, or if the value is a list

getStaticPropertyForPolicy

java.lang.Object getStaticPropertyForPolicy(java.lang.String objectName,
                                            java.lang.String propertyName)
                                            throws javax.management.JMRuntimeException,
                                                   java.lang.UnsupportedOperationException

Returns the value of the property with the given name, retrieved from clustering metadatas.

Parameters:

objectName - a name of object

propertyName - a name of property

Returns:

the value of the property with the given name, or null if there is not property for this name

Throws:

javax.management.JMRuntimeException - if any other exception occurs.

java.lang.UnsupportedOperationException - if operation is not supported.

getListPropertyForPolicy

java.util.List<java.lang.String> getListPropertyForPolicy(java.lang.String objectName,
                                                          java.lang.String propertyName)
                                                          throws java.lang.IllegalArgumentException

Returns the list of value of the property with the given name.

Parameters:

objectName - a name of object

propertyName - a name of property

Returns:

the list of value of the property with the given name, or null if there is not property for this name

Throws:

java.lang.IllegalArgumentException - if none object has the given name, or if the value is not a list

setPropertyForPolicy

void setPropertyForPolicy(java.lang.String objectName,
                          java.lang.String propertyName,
                          java.lang.String propertyValue)
                          throws javax.management.JMRuntimeException,
                                 java.lang.UnsupportedOperationException

Sets a property for a given object. A property is either a String or a list of String.

Parameters:

objectName - a name of object

propertyName - a name of property

propertyValue - a value for the given name of property

Throws:

java.lang.IllegalArgumentException - if none object has the given name, or if the property doesn't exist or has an invalid type

java.lang.UnsupportedOperationException - if the used manager is at client-side

javax.management.JMRuntimeException

setStaticPropertyForPolicy

void setStaticPropertyForPolicy(java.lang.String objectName,
                                java.lang.String propertyName,
                                java.lang.String propertyValue)
                                throws java.lang.IllegalArgumentException,
                                       java.lang.UnsupportedOperationException

Sets a property on policy class of a given object(not object instance). A property is either a String or a list of String.

Parameters:

objectName - a name of object

propertyName - a name of property

propertyValue - a value for the given name of property

Throws:

java.lang.IllegalArgumentException - if none object has the given name, or if the property doesn't exist or has an invalid type

java.lang.UnsupportedOperationException - if the used manager is at client-side

setListPropertyForPolicy

void setListPropertyForPolicy(java.lang.String objectName,
                              java.lang.String propertyName,
                              java.util.List<java.lang.String> propertyValues)
                              throws java.lang.IllegalArgumentException,
                                     java.lang.UnsupportedOperationException

Sets a property for a given object. A property is either a String or a list of String.

Parameters:

objectName - a name of object

propertyName - a name of property

propertyValues - a list of value for the given name of property

Throws:

java.lang.IllegalArgumentException - if none object has the given name, or if the property doesn't exist or has an invalid type

java.lang.UnsupportedOperationException - if the used manager is at client-side

setPropertiesForPolicy

void setPropertiesForPolicy(java.lang.String objectName,
                            java.util.Map<java.lang.String,java.lang.Object> properties)
                            throws java.lang.IllegalArgumentException,
                                   java.lang.UnsupportedOperationException

Sets the properties for a given object. A property is either a String or a list of String.

Parameters:

objectName - a name of object

properties - properties a set of properties

Throws:

java.lang.IllegalArgumentException - if none object has the given name, or if a property doesn't exist or has an invalid type

java.lang.UnsupportedOperationException - if the used manager is at client-side

setAlgorithmForPolicy

void setAlgorithmForPolicy(java.lang.String objectName,
                           java.lang.String policyClassName,
                           java.lang.String strategyClassName,
                           java.util.Map<java.lang.String,java.lang.Object> properties)
                           throws java.lang.IllegalArgumentException,
                                  java.lang.UnsupportedOperationException,
                                  java.lang.ClassNotFoundException

Sets the algorithm of load-balancing for the object with the given name.

Parameters:

objectName - a name of object

policyClassName - a name of class of policy

strategyClassName - a name of class of strategy

properties - a set of properties

Throws:

java.lang.IllegalArgumentException - if none object has the given name, or if a property doesn't exist or has an invalid type

java.lang.UnsupportedOperationException - if the used manager is at client-side

java.lang.ClassNotFoundException - if the class is missing

getServerRefs

java.util.List<java.lang.String> getServerRefs(java.lang.String objectName,
                                               java.lang.String protocolName)
                                               throws java.lang.IllegalArgumentException

Returns a list of String representing a ServerRef for an object with the given name and protocol.

Parameters:

objectName - a name of object

protocolName - a name of protocol

Returns:

a list of String representing a ServerRef for an object with the given name and protocol

Throws:

java.lang.IllegalArgumentException - if none object has the given name

getServerRefs

java.util.List<java.lang.String> getServerRefs(java.lang.String objectName)
                                               throws java.lang.IllegalArgumentException,
                                                      java.lang.UnsupportedOperationException

Returns a list of String representing a ServerRef for an object with the given name.

Parameters:

objectName - a name of object

Returns:

a list of String representing a ServerRef for an object with the given name

Throws:

java.lang.IllegalArgumentException - if none object has the given name

java.lang.UnsupportedOperationException - if the used manager is at client-side

getClusterNames

java.util.Set<java.lang.String> getClusterNames()
                                                throws java.lang.UnsupportedOperationException

Returns the set of name of cluster.

Returns:

the set of name of cluster

Throws:

java.lang.UnsupportedOperationException - if the used manager is at client-side

getObjectNames

java.util.Set<java.lang.String> getObjectNames(java.lang.String clusterName)
                                               throws java.lang.UnsupportedOperationException,
                                                      java.lang.IllegalArgumentException

Returns the set of object names included in the given cluster.

Parameters:

clusterName - The cluster name

Returns:

a set of object names included in the given cluster

Throws:

java.lang.UnsupportedOperationException - if the used manager is at client-side

java.lang.IllegalArgumentException - if none cluster has the given name

getDelayToRefresh

java.lang.Integer getDelayToRefresh()

Returns the time between each update of the cluster view by clients.

Returns:

the time between each update of the cluster view by clients

setDelayToRefresh

void setDelayToRefresh(java.lang.Integer delay)
                       throws java.lang.UnsupportedOperationException

Sets the time between each update of the cluster view by clients.

Parameters:

delay - the time between each update of the cluster view by clients

Throws:

java.lang.UnsupportedOperationException - if the used manager is at client-side

getClusterName

java.lang.String getClusterName(java.lang.String objectName)
                                throws java.lang.IllegalArgumentException

Returns the name of cluster for the object with the given name.

Parameters:

objectName - a name of object

Returns:

the name of cluster for a object with the given name

Throws:

java.lang.IllegalArgumentException - if none object has the given name

getMinPoolSize

java.lang.Integer getMinPoolSize(java.lang.String objectName)
                                 throws java.lang.IllegalArgumentException

Returns the minimal size of pool of CMIReferenceable for a object with the given name.

Parameters:

objectName - a name of object

Returns:

the minimal size of pool of CMIReferenceable for a object with the given name

Throws:

java.lang.IllegalArgumentException - if none object has the given name

getMaxPoolSize

java.lang.Integer getMaxPoolSize(java.lang.String objectName)
                                 throws java.lang.IllegalArgumentException

Returns the maximal size of pool of CMIReferenceable for a object with the given name.

Parameters:

objectName - a name of object

Returns:

the maximal size of pool of CMIReferenceable for a object with the given name

Throws:

java.lang.IllegalArgumentException - if none object has the given name

setMinPoolSize

void setMinPoolSize(java.lang.String objectName,
                    java.lang.Integer minPoolSize)
                    throws java.lang.IllegalArgumentException,
                           java.lang.UnsupportedOperationException

Sets the minimal size of pool of CMIReferenceable for a object with the given name.

Parameters:

objectName - a name of object

minPoolSize - the minimal size of pool of CMIReferenceable for a object with the given name

Throws:

java.lang.IllegalArgumentException - if no object is bound with the given name

java.lang.UnsupportedOperationException - if the used manager is at client-side

setMaxPoolSize

void setMaxPoolSize(java.lang.String objectName,
                    java.lang.Integer maxPoolSize)
                    throws java.lang.IllegalArgumentException,
                           java.lang.UnsupportedOperationException

Sets the maximal size of pool of CMIReferenceable for a object with the given name.

Parameters:

objectName - a name of object

maxPoolSize - the maximal size of pool of CMIReferenceable for a object with the given name

Throws:

java.lang.IllegalArgumentException - if no object is bound with the given name

java.lang.UnsupportedOperationException - if the used manager is at client-side

setMaxPoolWaiters

void setMaxPoolWaiters(java.lang.String objectName,
                       java.lang.Integer maxPoolWaiters)
                       throws java.lang.IllegalArgumentException,
                              java.lang.UnsupportedOperationException

Sets the max waiters of pool of CMIReferenceable for a object with the given name.

Parameters:

objectName - a name of object

maxPoolWaiters - the max waiters of pool of CMIReferenceable for a object with the given name

Throws:

java.lang.IllegalArgumentException - if no object is bound with the given name

java.lang.UnsupportedOperationException - if the used manager is at client-side

getMaxPoolWaiters

java.lang.Integer getMaxPoolWaiters(java.lang.String objectName)
                                    throws java.lang.IllegalArgumentException

Returns the waiters of pool of CMIReferenceable for a object with the given name.

Parameters:

objectName - a name of object

Returns:

the maximal size of pool of CMIReferenceable for a object with the given name

Throws:

java.lang.IllegalArgumentException - if none object has the given name

setPoolTimeout

void setPoolTimeout(java.lang.String objectName,
                    java.lang.Long poolTimeout)
                    throws java.lang.IllegalArgumentException,
                           java.lang.UnsupportedOperationException

Sets the pool timeout of CMIReferenceable for a object with the given name.

Parameters:

objectName - a name of object

poolTimeout - the timeout of pool of CMIReferenceable for a object with the given name

Throws:

java.lang.IllegalArgumentException - if no object is bound with the given name

java.lang.UnsupportedOperationException - if the used manager is at client-side

getPoolTimeout

java.lang.Long getPoolTimeout(java.lang.String objectName)
                              throws java.lang.IllegalArgumentException

Returns the pool timeout of CMIReferenceable for a object with the given name.

Parameters:

objectName - a name of object

Returns:

the timeout of pool of CMIReferenceable for a object with the given name

Throws:

java.lang.IllegalArgumentException - if none object has the given name

addServerToBlackList

void addServerToBlackList(java.lang.String serverName)
                          throws java.lang.UnsupportedOperationException,
                                 java.net.MalformedURLException,
                                 java.net.UnknownHostException

Adds a server to the blacklist.

Parameters:

serverName - a reference on a server

Throws:

java.lang.UnsupportedOperationException - if the used manager is at client-side

java.net.MalformedURLException - if the URL is malformed

java.net.UnknownHostException - if the given host cannot be resolved

removeServerFromBlackList

void removeServerFromBlackList(java.lang.String serverName)
                               throws java.lang.UnsupportedOperationException,
                                      java.net.MalformedURLException,
                                      java.net.UnknownHostException

Removes a server from the blacklist.

Parameters:

serverName - a reference on a server

Throws:

java.lang.UnsupportedOperationException - if the used manager is at client-side

java.net.MalformedURLException - if the URL is malformed

java.net.UnknownHostException - if the given host cannot be resolved

isServerBlackListed

boolean isServerBlackListed(java.lang.String serverName)
                            throws java.lang.UnsupportedOperationException,
                                   java.net.MalformedURLException,
                                   java.net.UnknownHostException

Returns true the server with the given reference if blacklisted.

Parameters:

serverName - a reference on a server

Returns:

true the server with the given reference if blacklisted

Throws:

java.lang.UnsupportedOperationException - if the used manager is at client-side

java.net.MalformedURLException - if the URL is malformed

java.net.UnknownHostException - if the given host cannot be resolved

addPooltoEmpty

void addPooltoEmpty(java.lang.String objectName)
                    throws java.lang.IllegalArgumentException,
                           java.lang.UnsupportedOperationException

Adds the pool of the object with the given name of the list of pool that should be empty.

Parameters:

objectName - a name of object

Throws:

java.lang.IllegalArgumentException - if no object is bound with the given name

java.lang.UnsupportedOperationException - if the used manager is at client-side

removePoolToEmpty

void removePoolToEmpty(java.lang.String objectName)
                       throws java.lang.IllegalArgumentException,
                              java.lang.UnsupportedOperationException

Removes the pool of the object with the given name of the list of pool that should be empty.

Parameters:

objectName - a name of object

Throws:

java.lang.IllegalArgumentException - if no object is bound with the given name

java.lang.UnsupportedOperationException - if the used manager is at client-side

isPoolToEmpty

boolean isPoolToEmpty(java.lang.String objectName)
                      throws java.lang.IllegalArgumentException

Returns true if the pool for object with the given name should be empty.

Parameters:

objectName - a name of object

Returns:

true if the pool for object with the given name should be empty

Throws:

java.lang.IllegalArgumentException - if no object is bound with the given name

getLoadFactor

java.lang.Integer getLoadFactor(java.lang.String serverRef)
                                throws java.lang.IllegalArgumentException,
                                       java.net.MalformedURLException,
                                       java.net.UnknownHostException

Returns the load-factor for the server with the given address.

Parameters:

serverRef - a reference on a server

Returns:

the load-factor for the server with the given address

Throws:

java.lang.IllegalArgumentException - if none server has the given address

java.net.MalformedURLException - if the URL is malformed

java.net.UnknownHostException - if the given host cannot be resolved

setLoadFactor

void setLoadFactor(java.lang.String serverRef,
                   java.lang.String loadFactor)
                   throws java.lang.UnsupportedOperationException,
                          java.net.MalformedURLException,
                          java.net.UnknownHostException

Sets the load-factor for the server with the given address.

Parameters:

serverRef - a reference on a server

loadFactor - the load-factor for the server with the given address

Throws:

java.lang.UnsupportedOperationException - if the used manager is at client-side

java.net.MalformedURLException - if the URL is malformed

java.net.UnknownHostException - if the given host cannot be resolved

getNbClientsConnectedToProvider

java.lang.Integer getNbClientsConnectedToProvider()

Returns:

the numbers of clients connected to a provider of the cluster view

getServerObjectsForProtocol

java.util.Set<java.lang.String> getServerObjectsForProtocol(java.lang.String serverUrl,
                                                            java.lang.String protocolName)
                                                            throws java.lang.IllegalArgumentException,
                                                                   java.lang.UnsupportedOperationException

Gets objects hosted on a given server started with a given protocol.

Parameters:

serverUrl - a server reference

protocolName - a name of protocol

Returns:

set of objects hosted on the server

Throws:

java.lang.IllegalArgumentException - if the given protocol name doesn't exist or the server is not registered for the given protocol

java.lang.UnsupportedOperationException - if the used manager is at client-side

retrieveAvailablePoliciesAndStrategies

java.util.Map<java.lang.String,java.util.Set<java.lang.String>> retrieveAvailablePoliciesAndStrategies()
                                                                                                       throws java.lang.UnsupportedOperationException

Gets available load balancing policies and strategies.

Returns:

available policies and strategies

Throws:

java.lang.UnsupportedOperationException - if the operation is not supported