org.jets3t.service.multithread.LookupACLEvent Maven / Gradle / Ivy
/*
* JetS3t : Java S3 Toolkit
* Project hosted at http://bitbucket.org/jmurty/jets3t/
*
* Copyright 2006-2010 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.S3Bucket;
import org.jets3t.service.model.S3Object;
/**
* Multi-threaded service event fired by {@link S3ServiceMulti#getObjectACLs(S3Bucket, S3Object[])}.
*
* EVENT_IN_PROGRESS events include an array of the {@link S3Object}s whose ACLs have been retrieved
* since the last progress event was fired. These objects are available via
* {@link #getObjectsWithACL()}.
*
* EVENT_CANCELLED events include an array of the {@link S3Object}s whose ACLs had not been retrieved
* before the operation was cancelled. These objects are available via
* {@link #getCancelledObjects()}.
*
* @author James Murty
*/
public class LookupACLEvent extends ServiceEvent {
private S3Object[] objects = null;
private LookupACLEvent(int eventCode, Object uniqueOperationId) {
super(eventCode, uniqueOperationId);
}
public static LookupACLEvent newErrorEvent(Throwable t, Object uniqueOperationId) {
LookupACLEvent event = new LookupACLEvent(EVENT_ERROR, uniqueOperationId);
event.setErrorCause(t);
return event;
}
public static LookupACLEvent newStartedEvent(ThreadWatcher threadWatcher, Object uniqueOperationId) {
LookupACLEvent event = new LookupACLEvent(EVENT_STARTED, uniqueOperationId);
event.setThreadWatcher(threadWatcher);
return event;
}
public static LookupACLEvent newInProgressEvent(ThreadWatcher threadWatcher,
S3Object[] completedObjects, Object uniqueOperationId)
{
LookupACLEvent event = new LookupACLEvent(EVENT_IN_PROGRESS, uniqueOperationId);
event.setThreadWatcher(threadWatcher);
event.setObjects(completedObjects);
return event;
}
public static LookupACLEvent newCompletedEvent(Object uniqueOperationId) {
LookupACLEvent event = new LookupACLEvent(EVENT_COMPLETED, uniqueOperationId);
return event;
}
public static LookupACLEvent newCancelledEvent(S3Object[] incompletedObjects,
Object uniqueOperationId)
{
LookupACLEvent event = new LookupACLEvent(EVENT_CANCELLED, uniqueOperationId);
event.setObjects(incompletedObjects);
return event;
}
public static LookupACLEvent newIgnoredErrorsEvent(ThreadWatcher threadWatcher,
Throwable[] ignoredErrors, Object uniqueOperationId)
{
LookupACLEvent event = new LookupACLEvent(EVENT_IGNORED_ERRORS, uniqueOperationId);
event.setIgnoredErrors(ignoredErrors);
return event;
}
private void setObjects(S3Object[] objects) {
this.objects = objects;
}
/**
* @return
* 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.
*/
public S3Object[] getObjectsWithACL() throws IllegalStateException {
if (getEventCode() != EVENT_IN_PROGRESS) {
throw new IllegalStateException("Completed Objects are only available from EVENT_IN_PROGRESS events");
}
return objects;
}
/**
* @return
* the S3Objects whose ACLs were not retrieved 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;
}
}