org.jets3t.service.multithread
Class UpdateACLEvent

java.lang.Object
  extended by org.jets3t.service.multithread.ServiceEvent
      extended by 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().

Author:
James Murty

Field Summary
 
Fields inherited from class org.jets3t.service.multithread.ServiceEvent
EVENT_CANCELLED, EVENT_COMPLETED, EVENT_ERROR, EVENT_IGNORED_ERRORS, EVENT_IN_PROGRESS, EVENT_STARTED
 
Method Summary
 S3Object[] getCancelledObjects()
           
 S3Object[] getObjectsWithUpdatedACL()
           
static UpdateACLEvent newCancelledEvent(S3Object[] incompletedObjects, Object uniqueOperationId)
           
static UpdateACLEvent newCompletedEvent(Object uniqueOperationId)
           
static UpdateACLEvent newErrorEvent(Throwable t, Object uniqueOperationId)
           
static UpdateACLEvent newIgnoredErrorsEvent(ThreadWatcher threadWatcher, Throwable[] ignoredErrors, Object uniqueOperationId)
           
static UpdateACLEvent newInProgressEvent(ThreadWatcher threadWatcher, S3Object[] completedObjects, Object uniqueOperationId)
           
static UpdateACLEvent newStartedEvent(ThreadWatcher threadWatcher, Object uniqueOperationId)
           
 
Methods inherited from class org.jets3t.service.multithread.ServiceEvent
getErrorCause, getEventCode, getIgnoredErrors, getThreadWatcher, getUniqueOperationId, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

newErrorEvent

public static UpdateACLEvent newErrorEvent(Throwable t,
                                           Object uniqueOperationId)

newStartedEvent

public static UpdateACLEvent newStartedEvent(ThreadWatcher threadWatcher,
                                             Object uniqueOperationId)

newInProgressEvent

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

newCompletedEvent

public static UpdateACLEvent newCompletedEvent(Object uniqueOperationId)

newCancelledEvent

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

newIgnoredErrorsEvent

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

getObjectsWithUpdatedACL

public S3Object[] getObjectsWithUpdatedACL()
                                    throws IllegalStateException
Returns:
the S3Objects that have had their ACLs updated since the last progress event was fired.
Throws:
IllegalStateException - updated objects are only available from EVENT_IN_PROGRESS events.

getCancelledObjects

public S3Object[] getCancelledObjects()
                               throws IllegalStateException
Returns:
the S3Objects that did not have ACLs updated before the operation was cancelled.
Throws:
IllegalStateException - cancelled objects are only available from EVENT_CANCELLED events.