io.apiman.gateway.platforms.servlet

Class GatewayServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

io.apiman.gateway.platforms.servlet.GatewayServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public abstract class GatewayServlet
extends javax.servlet.http.HttpServlet

The API Management gateway servlet. This servlet is responsible for converting inbound http servlet requests into ServiceRequests so that they can be fed into the API Management machinery. It also is responsible for converting the resulting ServiceResponse into an HTTP Servlet Response that is suitable for returning to the caller.

Author:

eric.wittmann@redhat.com

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GatewayServlet() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doAction(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, String action) Generic handler for all types of http actions/verbs.
protected void	doDelete(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)
protected void	doGet(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)
protected void	doPost(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)
protected void	doPut(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)
protected String	getApiKey(javax.servlet.http.HttpServletRequest request) Gets the API Key from the request.
protected String	getApiKeyFromQuery(javax.servlet.http.HttpServletRequest request) Gets the API key from the request's query string.
protected String	getDestination(javax.servlet.http.HttpServletRequest request) Returns the path to the resource.
protected abstract io.apiman.gateway.engine.IEngine	getEngine() Gets the engine - subclasses must implement this.
protected void	readHeaders(io.apiman.gateway.engine.beans.ServiceRequest srequest, javax.servlet.http.HttpServletRequest request) Reads the inbound request headers from the request and sets them on the ServiceRequest.
protected io.apiman.gateway.engine.beans.ServiceRequest	readRequest(javax.servlet.http.HttpServletRequest request) Reads a ServiceRequest from information found in the inbound portion of the http request.
protected void	writeError(javax.servlet.http.HttpServletResponse resp, Throwable error) Writes an error to the servlet response object.
protected void	writeResponse(javax.servlet.http.HttpServletResponse response, io.apiman.gateway.engine.beans.ServiceResponse sresponse) Writes the service response to the HTTP servlet response object.

Methods inherited from class javax.servlet.http.HttpServlet

doHead, doOptions, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

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

Methods inherited from class java.lang.Object

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

Constructor Detail

GatewayServlet

public GatewayServlet()

Constructor.

Method Detail

doGet

protected void doGet(javax.servlet.http.HttpServletRequest req,
         javax.servlet.http.HttpServletResponse resp)
              throws javax.servlet.ServletException,
                     IOException

Overrides:

doGet in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException

See Also:

HttpServlet.doGet(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

doPost

protected void doPost(javax.servlet.http.HttpServletRequest req,
          javax.servlet.http.HttpServletResponse resp)
               throws javax.servlet.ServletException,
                      IOException

Overrides:

doPost in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException

See Also:

HttpServlet.doPost(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

doPut

protected void doPut(javax.servlet.http.HttpServletRequest req,
         javax.servlet.http.HttpServletResponse resp)
              throws javax.servlet.ServletException,
                     IOException

Overrides:

doPut in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException

See Also:

HttpServlet.doPut(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

doDelete

protected void doDelete(javax.servlet.http.HttpServletRequest req,
            javax.servlet.http.HttpServletResponse resp)
                 throws javax.servlet.ServletException,
                        IOException

Overrides:

doDelete in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException

See Also:

HttpServlet.doDelete(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

doAction

protected void doAction(javax.servlet.http.HttpServletRequest req,
            javax.servlet.http.HttpServletResponse resp,
            String action)

Generic handler for all types of http actions/verbs.

Parameters:

req -

resp -

action -

getEngine

protected abstract io.apiman.gateway.engine.IEngine getEngine()

Gets the engine - subclasses must implement this.

Returns:

gets the engine

readRequest

protected io.apiman.gateway.engine.beans.ServiceRequest readRequest(javax.servlet.http.HttpServletRequest request)
                                                             throws Exception

Reads a ServiceRequest from information found in the inbound portion of the http request.

Parameters:

request - the undertow http server request

Returns:

a valid ServiceRequest

Throws:

IOException

Exception

getApiKey

protected String getApiKey(javax.servlet.http.HttpServletRequest request)

Gets the API Key from the request. The API key can be passed either via a custom http request header called X-API-Key or else by a query parameter in the URL called apikey.

Parameters:

request - the inbound request

Returns:

the api key or null if not found

getApiKeyFromQuery

protected String getApiKeyFromQuery(javax.servlet.http.HttpServletRequest request)

Gets the API key from the request's query string.

Parameters:

request - the inbound request

Returns:

the api key or null if not found

getDestination

protected String getDestination(javax.servlet.http.HttpServletRequest request)

Returns the path to the resource.

Parameters:

request -

readHeaders

protected void readHeaders(io.apiman.gateway.engine.beans.ServiceRequest srequest,
               javax.servlet.http.HttpServletRequest request)

Reads the inbound request headers from the request and sets them on the ServiceRequest.

Parameters:

request -

request -

writeResponse

protected void writeResponse(javax.servlet.http.HttpServletResponse response,
                 io.apiman.gateway.engine.beans.ServiceResponse sresponse)

Writes the service response to the HTTP servlet response object.

Parameters:

response -

sresponse -

writeError

protected void writeError(javax.servlet.http.HttpServletResponse resp,
              Throwable error)

Writes an error to the servlet response object.

Parameters:

resp -

error -