rapture.server.web.servlet

Class BaseServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

rapture.server.web.servlet.BaseServlet

All Implemented Interfaces:

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

Direct Known Subclasses:

ActivityServlet, AdminServlet, AsyncServlet, AuditServlet, BaseReflexScriptPageServlet, BlobContentServlet, BlobServlet, BlobUploadServlet, BootstrapServlet, DecisionServlet, DocServlet, EntitlementServlet, EnvironmentServlet, EventServlet, FieldsServlet, IdGenServlet, IndexServlet, JarServlet, JavaScriptPageServlet, JmxServlet, LockServlet, LoginServlet, MenuConfigServlet, MicroServiceServlet, NotificationServlet, PipelineServlet, PluginServlet, RestDocServlet, RunnerServlet, ScheduleServlet, ScriptServlet, SearchServlet, SeriesServlet, SessionControlServlet, StructuredServlet, SysServlet, TagServlet, UserBoundedScriptPageServlet, UserServlet

public class BaseServlet
extends javax.servlet.http.HttpServlet

The base servlet contains the common utility classes for manipulating requests and responses

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BaseServlet()

Method Summary

Modifier and Type	Method and Description
protected byte[]	getByteContentFromPart(javax.servlet.http.Part p)
protected java.lang.String	getFullContent(javax.servlet.http.HttpServletRequest req)
protected java.util.Map<java.lang.String,java.lang.Object>	getParams(javax.servlet.http.HttpServletRequest req)
protected rapture.common.CallingContext	getSessionContext(javax.servlet.http.HttpServletRequest req)
protected rapture.common.DispatchReturn	handleUnexpectedException(java.lang.Exception e) This should be called when we catch an exception after calling a dispatcher.
protected StandardCallInfo	processFunctionalRequest(javax.servlet.http.HttpServletRequest req)
protected void	sendResponseAppropriately(rapture.common.CallingContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, java.lang.String response)
protected void	validateContext(rapture.common.CallingContext context, java.lang.String entPath, rapture.common.RaptureEntitlementsContext entCtx) Check this session is valid

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPost, doPut, 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

BaseServlet

public BaseServlet()

Method Detail

getSessionContext

protected rapture.common.CallingContext getSessionContext(javax.servlet.http.HttpServletRequest req)

getFullContent

protected java.lang.String getFullContent(javax.servlet.http.HttpServletRequest req)
                                   throws java.io.IOException

Throws:

java.io.IOException

getParams

protected java.util.Map<java.lang.String,java.lang.Object> getParams(javax.servlet.http.HttpServletRequest req)
                                                              throws java.io.UnsupportedEncodingException,
                                                                     java.io.IOException,
                                                                     javax.servlet.ServletException

Throws:

java.io.UnsupportedEncodingException

java.io.IOException

javax.servlet.ServletException

getByteContentFromPart

protected byte[] getByteContentFromPart(javax.servlet.http.Part p)
                                 throws java.io.IOException

Throws:

java.io.IOException

processFunctionalRequest

protected StandardCallInfo processFunctionalRequest(javax.servlet.http.HttpServletRequest req)
                                             throws java.io.UnsupportedEncodingException,
                                                    java.io.IOException,
                                                    javax.servlet.ServletException

Throws:

java.io.UnsupportedEncodingException

java.io.IOException

javax.servlet.ServletException

validateContext

protected void validateContext(rapture.common.CallingContext context,
                               java.lang.String entPath,
                               rapture.common.RaptureEntitlementsContext entCtx)

Check this session is valid

Parameters:

context -

entPath -

entCtx -

sendResponseAppropriately

protected void sendResponseAppropriately(rapture.common.CallingContext context,
                                         javax.servlet.http.HttpServletRequest req,
                                         javax.servlet.http.HttpServletResponse resp,
                                         java.lang.String response)
                                  throws java.io.IOException

Throws:

java.io.IOException

handleUnexpectedException

protected rapture.common.DispatchReturn handleUnexpectedException(java.lang.Exception e)

This should be called when we catch an exception after calling a dispatcher. (We should never get an exception in those circumstances however....)

Parameters:

e -

Returns: