com.platform.ego
Interface ClientInfoProvider

All Superinterfaces:
InfoProvider

public interface ClientInfoProvider
extends InfoProvider

ClientInfoProvider is used to get various information about the EGO client.

Platform EGO aggregates information from all the hosts in the cluster providing a single point from which clients can request information about the state of any host. This includes the status of allocation requests, the consumer hierarchy including current resources assigned to each consumer, as well as activities that have been started in the distributed environment.

Version:
1.2.3

Method Summary
 ActivityInfo[] getActivityInfos(java.lang.String[] activityIDs, java.lang.String[] consumerNames, java.lang.String[] resourceNames)
          Get detailed information about activities.
 AllocationInfo[] getAllocationInfos(java.lang.String consumerPath)
          Get detailed information of allocations that is owned by the consumer.
 AllocationInfo[] getClientAllocationInfos(java.lang.String consumerPath)
          Get detailed information about allocations that are owned by the consumer and allocated by the client.
 ClientInfo getClientInfo()
          Get client detailed information.
 ConsumerHosts[] getConsumerHosts(java.lang.String consumerName)
          Get detailed information about hosts that are owned by the consumer.
 java.lang.String getConsumerTree(RoleType type)
          Get the static consumer tree.
 codegen.databinding.com.platform.www.DistributionPolicyConfigurationDocument.DistributionPolicyConfiguration getConsumerTree(RoleType type, boolean tree)
          Get the static consumer tree.
 
Methods inherited from interface com.platform.ego.InfoProvider
getClientInfos, getClusterInfo, getDefinedHostType, getMasterHost, getMasterHostList, getResourceGroups, getResourceInfos, getResourceSummary, getRoles4User, getServiceInfo, getUsers, getUsers4Role, verifyResreq
 

Method Detail

getClientInfo

ClientInfo getClientInfo()
                         throws EGOException
Get client detailed information.

Returns:
client detailed information.
Throws:
EGOException

getConsumerTree

java.lang.String getConsumerTree(RoleType type)
                                 throws EGOException,
                                        org.apache.xmlbeans.XmlException
Get the static consumer tree.

Parameters:
type - : specifies role that is not in properties information for consumer nodes.
Returns:
properties information for consumer nodes.
Throws:
EGOException, - XmlException
EGOException
org.apache.xmlbeans.XmlException

getConsumerTree

codegen.databinding.com.platform.www.DistributionPolicyConfigurationDocument.DistributionPolicyConfiguration getConsumerTree(RoleType type,
                                                                                                                             boolean tree)
                                                                                                                             throws EGOException,
                                                                                                                                    org.apache.xmlbeans.XmlException
Get the static consumer tree.

Parameters:
type - : specifies role that is not in properties information for consumer nodes.
tree - : obtain the policy tree.
Returns:
properties information for consumer nodes.
Throws:
EGOException, - XmlException
EGOException
org.apache.xmlbeans.XmlException

getAllocationInfos

AllocationInfo[] getAllocationInfos(java.lang.String consumerPath)
                                    throws EGOException
Get detailed information of allocations that is owned by the consumer.

Parameters:
consumerPath - : specifies path of consumer. if path of consumer equals empty, all allocations wil be returned.
Returns:
detailed information about the allocation.
Throws:
EGOException

getClientAllocationInfos

AllocationInfo[] getClientAllocationInfos(java.lang.String consumerPath)
                                          throws EGOException
Get detailed information about allocations that are owned by the consumer and allocated by the client.

Parameters:
consumerPath - : specifies path of consumer. if path of consumer equals empty, all allocations of the client will be returned.
Returns:
detailed information about the allocation.
Throws:
EGOException

getActivityInfos

ActivityInfo[] getActivityInfos(java.lang.String[] activityIDs,
                                java.lang.String[] consumerNames,
                                java.lang.String[] resourceNames)
                                throws EGOException
Get detailed information about activities.

Parameters:
activityIDs - : specifies ID of activity.
consumerNames - : specifies name of consumer.
resourceNames - : specifies name of resource.
Returns:
detailed information about the activity.
Throws:
EGOException

getConsumerHosts

ConsumerHosts[] getConsumerHosts(java.lang.String consumerName)
                                 throws EGOException
Get detailed information about hosts that are owned by the consumer.

Parameters:
consumerName - : specifies path of consumer.
Returns:
resource information of the consumer.
Throws:
EGOException


Copyright (C) 1992-2007 Platform Computing Corporation