Package org.eclipse.aether.spi.connector
Class MetadataDownload
java.lang.Object
org.eclipse.aether.spi.connector.Transfer
org.eclipse.aether.spi.connector.MetadataTransfer
org.eclipse.aether.spi.connector.MetadataDownload
A download of metadata from a remote repository. A repository connector processing this download has to use
setException(MetadataTransferException)
to report the results of the transfer.-
Constructor Summary
ConstructorDescriptionCreates a new uninitialized download.MetadataDownload
(org.eclipse.aether.metadata.Metadata metadata, String context, File file, String checksumPolicy) Deprecated.MetadataDownload
(org.eclipse.aether.metadata.Metadata metadata, String context, Path path, String checksumPolicy) Creates a new download with the specified properties. -
Method Summary
Modifier and TypeMethodDescriptionGets the checksum policy for this transfer.List
<org.eclipse.aether.repository.RemoteRepository> Gets the remote repositories that are being aggregated by the physically contacted remote repository (i.e.Gets the context of this transfer.setChecksumPolicy
(String checksumPolicy) Sets the checksum policy for this transfer.setException
(org.eclipse.aether.transfer.MetadataTransferException exception) Sets the exception that occurred during the transfer.Deprecated.setListener
(org.eclipse.aether.transfer.TransferListener listener) setMetadata
(org.eclipse.aether.metadata.Metadata metadata) Sets the metadata to transfer.Sets the local file the metadata is downloaded to or uploaded from.setRepositories
(List<org.eclipse.aether.repository.RemoteRepository> repositories) Sets the remote repositories that are being aggregated by the physically contacted remote repository (i.e.setRequestContext
(String context) Sets the request context of this transfer.setTrace
(org.eclipse.aether.RequestTrace trace) toString()
Methods inherited from class org.eclipse.aether.spi.connector.MetadataTransfer
getException, getFile, getMetadata, getPath
Methods inherited from class org.eclipse.aether.spi.connector.Transfer
getListener, getTrace
-
Constructor Details
-
MetadataDownload
public MetadataDownload()Creates a new uninitialized download. -
MetadataDownload
@Deprecated public MetadataDownload(org.eclipse.aether.metadata.Metadata metadata, String context, File file, String checksumPolicy) Deprecated.UseMetadataDownload(Metadata, String, Path, String)
instead.Creates a new download with the specified properties.- Parameters:
metadata
- The metadata to download, may benull
.context
- The context in which this download is performed, may benull
.file
- The local file to download the metadata to, may benull
.checksumPolicy
- The checksum policy, may benull
.
-
MetadataDownload
public MetadataDownload(org.eclipse.aether.metadata.Metadata metadata, String context, Path path, String checksumPolicy) Creates a new download with the specified properties.- Parameters:
metadata
- The metadata to download, may benull
.context
- The context in which this download is performed, may benull
.path
- The local file to download the metadata to, may benull
.checksumPolicy
- The checksum policy, may benull
.- Since:
- 2.0.0
-
-
Method Details
-
setMetadata
Description copied from class:MetadataTransfer
Sets the metadata to transfer.- Overrides:
setMetadata
in classMetadataTransfer
- Parameters:
metadata
- The metadata, may benull
.- Returns:
- This transfer for chaining, never
null
.
-
setFile
Deprecated.Description copied from class:MetadataTransfer
Sets the local file the metadata is downloaded to or uploaded from.- Overrides:
setFile
in classMetadataTransfer
- Parameters:
file
- The local file, may benull
.- Returns:
- This transfer for chaining, never
null
.
-
setPath
Description copied from class:MetadataTransfer
Sets the local file the metadata is downloaded to or uploaded from.- Overrides:
setPath
in classMetadataTransfer
- Parameters:
path
- The local file, may benull
.- Returns:
- This transfer for chaining, never
null
.
-
getChecksumPolicy
Gets the checksum policy for this transfer.- Returns:
- The checksum policy, never
null
.
-
setChecksumPolicy
Sets the checksum policy for this transfer.- Parameters:
checksumPolicy
- The checksum policy, may benull
.- Returns:
- This transfer for chaining, never
null
.
-
getRequestContext
Gets the context of this transfer.- Returns:
- The context id, never
null
.
-
setRequestContext
Sets the request context of this transfer.- Parameters:
context
- The context id, may benull
.- Returns:
- This transfer for chaining, never
null
.
-
getRepositories
Gets the remote repositories that are being aggregated by the physically contacted remote repository (i.e. a repository manager).- Returns:
- The remote repositories being aggregated, never
null
.
-
setRepositories
public MetadataDownload setRepositories(List<org.eclipse.aether.repository.RemoteRepository> repositories) Sets the remote repositories that are being aggregated by the physically contacted remote repository (i.e. a repository manager).- Parameters:
repositories
- The remote repositories being aggregated, may benull
.- Returns:
- This transfer for chaining, never
null
.
-
setException
public MetadataDownload setException(org.eclipse.aether.transfer.MetadataTransferException exception) Description copied from class:MetadataTransfer
Sets the exception that occurred during the transfer.- Overrides:
setException
in classMetadataTransfer
- Parameters:
exception
- The exception, may benull
to denote a successful transfer.- Returns:
- This transfer for chaining, never
null
.
-
setListener
-
setTrace
-
toString
-
MetadataDownload(Metadata, String, Path, String)
instead.