org.jets3t.service.multi.event
Class CopyObjectsEvent

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

public class CopyObjectsEvent
extends ServiceEvent

Multi-threaded service event fired by ThreadedStorageService.copyObjects(String, String, String[], StorageObject[], boolean).

EVENT_IN_PROGRESS events include an array of the Map results returned by the copy operation, see StorageService.copyObject(String, String, String, StorageObject, boolean). These objects are available via getCopyResults().

EVENT_CANCELLED events include an array of the StorageObjects that had not been copied 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
 StorageObject[] getCancelledObjects()
           
 StorageObject[] getCopiedObjects()
           
 java.util.Map[] getCopyResults()
           
 java.lang.String[] getSourceObjectKeys()
           
static CopyObjectsEvent newCancelledEvent(StorageObject[] incompletedObjects, java.lang.Object uniqueOperationId)
           
static CopyObjectsEvent newCompletedEvent(java.lang.Object uniqueOperationId, java.lang.String[] sourceObjectKeys, StorageObject[] destinationObjects)
           
static CopyObjectsEvent newErrorEvent(java.lang.Throwable t, java.lang.Object uniqueOperationId)
           
static CopyObjectsEvent newIgnoredErrorsEvent(ThreadWatcher threadWatcher, java.lang.Throwable[] ignoredErrors, java.lang.Object uniqueOperationId)
           
static CopyObjectsEvent newInProgressEvent(ThreadWatcher threadWatcher, java.util.Map[] completedResults, java.lang.Object uniqueOperationId)
           
static CopyObjectsEvent newStartedEvent(ThreadWatcher threadWatcher, java.lang.Object uniqueOperationId)
           
 
Methods inherited from class org.jets3t.service.multi.event.ServiceEvent
getErrorCause, getEventCode, getIgnoredErrors, getThreadWatcher, 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 CopyObjectsEvent newErrorEvent(java.lang.Throwable t,
                                             java.lang.Object uniqueOperationId)

newStartedEvent

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

newInProgressEvent

public static CopyObjectsEvent newInProgressEvent(ThreadWatcher threadWatcher,
                                                  java.util.Map[] completedResults,
                                                  java.lang.Object uniqueOperationId)

newCompletedEvent

public static CopyObjectsEvent newCompletedEvent(java.lang.Object uniqueOperationId,
                                                 java.lang.String[] sourceObjectKeys,
                                                 StorageObject[] destinationObjects)

newCancelledEvent

public static CopyObjectsEvent newCancelledEvent(StorageObject[] incompletedObjects,
                                                 java.lang.Object uniqueOperationId)

newIgnoredErrorsEvent

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

getCopyResults

public java.util.Map[] getCopyResults()
                               throws java.lang.IllegalStateException
Returns:
the Map results for the objects that have been copied since the last progress event was fired.
Throws:
java.lang.IllegalStateException - results are only available from EVENT_IN_PROGRESS events.

getCancelledObjects

public StorageObject[] getCancelledObjects()
                                    throws java.lang.IllegalStateException
Returns:
the StorageObjects that were not copied before the operation was cancelled.
Throws:
java.lang.IllegalStateException - cancelled objects are only available from EVENT_CANCELLED events.

getCopiedObjects

public StorageObject[] getCopiedObjects()
                                 throws java.lang.IllegalStateException
Returns:
the StorageObjects that were created by a a successful copy operation.
Throws:
java.lang.IllegalStateException - copied objects are only available from EVENT_COMPLETED events.

getSourceObjectKeys

public java.lang.String[] getSourceObjectKeys()
                                       throws java.lang.IllegalStateException
Returns:
the key names of source objects that were copied in a successful operation.
Throws:
java.lang.IllegalStateException - source object key names are only available from EVENT_COMPLETED events.