org.commonjava.indy.content

Interface DownloadManager

public interface DownloadManager

Organizes resolution of content from cached locations, remote locations, and group membership. This is a low-level interface intended to be used by ContentManager and ContentGenerator implementations. It does not include results from generator sources (i.e. ContentProducer).

Field Summary

Fields

Modifier and Type	Field and Description
static String	HTTP_PARAM_REPO Key used to bind RemoteRepository instances to the HTTP client in order to extract SSL/authentication info.
static String	ROOT_PATH Root path used when retrieving the root of a Location's cache.

Method Summary

Modifier and Type	Method and Description
boolean	delete(org.commonjava.indy.model.core.ArtifactStore store, String path)
boolean	delete(org.commonjava.indy.model.core.ArtifactStore store, String path, org.commonjava.maven.galley.event.EventMetadata eventMetadata)
boolean	deleteAll(List<? extends org.commonjava.indy.model.core.ArtifactStore> stores, String path)
boolean	exists(org.commonjava.indy.model.core.ArtifactStore store, String path) Artifact existence check for given store and path.
org.commonjava.maven.galley.model.Transfer	getStorageReference(org.commonjava.indy.model.core.ArtifactStore store, String... path)
org.commonjava.maven.galley.model.Transfer	getStorageReference(org.commonjava.indy.model.core.ArtifactStore store, String path, org.commonjava.maven.galley.model.TransferOperation op) Retrieve a Transfer object suitable for use in the specified operation.
org.commonjava.maven.galley.model.Transfer	getStorageReference(List<org.commonjava.indy.model.core.ArtifactStore> stores, String path, org.commonjava.maven.galley.model.TransferOperation op) Retrieve a Transfer object suitable for use in the specified operation.
org.commonjava.maven.galley.model.Transfer	getStorageReference(org.commonjava.indy.model.core.StoreKey key, String... path)
org.commonjava.maven.galley.model.Transfer	getStoreRootDirectory(org.commonjava.indy.model.core.ArtifactStore store)
org.commonjava.maven.galley.model.Transfer	getStoreRootDirectory(org.commonjava.indy.model.core.StoreKey key)
List<StoreResource>	list(org.commonjava.indy.model.core.ArtifactStore store, String path)
List<StoreResource>	list(org.commonjava.indy.model.core.ArtifactStore store, String path, org.commonjava.maven.galley.event.EventMetadata eventMetadatada)
List<StoreResource>	list(List<? extends org.commonjava.indy.model.core.ArtifactStore> stores, String path)
List<StoreResource>	list(List<? extends org.commonjava.indy.model.core.ArtifactStore> stores, String path, org.commonjava.maven.galley.event.EventMetadata eventMetadata)
List<org.commonjava.maven.galley.model.Transfer>	listRecursively(org.commonjava.indy.model.core.StoreKey src, String startPath)
void	rescan(org.commonjava.indy.model.core.ArtifactStore store)
void	rescan(org.commonjava.indy.model.core.ArtifactStore store, org.commonjava.maven.galley.event.EventMetadata eventMetadata)
void	rescanAll(List<? extends org.commonjava.indy.model.core.ArtifactStore> stores)
void	rescanAll(List<? extends org.commonjava.indy.model.core.ArtifactStore> stores, org.commonjava.maven.galley.event.EventMetadata eventMetadata)
org.commonjava.maven.galley.model.Transfer	retrieve(org.commonjava.indy.model.core.ArtifactStore store, String path) Retrieve the content at the given path from the given store, then return the transfer that references the content.
org.commonjava.maven.galley.model.Transfer	retrieve(org.commonjava.indy.model.core.ArtifactStore store, String path, org.commonjava.maven.galley.event.EventMetadata eventMetadata) Retrieve the content at the given path from the given store, then return the transfer that references the content.
List<org.commonjava.maven.galley.model.Transfer>	retrieveAll(List<? extends org.commonjava.indy.model.core.ArtifactStore> stores, String path) Retrieve the content at the given path from all stores, then return the set of transfers that reference the content.
List<org.commonjava.maven.galley.model.Transfer>	retrieveAll(List<? extends org.commonjava.indy.model.core.ArtifactStore> stores, String path, org.commonjava.maven.galley.event.EventMetadata eventMetadata) Retrieve the content at the given path from all stores, then return the set of transfers that reference the content.
org.commonjava.maven.galley.model.Transfer	retrieveFirst(List<? extends org.commonjava.indy.model.core.ArtifactStore> stores, String path) Retrieve the content at the given path from the first store possible, then return then return the transfer that references the content without iterating any farther.
org.commonjava.maven.galley.model.Transfer	retrieveFirst(List<? extends org.commonjava.indy.model.core.ArtifactStore> stores, String path, org.commonjava.maven.galley.event.EventMetadata eventMetadata) Retrieve the content at the given path from the first store possible, then return then return the transfer that references the content without iterating any farther.
org.commonjava.maven.galley.model.Transfer	store(org.commonjava.indy.model.core.ArtifactStore store, String path, InputStream stream, org.commonjava.maven.galley.model.TransferOperation op) Store the content contained in the InputStream under the given path within the storage directory for the given ArtifactStore.
org.commonjava.maven.galley.model.Transfer	store(org.commonjava.indy.model.core.ArtifactStore store, String path, InputStream stream, org.commonjava.maven.galley.model.TransferOperation op, org.commonjava.maven.galley.event.EventMetadata eventMetadata) Store the content contained in the InputStream under the given path within the storage directory for the given ArtifactStore.
org.commonjava.maven.galley.model.Transfer	store(List<? extends org.commonjava.indy.model.core.ArtifactStore> stores, String path, InputStream stream, org.commonjava.maven.galley.model.TransferOperation op) Store the content contained in the InputStream under the given path within the storage directory for first appropriate instance among the given ArtifactStore's.
org.commonjava.maven.galley.model.Transfer	store(List<? extends org.commonjava.indy.model.core.ArtifactStore> stores, String path, InputStream stream, org.commonjava.maven.galley.model.TransferOperation op, org.commonjava.maven.galley.event.EventMetadata eventMetadata) Store the content contained in the InputStream under the given path within the storage directory for first appropriate instance among the given ArtifactStore's.

Field Detail

HTTP_PARAM_REPO

static final String HTTP_PARAM_REPO

Key used to bind RemoteRepository instances to the HTTP client in order to extract SSL/authentication info. TODO: Given the attribute methods in the Galley Location api, this should be obsolete.

See Also:

Constant Field Values

ROOT_PATH

static final String ROOT_PATH

Root path used when retrieving the root of a Location's cache.

See Also:

Constant Field Values

Method Detail

retrieveFirst

org.commonjava.maven.galley.model.Transfer retrieveFirst(List<? extends org.commonjava.indy.model.core.ArtifactStore> stores,
                                                         String path)
                                                  throws IndyWorkflowException

Retrieve the content at the given path from the first store possible, then return then return the transfer that references the content without iterating any farther.

Throws:

IndyWorkflowException

retrieveFirst

org.commonjava.maven.galley.model.Transfer retrieveFirst(List<? extends org.commonjava.indy.model.core.ArtifactStore> stores,
                                                         String path,
                                                         org.commonjava.maven.galley.event.EventMetadata eventMetadata)
                                                  throws IndyWorkflowException

Retrieve the content at the given path from the first store possible, then return then return the transfer that references the content without iterating any farther.

Parameters:

eventMetadata - TODO

Throws:

IndyWorkflowException

retrieveAll

List<org.commonjava.maven.galley.model.Transfer> retrieveAll(List<? extends org.commonjava.indy.model.core.ArtifactStore> stores,
                                                             String path)
                                                      throws IndyWorkflowException

Retrieve the content at the given path from all stores, then return the set of transfers that reference the content.

Throws:

IndyWorkflowException

retrieveAll

List<org.commonjava.maven.galley.model.Transfer> retrieveAll(List<? extends org.commonjava.indy.model.core.ArtifactStore> stores,
                                                             String path,
                                                             org.commonjava.maven.galley.event.EventMetadata eventMetadata)
                                                      throws IndyWorkflowException

Retrieve the content at the given path from all stores, then return the set of transfers that reference the content.

Parameters:

eventMetadata - TODO

Throws:

IndyWorkflowException

retrieve

org.commonjava.maven.galley.model.Transfer retrieve(org.commonjava.indy.model.core.ArtifactStore store,
                                                    String path)
                                             throws IndyWorkflowException

Retrieve the content at the given path from the given store, then return the transfer that references the content.

Throws:

IndyWorkflowException

retrieve

org.commonjava.maven.galley.model.Transfer retrieve(org.commonjava.indy.model.core.ArtifactStore store,
                                                    String path,
                                                    org.commonjava.maven.galley.event.EventMetadata eventMetadata)
                                             throws IndyWorkflowException

Retrieve the content at the given path from the given store, then return the transfer that references the content.

Parameters:

eventMetadata - TODO

Throws:

IndyWorkflowException

store

org.commonjava.maven.galley.model.Transfer store(org.commonjava.indy.model.core.ArtifactStore store,
                                                 String path,
                                                 InputStream stream,
                                                 org.commonjava.maven.galley.model.TransferOperation op)
                                          throws IndyWorkflowException

Store the content contained in the InputStream under the given path within the storage directory for the given ArtifactStore. Use the given TransferOperation to trigger the appropriate tangential maintenance, etc. actions. Return the Transfer that references the stored content.
If the given ArtifactStore isn't a HostedRepository, or is a Group that doesn't contain a HostedRepository, fail. If the HostedRepository instances involved don't allow deployment/storage, or don't allow appropriate deployment (releases-only for snapshot content, or vice versa), then fail.

Throws:

IndyWorkflowException

store

org.commonjava.maven.galley.model.Transfer store(org.commonjava.indy.model.core.ArtifactStore store,
                                                 String path,
                                                 InputStream stream,
                                                 org.commonjava.maven.galley.model.TransferOperation op,
                                                 org.commonjava.maven.galley.event.EventMetadata eventMetadata)
                                          throws IndyWorkflowException

Store the content contained in the InputStream under the given path within the storage directory for the given ArtifactStore. Use the given TransferOperation to trigger the appropriate tangential maintenance, etc. actions. Return the Transfer that references the stored content.
If the given ArtifactStore isn't a HostedRepository, or is a Group that doesn't contain a HostedRepository, fail. If the HostedRepository instances involved don't allow deployment/storage, or don't allow appropriate deployment (releases-only for snapshot content, or vice versa), then fail.

Parameters:

eventMetadata - TODO

Throws:

IndyWorkflowException

store

org.commonjava.maven.galley.model.Transfer store(List<? extends org.commonjava.indy.model.core.ArtifactStore> stores,
                                                 String path,
                                                 InputStream stream,
                                                 org.commonjava.maven.galley.model.TransferOperation op)
                                          throws IndyWorkflowException

Store the content contained in the InputStream under the given path within the storage directory for first appropriate instance among the given ArtifactStore's. Use the given TransferOperation to trigger the appropriate tangential maintenance, etc. actions. Return the Transfer that references the stored content.
If the given ArtifactStore isn't a HostedRepository, or is a Group that doesn't contain a HostedRepository, fail. If the HostedRepository instances involved don't allow deployment/storage, or don't allow appropriate deployment (releases-only for snapshot content, or vice versa), then fail.

Throws:

IndyWorkflowException

store

org.commonjava.maven.galley.model.Transfer store(List<? extends org.commonjava.indy.model.core.ArtifactStore> stores,
                                                 String path,
                                                 InputStream stream,
                                                 org.commonjava.maven.galley.model.TransferOperation op,
                                                 org.commonjava.maven.galley.event.EventMetadata eventMetadata)
                                          throws IndyWorkflowException

Store the content contained in the InputStream under the given path within the storage directory for first appropriate instance among the given ArtifactStore's. Use the given TransferOperation to trigger the appropriate tangential maintenance, etc. actions. Return the Transfer that references the stored content.
If the given ArtifactStore isn't a HostedRepository, or is a Group that doesn't contain a HostedRepository, fail. If the HostedRepository instances involved don't allow deployment/storage, or don't allow appropriate deployment (releases-only for snapshot content, or vice versa), then fail.

Parameters:

eventMetadata - TODO

Throws:

IndyWorkflowException

delete

boolean delete(org.commonjava.indy.model.core.ArtifactStore store,
               String path)
        throws IndyWorkflowException

Throws:

IndyWorkflowException

delete

boolean delete(org.commonjava.indy.model.core.ArtifactStore store,
               String path,
               org.commonjava.maven.galley.event.EventMetadata eventMetadata)
        throws IndyWorkflowException

Throws:

IndyWorkflowException

deleteAll

boolean deleteAll(List<? extends org.commonjava.indy.model.core.ArtifactStore> stores,
                  String path)
           throws IndyWorkflowException

Throws:

IndyWorkflowException

rescan

void rescan(org.commonjava.indy.model.core.ArtifactStore store)
     throws IndyWorkflowException

Throws:

IndyWorkflowException

rescan

void rescan(org.commonjava.indy.model.core.ArtifactStore store,
            org.commonjava.maven.galley.event.EventMetadata eventMetadata)
     throws IndyWorkflowException

Throws:

IndyWorkflowException

rescanAll

void rescanAll(List<? extends org.commonjava.indy.model.core.ArtifactStore> stores)
        throws IndyWorkflowException

Throws:

IndyWorkflowException

rescanAll

void rescanAll(List<? extends org.commonjava.indy.model.core.ArtifactStore> stores,
               org.commonjava.maven.galley.event.EventMetadata eventMetadata)
        throws IndyWorkflowException

Throws:

IndyWorkflowException

list

List<StoreResource> list(org.commonjava.indy.model.core.ArtifactStore store,
                         String path)
                  throws IndyWorkflowException

Throws:

IndyWorkflowException

list

List<StoreResource> list(org.commonjava.indy.model.core.ArtifactStore store,
                         String path,
                         org.commonjava.maven.galley.event.EventMetadata eventMetadatada)
                  throws IndyWorkflowException

Throws:

IndyWorkflowException

list

List<StoreResource> list(List<? extends org.commonjava.indy.model.core.ArtifactStore> stores,
                         String path)
                  throws IndyWorkflowException

Throws:

IndyWorkflowException

list

List<StoreResource> list(List<? extends org.commonjava.indy.model.core.ArtifactStore> stores,
                         String path,
                         org.commonjava.maven.galley.event.EventMetadata eventMetadata)
                  throws IndyWorkflowException

Throws:

IndyWorkflowException

getStoreRootDirectory

org.commonjava.maven.galley.model.Transfer getStoreRootDirectory(org.commonjava.indy.model.core.StoreKey key)
                                                          throws IndyWorkflowException

Throws:

IndyWorkflowException

getStoreRootDirectory

org.commonjava.maven.galley.model.Transfer getStoreRootDirectory(org.commonjava.indy.model.core.ArtifactStore store)

getStorageReference

org.commonjava.maven.galley.model.Transfer getStorageReference(org.commonjava.indy.model.core.StoreKey key,
                                                               String... path)
                                                        throws IndyWorkflowException

Throws:

IndyWorkflowException

getStorageReference

org.commonjava.maven.galley.model.Transfer getStorageReference(org.commonjava.indy.model.core.ArtifactStore store,
                                                               String... path)

listRecursively

List<org.commonjava.maven.galley.model.Transfer> listRecursively(org.commonjava.indy.model.core.StoreKey src,
                                                                 String startPath)
                                                          throws IndyWorkflowException

Throws:

IndyWorkflowException

getStorageReference

org.commonjava.maven.galley.model.Transfer getStorageReference(List<org.commonjava.indy.model.core.ArtifactStore> stores,
                                                               String path,
                                                               org.commonjava.maven.galley.model.TransferOperation op)
                                                        throws IndyWorkflowException

Retrieve a Transfer object suitable for use in the specified operation. This method handles the selection logic, and doesn't fire any events (the returned Transfer object handles that in this case). The first suitable store is used to hold the Transfer.

Parameters:

stores - The stores in which the Transfer should reside

path - The path of the Transfer inside the store

op - The operation we want to execute on the returned Transfer

Returns:

A suitable transfer object (not null; those cases result in an exception) NOTE: the returned transfer may not exist!

Throws:

IndyWorkflowException - in case no suitable storage location can be found

getStorageReference

org.commonjava.maven.galley.model.Transfer getStorageReference(org.commonjava.indy.model.core.ArtifactStore store,
                                                               String path,
                                                               org.commonjava.maven.galley.model.TransferOperation op)
                                                        throws IndyWorkflowException

Retrieve a Transfer object suitable for use in the specified operation. This method handles the selection logic in the event the store is a Group, and doesn't fire any events (the returned Transfer object handles that in this case).

Parameters:

store - The store in which the Transfer should reside

path - The path of the Transfer inside the store

op - The operation we want to execute on the returned Transfer

Returns:

A suitable transfer object (not null; those cases result in an exception) NOTE: the returned transfer may not exist!

Throws:

IndyWorkflowException - in case no suitable storage location can be found

exists

boolean exists(org.commonjava.indy.model.core.ArtifactStore store,
               String path)
        throws IndyWorkflowException

Artifact existence check for given store and path. This method doesn't fire any events.

Parameters:

store - The store in which the check is performed

path - The path of the Transfer inside the store

Throws:

IndyWorkflowException - in case no suitable storage location can be found