org.jets3t.service.multithread
Class LookupACLEvent

java.lang.Object
  extended by org.jets3t.service.multi.event.ServiceEvent
      extended by org.jets3t.service.multithread.ServiceEvent
          extended by org.jets3t.service.multithread.LookupACLEvent

public class LookupACLEvent
extends ServiceEvent

Multi-threaded service event fired by S3ServiceMulti.getObjectACLs(S3Bucket, S3Object[]).

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

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

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
 S3Object[] getCancelledObjects()
           
 S3Object[] getObjectsWithACL()
           
static LookupACLEvent newCancelledEvent(S3Object[] incompletedObjects, Object uniqueOperationId)
           
static LookupACLEvent newCompletedEvent(Object uniqueOperationId)
           
static LookupACLEvent newErrorEvent(Throwable t, Object uniqueOperationId)
           
static LookupACLEvent newIgnoredErrorsEvent(ThreadWatcher threadWatcher, Throwable[] ignoredErrors, Object uniqueOperationId)
           
static LookupACLEvent newInProgressEvent(ThreadWatcher threadWatcher, S3Object[] completedObjects, Object uniqueOperationId)
           
static LookupACLEvent newStartedEvent(ThreadWatcher threadWatcher, 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, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

newErrorEvent

public static LookupACLEvent newErrorEvent(Throwable t,
                                           Object uniqueOperationId)

newStartedEvent

public static LookupACLEvent newStartedEvent(ThreadWatcher threadWatcher,
                                             Object uniqueOperationId)

newInProgressEvent

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

newCompletedEvent

public static LookupACLEvent newCompletedEvent(Object uniqueOperationId)

newCancelledEvent

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

newIgnoredErrorsEvent

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

getObjectsWithACL

public S3Object[] getObjectsWithACL()
                             throws IllegalStateException
Returns:
the S3Objects whose ACLs have been retrieved since the last progress event was fired.
Throws:
IllegalStateException - objects with ACL are only available from EVENT_IN_PROGRESS events.

getCancelledObjects

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