File Doc Category Size Date Package
CommunicatorServerMBean.java API Doc Java SE 5 API 6363 Fri Aug 26 14:55:06 BST 2005 com.sun.jmx.snmp.daemon

CommunicatorServerMBean

public interface CommunicatorServerMBean

Defines generic behaviour for the server part of a connector or an adaptor. Most connectors or adaptors extend CommunicatorServer and inherit this behaviour. Connectors or adaptors that do not fit into this model do not extend CommunicatorServer.

An CommunicatorServer is an active object, it listens for client requests and processes them in its own thread. When necessary, a CommunicatorServer creates other threads to process multiple requests concurrently.

A CommunicatorServer object can be stopped by calling the stop method. When it is stopped, the CommunicatorServer no longer listens to client requests and no longer holds any thread or communication resources. It can be started again by calling the start method.

A CommunicatorServer has a state property which reflects its activity.

CommunicatorServer State

stopped OFFLINE

starting STARTING

running ONLINE

stopping STOPPING

The STARTING state marks the transition from OFFLINE to ONLINE.

The STOPPING state marks the transition from ONLINE to OFFLINE. This occurs when the CommunicatorServer is finishing or interrupting active requests.

A CommunicatorServer may serve several clients concurrently. The number of concurrent clients can be limited using the property maxActiveClientCount. The default value of this property is defined by the subclasses.

When a CommunicatorServer is unregistered from the MBeanServer, it is stopped automatically.

This API is a Sun Microsystems internal API and is subject to change without notice.

version: 1.25 12/19/03
author: Sun Microsystems, Inc

Fields Summary
Constructors Summary
Methods Summary
public java.lang.String getHost()
Gets the host name used by this CommunicatorServer.
return
The host name used by this CommunicatorServer.
public int getPort()
Gets the port number used by this CommunicatorServer.
return
The port number used by this CommunicatorServer.
public abstract java.lang.String getProtocol()
Gets the protocol being used by this CommunicatorServer.
return
The protocol as a string.
public int getState()
Gets the state of this CommunicatorServer as an integer.
return
ONLINE, OFFLINE, STARTING or STOPPING.
public java.lang.String getStateString()
Gets the state of this CommunicatorServer as a string.
return
One of the strings "ONLINE", "OFFLINE", "STARTING" or "STOPPING".
public boolean isActive()
Tests if the CommunicatorServer is active.
return
True if connector is ONLINE; false otherwise.
public void setPort(int port)
Sets the port number used by this CommunicatorServer.
param
port The port number used by this CommunicatorServer.
exception
java.lang.IllegalStateException This method has been invoked while the communicator was ONLINE or STARTING.
public void start()
Starts this CommunicatorServer.
Has no effect if this CommunicatorServer is ONLINE or STOPPING.
public void stop()
Stops this CommunicatorServer.
Has no effect if this CommunicatorServer is OFFLINE or STOPPING.
public boolean waitState(int state, long timeOut)
Waits untill either the State attribute of this MBean equals the specified state parameter, or the specified timeOut has elapsed. The method waitState returns with a boolean value indicating whether the specified state parameter equals the value of this MBean's State attribute at the time the method terminates. Two special cases for the timeOut parameter value are:
if timeOut is negative then waitState returns immediately (i.e. does not wait at all),

if timeOut equals zero then waitState waits untill the value of this MBean's State attribute is the same as the state parameter (i.e. will wait indefinitely if this condition is never met).
param
state The value of this MBean's State attribute to wait for. state can be one of:

CommunicatorServer.OFFLINE,

CommunicatorServer.ONLINE,

CommunicatorServer.STARTING,

CommunicatorServer.STOPPING.

param
timeOut The maximum time to wait for, in milliseconds, if positive. Infinite time out if 0, or no waiting at all if negative.
return
true if the value of this MBean's State attribute is the same as the state parameter; false otherwise.