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
public final class MetadataDownload extends MetadataTransfer
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 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.
      Use MetadataDownload(Metadata, String, Path, String) instead.
      Creates a new download with the specified properties.
      Parameters:
      metadata - The metadata to download, may be null.
      context - The context in which this download is performed, may be null.
      file - The local file to download the metadata to, may be null.
      checksumPolicy - The checksum policy, may be null.

    • 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 be null.
      context - The context in which this download is performed, may be null.
      path - The local file to download the metadata to, may be null.
      checksumPolicy - The checksum policy, may be null.
      Since:
      2.0.0

  • Method Details

    • setMetadata

      public MetadataDownload setMetadata(org.eclipse.aether.metadata.Metadata metadata)
      Description copied from class: MetadataTransfer
      Sets the metadata to transfer.
      Overrides:
      setMetadata in class MetadataTransfer
      Parameters:
      metadata - The metadata, may be null.
      Returns:
      This transfer for chaining, never null.

    • setFile

      @Deprecated public MetadataDownload setFile(File file)
      Deprecated.
      Description copied from class: MetadataTransfer
      Sets the local file the metadata is downloaded to or uploaded from.
      Overrides:
      setFile in class MetadataTransfer
      Parameters:
      file - The local file, may be null.
      Returns:
      This transfer for chaining, never null.

    • setPath

      public MetadataDownload setPath(Path path)
      Description copied from class: MetadataTransfer
      Sets the local file the metadata is downloaded to or uploaded from.
      Overrides:
      setPath in class MetadataTransfer
      Parameters:
      path - The local file, may be null.
      Returns:
      This transfer for chaining, never null.

    • getChecksumPolicy

      public String getChecksumPolicy()
      Gets the checksum policy for this transfer.
      Returns:
      The checksum policy, never null.

    • setChecksumPolicy

      public MetadataDownload setChecksumPolicy(String checksumPolicy)
      Sets the checksum policy for this transfer.
      Parameters:
      checksumPolicy - The checksum policy, may be null.
      Returns:
      This transfer for chaining, never null.

    • getRequestContext

      public String getRequestContext()
      Gets the context of this transfer.
      Returns:
      The context id, never null.

    • setRequestContext

      public MetadataDownload setRequestContext(String context)
      Sets the request context of this transfer.
      Parameters:
      context - The context id, may be null.
      Returns:
      This transfer for chaining, never null.

    • getRepositories

      public List<org.eclipse.aether.repository.RemoteRepository> 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 be null.
      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 class MetadataTransfer
      Parameters:
      exception - The exception, may be null to denote a successful transfer.
      Returns:
      This transfer for chaining, never null.

    • setListener

      public MetadataDownload setListener(org.eclipse.aether.transfer.TransferListener listener)

    • setTrace

      public MetadataDownload setTrace(org.eclipse.aether.RequestTrace trace)

    • toString

      public String toString()
      Overrides:
      toString in class Object