Rio Project 4.2 API Documentation

Package org.rioproject.monitor

Provides the capability to deploy and monitor applications.

See:
Description

Interface Summary

DeployAdmin	DeployAdmin interface defines methods to deploy, undeploy, redeploy, query and optionally remove pending deployment and redeployment requests
DeployHandler	An interface that returns OperationalStrings to deploy
InstanceIDManager	The interface defines the semantics to manage instance identifiers.
ProvisionListener	A ProvisionListener waits for notification that a Service has been provisioned
ProvisionMonitor	The ProvisionMonitor extends the ProvisionManager and Service interfaces, and defines the semantics required for ProvisionMonitor instances to back-up each other
ProvisionMonitorAdmin	The ProvisionMonitorAdmin extends ServiceAdmin and DeployAdmin interfaces
ProvisionMonitorImplMBean	MBean interface for the ProvisonMonitor
ServiceChannel.ServiceChannelListener	Interface for clients

Class Summary

AbstractOARDeployHandler	An abstract DeployHandler providing support for ease of code.
AssociationMatcher	Utility to match Associations to ServiceElements.
FileSystemOARDeployHandler	A DeployHandler that handles OAR files.
InstantiatorResource	An InstantiatorResource is the object being leased and controlled by the ServiceResource, and represents an available ServiceInstantiation that can be used to provision a service.
LeastActiveSelector	LeastActiveSelector is used to select a target Cybernode for provisioning.
ProvisionFailureEvent	This class is used to communicate to interested registrants that a provision attempt for a particular service was unsuccessful
ProvisionFailureEventAdapter	Provides the support to transform ProvisionFailureEvent notifications to JMX notifications
ProvisionMonitor.PeerInfo	Contains information about ProvisionMonitor peers involved in providing support for backup approach
ProvisionMonitorAdminImpl	The ProvisionMonitorAdminImpl class implements the ServiceAdmin interface providing administrative support.
ProvisionMonitorAdminProxy	A ProvisionMonitorAdminProxy is a proxy for the ProvisionMonitorAdmin server.
ProvisionMonitorEvent	This class is used to communicate state changes on OperationalString and ServiceElements contained within OperationalString objects that are being monitored by the ProvisionMonitor.
ProvisionMonitorEventAdapter	Provides the support to transform ProvisionMonitorEvent notifications to JMX notifications
ProvisionMonitorImpl	The ProvisionMonitor service provides the capability to deploy and monitor OperationalStrings.
ProvisionMonitorPermission	Permission that can be used to express the access control policy for an instance of an ProvisionMonitor server exported with a BasicJeriExporter.
ProvisionRequest	The ProvisionRequest class provides a container object holding information to provision a ServiceBean
RecordHolder	The RecordHolder class is a simple container that holds an OperationalString and an action indicating whether the OperationalString was modified or removed.
ResourceCostSelector	This class provides an implementation of a ServiceResourceSelector which manages a TreeSet of ServiceResource objects which reflect the resources being leased.
ResourceCostSelector.CostComparator	The CostComparator is a Comparator which sorts the Collection based on the Comparable implementation of the ResourceCapability
RoundRobinSelector	This class provides an implementation of a ServiceResourceSelector which manages a LinkedList of ServiceResource objects which reflect the resources being leased.
ServiceChannel	The ServiceChannel provides a local channel for service instances that have been provisioned or failed
ServiceChannel.ServiceChannelEvent	Event sent to listeners
ServiceElementManager	ServiceElementManager is used to manage the discovery and dispatch (provision) request for a Service within an OperationalString
ServiceProvisioner	The ServiceProvisioner is responsible for the managing the leases of ServiceBeanInstantiator objects and performing the actual provisioning of ServiceElement objects to available ServiceBeanInstantiator instances based on the capability to fulfill the Quality of Service specification of the ServiceElement.
ServiceProvisionEventHandler	Class to handle ServiceProvisionEvent notifications
ServiceResourceSelector	This abstract class defines the semantics for selecting a ServiceResource based on requirements contained within a ServiceElement.

Enum Summary

ProvisionMonitorEvent.Action

Exception Summary

ProvisionException

Thrown when an unrecoverable exception happens trying to provision a service

Package org.rioproject.monitor Description

Provides the capability to deploy and monitor applications.

Configuring ProvisionMonitor

The ProvisionMonitor package supports the following configuration entries; where each configuration entry name is associated with the component name org.rioproject.monitor

• faultDetectionHandler

  Type:	org.rioproject.core.FaultDetectionHandler
  Default:	A new org.rioproject.resources.client.StandardFaultDetectionHandler
  Description:	The faultDetectionHandler is used to configure the FaultDetectionHandler the Provision Monitor uses to determine it's reachability for peer instances

• initialLookupGroups
  

  Type:	String[]
  Default:	All groups
  Description:	This entry will be read at initialization by a ProvisionMonitor to determine the initial set of multicast discovery groups the ProvisionMonitor should participate in. Any future changes to the set of discovery groups should be made via ProvisionMonitor 's admin proxy using the JoinAdmin interface.

• initialLookupLocators
  

  Type:	LookupLocator[]
  Default:	null
  Description:	This entry will be read at initialization by a ProvisionMonitor to determine the initial set of specific lookup services the ProvisionMonitor should register with. Any future changes to the set of discovery groups should be made via ProvisionMonitor 's admin proxy using the JoinAdmin interface.

• initialOpStrings

  Type:	String[]
  Default:	none
  Description:	An array of OperationalString files. The OperationalString file(s) will be loaded and managed at startup. Example : String[] getInitialOpStrings() { def opstrings = ["../config/system.groovy"] return opstrings as String[] }

• initialOpStringLoadDelay

  Type:	long
  Default:	5 seconds
  Description:	The amount of time (in milliseconds) to wait to load OperationalString files declared in the initialOpStrings property.

• deployHandlers

  Type:	DeployHandler
  Default:	new DeployHandler[]{new FileSystemOARDeployHandler(new File("${RIO_HOME}/deploy"))
  Description:	This property is read at startup and defines the DeployHandler instances that will be used by the Provision Monitor. DeployHandler instances are polled at fixed intervals to return OperationalStrings to deploy. The default DeployHandler is the FileSystemOARDeployHandler. This DeployHandler is used to enable hot deployment of OARs. The FileSystemOARDeployHandler looks for files with a "oar" extension, installs and unarchives the OAR, and returns configured OperationalStrings for OARs.

• deployMonitorPeriod

  Type:	long
  Default:	30 seconds
  Description:	This property is read at startup and defines the amount of time (in milliseconds) the DeployMonitor will poll DeployHandler instances for OperationalString deployments. Setting this value to -1 disables hot deployment of OARs.

• installDir

  Type:	String
  Default:	${RIO_HOME}/deploy
  Description:	This property is read at startup and defines the directory path that is used to install and service deployed OARs and application resources. OARs are installed to a subdirectory (as per the rules of OAR-Name) and extracted. If this directory does not exist it will be created.

• loginContext
  

  Type:	LoginContext
  Default:	Do not perform JAAS login
  Description:	Specifies the JAAS login context to use for performing a JAAS login and supplying the Subject to use when running the service. If this entry is not specified, no JAAS login is performed. This entry is obtained at service start and restart.

• logDirectory
  

  Type:	String
  Default:	none
  Description:	If the a log directory is being used, the value of this entry is the name of the directory that will be used to persist the ProvisionMonitor's state.

• opStringName
  

  Type:	String
  Default:	"System-Core"
  Description:	The name of the OperationalString the ProvisionMonitor is a part of

• opStringManagerExporter

  Type:	Exporter
  Default:	A new BasicJeriExporter with a TcpServerEndpoint created on a random port, a BasicILFactory, distributed garbage collection turned off, keep alive on.
  Description:	The exporter used to export the OpStringManager. The OpStringManager is a remote object which manages OperationalString instances. A new exporter is obtained every time an OpStringManager needs to export itself.

• provisionMonitorEventTaskPoolMaximum
  

  Type:	int
  Default:	20
  Description:	The minimum amount of Thread instances to have in the pool of Thread instances used to notify interested clients of ProvisionMonitorEvent instances

• serviceComment
  

  Type:	String
  Default:	null
  Description:	The comment the ProvisionMonitor will use to construct a Comment Entry

• serverExporter
  

  Type:	Exporter
  Default:	A new BasicJeriExporter with a TcpServerEndpoint created on a random port, a BasicILFactory, distributed garbage collection turned off, keep alive on. If activatable, the same default will be used but wrapped in an ActivationExporter and created with the service's ActivationID
  Description:	The exporter used to export the server. If the server is activatable, the service's ActivationID will be passed as the data argument, otherwise the data argument will be null. A new exporter is obtained every time a ProvisionMonitorImpl needs to export itself.

• serviceName
  

  Type:	String
  Default:	ProvisionMonitor
  Description:	The name the ProvisionMonitor should use as a Name Entry, and for display purposes

• serviceResourceSelector
  

  Type:	ServiceResourceSelector
  Default:	RoundRobinSelector
  Description:	The ServiceResourceSelector provides a mechanism to select Cybernodes in a particular fashion

  
  
• instantiatorPreparer
  

  Type:	ProxyPreparer
  Default:	An instance of BasicProxyPreparer that does nothing
  Description:	ProxyPreparer for ServiceInstantiator proxies. The preparer should expect the net.jini.core.event.RemoteEventListener.notify method on the returned proxy.

• provisionerLeasePeriodPolicy

  Type:	com.sun.jini.landlord.LeasePeriodPolicy
  Default:	5 minutes A new com.sun.jini.landlord.FixedLeasePeriodPolicy that allows leases up to 10 minutes with a default lease grant of 5 minutes
  Description:	Policy used to determine the length of initial grants and renewals of the leases for ServiceInstantiator instances




• activationIdPreparer

  Type:	ProxyPreparer
  Default:	new BasicProxyPreparer()
  Description:	Specifies the proxy preparer to use for the ActivationIDfor this service, if this service is run as activatable

• activationSystemPreparer

  Type:	ProxyPreparer
  Default:	new BasicProxyPreparer()
  Description:	Specifies the proxy preparer to use for the ActivationSystemproxy. During shutdown, this service calls the unregisterObject method on the ActivationSystem instance returned from this preparer