Package org.eclipse.aether.spi.connector

Class ArtifactTransfer

java.lang.Object
org.eclipse.aether.spi.connector.Transfer
org.eclipse.aether.spi.connector.ArtifactTransfer
Direct Known Subclasses:
ArtifactDownload, ArtifactUpload
public abstract class ArtifactTransfer extends Transfer
A download/upload of an artifact.
Restriction:
This class is not intended to be extended by clients.

  • Method Details

    • getArtifact

      public Artifact getArtifact()
      Gets the artifact being transferred.
      Returns:
      The artifact being transferred or null if not set.

    • setArtifact

      public ArtifactTransfer setArtifact(Artifact artifact)
      Sets the artifact to transfer.
      Parameters:
      artifact - The artifact, may be null.
      Returns:
      This transfer for chaining, never null.

    • getFile

      @Deprecated public File getFile()
      Deprecated.
      Use getPath() instead.
      Gets the local file the artifact 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 artifact 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 ArtifactTransfer setFile(File file)
      Deprecated.
      Use setPath(Path) instead.
      Sets the local file the artifact is downloaded to or uploaded from.
      Parameters:
      file - The local file, may be null.
      Returns:
      This transfer for chaining, never null.

    • setPath

      public ArtifactTransfer setPath(Path path)
      Sets the local file the artifact 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 ArtifactTransferException 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 ArtifactTransfer setException(ArtifactTransferException 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.