src.org.jets3t.service.multithread.CreateObjectsEvent Maven / Gradle / Ivy
Show all versions of jets3t Show documentation
/*
* jets3t : Java Extra-Tasty S3 Toolkit (for Amazon S3 online storage service)
* This is a java.net project, see https://jets3t.dev.java.net/
*
* Copyright 2006 James Murty
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.jets3t.service.multithread;
import org.jets3t.service.model.S3Object;
/**
* Multi-threaded service event fired by {@link S3ServiceMulti#putObjects(S3Bucket, S3Object[])}.
*
* EVENT_IN_PROGRESS events include an array of the {@link S3Object}s that have been created
* since the last progress event was fired. These objects are available via
* {@link #getCreatedObjects()}.
*
* EVENT_CANCELLED events include an array of the {@link S3Object}s that had not been created
* before the operation was cancelled. These objects are available via
* {@link #getCancelledObjects()}.
*
* @author James Murty
*/
public class CreateObjectsEvent extends ServiceEvent {
private S3Object[] objects = null;
private CreateObjectsEvent(int eventCode, Object uniqueOperationId) {
super(eventCode, uniqueOperationId);
}
public static CreateObjectsEvent newErrorEvent(Throwable t, Object uniqueOperationId) {
CreateObjectsEvent event = new CreateObjectsEvent(EVENT_ERROR, uniqueOperationId);
event.setErrorCause(t);
return event;
}
public static CreateObjectsEvent newStartedEvent(ThreadWatcher threadWatcher, Object uniqueOperationId) {
CreateObjectsEvent event = new CreateObjectsEvent(EVENT_STARTED, uniqueOperationId);
event.setThreadWatcher(threadWatcher);
return event;
}
public static CreateObjectsEvent newInProgressEvent(ThreadWatcher threadWatcher,
S3Object[] completedObjects, Object uniqueOperationId)
{
CreateObjectsEvent event = new CreateObjectsEvent(EVENT_IN_PROGRESS, uniqueOperationId);
event.setThreadWatcher(threadWatcher);
event.setObjects(completedObjects);
return event;
}
public static CreateObjectsEvent newCompletedEvent(Object uniqueOperationId) {
CreateObjectsEvent event = new CreateObjectsEvent(EVENT_COMPLETED, uniqueOperationId);
return event;
}
public static CreateObjectsEvent newCancelledEvent(S3Object[] incompletedObjects, Object uniqueOperationId) {
CreateObjectsEvent event = new CreateObjectsEvent(EVENT_CANCELLED, uniqueOperationId);
event.setObjects(incompletedObjects);
return event;
}
public static CreateObjectsEvent newIgnoredErrorsEvent(ThreadWatcher threadWatcher,
Throwable[] ignoredErrors, Object uniqueOperationId)
{
CreateObjectsEvent event = new CreateObjectsEvent(EVENT_IGNORED_ERRORS, uniqueOperationId);
event.setIgnoredErrors(ignoredErrors);
return event;
}
private void setObjects(S3Object[] objects) {
this.objects = objects;
}
/**
* @return
* the S3Objects that have been created since the last progress event was fired.
* @throws IllegalStateException
* created objects are only available from EVENT_IN_PROGRESS events.
*/
public S3Object[] getCreatedObjects() throws IllegalStateException {
if (getEventCode() != EVENT_IN_PROGRESS) {
throw new IllegalStateException("Created Objects are only available from EVENT_IN_PROGRESS events");
}
return objects;
}
/**
* @return
* the S3Objects that were not created before the operation was cancelled.
* @throws IllegalStateException
* cancelled objects are only available from EVENT_CANCELLED events.
*/
public S3Object[] getCancelledObjects() throws IllegalStateException {
if (getEventCode() != EVENT_CANCELLED) {
throw new IllegalStateException("Cancelled Objects are only available from EVENT_CANCELLED events");
}
return objects;
}
}