com.platform.ego
Interface InfoProvider

All Known Subinterfaces:
ClientInfoProvider

public interface InfoProvider

Info-Provider is used to get various informations of EGO.

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.

Version:
1.2.3

Method Summary
 ClientInfo[] getClientInfos(java.lang.String clientName)
          Get the infomation of client.
 ClusterInfo getClusterInfo()
          Retrieve meta data about the EGO cluster.
 java.lang.String[] getDefinedHostType()
          Get active host types.
 java.lang.String getMasterHost()
          Get name of master host.
 java.lang.String[] getMasterHostList()
          Get master candidate host list.
 ResourceGroup[] getResourceGroups(java.lang.String[] resourceGroupNames)
          Get information about ResourceGroup(s).
 ResourceInfo[] getResourceInfos(java.lang.String resreq, java.lang.String[] reslist)
          Get resource information from EGO.
 ResourceSummary getResourceSummary()
          Get host summary information.
 Role[] getRoles4User(java.lang.String username)
          Get the role of certain user
 ServiceInfo[] getServiceInfo(java.lang.String serviceName)
          Get the infomation of service named serviceName from EGO.
 User[] getUsers()
          Get list of user who can use EGO cluster
 java.lang.String[] getUsers4Role(Role role)
          Get the users of certain role
 boolean verifyResreq(java.lang.String resreq)
          Verify resource requirement string's syntax is correct or not.
 

Method Detail

getClusterInfo

ClusterInfo getClusterInfo()
                           throws EGOException
Retrieve meta data about the EGO cluster.

Returns:
one ClusterInfo element
Throws:
EGOException

getMasterHost

java.lang.String getMasterHost()
                               throws EGOException
Get name of master host.

Returns:
the name of master host
Throws:
EGOException

getMasterHostList

java.lang.String[] getMasterHostList()
                                     throws EGOException
Get master candidate host list.

Returns:
a list of masters' name
Throws:
EGOException

getResourceSummary

ResourceSummary getResourceSummary()
                                   throws EGOException
Get host summary information.

Returns:
host summary information
Throws:
EGOException

getDefinedHostType

java.lang.String[] getDefinedHostType()
                                      throws EGOException
Get active host types.

Returns:
a list of host types
Throws:
EGOException

getResourceGroups

ResourceGroup[] getResourceGroups(java.lang.String[] resourceGroupNames)
                                  throws EGOException
Get information about ResourceGroup(s).

Parameters:
resourceGroupNames - : specifies which resource group info is requested.
Returns:
an array of ResourceGroup objects.
Throws:
EGOException

getResourceInfos

ResourceInfo[] getResourceInfos(java.lang.String resreq,
                                java.lang.String[] reslist)
                                throws EGOException
Get resource information from EGO.

Parameters:
resreq - : specifies resource requirement string.
reslist - : specifies list of resource.
Returns:
a list of resource information.
Throws:
EGOException

getServiceInfo

ServiceInfo[] getServiceInfo(java.lang.String serviceName)
                             throws EGOException
Get the infomation of service named serviceName from EGO.

Parameters:
serviceName - : specifies name of the service which is wanted to query
Returns:
an array of ServiceInfo objects.
Throws:
EGOException - get failure

getRoles4User

Role[] getRoles4User(java.lang.String username)
                     throws EGOException
Get the role of certain user

Parameters:
username - : specifies name of user
Returns:
a list of class Role
Throws:
EGOException - query failure

getUsers4Role

java.lang.String[] getUsers4Role(Role role)
                                 throws EGOException
Get the users of certain role

Parameters:
role - : specifies role which wanted to be queried
Returns:
a list of user name
Throws:
EGOException - query failure

getUsers

User[] getUsers()
                throws EGOException
Get list of user who can use EGO cluster

Returns:
an array of User objects
Throws:
EGOException - query failure

getClientInfos

ClientInfo[] getClientInfos(java.lang.String clientName)
                            throws EGOException
Get the infomation of client.

Parameters:
clientName - : specifies name of client.
Returns:
an array of ClientInfo objects.
Throws:
EGOException

verifyResreq

boolean verifyResreq(java.lang.String resreq)
                     throws EGOException
Verify resource requirement string's syntax is correct or not.

Parameters:
resreq - : specifies string of resource requirement.
Throws:
EGOException


Copyright (C) 1992-2007 Platform Computing Corporation