Class DefaultBucketLister


  • public class DefaultBucketLister
    extends BucketLister
    Default BucketLister implementation that lists all objects in the configured bucket.
    Author:
    James Murty
    • Constructor Detail

      • DefaultBucketLister

        public DefaultBucketLister​(javax.servlet.ServletConfig servletConfig)
                            throws javax.servlet.ServletException
        Constructs the Bucket lister with the required parameters.

        The required parameters that must be available in the servlet configuration are:

        • AwsAccessKey: The AWS Access Key for an S3 account
        • AwsSecretKey: The AWS Secret Key for an S3 account
        • S3BucketName: The bucket all objects are stored in (regardless of what bucket name the client provided).
        Parameters:
        servletConfig -
        Throws:
        javax.servlet.ServletException
    • Method Detail

      • listObjects

        public void listObjects​(GatekeeperMessage gatekeeperMessage,
                                ClientInformation clientInformation)
                         throws S3ServiceException
        Description copied from class: BucketLister
        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.
        Specified by:
        listObjects in class BucketLister
        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:
        S3ServiceException