uk.ac.ed.epcc.webapp.servlet

Class WebappServlet

java.lang.Object

HttpServlet

uk.ac.ed.epcc.webapp.servlet.WebappServlet

Direct Known Subclasses:

BadKeyServlet, ContainerAuthServlet, LoginServlet, PasswordChangeRequestServlet, QRServlet, RegisterServlet, RemoteAuthServlet, ServeDataServlet, SessionServlet, TransitionServlet

public abstract class WebappServlet
extends HttpServlet

webappServlet Base class for servlets in the web application, it hold generally useful methods for use by all servlets

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ARGS
static java.lang.String	CONFIRM_NO
static java.lang.String	CONFIRM_POST_URL
static java.lang.String	CONFIRM_TYPE
static java.lang.String	CONFIRM_YES
static java.lang.String	EXTRA_HTML
static java.lang.String	MESSAGE_EXTRA_ATTR The attribute name for the secondary message (optional) This can be passed as an attribute to add secondary text to a message default extra text can also be included in the message bundle with a name based on the message type.
static java.lang.String	MESSAGE_TYPE_ATTR The attribute name for the message type.
static java.lang.String	MESSAGES_JSP_URL
static java.lang.String	SCRIPTS_CONFIRM_JSP

Constructor Summary

Constructors

Constructor and Description
WebappServlet()

Method Summary

Modifier and Type	Method and Description
void	badInputCheck(AppContext conn) Call this method when invalid data is passed to something that should have been application generated and is therefore might be indicative of somebody probing for vulnerabilities.
static void	checkBadInput(SessionService sess)
java.lang.Boolean	confirm(HttpServletRequest req, HttpServletResponse res, AppContext conn, java.lang.String type, java.lang.Object[] args) process a confirm page It either returns a Boolean object if the answer is available or redirects to the confirm page and returns null.
java.lang.Boolean	confirm(HttpServletRequest req, HttpServletResponse res, AppContext conn, java.lang.String type, java.lang.Object[] args, SimpleXMLBuilder extra)
void	doGet(HttpServletRequest req, HttpServletResponse res)
protected void	doPost(HttpServletRequest req, HttpServletResponse res)
protected abstract void	doPost(HttpServletRequest req, HttpServletResponse res, AppContext conn) Method that does the actual work
protected void	doPut(HttpServletRequest req, HttpServletResponse res)
protected void	doPut(HttpServletRequest req, HttpServletResponse res, AppContext conn) Method to handle put requests
static java.lang.String	encodeCGI(java.lang.String input) Translates a string into CGI format (used for encoding form values in URLs)
Logger	getLogger(AppContext c) get a logger based on the class name
void	handleFormResult(AppContext conn, HttpServletRequest req, HttpServletResponse res, FormResult result)
void	message(AppContext context, HttpServletRequest req, HttpServletResponse res, java.lang.String message_type) Show a standard pre-formatted message page from the servlet.
void	message(AppContext context, HttpServletRequest req, HttpServletResponse res, java.lang.String message_type, java.lang.Object... args) Show a standard pre-formatted message page from the servlet.
static void	messageWithArgs(AppContext context, HttpServletRequest req, HttpServletResponse res, java.lang.String message_type, java.lang.Object[] args)
protected void	sendMessageWithArgs(AppContext context, HttpServletRequest req, HttpServletResponse res, java.lang.String message_type, java.lang.Object[] args)

Methods inherited from class java.lang.Object

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

Field Detail

MESSAGES_JSP_URL

public static final java.lang.String MESSAGES_JSP_URL

See Also:

Constant Field Values

MESSAGE_TYPE_ATTR

public static final java.lang.String MESSAGE_TYPE_ATTR

The attribute name for the message type. This is looked up in the message bundle to get the text

See Also:

Constant Field Values

MESSAGE_EXTRA_ATTR

public static final java.lang.String MESSAGE_EXTRA_ATTR

The attribute name for the secondary message (optional) This can be passed as an attribute to add secondary text to a message default extra text can also be included in the message bundle with a name based on the message type.

See Also:

Constant Field Values

CONFIRM_NO

public static final java.lang.String CONFIRM_NO

See Also:

Constant Field Values

CONFIRM_YES

public static final java.lang.String CONFIRM_YES

See Also:

Constant Field Values

EXTRA_HTML

public static final java.lang.String EXTRA_HTML

See Also:

Constant Field Values

ARGS

public static final java.lang.String ARGS

See Also:

Constant Field Values

SCRIPTS_CONFIRM_JSP

public static final java.lang.String SCRIPTS_CONFIRM_JSP

See Also:

Constant Field Values

CONFIRM_TYPE

public static final java.lang.String CONFIRM_TYPE

See Also:

Constant Field Values

CONFIRM_POST_URL

public static final java.lang.String CONFIRM_POST_URL

See Also:

Constant Field Values

Constructor Detail

WebappServlet

public WebappServlet()

Method Detail

doGet

public void doGet(HttpServletRequest req,
                  HttpServletResponse res)
           throws ServletException,
                  java.io.IOException

Throws:

ServletException

java.io.IOException

doPost

protected final void doPost(HttpServletRequest req,
                            HttpServletResponse res)
                     throws ServletException,
                            java.io.IOException

Throws:

ServletException

java.io.IOException

doPut

protected final void doPut(HttpServletRequest req,
                           HttpServletResponse res)
                    throws ServletException,
                           java.io.IOException

Throws:

ServletException

java.io.IOException

doPost

protected abstract void doPost(HttpServletRequest req,
                               HttpServletResponse res,
                               AppContext conn)
                        throws ServletException,
                               java.io.IOException

Method that does the actual work

Parameters:

req -

res -

conn -

Throws:

ServletException

java.io.IOException

doPut

protected void doPut(HttpServletRequest req,
                     HttpServletResponse res,
                     AppContext conn)
              throws ServletException,
                     java.io.IOException

Method to handle put requests

Parameters:

req -

res -

conn -

Throws:

ServletException

java.io.IOException

getLogger

public Logger getLogger(AppContext c)

get a logger based on the class name

Parameters:

c -

Returns:

Logger

badInputCheck

public void badInputCheck(AppContext conn)

Call this method when invalid data is passed to something that should have been application generated and is therefore might be indicative of somebody probing for vulnerabilities.

Parameters:

conn -

checkBadInput

public static void checkBadInput(SessionService sess)

message

public void message(AppContext context,
                    HttpServletRequest req,
                    HttpServletResponse res,
                    java.lang.String message_type)
             throws ServletException,
                    java.io.IOException

Show a standard pre-formatted message page from the servlet. This can only be called once as it won't work if any output is committed its the standard way for a servlet to generate output other than redirecting to a submitting page. Pre-formatted messages are defined in bundles and pass through AppContext.expandText(String) before being shown

Parameters:

context -

req -

res -

message_type -

Throws:

ServletException

java.io.IOException

See Also:

MessageBundleService

message

public void message(AppContext context,
                    HttpServletRequest req,
                    HttpServletResponse res,
                    java.lang.String message_type,
                    java.lang.Object... args)
             throws ServletException,
                    java.io.IOException

Show a standard pre-formatted message page from the servlet. This can only be called once as it won't work if any output is committed its the standard way for a servlet to generate output other than redirecting to a submitting page. Pre-formatted messages are defined in bundles and pass through AppContext.expandText(String) before being shown

Parameters:

context - AppContext

req -

res -

message_type - name of message

args - array of arguments.

Throws:

ServletException

java.io.IOException

See Also:

MessageBundleService

sendMessageWithArgs

protected void sendMessageWithArgs(AppContext context,
                                   HttpServletRequest req,
                                   HttpServletResponse res,
                                   java.lang.String message_type,
                                   java.lang.Object[] args)
                            throws ServletException,
                                   java.io.IOException

Throws:

ServletException

java.io.IOException

messageWithArgs

public static void messageWithArgs(AppContext context,
                                   HttpServletRequest req,
                                   HttpServletResponse res,
                                   java.lang.String message_type,
                                   java.lang.Object[] args)
                            throws ServletException,
                                   java.io.IOException

Throws:

ServletException

java.io.IOException

confirm

public java.lang.Boolean confirm(HttpServletRequest req,
                                 HttpServletResponse res,
                                 AppContext conn,
                                 java.lang.String type,
                                 java.lang.Object[] args)
                          throws java.io.IOException,
                                 ServletException

process a confirm page It either returns a Boolean object if the answer is available or redirects to the confirm page and returns null. The title and text of the confirm message is defined in confirm.properties

Parameters:

req -

res -

conn -

type - type of message

args -

Returns:

TRUE or FALSE or NULL

Throws:

java.io.IOException

ServletException

confirm

public java.lang.Boolean confirm(HttpServletRequest req,
                                 HttpServletResponse res,
                                 AppContext conn,
                                 java.lang.String type,
                                 java.lang.Object[] args,
                                 SimpleXMLBuilder extra)
                          throws java.io.IOException,
                                 ServletException

Throws:

java.io.IOException

ServletException

handleFormResult

public void handleFormResult(AppContext conn,
                             HttpServletRequest req,
                             HttpServletResponse res,
                             FormResult result)
                      throws java.lang.Exception

Throws:

java.lang.Exception

encodeCGI

public static java.lang.String encodeCGI(java.lang.String input)

Translates a string into CGI format (used for encoding form values in URLs)

Parameters:

input - the String to encode

Returns:

String a CGI encoded string