com.pb.downloadmanager.api

Class DownloadManagerBuilder

java.lang.Object

com.pb.downloadmanager.api.DownloadManagerBuilder

public final class DownloadManagerBuilder
extends java.lang.Object

This class builds a DownloadManager to be used for downloading remote files to a local download location. The local download location must be specified when creating the builder. A PermissionsManager may optionally be specified to have to the repository manage file permissions. Add download managers (Downloader or WorkspaceDownloader) for each type of remote source to download from. Call build to retrieve the DownloadManager

Constructor Summary

Constructors

Constructor and Description
DownloadManagerBuilder() Starts building a DownloadManager without a repository root.
DownloadManagerBuilder(java.lang.String downloadLocation) Starts building a DownloadManager with the path to the download location.
DownloadManagerBuilder(java.lang.String downloadLocation, PermissionsManager permissions) Starts building a DownloadManager with the path to the download location and a PermissionsManager.

Method Summary

Modifier and Type	Method and Description
DownloadManagerBuilder	addDownloader(Downloader downloader) Adds a Downloader to support downloading from a specific remote source.
DownloadManagerBuilder	addDownloader(WorkspaceDownloader workspaceDownloader) Adds a WorkspaceDownloader to support downloading from a specific remote source.
DownloadManager	build() Builds a DownloadManager based on previous calls to the builder.

Methods inherited from class java.lang.Object

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

Constructor Detail

DownloadManagerBuilder

public DownloadManagerBuilder()

Starts building a DownloadManager without a repository root. Not having a repository means this builder will not be able to add any WorkspaceDownloader. This builder will create a very limited DownloadManager.

DownloadManagerBuilder

public DownloadManagerBuilder(java.lang.String downloadLocation)

Starts building a DownloadManager with the path to the download location. The download location should be a path representing a local filesystem directory that will be used as the repository's root directory for downloading. If the directory does not exist then it will be created, along with any parent directories that do not exist. This constructor creates a repository that does not manages file permissions.

Parameters:

downloadLocation - a local filesystem path the repository will use as a root directory for downloading.

DownloadManagerBuilder

public DownloadManagerBuilder(java.lang.String downloadLocation,
                              PermissionsManager permissions)

Starts building a DownloadManager with the path to the download location and a PermissionsManager. The download location should be a path representing a local filesystem directory that will be used as the repository's root directory for downloading. If the directory does not exist then it will be created, along with any missing parent directories. Each created directory created will be passed through the supplied PermissionsManager. The PermissionsManager will be handle all files created or downloaded under the download location.

Parameters:

downloadLocation - a local filesystem path the repository will use as a root directory for downloading.

permissions - a permissions manager will apply permissions after a resource is downloaded

Method Detail

addDownloader

public DownloadManagerBuilder addDownloader(Downloader downloader)

Adds a Downloader to support downloading from a specific remote source. If multiple download managers claim to support a path then the download manager added first will be used.

Parameters:

downloader - a download manager to add to the supported download managers for the repository being built

Returns:

this builder

addDownloader

public DownloadManagerBuilder addDownloader(WorkspaceDownloader workspaceDownloader)

Adds a WorkspaceDownloader to support downloading from a specific remote source. If multiple download managers claim to support a path then the download manager added first will be used. A WorkspaceDownloader is a download manager that uses workspaces. Workspaces are unique directories for each download path.

Parameters:

workspaceDownloader - a workspace download manager to add to the supported download managers for the repository being built

Returns:

this builder

build

public DownloadManager build()

Builds a DownloadManager based on previous calls to the builder.

Returns:

A repository that will use the supplied download managers to download to the given download location.