com.platform.ego
Interface Allocation


public interface Allocation

The interface provides a mechanism to control resource allocations.

Based on the availability of resources and the amount of resources a consumer is entitled to, Platform EGO applies policies to determine how many resources to allocate to a given request. The client is notified asynchronously as the resources become available. In this case, CPU slots are identified by the physical host that they reside on and this host information is passed back to the client.

Version:
1.2.3

Method Summary
 void free()
          This operation is used to cancel an existing allocation.
 java.lang.String getAllocID()
          Get ID of allocation.
 AllocationInfo getAllocInfo()
          Get detailed information of allocation.
 AllocRequest getAllocRequest()
          Get request of allocation.
 java.lang.String getConsumerID()
          Get path of consumer that owns the allocation.
 Resource getResource(java.lang.String resName)
          Get resource by name of resource.
 Resource[] getResources()
          Get all resources that are included in the allocation.
 void realloc(ReallocRequest allocateSpec)
          This operation is used to modify the parameters of an existing allocation.
 void release(ReleaseRequest releaseReq)
          This operation is used to release or replace resources that have been assigned to an allocation.
 Activity[] startActivity(ActivityRequest actreq, ActivityCallbackHandler handler)
          The operation is used by an EGO client to request the execution of an activity on all resources assigned to allocation.
 void unblock(java.lang.String[] resourceNames)
          This operation is used to remove resources from BLOCK list.
 

Method Detail

realloc

void realloc(ReallocRequest allocateSpec)
             throws EGOException
This operation is used to modify the parameters of an existing allocation.

Parameters:
allocateSpec - : specifies a description of the parameters to change within the existing allocation.
Throws:
EGOException

free

void free()
          throws EGOException
This operation is used to cancel an existing allocation. Cancelling an allocation implies that all resources assigned to the allocation are reclaimed by EGO, and that all activities running within these allocations are terminated.

Throws:
EGOException

release

void release(ReleaseRequest releaseReq)
             throws EGOException
This operation is used to release or replace resources that have been assigned to an allocation.

Parameters:
releaseReq - : specifies one or more elements describing which resources to remove from the allocation. They must be part of the existing allocation to be released.
Throws:
EGOException

unblock

void unblock(java.lang.String[] resourceNames)
             throws EGOException
This operation is used to remove resources from BLOCK list.

Parameters:
resourceNames - : specifies names of resource.
Throws:
EGOException

getAllocID

java.lang.String getAllocID()
Get ID of allocation.

Returns:
ID of allocation.

getAllocRequest

AllocRequest getAllocRequest()
Get request of allocation.

Returns:
request of allocation.

getConsumerID

java.lang.String getConsumerID()
Get path of consumer that owns the allocation.

Returns:
one consumer path.

getResources

Resource[] getResources()
Get all resources that are included in the allocation.

Returns:
a set of resources.

getResource

Resource getResource(java.lang.String resName)
Get resource by name of resource.

Returns:
a Resource object.

getAllocInfo

AllocationInfo getAllocInfo()
                            throws EGOException
Get detailed information of allocation.

Returns:
information of allocation.
Throws:
EGOException

startActivity

Activity[] startActivity(ActivityRequest actreq,
                         ActivityCallbackHandler handler)
                         throws EGOException
The operation is used by an EGO client to request the execution of an activity on all resources assigned to allocation.

Parameters:
actreq - : specifies request of activity.
handler - : specifies handler of callback message of this allocation from EGO cluster.
Returns:
an Activity array object.
Throws:
EGOException


Copyright (C) 1992-2007 Platform Computing Corporation