Rio Project 4.2 API Documentation

org.rioproject.cybernode
Class CybernodeAdminProxy

java.lang.Object
  org.rioproject.resources.servicecore.ServiceAdminProxy
      org.rioproject.cybernode.CybernodeAdminProxy

All Implemented Interfaces:

DestroyAdmin, Serializable, Remote, JoinAdmin, ReferentUuid, ServiceBeanAdmin, CybernodeAdmin, ServiceBeanControl, ServiceAdmin, ComputeResourceAdmin

public class CybernodeAdminProxy
extends ServiceAdminProxy
implements CybernodeAdmin, Serializable

A CybernodeAdminProxy is a proxy for the CybernodeAdmin server. This is the object passed to clients of the CybernodeAdmin.

Author:

Dennis Reedy

See Also:

Serialized Form

Field Summary

Fields inherited from class org.rioproject.resources.servicecore.ServiceAdminProxy

serviceAdmin, uuid

Method Summary

ComputeResourceUtilization	getComputeResourceUtilization() Get the ComputeResourceUtilization for the compute resource
ComputeResourceUtilization	getComputeResourceUtilization(Uuid serviceUuid) Get the ComputeResourceUtilization for an instantiated service
MeasuredResource[]	getMeasuredResources() Get the MeasuredResource components for the ComputeResource
boolean	getPersistentProvisioning() Get whether the Cybernode supports persistent provisioning of qualitative capabilities
PlatformCapability[]	getPlatformCapabilties() Get the PlatformCapability components for the ComputeResource
int	getRegistryPort() Get the port that the Cybernode has started the RMI Registry on
long	getReportInterval() Get the reportInterval property which controls how often the ComputeResource will inform registered Observers of a state change.
ResourceCapability	getResourceCapability() Get the ResourceCapability for the compute resource
Integer	getServiceCount() Get the number of services that this Cybernode has instantiated
Integer	getServiceLimit() Get the upper limit of services that this Cybernode can instantiate
SLA[]	getSLAs() Get the system SLAs which provide control information for the MeasurableCapability components the ComputeResource contains
double	getUtilization() Get the resource's utilization.
void	setPersistentProvisioning(boolean support) Set whether the Cybernode supports persistent provisioning of qualitative capabilities
void	setReportInterval(long reportInterval) Set the reportInterval property which controls how often the ComputeResource will inform registered Observers of a state change.
void	setServiceLimit(Integer count) Set the upper limit of services that this Cybernode can instantiate
boolean	setSLA(SLA serviceLevelAgreement) Set the SLA for a MeasurableCapability contained within the ComputeResource

Methods inherited from class org.rioproject.resources.servicecore.ServiceAdminProxy

addLookupAttributes, addLookupGroups, addLookupLocators, advertise, destroy, equals, getJoinSet, getLookupAttributes, getLookupGroups, getLookupLocators, getReferentUuid, getServiceBeanInstantiatorUuid, getServiceElement, getUpTime, hashCode, modifyLookupAttributes, removeLookupGroups, removeLookupLocators, setLookupGroups, setLookupLocators, setServiceElement, start, stop, unadvertise

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.rioproject.resources.servicecore.ServiceAdmin

getJoinSet

Methods inherited from interface org.rioproject.core.jsb.ServiceBeanAdmin

getServiceBeanInstantiatorUuid, getServiceElement, getUpTime, setServiceElement

Methods inherited from interface org.rioproject.jsb.ServiceBeanControl

advertise, start, stop, unadvertise

Methods inherited from interface net.jini.admin.JoinAdmin

addLookupAttributes, addLookupGroups, addLookupLocators, getLookupAttributes, getLookupGroups, getLookupLocators, modifyLookupAttributes, removeLookupGroups, removeLookupLocators, setLookupGroups, setLookupLocators

Methods inherited from interface com.sun.jini.admin.DestroyAdmin

destroy

Method Detail

getServiceLimit

public Integer getServiceLimit()
                        throws RemoteException

Description copied from interface: CybernodeAdmin

Get the upper limit of services that this Cybernode can instantiate

Specified by:

getServiceLimit in interface CybernodeAdmin

Returns:

The upper limit of services

Throws:

RemoteException - If communication errors happen

getRegistryPort

public int getRegistryPort()
                    throws RemoteException

Description copied from interface: CybernodeAdmin

Get the port that the Cybernode has started the RMI Registry on

Specified by:

getRegistryPort in interface CybernodeAdmin

Returns:

The port the Cybernode has started the RMI Registry on

Throws:

RemoteException - If communication errors happen

setServiceLimit

public void setServiceLimit(Integer count)
                     throws RemoteException

Description copied from interface: CybernodeAdmin

Set the upper limit of services that this Cybernode can instantiate

Specified by:

setServiceLimit in interface CybernodeAdmin

Parameters:

count - Integer indicating the upper limit of services

Throws:

RemoteException - If communication errors happen

getServiceCount

public Integer getServiceCount()
                        throws RemoteException

Description copied from interface: CybernodeAdmin

Get the number of services that this Cybernode has instantiated

Specified by:

getServiceCount in interface CybernodeAdmin

Returns:

The number of services the Cybernode has instantiated

Throws:

RemoteException - If communication errors happen

getPersistentProvisioning

public boolean getPersistentProvisioning()
                                  throws RemoteException

Description copied from interface: CybernodeAdmin

Get whether the Cybernode supports persistent provisioning of qualitative capabilities

Specified by:

getPersistentProvisioning in interface CybernodeAdmin

Returns:

True if the Cybernode supports persistent provisioning of qualitative capabilities otherwise return false

Throws:

RemoteException - If communication errors happen

setPersistentProvisioning

public void setPersistentProvisioning(boolean support)
                               throws IOException

Description copied from interface: CybernodeAdmin

Set whether the Cybernode supports persistent provisioning of qualitative capabilities

Specified by:

setPersistentProvisioning in interface CybernodeAdmin

Parameters:

support - Set to true if the Cybernode supports persistent provisioning of qualitative capabilities otherwise, set false

Throws:

RemoteException - If communication errors happen

IOException

setSLA

public boolean setSLA(SLA serviceLevelAgreement)
               throws RemoteException

Description copied from interface: ComputeResourceAdmin

Set the SLA for a MeasurableCapability contained within the ComputeResource

Specified by:

setSLA in interface ComputeResourceAdmin

Parameters:

serviceLevelAgreement - The SLA for the ComputeResource

Returns:

True if updated, false otherwise

Throws:

RemoteException - If communication errors occur

getSLAs

public SLA[] getSLAs()
              throws RemoteException

Description copied from interface: ComputeResourceAdmin

Get the system SLAs which provide control information for the MeasurableCapability components the ComputeResource contains

Specified by:

getSLAs in interface ComputeResourceAdmin

Returns:

The system SLA for each MeasurableCapability contained within the ComputeResource

Throws:

RemoteException - If communication errors occur

getPlatformCapabilties

public PlatformCapability[] getPlatformCapabilties()
                                            throws RemoteException

Description copied from interface: ComputeResourceAdmin

Get the PlatformCapability components for the ComputeResource

Specified by:

getPlatformCapabilties in interface ComputeResourceAdmin

Returns:

The PlatformCapability components for the ComputeResource

Throws:

RemoteException - If communication errors occur

getMeasuredResources

public MeasuredResource[] getMeasuredResources()
                                        throws RemoteException

Description copied from interface: ComputeResourceAdmin

Get the MeasuredResource components for the ComputeResource

Specified by:

getMeasuredResources in interface ComputeResourceAdmin

Returns:

Array of MeasuredResource instances that correspond to MeasurableCapability components

Throws:

RemoteException - If communication errors occur

getUtilization

public double getUtilization()
                      throws RemoteException

Description copied from interface: ComputeResourceAdmin

Get the resource's utilization. ComputeResource quantitative behavior is represented by MeasurableCapability objects. MeasurableCapability objects produce a relative value which represents the percentage of the capability being measured. This value is referred to as a MeasurableCapability utilization. This method returns the aggregate of all computed utilizations

Specified by:

getUtilization in interface ComputeResourceAdmin

Returns:

The ComputeResource's utilization

Throws:

RemoteException - If communication errors occur

getResourceCapability

public ResourceCapability getResourceCapability()
                                         throws RemoteException

Description copied from interface: ComputeResourceAdmin

Get the ResourceCapability for the compute resource

Specified by:

getResourceCapability in interface ComputeResourceAdmin

Returns:

The ResourceCapability for the compute resource. The ResourceCapability class provides the utilization, platform and measurable capabilities for a compute resource.

Throws:

RemoteException - If communication errors occur

getComputeResourceUtilization

public ComputeResourceUtilization getComputeResourceUtilization()
                                                         throws RemoteException

Description copied from interface: ComputeResourceAdmin

Get the ComputeResourceUtilization for the compute resource

Specified by:

getComputeResourceUtilization in interface ComputeResourceAdmin

Returns:

The ComputeResourceUtilization for the compute resource. This object represents a snapshot of the depletion-oriented resources on the compute resource. A new ComputeResourceUtilization is created each time this method is invoked

Throws:

RemoteException - If communication errors occur

getComputeResourceUtilization

public ComputeResourceUtilization getComputeResourceUtilization(Uuid serviceUuid)
                                                         throws RemoteException

Description copied from interface: ComputeResourceAdmin

Get the ComputeResourceUtilization for an instantiated service

Specified by:

getComputeResourceUtilization in interface ComputeResourceAdmin

Parameters:

serviceUuid - The Uuid of an instantiated service

Returns:

The ComputeResourceUtilization for the service identified by the serviceUuid. If the identified service is contained within the Cybernode, the returned ComputeResourceUtilization will be the same as the value returned from ComputeResourceAdmin.getComputeResourceUtilization().

If the identified service has been executed in it's own process, the returned value will represent the ComputeResourceUtilization for that process.

If no instantiated service can be found, a null is returned.

Throws:

RemoteException - If communication errors occur

getReportInterval

public long getReportInterval()
                       throws RemoteException

Description copied from interface: ComputeResourceAdmin

Get the reportInterval property which controls how often the ComputeResource will inform registered Observers of a state change. A state change is determined if any of the MeasurableCapability components contained within this ComputeResource provide an update in the interval specified by the reportInterval property

Specified by:

getReportInterval in interface ComputeResourceAdmin

Returns:

The interval controlling when the ComputeResource reports change of state

Throws:

RemoteException - If communication errors occur

setReportInterval

public void setReportInterval(long reportInterval)
                       throws RemoteException

Description copied from interface: ComputeResourceAdmin

Set the reportInterval property which controls how often the ComputeResource will inform registered Observers of a state change. A state change is determined if any of the MeasurableCapability components contained within this ComputeResource provide an update in the interval specified by the reportInterval property.

Note: MeasurableCapability components contained within the ComputeResource may have reportRates greater than then the reportInterval. If this is the case, the ComputeResource will only report state changes if the values reported by the contained MeasurableCapability objects change.

Specified by:

setReportInterval in interface ComputeResourceAdmin

Parameters:

reportInterval - The interval controlling when the ComputeResource reports change of state to registered Observers

Throws:

RemoteException - If communication errors occur