|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ParcelResource
This interface describes a parcel resource and all the operations that can
be performed on it. All the commands in this resource are modeled as
follows: When you execute a command, for example startDownload, that command
simply starts the download and returns right away. This is why they are
labeled as a synchronous commands. In order to see the progress of the command
a call to readParcel()
needs to be made. This will
show the current stage and any progress information if the parcel is in a
transition stage. Eg. DOWNLOADING, DISTRIBUTING etc.
If the command for some reason could not execute properly, an error
is returned to the user as part of the synchronous command.
A Parcel goes through many stages during its lifecycle. The various stages
and their order is described on in ApiParcel
Method Summary | |
---|---|
ApiCommand |
activateCommand()
A synchronous command that activates the parcel on the cluster. |
ApiCommand |
cancelDistributionCommand()
A synchronous command that cancels the parcel distribution. |
ApiCommand |
cancelDownloadCommand()
A synchronous command that cancels the parcel download. |
ApiCommand |
deactivateCommand()
A synchronous command that deactivates the parcel on the cluster. |
ApiParcel |
readParcel()
Retrieves detailed information about a parcel. |
ApiCommand |
removeDownloadCommand()
A synchronous command that removes the downloaded parcel. |
ApiCommand |
startDistributionCommand()
A synchronous command that starts the distribution of the parcel to the cluster. |
ApiCommand |
startDownloadCommand()
A synchronous command that starts the parcel download. |
ApiCommand |
startRemovalOfDistributionCommand()
A synchronous command that removes the distribution from the hosts in the cluster. |
Method Detail |
---|
@Path(value="/") ApiParcel readParcel()
@Path(value="/commands/startDownload") ApiCommand startDownloadCommand()
Since it is synchronous, the result is known immediately upon return.
In order to see the progress of the download, a call
to readParcel()
needs to be made.
@Path(value="/commands/cancelDownload") ApiCommand cancelDownloadCommand()
Since it is synchronous, the result is known immediately upon return.
@Path(value="/commands/removeDownload") ApiCommand removeDownloadCommand()
Since it is synchronous, the result is known immediately upon return.
@Path(value="/commands/startDistribution") ApiCommand startDistributionCommand()
Since it is synchronous, the result is known immediately upon return.
In order to see the progress of the distribution, a call
to readParcel()
needs to be made.
@Path(value="/commands/cancelDistribution") ApiCommand cancelDistributionCommand()
Since it is synchronous, the result is known immediately upon return.
@Path(value="/commands/startRemovalOfDistribution") ApiCommand startRemovalOfDistributionCommand()
Since it is synchronous, the result is known immediately upon return.
In order to see the progress of the removal, a call
to readParcel()
needs to be made.
@Path(value="/commands/activate") ApiCommand activateCommand()
Since it is synchronous, the result is known immediately upon return.
@Path(value="/commands/deactivate") ApiCommand deactivateCommand()
Since it is synchronous, the result is known immediately upon return.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |