com.ansys.ingress.client.api.transfers

## Class TransferEventAdapter

- java.lang.Object
- - com.ansys.ingress.client.api.transfers.TransferEventAdapter

- All Implemented Interfaces:
    TransferEventListener

      public abstract class TransferEventAdapter
      extends java.lang.Object
      implements TransferEventListener

  TransferEventAdapter is an abstract adapter class for receiving `TransferEvent`s. It exists as a convenience class for creating `TransferEventListener` implementations.

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `TransferEventAdapter()`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `dataExtractionCompleted(TransferEvent tEvent)` Indicates metadata extraction completed on the server.
    `void` | `dataExtractionStarted(TransferEvent tEvent)` Indicates metadata extraction started on the server.
    `void` | `fileDownloaded(TransferEvent event)` For a download, indicates a file has been downloaded to the destination file system.
    `void` | `transferCached(TransferEvent tEvent)` Indicates a transfer has completed transferring files to the EKM cache server.
    `void` | `transferCanceled(TransferEvent tEvent)` Indicates the transfer was canceled before completion.
    `void` | `transferCompleted(TransferEvent tEvent)` Indicates a transfer completed successfully.
    `void` | `transferFailed(TransferEvent tEvent)` Indicates a transfer failed.
    `void` | `transferProgress(TransferEvent tEvent)` Indicates progress has been reported by the transfer.
    `void` | `transferStarted(TransferEvent tEvent)` Indicates a transfer was started.

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### TransferEventAdapter

          public TransferEventAdapter()

  - ### Method Detail

    - #### transferStarted

          public void transferStarted(TransferEvent tEvent)

      Description copied from interface: `TransferEventListener`
      Indicates a transfer was started.
      Specified by:
        `transferStarted` in interface `TransferEventListener`
      Parameters:
        `tEvent` - the event

    - #### transferCached

          public void transferCached(TransferEvent tEvent)

      Description copied from interface: `TransferEventListener`
      Indicates a transfer has completed transferring files to the EKM cache server.
      Specified by:
        `transferCached` in interface `TransferEventListener`
      Parameters:
        `tEvent` - the event

    - #### transferCompleted

          public void transferCompleted(TransferEvent tEvent)

      Description copied from interface: `TransferEventListener`
      Indicates a transfer completed successfully.
      Specified by:
        `transferCompleted` in interface `TransferEventListener`
      Parameters:
        `tEvent` - the event

    - #### transferFailed

          public void transferFailed(TransferEvent tEvent)

      Description copied from interface: `TransferEventListener`
      Indicates a transfer failed. Details about any errors that occurred are contained in the event.
      Specified by:
        `transferFailed` in interface `TransferEventListener`
      Parameters:
        `tEvent` - the event

    - #### transferProgress

          public void transferProgress(TransferEvent tEvent)

      Description copied from interface: `TransferEventListener`
      Indicates progress has been reported by the transfer. Details about the progress of the transfer are included in the event.
      Specified by:
        `transferProgress` in interface `TransferEventListener`
      Parameters:
        `tEvent` - the event

    - #### transferCanceled

          public void transferCanceled(TransferEvent tEvent)

      Description copied from interface: `TransferEventListener`
      Indicates the transfer was canceled before completion.
      Specified by:
        `transferCanceled` in interface `TransferEventListener`
      Parameters:
        `tEvent` - the event

    - #### dataExtractionStarted

          public void dataExtractionStarted(TransferEvent tEvent)

      Description copied from interface: `TransferEventListener`
      Indicates metadata extraction started on the server.
      Specified by:
        `dataExtractionStarted` in interface `TransferEventListener`
      Parameters:
        `tEvent` - the event

    - #### dataExtractionCompleted

          public void dataExtractionCompleted(TransferEvent tEvent)

      Description copied from interface: `TransferEventListener`
      Indicates metadata extraction completed on the server.
      Specified by:
        `dataExtractionCompleted` in interface `TransferEventListener`
      Parameters:
        `tEvent` - the event

    - #### fileDownloaded

          public void fileDownloaded(TransferEvent event)

      Description copied from interface: `TransferEventListener`
      For a download, indicates a file has been downloaded to the destination file system.
      Specified by:
        `fileDownloaded` in interface `TransferEventListener`
      Parameters:
        `event` - the event