org.jets3t.servlets.gatekeeper
Class BucketLister

java.lang.Object
  extended by org.jets3t.servlets.gatekeeper.BucketLister
Direct Known Subclasses:
DefaultBucketLister

public abstract class BucketLister
extends java.lang.Object

Provides a listing of objects in an S3 account to a client application that cannot query the account for itself.

The object listing may contain all the objects in the bucket, or any subset as is appropriate for the client application or user in question.

Author:
James Murty

Constructor Summary
BucketLister(javax.servlet.ServletConfig servletConfig)
           
 
Method Summary
abstract  void listObjects(GatekeeperMessage gatekeeperMessage, ClientInformation clientInformation)
          Create in the GatekeeperMessage object a list of SignatureRequest objects capturing details about the S3 objects contained in a bucket.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BucketLister

public BucketLister(javax.servlet.ServletConfig servletConfig)
             throws javax.servlet.ServletException
Throws:
javax.servlet.ServletException
Method Detail

listObjects

public abstract void listObjects(GatekeeperMessage gatekeeperMessage,
                                 ClientInformation clientInformation)
                          throws java.lang.Exception
Create in the GatekeeperMessage object a list of SignatureRequest objects capturing details about the S3 objects contained in a bucket. The client application will interpret the SignatureRequest object details to reconstruct the objects.

Parameters:
gatekeeperMessage - the message object that was received, and in which the object listing to be returned is stored.
clientInformation - information about the client end-point this request was received from.
Throws:
java.lang.Exception