com.android.repository.impl.installer

Class AbstractPackageOperation

java.lang.Object

com.android.repository.impl.installer.AbstractPackageOperation

All Implemented Interfaces:

PackageOperation

Direct Known Subclasses:

AbstractInstaller, AbstractUninstaller

public abstract class AbstractPackageOperation
extends java.lang.Object
implements PackageOperation

Frameworks for concrete Installers and Uninstallers that manages creation of temp directories, writing package metadata and install status, and resuming in-progress installs.

Nested Class Summary

Nested classes/interfaces inherited from interface com.android.repository.api.PackageOperation

PackageOperation.InstallStatus, PackageOperation.StatusChangeListener, PackageOperation.StatusChangeListenerException

Field Summary

Fields

Modifier and Type	Field and Description
protected FileOp	mFop

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractPackageOperation(RepoManager repoManager, FileOp fop)

Method Summary

Modifier and Type	Method and Description
boolean	complete(ProgressIndicator progress) Finds the prepared files using the installer metadata, and calls doComplete(File, ProgressIndicator).
protected abstract boolean	doComplete(java.io.File installTemp, ProgressIndicator progress) Subclasses should implement this to do any install/uninstall completion actions required.
protected abstract boolean	doPrepare(java.io.File installTempPath, ProgressIndicator progress) Subclasses should override this to prepare a package for (un)installation, including downloading, unzipping, etc.
PackageOperation.InstallStatus	getInstallStatus() Gets the current InstallStatus of this installer.
RepoManager	getRepoManager() Gets the RepoManager for which we're installing/uninstalling a package.
boolean	prepare(ProgressIndicator progress) Writes information used to restore the operation state if needed, then calls doPrepare(File, ProgressIndicator)
void	registerStateChangeListener(PackageOperation.StatusChangeListener listener) Registers a listener that will be called when the InstallStatus of this installer changes.
protected boolean	updateStatus(PackageOperation.InstallStatus status, ProgressIndicator progress) Sets our status to status and notifies our listeners.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.android.repository.api.PackageOperation

getLocation, getName, getPackage

Field Detail

mFop

protected final FileOp mFop

Constructor Detail

AbstractPackageOperation

protected AbstractPackageOperation(@NonNull
                                   RepoManager repoManager,
                                   @NonNull
                                   FileOp fop)

Method Detail

doPrepare

protected abstract boolean doPrepare(@NonNull
                                     java.io.File installTempPath,
                                     @NonNull
                                     ProgressIndicator progress)

Subclasses should override this to prepare a package for (un)installation, including downloading, unzipping, etc. as needed. No modification to the actual SDK should happen during this time.

Parameters:

installTempPath - The dir that should be used for any intermediate processing.

progress - For logging and progress display

doComplete

protected abstract boolean doComplete(@Nullable
                                      java.io.File installTemp,
                                      @NonNull
                                      ProgressIndicator progress)

Subclasses should implement this to do any install/uninstall completion actions required.

Parameters:

installTemp - The temporary dir in which we prepared the (un)install. May be null if for example the installer removed the installer properties file, but should not be normally.

progress - For logging and progress indication.

Returns:

true if the operation succeeded, false otherwise.

See Also:

complete(ProgressIndicator)

complete

public final boolean complete(@NonNull
                              ProgressIndicator progress)

Finds the prepared files using the installer metadata, and calls doComplete(File, ProgressIndicator).

Specified by:

complete in interface PackageOperation

Parameters:

progress - A ProgressIndicator, to show install progress and facilitate logging.

Returns:

true if the install was successful, false otherwise.

prepare

public final boolean prepare(@NonNull
                             ProgressIndicator progress)

Writes information used to restore the operation state if needed, then calls doPrepare(File, ProgressIndicator)

Specified by:

prepare in interface PackageOperation

Parameters:

progress - A ProgressIndicator, to show progress and facilitate logging.

Returns:

true if the operation succeeded, false otherwise.

getRepoManager

@NonNull
public RepoManager getRepoManager()

Description copied from interface: PackageOperation

Gets the RepoManager for which we're installing/uninstalling a package.

Specified by:

getRepoManager in interface PackageOperation

registerStateChangeListener

public final void registerStateChangeListener(@NonNull
                                              PackageOperation.StatusChangeListener listener)

Registers a listener that will be called when the InstallStatus of this installer changes.

Specified by:

registerStateChangeListener in interface PackageOperation

getInstallStatus

@NonNull
public final PackageOperation.InstallStatus getInstallStatus()

Gets the current InstallStatus of this installer.

Specified by:

getInstallStatus in interface PackageOperation

updateStatus

protected final boolean updateStatus(@NonNull
                                     PackageOperation.InstallStatus status,
                                     @NonNull
                                     ProgressIndicator progress)

Sets our status to status and notifies our listeners. If any listener throws an exception we will stop processing listeners and update our status to InstallStatus.FAILED (calling the listeners again with that status update).