Interface TransferListenerContainer

All Known Implementing Classes:
TransferListenerContainerImpl

public interface TransferListenerContainer
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addTransferListener(org.apache.maven.wagon.events.TransferListener transferListener)
    Add a TransferListener to be notified
    void
    fireTransferCompleted(org.apache.maven.wagon.resource.Resource resource, int requestType)
    Notify TransferListeners that the transfer was completed successfully
    void
    fireTransferError(org.apache.maven.wagon.resource.Resource resource, int requestType, Exception exception)
    Notify TransferListeners that an error occurred during the transfer
    void
    fireTransferInitiated(org.apache.maven.wagon.resource.Resource resource, int requestType)
    Notify TransferListeners that a transfer is being initiated
    void
    fireTransferProgress(org.apache.maven.wagon.resource.Resource resource, int requestType, byte[] buffer, int length)
    Notify TransferListeners about the progress of a transfer
    void
    fireTransferStarted(org.apache.maven.wagon.resource.Resource resource, int requestType, File localFile)
    Notify TransferListeners that a transfer has started successfully
    boolean
    hasTransferListener(org.apache.maven.wagon.events.TransferListener transferListener)
    Returns whether a TransferListener is already in the collection of TransferListeners to be notified
    void
    removeTransferListener(org.apache.maven.wagon.events.TransferListener transferListener)
    Remove a TransferListener so that it is no longer notified
  • Method Details

    • addTransferListener

      void addTransferListener(org.apache.maven.wagon.events.TransferListener transferListener)
      Add a TransferListener to be notified
      Parameters:
      transferListener - The TransferListener to be notified
    • removeTransferListener

      void removeTransferListener(org.apache.maven.wagon.events.TransferListener transferListener)
      Remove a TransferListener so that it is no longer notified
      Parameters:
      transferListener - The TransferListener that should no longer be notified
    • hasTransferListener

      boolean hasTransferListener(org.apache.maven.wagon.events.TransferListener transferListener)
      Returns whether a TransferListener is already in the collection of TransferListeners to be notified
      Parameters:
      transferListener - the TransferListener to look for
      Returns:
      true if the TransferListener is already in the collection of TransferListeners to be notified, otherwise false
    • fireTransferInitiated

      void fireTransferInitiated(org.apache.maven.wagon.resource.Resource resource, int requestType)
      Notify TransferListeners that a transfer is being initiated
      Parameters:
      resource - The resource being transfered
      requestType - The type of request to be executed
      See Also:
      • TransferEvent.TRANSFER_INITIATED
    • fireTransferStarted

      void fireTransferStarted(org.apache.maven.wagon.resource.Resource resource, int requestType, File localFile)
      Notify TransferListeners that a transfer has started successfully
      Parameters:
      resource - The resource being transfered
      requestType - The type of request being executed
      localFile - local file used
      See Also:
      • TransferEvent.TRANSFER_STARTED
    • fireTransferProgress

      void fireTransferProgress(org.apache.maven.wagon.resource.Resource resource, int requestType, byte[] buffer, int length)
      Notify TransferListeners about the progress of a transfer
      Parameters:
      resource - The resource being transfered
      requestType - The type of request being executed
      buffer - The buffer of bytes being transfered
      length - The length of the data in the buffer
      See Also:
      • TransferEvent.TRANSFER_PROGRESS
    • fireTransferCompleted

      void fireTransferCompleted(org.apache.maven.wagon.resource.Resource resource, int requestType)
      Notify TransferListeners that the transfer was completed successfully
      Parameters:
      resource - The resource being transfered
      requestType - The type of request executed
      See Also:
      • TransferEvent.TRANSFER_COMPLETED
    • fireTransferError

      void fireTransferError(org.apache.maven.wagon.resource.Resource resource, int requestType, Exception exception)
      Notify TransferListeners that an error occurred during the transfer
      Parameters:
      resource - The resource being transfered
      requestType - The type of the request being executed
      exception - The error that occurred