Package org.eclipse.aether.spi.connector

Class MetadataTransfer

java.lang.Object
org.eclipse.aether.spi.connector.Transfer
org.eclipse.aether.spi.connector.MetadataTransfer
Direct Known Subclasses:
MetadataDownload, MetadataUpload
public abstract class MetadataTransfer extends Transfer
A download/upload of metadata.
Restriction:
This class is not intended to be extended by clients.

  • Method Details

    • getMetadata

      public Metadata getMetadata()
      Gets the metadata being transferred.
      Returns:
      The metadata being transferred or null if not set.

    • setMetadata

      public MetadataTransfer setMetadata(Metadata metadata)
      Sets the metadata to transfer.
      Parameters:
      metadata - The metadata, may be null.
      Returns:
      This transfer for chaining, never null.

    • getFile

      @Deprecated public File getFile()
      Deprecated.
      Use getPath() instead.
      Gets the local file the metadata is downloaded to or uploaded from. In case of a download, a connector should first transfer the bytes to a temporary file and only overwrite the target file once the entire download is completed such that an interrupted/failed download does not corrupt the current file contents.
      Returns:
      The local file or null if not set.

    • getPath

      public Path getPath()
      Gets the local file the metadata is downloaded to or uploaded from. In case of a download, a connector should first transfer the bytes to a temporary file and only overwrite the target file once the entire download is completed such that an interrupted/failed download does not corrupt the current file contents.
      Returns:
      The local file or null if not set.
      Since:
      2.0.0

    • setFile

      @Deprecated public MetadataTransfer setFile(File file)
      Deprecated.
      Use setPath(Path) instead.
      Sets the local file the metadata is downloaded to or uploaded from.
      Parameters:
      file - The local file, may be null.
      Returns:
      This transfer for chaining, never null.

    • setPath

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

    • getException

      public MetadataTransferException getException()
      Gets the exception that occurred during the transfer (if any).
      Specified by:
      getException in class Transfer
      Returns:
      The exception or null if the transfer was successful.

    • setException

      public MetadataTransfer setException(MetadataTransferException exception)
      Sets the exception that occurred during the transfer.
      Parameters:
      exception - The exception, may be null to denote a successful transfer.
      Returns:
      This transfer for chaining, never null.