Package org.jets3t.service.multithread
Class ServiceEvent
- java.lang.Object
-
- org.jets3t.service.multi.event.ServiceEvent
-
- org.jets3t.service.multithread.ServiceEvent
-
- Direct Known Subclasses:
CopyObjectsEvent
,CreateBucketsEvent
,CreateObjectsEvent
,DeleteObjectsEvent
,DeleteVersionedObjectsEvent
,DownloadObjectsEvent
,GetObjectHeadsEvent
,GetObjectsEvent
,ListObjectsEvent
,LookupACLEvent
,UpdateACLEvent
@Deprecated public abstract class ServiceEvent extends ServiceEvent
Deprecated.0.8.0 useServiceEvent
instead.Base class of all events produced byS3ServiceMulti
.Every event has an event code that indicates the state of a process when the event was generated. The event code will also give a guide as to what information the event will contain.
The event codes, and their meanings, are:
- EVENT_STARTED: An S3 operation has commenced, but no work has yet been done.
- EVENT_IN_PROGRESS: An S3 operation is in progress. Progress events are fired at regular time intervals, and will include information about any work that have been completed as part of the overall operation.
- EVENT_COMPLETED: An S3 operation has completed, and all the work has been done.
- EVENT_CANCELLED: An S3 operation was started but has been cancelled before it could complete. If an operation is cancelled, this event will be fired instead of the EVENT_COMPLETED.
- EVENT_ERROR: An S3 operation has failed and an exception has been thrown. The error
will be availble from
ServiceEvent.getErrorCause()
- EVENT_IGNORED_ERRORS: One or more operations have failed but ,because the
"s3service.ignore-exceptions-in-multi" JetS3t property value is set to true,
the overall operation has continued. The errors will be available from
ServiceEvent.getIgnoredErrors()
EVENT_STARTED and EVENT_IN_PROGRESS events may include a
ThreadWatcher
object containing detailed information about the progress of an S3 operation, such as how many threads have completed and, of uploads and downloads, how many bytes have been transferred at what speed and how long until the transfer is complete.See the event object specific to the operation you are performing for more details about the information available in service events.
- Author:
- James Murty
-
-
Field Summary
-
Fields inherited from class org.jets3t.service.multi.event.ServiceEvent
EVENT_CANCELLED, EVENT_COMPLETED, EVENT_ERROR, EVENT_IGNORED_ERRORS, EVENT_IN_PROGRESS, EVENT_STARTED
-
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description ThreadWatcher
getThreadWatcher()
Deprecated.-
Methods inherited from class org.jets3t.service.multi.event.ServiceEvent
getErrorCause, getEventCode, getIgnoredErrors, getUniqueOperationId, toString
-
-
-
-
Method Detail
-
getThreadWatcher
public ThreadWatcher getThreadWatcher() throws IllegalStateException
Deprecated.- Overrides:
getThreadWatcher
in classServiceEvent
- Returns:
- a thread watcher object containing information about the progress of an operation.
- Throws:
IllegalStateException
- a thread watcher can only be retrieved from an EVENET_STARTED or EVENT_IN_PROGRESS event.
-
-