org.jets3t.service.multithread

Class UpdateACLEvent

java.lang.Object

org.jets3t.service.multi.event.ServiceEvent

org.jets3t.service.multithread.ServiceEvent

org.jets3t.service.multithread.UpdateACLEvent

public class UpdateACLEvent
extends ServiceEvent

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

EVENT_IN_PROGRESS events include an array of the S3Objects that have had their ACLs updated since the last progress event was fired. These objects are available via getObjectsWithUpdatedACL().

EVENT_CANCELLED events include an array of the S3Objects that did not have their ACLs updated 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[]	getObjectsWithUpdatedACL()
static UpdateACLEvent	newCancelledEvent(S3Object[] incompletedObjects, java.lang.Object uniqueOperationId)
static UpdateACLEvent	newCompletedEvent(java.lang.Object uniqueOperationId)
static UpdateACLEvent	newErrorEvent(java.lang.Throwable t, java.lang.Object uniqueOperationId)
static UpdateACLEvent	newIgnoredErrorsEvent(ThreadWatcher threadWatcher, java.lang.Throwable[] ignoredErrors, java.lang.Object uniqueOperationId)
static UpdateACLEvent	newInProgressEvent(ThreadWatcher threadWatcher, S3Object[] completedObjects, java.lang.Object uniqueOperationId)
static UpdateACLEvent	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 UpdateACLEvent newErrorEvent(java.lang.Throwable t,
                                           java.lang.Object uniqueOperationId)

newStartedEvent

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

newInProgressEvent

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

newCompletedEvent

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

newCancelledEvent

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

newIgnoredErrorsEvent

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

getObjectsWithUpdatedACL

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

Returns:

the S3Objects that have had their ACLs updated since the last progress event was fired.

Throws:

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

getCancelledObjects

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

Returns:

the S3Objects that did not have ACLs updated before the operation was cancelled.

Throws:

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