org.jets3t.service.multithread

Class GetObjectsEvent

java.lang.Object

org.jets3t.service.multi.event.ServiceEvent

org.jets3t.service.multithread.ServiceEvent

org.jets3t.service.multithread.GetObjectsEvent

public class GetObjectsEvent
extends ServiceEvent

Multi-threaded service event fired by S3ServiceMulti.getObjects(org.jets3t.service.model.S3Bucket, org.jets3t.service.model.S3Object[]).

EVENT_IN_PROGRESS events include an array of the S3Objects that have been retrieved since the last progress event was fired. These objects are available via getCompletedObjects().

EVENT_CANCELLED events include an array of the S3Objects that had not been retrieved before the operation was cancelled. These objects are available via getCancelledObjects().

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

Modifier and Type	Method and Description
S3Object[]	getCancelledObjects()
S3Object[]	getCompletedObjects()
static GetObjectsEvent	newCancelledEvent(S3Object[] incompletedObjects, java.lang.Object uniqueOperationId)
static GetObjectsEvent	newCompletedEvent(java.lang.Object uniqueOperationId)
static GetObjectsEvent	newErrorEvent(java.lang.Throwable t, java.lang.Object uniqueOperationId)
static GetObjectsEvent	newIgnoredErrorsEvent(ThreadWatcher threadWatcher, java.lang.Throwable[] ignoredErrors, java.lang.Object uniqueOperationId)
static GetObjectsEvent	newInProgressEvent(ThreadWatcher threadWatcher, S3Object[] completedObjects, java.lang.Object uniqueOperationId)
static GetObjectsEvent	newStartedEvent(ThreadWatcher threadWatcher, java.lang.Object uniqueOperationId)

Methods inherited from class org.jets3t.service.multithread.ServiceEvent

getThreadWatcher

Methods inherited from class org.jets3t.service.multi.event.ServiceEvent

getErrorCause, getEventCode, getIgnoredErrors, getUniqueOperationId, setErrorCause, setIgnoredErrors, setThreadWatcher, toString

Methods inherited from class java.lang.Object

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

Method Detail

newErrorEvent

public static GetObjectsEvent newErrorEvent(java.lang.Throwable t,
                                            java.lang.Object uniqueOperationId)

newStartedEvent

public static GetObjectsEvent newStartedEvent(ThreadWatcher threadWatcher,
                                              java.lang.Object uniqueOperationId)

newInProgressEvent

public static GetObjectsEvent newInProgressEvent(ThreadWatcher threadWatcher,
                                                 S3Object[] completedObjects,
                                                 java.lang.Object uniqueOperationId)

newCompletedEvent

public static GetObjectsEvent newCompletedEvent(java.lang.Object uniqueOperationId)

newCancelledEvent

public static GetObjectsEvent newCancelledEvent(S3Object[] incompletedObjects,
                                                java.lang.Object uniqueOperationId)

newIgnoredErrorsEvent

public static GetObjectsEvent newIgnoredErrorsEvent(ThreadWatcher threadWatcher,
                                                    java.lang.Throwable[] ignoredErrors,
                                                    java.lang.Object uniqueOperationId)

getCompletedObjects

public S3Object[] getCompletedObjects()
                               throws java.lang.IllegalStateException

Returns:

the S3Objects that have been retrieved since the last progress event was fired.

Throws:

java.lang.IllegalStateException - completed objects are only available from EVENT_IN_PROGRESS events.

getCancelledObjects

public S3Object[] getCancelledObjects()
                               throws java.lang.IllegalStateException

Returns:

the S3Objects that were not retrieved before the operation was cancelled.

Throws:

java.lang.IllegalStateException - cancelled objects are only available from EVENT_CANCELLED events.