GemFire 7.0

com.gemstone.gemfire.management
Interface CacheServerMXBean


public interface CacheServerMXBean

MBean that provides access to information and management functionality for a CacheServer. Notification emitted are a)gemfire.distributedsystem.cacheserver.client.joined b)gemfire.distributedsystem.cacheserver.client.left c)gemfire.distributedsystem.cacheserver.client.crashed

Since:
7.0

Method Summary
 void closeAllContinuousQuery(String regionName)
          Unregister all CQs from a region
 void closeContinuousQuery(String queryName)
          Unregister a CQ
 void executeContinuousQuery(String queryName)
          Execute an ad-hoc CQ on the server
 ServerLoadData fetchLoadProbe()
          Returns the load probe for this CacheServer.
 long getActiveCQCount()
          Returns the number of active (currently executing) CQs.
 String getBindAddress()
          Returns a string representing the IP address or host name that this CacheServer will listen on.
 int getCapacity()
          Returns the capacity (in megabytes) of the client queue.
 int getClientConnectionCount()
          Returns the number of sockets accepted and used for client to server messaging.
 long getClientNotificationAvgLatency()
          Returns the average latency for processing client notifications.
 float getClientNotificationRate()
          Returns the rate of client notifications.
 double getConnectionLoad()
          Returns the load from client to server connections as reported by the load probe installed in this server.
 int getConnectionThreads()
          Returns the current number of threads handling a client connection.
 String[] getContinuousQueryList()
          Returns a list of names for all registered CQs.
 int getCurrentClients()
          Returns the number of client virtual machines connected.
 String getDiskStoreName()
          Returns the name of the disk store that is used for persistence.
 String getEvictionPolicy()
          Returns the eviction policy that is executed when the capacity of the client queue is reached.
 long getGetRequestAvgLatency()
          Returns the average get request latency.
 float getGetRequestRate()
          Returns the rate of get requests.
 String getHostNameForClients()
          Returns the name or IP address to pass to the client as the location where the server is listening.
 int getIndexCount()
          Returns the total number of indexes in use by the member.
 String[] getIndexList()
          Returns a list of names for all indexes.
 double getLoadPerConnection()
          Returns the estimate of how much load is added for each new connection as reported by the load probe installed in this server.
 double getLoadPerQueue()
          Returns the estimate of how much load is added for each new queue as reported by the load probe installed in this server.
 long getLoadPollInterval()
          Returns the frequency (in milliseconds) to poll the load probe on this CacheServer.
 int getMaxConnections()
          Returns the maximum allowed client connections.
 int getMaximumMessageCount()
          Returns the maximum number of messages that can be enqueued in a client-queue.
 int getMaximumTimeBetweenPings()
          Returns the maximum amount of time between client pings.
 int getMaxThreads()
          Returns the maxium number of threads allowed in this CacheServer to service client requests.
 int getMessageTimeToLive()
          Returns the time (in seconds) after which a message in the client queue will expire.
 int getNumClientNotificationRequests()
          Returns the number of cache client notification requests.
 int getNumSubscriptions()
          Returns the number of clients who have existing subscriptions.
 int getPort()
          Returns the port on which this CacheServer listens for clients.
 long getPutRequestAvgLatency()
          Returns the average put request latency.
 float getPutRequestRate()
          Returns the rate of put requests.
 float getQueryRequestRate()
          Returns the rate of queries.
 double getQueueLoad()
          Returns the load from queues as reported by the load probe installed in this server.
 long getRegisteredCQCount()
          Returns the number of registered CQs.
 int getSocketBufferSize()
          Returns the configured buffer size of the socket connection for this CacheServer.
 int getThreadQueueSize()
          Returns the current number of connections waiting for a thread to start processing their message.
 int getTotalConnectionsTimedOut()
          Returns the total number of client connections that timed out and were closed.
 int getTotalFailedConnectionAttempts()
          Returns the total number of client connection requests that failed.
 long getTotalIndexMaintenanceTime()
          Returns the total time spent updating indexes due to changes in the data.
 long getTotalReceivedBytes()
          Returns the total number of bytes received from clients.
 long getTotalSentBytes()
          Returns the total number of bytes sent to clients.
 boolean isRunning()
          Returns whether or not this CacheServer is running.
 String[] listClientIds()
          Returns a list of IDs for all connected clients.
 void removeIndex(String indexName)
          Remove an index.
 ClientHealthStatus[] showAllClientStats()
          Returns health and statistic information for all clients.
 ClientHealthStatus showClientStats(String clientId)
          Returns health and statistic information for a client.
 void stopContinuousQuery(String queryName)
          Stop (pause) a CQ from executing
 

Method Detail

getPort

int getPort()
Returns the port on which this CacheServer listens for clients.


getBindAddress

String getBindAddress()
Returns a string representing the IP address or host name that this CacheServer will listen on.


getSocketBufferSize

int getSocketBufferSize()
Returns the configured buffer size of the socket connection for this CacheServer.


getMaximumTimeBetweenPings

int getMaximumTimeBetweenPings()
Returns the maximum amount of time between client pings. This value is used to determine the health of client's attached to the server.


getMaxConnections

int getMaxConnections()
Returns the maximum allowed client connections.


getMaxThreads

int getMaxThreads()
Returns the maxium number of threads allowed in this CacheServer to service client requests.


getMaximumMessageCount

int getMaximumMessageCount()
Returns the maximum number of messages that can be enqueued in a client-queue.


getMessageTimeToLive

int getMessageTimeToLive()
Returns the time (in seconds) after which a message in the client queue will expire.


getLoadPollInterval

long getLoadPollInterval()
Returns the frequency (in milliseconds) to poll the load probe on this CacheServer.


getHostNameForClients

String getHostNameForClients()
Returns the name or IP address to pass to the client as the location where the server is listening. When the server connects to the locator it tells the locator the host and port where it is listening for client connections. If the host the server uses by default is one that the client can’t translate into an IP address, the client will have no route to the server’s host and won’t be able to find the server. For this situation, you must supply the server’s alternate hostname for the locator to pass to the client.


fetchLoadProbe

ServerLoadData fetchLoadProbe()
Returns the load probe for this CacheServer.


isRunning

boolean isRunning()
Returns whether or not this CacheServer is running.

Returns:
True of the server is running, false otherwise.

getCapacity

int getCapacity()
Returns the capacity (in megabytes) of the client queue.


getEvictionPolicy

String getEvictionPolicy()
Returns the eviction policy that is executed when the capacity of the client queue is reached.


getDiskStoreName

String getDiskStoreName()
Returns the name of the disk store that is used for persistence.


getClientConnectionCount

int getClientConnectionCount()
Returns the number of sockets accepted and used for client to server messaging.


getCurrentClients

int getCurrentClients()
Returns the number of client virtual machines connected.


getGetRequestAvgLatency

long getGetRequestAvgLatency()
Returns the average get request latency.


getPutRequestAvgLatency

long getPutRequestAvgLatency()
Returns the average put request latency.


getTotalConnectionsTimedOut

int getTotalConnectionsTimedOut()
Returns the total number of client connections that timed out and were closed.


getTotalFailedConnectionAttempts

int getTotalFailedConnectionAttempts()
Returns the total number of client connection requests that failed.


getThreadQueueSize

int getThreadQueueSize()
Returns the current number of connections waiting for a thread to start processing their message.


getConnectionThreads

int getConnectionThreads()
Returns the current number of threads handling a client connection.


getConnectionLoad

double getConnectionLoad()
Returns the load from client to server connections as reported by the load probe installed in this server.


getLoadPerConnection

double getLoadPerConnection()
Returns the estimate of how much load is added for each new connection as reported by the load probe installed in this server.


getQueueLoad

double getQueueLoad()
Returns the load from queues as reported by the load probe installed in this server.


getLoadPerQueue

double getLoadPerQueue()
Returns the estimate of how much load is added for each new queue as reported by the load probe installed in this server.


getGetRequestRate

float getGetRequestRate()
Returns the rate of get requests.


getPutRequestRate

float getPutRequestRate()
Returns the rate of put requests.


getTotalSentBytes

long getTotalSentBytes()
Returns the total number of bytes sent to clients.


getTotalReceivedBytes

long getTotalReceivedBytes()
Returns the total number of bytes received from clients.


getNumClientNotificationRequests

int getNumClientNotificationRequests()
Returns the number of cache client notification requests.


getClientNotificationAvgLatency

long getClientNotificationAvgLatency()
Returns the average latency for processing client notifications.


getClientNotificationRate

float getClientNotificationRate()
Returns the rate of client notifications.


getRegisteredCQCount

long getRegisteredCQCount()
Returns the number of registered CQs.


getActiveCQCount

long getActiveCQCount()
Returns the number of active (currently executing) CQs.


getQueryRequestRate

float getQueryRequestRate()
Returns the rate of queries.


getIndexCount

int getIndexCount()
Returns the total number of indexes in use by the member.


getIndexList

String[] getIndexList()
Returns a list of names for all indexes.


getTotalIndexMaintenanceTime

long getTotalIndexMaintenanceTime()
Returns the total time spent updating indexes due to changes in the data.


removeIndex

void removeIndex(String indexName)
                 throws Exception
Remove an index.

Parameters:
indexName - Name of the index to be removed.
Throws:
Exception

getContinuousQueryList

String[] getContinuousQueryList()
Returns a list of names for all registered CQs.


executeContinuousQuery

void executeContinuousQuery(String queryName)
                            throws Exception
Execute an ad-hoc CQ on the server

Parameters:
queryName - Name of the CQ to execute.
Throws:
Exception

stopContinuousQuery

void stopContinuousQuery(String queryName)
                         throws Exception
Stop (pause) a CQ from executing

Parameters:
queryName - Name of the CQ to stop.
Throws:
Exception

closeAllContinuousQuery

void closeAllContinuousQuery(String regionName)
                             throws Exception
Unregister all CQs from a region

Parameters:
regionName - Name of the region from which to remove CQs.
Throws:
Exception

closeContinuousQuery

void closeContinuousQuery(String queryName)
                          throws Exception
Unregister a CQ

Parameters:
queryName - Name of the CQ to unregister.
Throws:
Exception

listClientIds

String[] listClientIds()
                       throws Exception
Returns a list of IDs for all connected clients.

Returns:
A list of IDs or a length 0 array if no clients are registered.
Throws:
Exception

showClientStats

ClientHealthStatus showClientStats(String clientId)
                                   throws Exception
Returns health and statistic information for a client. Information is only available for clients which have set a "StatisticsInterval".

Parameters:
clientId - ID of the client for which to retrieve information.
Throws:
Exception

getNumSubscriptions

int getNumSubscriptions()
Returns the number of clients who have existing subscriptions.


showAllClientStats

ClientHealthStatus[] showAllClientStats()
                                        throws Exception
Returns health and statistic information for all clients. Information is only available for clients which have set a "StatisticsInterval".

Throws:
Exception

GemFire 7.0

Copyright © 1997-2012 VMware, Inc. All rights reserved.