Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS (src) FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.jboss.remoting.detection
Class AbstractDetector

java.lang.Object
  extended byorg.jboss.remoting.detection.AbstractDetector
All Implemented Interfaces:
AbstractDetectorMBean (src) , Detector (src) , MBeanRegistration (src)
Direct Known Subclasses:
JNDIDetector (src) , MulticastDetector (src)
public abstract class AbstractDetector
extends java.lang.Object
implements Detector (src) , AbstractDetectorMBean (src)

AbstractDetector

Field Summary
protected  Logger (src) log
           
protected  MBeanServer (src) mbeanserver
           
protected  ObjectName (src) objectName
           
protected  ObjectName (src) registryObjectName
           
 
Constructor Summary
AbstractDetector()
           
 
Method Summary
protected  boolean checkInvokerServer(Detection (src)  detection, java.lang.ClassLoader cl)
           
protected  void detect(Detection (src)  detection)
          called when a remote detection from a peer is received by a detector
 org.w3c.dom.Element getConfiguration()
          The getConfiguration method
 long getDefaultTimeDelay()
           
protected  long getHeartbeatDelay()
          return the initial delay in milliseconds before the initial heartbeat is fired.
protected  long getHeartbeatPeriod()
          return the period in milliseconds between subsequent heartbeats.
 long getHeartbeatTimeDelay()
          The amount of time to wait between sending (and sometimes receiving) detection messages.
protected  long getPingerDelay()
          return the delay in milliseconds between when the timer is created to when the first pinger thread runs.
protected  long getPingerPeriod()
          return the period in milliseconds between checking lost servers against the last detection timestamp.
protected abstract  void heartbeat()
          subclasses must implement to provide the specific heartbeat protocol for this server to send out to other servers on the network
protected  boolean isRemoteDetection(Detection (src)  detection)
           
 void postDeregister()
          This method is called by the MBeanServer after deregistration takes place.
 void postRegister(java.lang.Boolean aBoolean)
          This method is called by the MBeanServer after registration takes place or when registration fails.
 void preDeregister()
          This method is called by the MBeanServer before deregistration takes place.
 ObjectName (src) preRegister(MBeanServer (src)  mBeanServer, ObjectName (src)  objectName)
          This method is called by the MBeanServer before registration takes place.
 void setConfiguration(org.w3c.dom.Element xml)
          set the configuration for the domains to be recognized by detector
 void setDefaultTimeDelay(long defaultTimeDelay)
          The amount of time which can elapse without receiving a detection event before a server will be suspected as being dead and peroforming an explicit invocation on it to verify it is alive.
 void setHeartbeatTimeDelay(long heartbeatTimeDelay)
          The amount of time to wait between sending (and sometimes receiving) detection messages.
 void start()
          called by MBeanServer to start the mbean lifecycle
protected  void startHeartbeat(long delay, long period)
          start heartbeating
protected  void startPinger(long delay, long period)
          start the pinger timer thread
 void stop()
          called by the MBeanServer to stop the mbean lifecycle
protected  void stopHeartbeat()
          stop heartbeating
protected  void stopPinger()
          stop the pinger timer thread
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

log

protected final Logger (src)  log

mbeanserver

protected MBeanServer (src)  mbeanserver

objectName

protected ObjectName (src)  objectName

registryObjectName

protected ObjectName (src)  registryObjectName
Constructor Detail

AbstractDetector

public AbstractDetector()
Method Detail

setHeartbeatTimeDelay

public void setHeartbeatTimeDelay(long heartbeatTimeDelay)
                           throws ConfigurationException (src)
The amount of time to wait between sending (and sometimes receiving) detection messages.

Specified by:
setHeartbeatTimeDelay in interface AbstractDetectorMBean (src)
Parameters:
heartbeatTimeDelay -
Throws:
ConfigurationException (src)

getHeartbeatTimeDelay

public long getHeartbeatTimeDelay()
The amount of time to wait between sending (and sometimes receiving) detection messages.

Specified by:
getHeartbeatTimeDelay in interface AbstractDetectorMBean (src)
Returns:

setDefaultTimeDelay

public void setDefaultTimeDelay(long defaultTimeDelay)
                         throws ConfigurationException (src)
The amount of time which can elapse without receiving a detection event before a server will be suspected as being dead and peroforming an explicit invocation on it to verify it is alive.

Specified by:
setDefaultTimeDelay in interface AbstractDetectorMBean (src)
Parameters:
defaultTimeDelay - time in milliseconds
Throws:
ConfigurationException (src)

getDefaultTimeDelay

public long getDefaultTimeDelay()
Specified by:
getDefaultTimeDelay in interface AbstractDetectorMBean (src)
Returns:
The amount of time which can elapse without receiving a detection event before a server will be suspected as being dead and peroforming an explicit invocation on it to verify it is alive.

start

public void start()
           throws java.lang.Exception
called by MBeanServer to start the mbean lifecycle

Specified by:
start in interface Detector (src)
Throws:
java.lang.Exception

getPingerDelay

protected long getPingerDelay()
return the delay in milliseconds between when the timer is created to when the first pinger thread runs. defaults to 5000

Returns:

getPingerPeriod

protected long getPingerPeriod()
return the period in milliseconds between checking lost servers against the last detection timestamp. defaults to 1500

Returns:

startPinger

protected void startPinger(long delay,
                           long period)
start the pinger timer thread

Parameters:
delay -
period -

stopPinger

protected void stopPinger()
stop the pinger timer thread

stop

public void stop()
          throws java.lang.Exception
called by the MBeanServer to stop the mbean lifecycle

Specified by:
stop in interface Detector (src)
Throws:
java.lang.Exception

postDeregister

public void postDeregister()
Description copied from interface: MBeanRegistration (src)
This method is called by the MBeanServer after deregistration takes place.

Specified by:
postDeregister in interface MBeanRegistration (src)

postRegister

public void postRegister(java.lang.Boolean aBoolean)
Description copied from interface: MBeanRegistration (src)
This method is called by the MBeanServer after registration takes place or when registration fails.

Specified by:
postRegister in interface MBeanRegistration (src)
Parameters:
aBoolean - the MBeanServer passes true when the MBean was registered, false otherwise.

preDeregister

public void preDeregister()
                   throws java.lang.Exception
Description copied from interface: MBeanRegistration (src)
This method is called by the MBeanServer before deregistration takes place.

The MBean can throw an exception, this will stop the deregistration. The exception is forwarded to the invoker wrapped in an MBeanRegistrationException.

Specified by:
preDeregister in interface MBeanRegistration (src)
Throws:
java.lang.Exception

preRegister

public ObjectName (src)  preRegister(MBeanServer (src)  mBeanServer,
                              ObjectName (src)  objectName)
                       throws java.lang.Exception
Description copied from interface: MBeanRegistration (src)
This method is called by the MBeanServer before registration takes place. The MBean is passed a reference of the MBeanServer it is about to be registered with. The MBean must return the ObjectName it will be registered with. The MBeanServer can pass a suggested object depending upon how the MBean is registered.

The MBean can stop the registration by throwing an exception.The exception is forwarded to the invoker wrapped in an MBeanRegistrationException.

Specified by:
preRegister in interface MBeanRegistration (src)
Returns:
the actual ObjectName to register this MBean with.
Throws:
java.lang.Exception - for any error, the MBean is not registered.

setConfiguration

public void setConfiguration(org.w3c.dom.Element xml)
                      throws java.lang.Exception
set the configuration for the domains to be recognized by detector

Specified by:
setConfiguration in interface AbstractDetectorMBean (src)
Parameters:
xml -
Throws:
java.lang.Exception

getConfiguration

public org.w3c.dom.Element getConfiguration()
The getConfiguration method

Specified by:
getConfiguration in interface AbstractDetectorMBean (src)
Returns:
an Element value

startHeartbeat

protected void startHeartbeat(long delay,
                              long period)
start heartbeating

Parameters:
delay -
period -

stopHeartbeat

protected void stopHeartbeat()
stop heartbeating

getHeartbeatDelay

protected long getHeartbeatDelay()
return the initial delay in milliseconds before the initial heartbeat is fired. Defaults to 0

Returns:

getHeartbeatPeriod

protected long getHeartbeatPeriod()
return the period in milliseconds between subsequent heartbeats. Defaults to 1000

Returns:

heartbeat

protected abstract void heartbeat()
subclasses must implement to provide the specific heartbeat protocol for this server to send out to other servers on the network

detect

protected void detect(Detection (src)  detection)
called when a remote detection from a peer is received by a detector

Parameters:
detection -

isRemoteDetection

protected boolean isRemoteDetection(Detection (src)  detection)

checkInvokerServer

protected boolean checkInvokerServer(Detection (src)  detection,
                                     java.lang.ClassLoader cl)
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS (src) FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD