com.platform.ego
Interface ConsumerAdmin


public interface ConsumerAdmin

This interface supports the control and management functions of EGO's consumer.

Version:
1.2.3

Method Summary
 void addConsumer(Consumer consumer, java.lang.String parentPath)
          Add consumer node and its properties.
 void delConsumer(java.lang.String consumerPath)
          Delete consumer node and its properties.
 ConsumerHosts[] getConsumerResources(java.lang.String consumerPath)
          Get resources that are allocated to specific consumer.
 void setConsumer(Consumer consumer, java.lang.String consumerPath)
          Set consumer node and its properties.
 void setResourcePlan(java.lang.String pathname, codegen.databinding.com.platform.www.ConsumerDocument.Consumer cns, java.lang.String rGroupName)
          This operation allows an EGO administrator to manipulate the current policy for a Consumer.
 void setResourcePlan(java.lang.String path, codegen.databinding.com.platform.www.DistributionPolicyConfigurationDocument.DistributionPolicyConfiguration dpcc, java.lang.String[] dtNames)
          Set the consumer policy.
 void setResourcePlan(java.lang.String path, java.lang.String xmlstr)
          Set the consumer policy using XML as input parameter.
 boolean verifyConsumerPath(java.lang.String consumerPath, java.lang.String resourceGroupName)
          Verify consumer path is valid or not.
 

Method Detail

setResourcePlan

void setResourcePlan(java.lang.String path,
                     java.lang.String xmlstr)
                     throws EGOException,
                            org.apache.xmlbeans.XmlException
Set the consumer policy using XML as input parameter.

Parameters:
path - : specifies path of consumer.
xmlstr - : specifies policy of consumer.
Throws:
EGOException
org.apache.xmlbeans.XmlException

setResourcePlan

void setResourcePlan(java.lang.String path,
                     codegen.databinding.com.platform.www.DistributionPolicyConfigurationDocument.DistributionPolicyConfiguration dpcc,
                     java.lang.String[] dtNames)
                     throws EGOException,
                            org.apache.xmlbeans.XmlException
Set the consumer policy.

Parameters:
path - : specifies path of consumer.
dpcc - : specifies policy of consumer.
distributionTreeNames - : names of those trees that have been changed.
Throws:
EGOException
org.apache.xmlbeans.XmlException

setResourcePlan

void setResourcePlan(java.lang.String pathname,
                     codegen.databinding.com.platform.www.ConsumerDocument.Consumer cns,
                     java.lang.String rGroupName)
                     throws EGOException
This operation allows an EGO administrator to manipulate the current policy for a Consumer.

Parameters:
pathname -
cns -
rGroupName -
Throws:
java.rmi.RemoteException
APIException
org.apache.xmlbeans.XmlException
EGOException

addConsumer

void addConsumer(Consumer consumer,
                 java.lang.String parentPath)
                 throws EGOException
Add consumer node and its properties.

Parameters:
consumer - : specifies properties of consumer.
parentPath - : specifies path of consumer.
Throws:
EGOException

delConsumer

void delConsumer(java.lang.String consumerPath)
                 throws EGOException
Delete consumer node and its properties.

Parameters:
consumerPath - : specifies path of consumer.
Throws:
EGOException

setConsumer

void setConsumer(Consumer consumer,
                 java.lang.String consumerPath)
                 throws EGOException
Set consumer node and its properties.

Parameters:
consumer - : specifies properties of consumer.
consumerPath - : specifies path of consumer.
Throws:
EGOException

getConsumerResources

ConsumerHosts[] getConsumerResources(java.lang.String consumerPath)
                                     throws EGOException
Get resources that are allocated to specific consumer.

Parameters:
consumerPath - : specifies path of consumer.
Returns:
an array of resources.
Throws:
EGOException

verifyConsumerPath

boolean verifyConsumerPath(java.lang.String consumerPath,
                           java.lang.String resourceGroupName)
                           throws EGOException
Verify consumer path is valid or not.

Parameters:
consumerPath - : specifies path of consumer.
resourceGroupName - : specifies name of resource group.
Throws:
EGOException


Copyright (C) 1992-2007 Platform Computing Corporation