org.rioproject.admin

Interface MonitorableService

All Known Subinterfaces:

Cybernode, EventCollector, ProvisionMonitor, org.rioproject.servicecore.Service

All Known Implementing Classes:

ServiceBeanAdapter, ServiceProvider

public interface MonitorableService

A MonitorableService provides the semantics to determine if a service (which implements this interface) is reachable. One of two mechanisms can be used:

1. Establish a Lease to monitor the reachability of the Service. Using this method a Lease is returned. If the service is unreachable the Lease can not be renewed, a RemoteException will be thrown
2. The Service will use a heartbeat mechanism to notify the caller of it's existence

Author:

Dennis Reedy

Method Summary

Modifier and Type	Method and Description
net.jini.core.lease.Lease	monitor(long duration) Establish a Lease to monitor the reachability of the Service
void	ping() Low cost roundtrip check
void	startHeartbeat(String[] configArgs) Start a heartbeat mechanism to determine the reachability of the Service.

Method Detail

ping

void ping()
   throws RemoteException

Low cost roundtrip check

Throws:

RemoteException - If an error occurred during communication with the service

monitor

net.jini.core.lease.Lease monitor(long duration)
                           throws net.jini.core.lease.LeaseDeniedException,
                                  RemoteException

Establish a Lease to monitor the reachability of the Service

Parameters:

duration - The duration (in milliseconds) of the requested Lease

Returns:

Lease The Lease to maintain

Throws:

net.jini.core.lease.LeaseDeniedException - If requested Lease is denied

RemoteException - If communication errors occur

startHeartbeat

void startHeartbeat(String[] configArgs)
             throws net.jini.config.ConfigurationException,
                    RemoteException

Start a heartbeat mechanism to determine the reachability of the Service. The endpoint to send the heartbeat to will be found by the configuration property

 org.rioproject.impl.fdh.HeartbeatFaultDetectionHandler.heartbeatServer
 

Parameters:

configArgs - Configuration attributes the Service will use to establish a heartbeat mechanism

Throws:

net.jini.config.ConfigurationException - If there are errors processing the configuration

RemoteException - If communication errors occur