Interface IArtifactSink

  • All Known Subinterfaces:
    IRawArtifactSink

    public interface IArtifactSink
    Interface for receiving the content of an artifact. In order to support streaming from a remote server where integrity can only be checked after transferring the entire content, there are methods to commit, abort, or retry the write operation.
    See Also:
    ArtifactSinkFactory
    • Method Detail

      • getArtifactToBeWritten

        org.eclipse.equinox.p2.metadata.IArtifactKey getArtifactToBeWritten()
        Returns the key of the artifact expected by this instance.
      • canBeginWrite

        boolean canBeginWrite()
        Check if beginWrite() can be called on this instance. This method will typically return false if commitWrite() has already been called on this instance, or if beginWrite() has been called before and the instance doesn't support re-starting the write operation.
        Returns:
        true if beginWrite() can be called on this instance.
      • abortWrite

        void abortWrite()
                 throws ArtifactSinkException
        Method for aborting the write operation. Should be called if an error is detected while streaming the artifact content.
        Throws:
        ArtifactSinkException - if an error occurs while aborting the write operation.