com.caucho.management.server
Interface ClusterServerMXBean

All Superinterfaces:
ManagedObjectMXBean
All Known Implementing Classes:
ClusterServerAdmin

public interface ClusterServerMXBean
extends ManagedObjectMXBean

A client-view of a cluster's server. The load balancer and persistent store will use the ClusterServer to communicate to other servers in the cluster. The JMX name looks like:

   resin:type=ClusterServer,name=web-a
 


Method Summary
 void enableSessionOnly()
          Enables connections to the target server.
 java.lang.String getAddress()
          Returns the ip address or host name of the server.
 ClusterMXBean getCluster()
          The containing cluster.
 long getClusterIdleTime()
          Returns the timeout for an idle socket that is connected to the target server.
 int getClusterIndex()
          The cluster index of the server.
 java.lang.String getClusterState()
          Returns the lifecycle state as a cluster server.
 int getConnectionActiveCount()
          Returns the number of connections actively being used to communicate with the target server.
 long getConnectionBusyCountTotal()
          Returns the number of connections which resulted in a busy response.
 long getConnectionFailCountTotal()
          Returns the number of connections which could not connect to the target server.
 int getConnectionIdleCount()
          Returns the number of open but currently unused connections to the target server.
 long getConnectionKeepaliveCountTotal()
          Returns the number of connections that have been made to the target server.
 int getConnectionMin()
          The minimum number of connections for green load balancing.
 long getConnectionNewCountTotal()
          Returns the number of connections that have been made to the target server.
 long getConnectTimeout()
          The timeout in milliseconds for connecting to the server.
 java.lang.String getHeartbeatState()
           
 long getIdleTime()
          Returns the timeout for an idle socket that is connected to the target server.
 java.util.Date getLastBusyTime()
          Returns the last time of the busy response.
 java.util.Date getLastFailTime()
          Returns the time of the last failure.
 java.util.Date getLastHeartbeatTime()
           
 double getLatencyFactor()
          Returns the server's latency factory
 java.lang.String getLoadBalanceState()
          Returns the load balance state.
 int getMessageQueueLargeSize()
           
 int getMessageQueueSize()
           
 int getPort()
          Returns the resin/admin port number of the server.
 long getRecoverTime()
          Returns the timeout for assuming a target server remains unavailable once a connection attempt fails.
 double getServerCpuLoadAvg()
          Returns the server's load average.
 long getSocketTimeout()
          Returns the timeout to use for reads when communicating with the target server.
 long getWarmupTime()
          Returns the warmup time in milliseconds.
 int getWeight()
          Returns the load-balancer weight, defaulting to 100.
 boolean isDynamicServer()
          Returns true if this is a dynamic server
 boolean isHeartbeatActive()
           
 boolean isSelfServer()
          Returns true for the server's own ClusterServer
 boolean isTriadServer()
          Returns true if this is a triad server
 boolean ping()
          Returns true if a connection can be made to the target server.
 void removeDynamicServer()
          Remove this server as a dynamic server
 void start()
          Enables connections to the target server.
 void stop()
          Disables connections to the target server.
 
Methods inherited from interface com.caucho.management.server.ManagedObjectMXBean
getName, getObjectName, getType
 

Method Detail

getCluster

ClusterMXBean getCluster()
The containing cluster.


getClusterIndex

int getClusterIndex()
The cluster index of the server.


getAddress

java.lang.String getAddress()
Returns the ip address or host name of the server.


getPort

int getPort()
Returns the resin/admin port number of the server.


isDynamicServer

boolean isDynamicServer()
Returns true if this is a dynamic server


isTriadServer

boolean isTriadServer()
Returns true if this is a triad server


isSelfServer

boolean isSelfServer()
Returns true for the server's own ClusterServer


getConnectTimeout

@Units(value="milliseconds")
long getConnectTimeout()
The timeout in milliseconds for connecting to the server.


getConnectionMin

int getConnectionMin()
The minimum number of connections for green load balancing.


getRecoverTime

@Units(value="milliseconds")
long getRecoverTime()
Returns the timeout for assuming a target server remains unavailable once a connection attempt fails. When the timeout period elapses another attempt is made to connect to the target server


getIdleTime

@Units(value="milliseconds")
long getIdleTime()
Returns the timeout for an idle socket that is connected to the target server. If the socket is not used within the timeout period the idle connection is closed.


getSocketTimeout

@Units(value="milliseconds")
long getSocketTimeout()
Returns the timeout to use for reads when communicating with the target server.


getWarmupTime

@Units(value="milliseconds")
long getWarmupTime()
Returns the warmup time in milliseconds.


getWeight

int getWeight()
Returns the load-balancer weight, defaulting to 100.


getClusterIdleTime

@Units(value="milliseconds")
long getClusterIdleTime()
Returns the timeout for an idle socket that is connected to the target server. If the socket is not used within the timeout period the idle connection is closed.


getClusterState

java.lang.String getClusterState()
Returns the lifecycle state as a cluster server.


getLoadBalanceState

java.lang.String getLoadBalanceState()
Returns the load balance state.


isHeartbeatActive

boolean isHeartbeatActive()

getHeartbeatState

java.lang.String getHeartbeatState()

getLastHeartbeatTime

java.util.Date getLastHeartbeatTime()

getConnectionActiveCount

int getConnectionActiveCount()
Returns the number of connections actively being used to communicate with the target server.


getConnectionIdleCount

int getConnectionIdleCount()
Returns the number of open but currently unused connections to the target server.


getConnectionNewCountTotal

long getConnectionNewCountTotal()
Returns the number of connections that have been made to the target server.


getConnectionKeepaliveCountTotal

long getConnectionKeepaliveCountTotal()
Returns the number of connections that have been made to the target server.


getConnectionFailCountTotal

long getConnectionFailCountTotal()
Returns the number of connections which could not connect to the target server.


getLastFailTime

java.util.Date getLastFailTime()
Returns the time of the last failure.


getConnectionBusyCountTotal

long getConnectionBusyCountTotal()
Returns the number of connections which resulted in a busy response.


getLastBusyTime

java.util.Date getLastBusyTime()
Returns the last time of the busy response.


getServerCpuLoadAvg

double getServerCpuLoadAvg()
Returns the server's load average.


getLatencyFactor

double getLatencyFactor()
Returns the server's latency factory


getMessageQueueSize

int getMessageQueueSize()

getMessageQueueLargeSize

int getMessageQueueLargeSize()

start

void start()
Enables connections to the target server.


enableSessionOnly

void enableSessionOnly()
Enables connections to the target server.


stop

void stop()
Disables connections to the target server.


removeDynamicServer

void removeDynamicServer()
Remove this server as a dynamic server


ping

boolean ping()
Returns true if a connection can be made to the target server.