DownloadResults (Geronimo 2.0.1 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.geronimo.system.plugin
Class DownloadResults

java.lang.Object
  org.apache.geronimo.system.plugin.DownloadResults

All Implemented Interfaces:: Serializable, DownloadPoller

public class DownloadResults
extends Object
implements Serializable, DownloadPoller
extends Object
implements Serializable, DownloadPoller

Provides the results of a configuration download operation. This is updated along the way for callers who want to monitor the ongoing progress.

See Also:: Serialized Form

Constructor Summary
`DownloadResults()`

Method Summary
`void`	`addDependencyInstalled(Artifact dep)` Notes that the current install operation found a dependency, and that dependency was downloaded from a remote repository and installed into the local server environment.
`void`	`addDependencyPresent(Artifact dep)` Notes that the current install operation found a dependency, and that dependency was satisfied by an artifact already available in the current server environment.
`void`	`addDownloadBytes(long bytes)` Called at the end of a file download with the number of bytes downloaded in the current operation.
`void`	`addInstalledConfigID(Artifact dep)` Notes that a configuration passed as an argument to the install operation was successfully installed.
`void`	`addRemovedConfigID(Artifact obsolete)` Notes a configuration that was removed because it was obsoleted by a newly-installed configuration.
`void`	`addRestartedConfigID(Artifact target)` Notes that a configuration was restarted as a result of the current operation.
`DownloadResults`	`duplicate()`
`String`	`getCurrentFile()` Gets the name of the file that is currently being operated on.
`int`	`getCurrentFilePercent()` Gets the progress on the current file expressed as a percentage.
`String`	`getCurrentMessage()` Gets a description of the work currently being done.
`Artifact[]`	`getDependenciesInstalled()` Gets the dependencies that we've successfully downloaded and installed into the local server environment.
`Artifact[]`	`getDependenciesPresent()` Gets the dependencies that we've needed but they're already present in the local server so no installation was necessary.
`Exception`	`getFailure()` If the operation failed, the Exception that caused the failure.
`Artifact[]`	`getInstalledConfigIDs()` Gets the list of the originally requested Config IDs that were successfully installed.
`Artifact[]`	`getRemovedConfigIDs()`
`Artifact[]`	`getRestartedConfigIDs()`
`long`	`getTotalDownloadBytes()` The total number of bytes in the archives downloaded from remote repositories.
`boolean`	`isFailed()`
`boolean`	`isFinished()`
`void`	`setCurrentFile(String currentFile)` Indicates which file the configuration installer is working on at the moment.
`void`	`setCurrentFilePercent(int currentFileProgress)` Gives the percent complete for a file currently being downloaded.
`void`	`setCurrentMessage(String currentMessage)` Describes the current operation status as a text message.
`void`	`setFailure(Exception failure)` Indicates that a failure was encountered during the installation operation.
`void`	`setFinished()` Always called when the operation is complete, regardless of whether there was a failure or not.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

DownloadResults

public DownloadResults()

Method Detail