org.jets3t.servlets.gatekeeper

Class GatekeeperServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.jets3t.servlets.gatekeeper.GatekeeperServlet

All Implemented Interfaces:

java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class GatekeeperServlet
extends javax.servlet.http.HttpServlet

A servlet implementation of an S3 Gatekeeper, as described in the document Gatekeeper Concepts.

This servlet offers an easily configurable and extensible approach, where key steps in the authorization and signature generation process are performed by pluggable interfaces:

• TransactionIdProvider: Generate a transaction ID to uniquely identify a request/response transaction
• Authorizer: Allow or deny specific requested operations
• UrlSigner: Generate signed URLs for each operation that has been allowed by the Authorizer

These pluggable interfaces are configured in the servlet's configuration file, or if left unconfigured the default JetS3t implementations are used.

For more information about this servlet please refer to: JetS3t Gatekeeper

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private Authorizer	authorizer
private BucketLister	bucketLister
private boolean	isInitCompleted
private static org.apache.commons.logging.Log	log
private static long	serialVersionUID
private javax.servlet.ServletConfig	servletConfig
private TransactionIdProvider	transactionIdProvider
private UrlSigner	urlSigner

Constructor Summary

Constructors

Constructor and Description
GatekeeperServlet()

Method Summary

Modifier and Type	Method and Description
void	doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Sends a simple HTML page in response to GET requests, indicating that the servlet is running.
void	doPost(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Handles POST requests that contain Gatekeeper messages encoded as POST form properties, and sends a plain text response document containing the Gatekeeper response message encoded as a properties file.
void	init(javax.servlet.ServletConfig servletConfig) Initialises the pluggable implementation classes for Authorizer, TransactionIdProvider, and UrlSigner
private Authorizer	initAuthorizer() Initialises the Authorizer implementation that will be used by the servlet.
private BucketLister	initBucketLister() Initialises the BucketLister implementation that will be used by the servlet.
private TransactionIdProvider	initTransactionIdProvider() Initialises the TransactionIdProvider implementation that will be used by the servlet.
private UrlSigner	initUrlSigner() Initialises the UrlSigner implementation that will be used by the servlet.
private java.lang.Object	instantiateClass(java.lang.String className, java.lang.Class[] constructorParamClasses, java.lang.Object[] constructorParams) Instantiates a class by locating and invoking the appropriate constructor.

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

log

private static final org.apache.commons.logging.Log log

servletConfig

private javax.servlet.ServletConfig servletConfig

transactionIdProvider

private TransactionIdProvider transactionIdProvider

urlSigner

private UrlSigner urlSigner

authorizer

private Authorizer authorizer

bucketLister

private BucketLister bucketLister

isInitCompleted

private boolean isInitCompleted

Constructor Detail

GatekeeperServlet

public GatekeeperServlet()

Method Detail

instantiateClass

private java.lang.Object instantiateClass(java.lang.String className,
                                          java.lang.Class[] constructorParamClasses,
                                          java.lang.Object[] constructorParams)
                                   throws javax.servlet.ServletException

Instantiates a class by locating and invoking the appropriate constructor.

Parameters:

className -

constructorParamClasses -

constructorParams -

Returns:

Throws:

javax.servlet.ServletException

init

public void init(javax.servlet.ServletConfig servletConfig)
          throws javax.servlet.ServletException

Initialises the pluggable implementation classes for Authorizer, TransactionIdProvider, and UrlSigner

Specified by:

init in interface javax.servlet.Servlet

Overrides:

init in class javax.servlet.GenericServlet

Throws:

javax.servlet.ServletException

initAuthorizer

private Authorizer initAuthorizer()
                           throws javax.servlet.ServletException

Initialises the Authorizer implementation that will be used by the servlet.

Returns:

Throws:

javax.servlet.ServletException

initUrlSigner

private UrlSigner initUrlSigner()
                         throws javax.servlet.ServletException

Initialises the UrlSigner implementation that will be used by the servlet.

Returns:

Throws:

javax.servlet.ServletException

initTransactionIdProvider

private TransactionIdProvider initTransactionIdProvider()
                                                 throws javax.servlet.ServletException

Initialises the TransactionIdProvider implementation that will be used by the servlet.

Returns:

Throws:

javax.servlet.ServletException

initBucketLister

private BucketLister initBucketLister()
                               throws javax.servlet.ServletException

Initialises the BucketLister implementation that will be used by the servlet.

Returns:

Throws:

javax.servlet.ServletException

doGet

public void doGet(javax.servlet.http.HttpServletRequest request,
                  javax.servlet.http.HttpServletResponse response)
           throws javax.servlet.ServletException,
                  java.io.IOException

Sends a simple HTML page in response to GET requests, indicating that the servlet is running.

Overrides:

doGet in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

java.io.IOException

doPost

public void doPost(javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response)
            throws javax.servlet.ServletException,
                   java.io.IOException

Handles POST requests that contain Gatekeeper messages encoded as POST form properties, and sends a plain text response document containing the Gatekeeper response message encoded as a properties file.

Overrides:

doPost in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

java.io.IOException