com.dpslink.base.servlet

Class BaseServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.dpslink.base.servlet.BaseServlet

All Implemented Interfaces:

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

Direct Known Subclasses:

FlashServlet, GoBack, Printable, SiteError

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

An abstract extension of HttpServlet that provides default functionality for basic servlet processing and defines method signatures for specific application and servlet requirements.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	BaseServlet.Context Inner class used to store servlet context information.

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	BROWSER_IE The browser type value for Microsoft Internet Explorer compatible web browsers.
protected static int	BROWSER_NN The browser type value for Netscape Navigator compatible web browsers.
protected static int	BROWSER_XX The browser type value for unknown browsers.
protected static int	RESP_NULL The response flag "null" value.
protected static int	RESP_REDIRECTED The response flag "page redirected" value.
protected static int	RQST_AJAX The request flag "AJAX call" value.
protected static int	RQST_NULL The request flag "null" value.
private static long	serialVersionUID The class' serialization version id.
private static java.lang.Boolean	SERVER_TOMCAT Indicates if the application is running in an Apache Tomcat server.

Constructor Summary

Constructors

Constructor and Description
BaseServlet()

Method Summary

Modifier and Type	Method and Description
protected int	confirmSession(BaseServlet.Context ctx) Determines if the servlet is being accessed within the context of a valid session.
protected BaseServlet.Context	createContext(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Creates the servlet context inner class.
protected void	createNewSession(BaseServlet.Context ctx) Creates a new session object and initializes the minimum required values for a new session.
protected abstract void	createNewSessionImpl(BaseServlet.Context ctx) Provides additional application-specific functionality for creating a new session.
protected void	determineBrowser(BaseServlet.Context ctx) Determines the type of browser being used (i.e.
void	doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Handles HTTP GET requests.
void	doPost(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Handles HTTP POST requests.
protected abstract boolean	editFormFields(BaseServlet.Context ctx) Edits the values from the html template's form fields.
protected java.lang.String	getCookie(BaseServlet.Context ctx, java.lang.String name) Obtains the value of a cookie key from request object.
protected java.lang.String	getInvokerName(BaseServlet.Context ctx) Returns the name for the servlet that invoked this servlet.
protected java.lang.String	getInvokerName(BaseServlet.Context ctx, boolean inclSlash) Returns the name for the servlet that invoked this servlet.
protected java.lang.String	getInvokerParams(BaseServlet.Context ctx) Returns the url parameters (query string) for the servlet that invoked this servlet.
protected java.lang.String	getInvokerParams(BaseServlet.Context ctx, boolean inclQmark) Returns the url parameters (query string) for the servlet that invoked this servlet.
protected java.lang.String	getInvokerPath(BaseServlet.Context ctx) Returns the path for the servlet that invoked this servlet.
protected java.lang.String	getInvokerPath(BaseServlet.Context ctx, boolean inclSlash) Returns the path for the servlet that invoked this servlet.
protected java.lang.String	getInvokerURL(BaseServlet.Context ctx) Returns the full url for the servlet that invoked this servlet.
protected abstract java.lang.String	getNextURL(BaseServlet.Context ctx) Returns the next URL (including parameters) to be processed when this servlet's processing has been successfully completed (no edit errors, etc.).
protected java.lang.String	getPageParams(BaseServlet.Context ctx) Returns the URL parameters required to process the servlet when the template's form is posted.
protected java.lang.String	getPageTitle(BaseServlet.Context ctx) Returns the title of the servlet page to be displayed to the user.
protected java.lang.String	getRequestURL(BaseServlet.Context ctx) Returns the current request's full url.
protected java.lang.String	getServletName(BaseServlet.Context ctx) Returns the name for the current servlet.
protected java.lang.String	getServletName(BaseServlet.Context ctx, boolean inclSlash) Returns the name for the current servlet.
protected java.lang.String	getServletParams(BaseServlet.Context ctx) Returns the current servlet's url parameters (query string).
protected java.lang.String	getServletParams(BaseServlet.Context ctx, boolean inclQmark) Returns the current servlet's url parameters (query string).
protected java.lang.String	getServletPath(BaseServlet.Context ctx) Returns the current servlet's path.
protected java.lang.String	getServletPath(BaseServlet.Context ctx, boolean inclSlash) Returns the current servlet's path.
protected java.lang.String	getServletURL(BaseServlet.Context ctx) Returns the current servlet's url.
protected java.lang.String	getServletURL(BaseServlet.Context ctx, boolean inclSlash) Returns the current servlet's url.
protected java.lang.String	getTemplateMessage(java.lang.String msgidsfx) Returns the message text for a given message id suffix.
protected java.lang.String	getTemplateMessage(java.lang.String msgidsfx, java.lang.String value) Returns the message text for a given message id suffix with the given substitution values inserted into the message text.
protected java.lang.String	getTemplateMessage(java.lang.String msgidsfx, java.lang.String value1, java.lang.String value2) Returns the message text for a given message id suffix with the given substitution values inserted into the message text.
protected java.lang.String	getTemplateMessage(java.lang.String msgidsfx, java.lang.String value1, java.lang.String value2, java.lang.String value3) Returns the message text for a given message id suffix with the given substitution values inserted into the message text.
protected java.lang.String	getTemplateMessage(java.lang.String msgidsfx, java.lang.String value1, java.lang.String value2, java.lang.String value3, java.lang.String value4) Returns the message text for a given message id suffix with the given substitution values inserted into the message text.
protected abstract java.lang.String	getTemplateName(BaseServlet.Context ctx) Returns the name of the html template file used by the servlet.
protected org.apache.velocity.VelocityContext	initTemplateData(BaseServlet.Context ctx, boolean cookies) Creates, initializes and returns a new set of Velocity template data.
protected abstract void	initTemplateDataImpl(BaseServlet.Context ctx, org.apache.velocity.VelocityContext vc, boolean cookies) Provides additional application-specific functionality for initializing a new set of Velocity template data.
protected boolean	isPrintable(BaseServlet.Context ctx) Answers if the servlet allows for a printable version to be displayed.
protected boolean	isServerTomcat() Answers if the application is running in an Apache Tomcat server.
private boolean	isServletURL(java.lang.String url) Answers if the given URL is for a servlet vs.
private boolean	isURLSecure(java.lang.String servlet) Answers whether a given servlet name is to use SSL.
protected void	log(java.lang.Exception e) Logs an exception to the log file.
protected java.lang.String	qualifyURL(BaseServlet.Context ctx, java.lang.String url) Fully qualifies a static HTML URL or a servlet URL based on the current request method (GET or POST).
private java.lang.String	qualifyURL(BaseServlet.Context ctx, java.lang.String url, boolean post) Fully qualifies a static HTML URL or a servlet URL based on the given post parameter flag.
private java.lang.String	qualifyURL2(BaseServlet.Context ctx, java.lang.String fullURL) Requalifies a static HTML URL or a servlet URL based on the current protocol.
private java.lang.String	qualifyURL3(BaseServlet.Context ctx, java.lang.String htmlURL, boolean post) Requalifies a static HTML URL based on the given post parameter flag.
protected abstract void	readParameters(BaseServlet.Context ctx, boolean post) Reads the parameters passed to the servlet via the http request object.
protected void	redirectURL(BaseServlet.Context ctx, java.lang.String url) Handles redirection for static html URLs and for servlet URLs.
protected void	requestComplete(BaseServlet.Context ctx, boolean post) Handles completion processing for a request, such as any housekeeping tasks that might need to be performed after all other processing for a request has been completed.
protected abstract boolean	requiresLogon(BaseServlet.Context ctx) Answers if the servlet requires a valid non-default user in order to continue processing.
protected abstract void	resetFormFields(BaseServlet.Context ctx) Resets the values for the html template's form fields.
protected abstract void	setCookieValues(BaseServlet.Context ctx) Adds one or more values to the http session cookies.
static void	setP3PCompactPolicy(javax.servlet.http.HttpServletResponse response) Sets the response header P3P compact policy for the given HTTP response.
protected abstract void	setSessionValues(BaseServlet.Context ctx) Adds one or more values to the http session object.
protected abstract void	setTemplateData(BaseServlet.Context ctx) Sets the various data required by the html template.
protected boolean	showSiteError(BaseServlet.Context ctx) Redirects to the site error page.
protected boolean	showSiteError(BaseServlet.Context ctx, java.lang.Exception e) Redirects to the site error page.
protected boolean	showSiteError(BaseServlet.Context ctx, java.lang.String msg) Redirects to the site error page.
private boolean	switchProtocol(BaseServlet.Context ctx) Determines if the current request requires the protocol to be switched from nonsecure to secure or from secure to nonsecure.
protected void	useExistingSession(BaseServlet.Context ctx) Reinitializes the minimum required values for an existing session.
protected abstract void	useExistingSessionImpl(BaseServlet.Context ctx) Provides additional application-specific functionality for using an existing session.
protected void	writeCookie(BaseServlet.Context ctx, java.lang.String name, java.lang.String value) Adds a given cookie name and value to the response header and sets the cookie to expire based on the value for "Site.Cookie.Expires" or to a quasi-permanent default of one year.
protected void	writeCookie(BaseServlet.Context ctx, java.lang.String name, java.lang.String value, int age) Adds a given cookie name and value to the response header and sets the cookie to expire based on the given age.
private void	writePage(BaseServlet.Context ctx) Writes (sends) a page of html via the TemplateProcessor class.
protected abstract void	writePageImpl(BaseServlet.Context ctx) Provides additional application-specific functionality for writing a page.
protected void	writeTempCookie(BaseServlet.Context ctx, java.lang.String name, java.lang.String value) Adds a given cookie name and value to the response header and sets the cookie as a temporary session cookie (expires when the user closes their web browser).
private void	writeURL(BaseServlet.Context ctx) Writes (redirects to) a URL.

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, 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

The class' serialization version id.

See Also:

Constant Field Values

BROWSER_IE

protected static final int BROWSER_IE

The browser type value for Microsoft Internet Explorer compatible web browsers.

See Also:

Constant Field Values

BROWSER_NN

protected static final int BROWSER_NN

The browser type value for Netscape Navigator compatible web browsers.

See Also:

Constant Field Values

BROWSER_XX

protected static final int BROWSER_XX

The browser type value for unknown browsers.

See Also:

Constant Field Values

RQST_NULL

protected static final int RQST_NULL

The request flag "null" value.

See Also:

Constant Field Values

RQST_AJAX

protected static final int RQST_AJAX

The request flag "AJAX call" value.

See Also:

Constant Field Values

RESP_NULL

protected static final int RESP_NULL

The response flag "null" value.

See Also:

Constant Field Values

RESP_REDIRECTED

protected static final int RESP_REDIRECTED

The response flag "page redirected" value.

See Also:

Constant Field Values

SERVER_TOMCAT

private static java.lang.Boolean SERVER_TOMCAT

Indicates if the application is running in an Apache Tomcat server.

Constructor Detail

BaseServlet

public BaseServlet()

Method Detail

doGet

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

Handles HTTP GET requests. Invoked by the servlet API.

Overrides:

doGet in class javax.servlet.http.HttpServlet

Parameters:

request - (HttpServletRequest) The servlet's incoming request.

response - (HttpServletResponse) The servlet's outgoing response.

Throws:

java.io.IOException - - if an error occurs while processing the request or response.

javax.servlet.ServletException - - if an error occurs while processing the request or response.

doPost

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

Handles HTTP POST requests. Invoked by the servlet API.

Overrides:

doPost in class javax.servlet.http.HttpServlet

Parameters:

request - (HttpServletRequest) The servlet's incoming request.

response - (HttpServletResponse) The servlet's outgoing response.

Throws:

java.io.IOException - - if an error occurs while processing the request or response.

javax.servlet.ServletException - - if an error occurs while processing the request or response.

createNewSession

protected void createNewSession(BaseServlet.Context ctx)

Creates a new session object and initializes the minimum required values for a new session. Invoked by the confirmSession method.

Parameters:

ctx - (Context) The current servlet context.

createNewSessionImpl

protected abstract void createNewSessionImpl(BaseServlet.Context ctx)

Provides additional application-specific functionality for creating a new session. Invoked by the createNewSession method. Subclasses should override this method to provide application-specific processing, such as for initializing any additional session or context values.

Parameters:

ctx - (Context) The current servlet context.

useExistingSession

protected void useExistingSession(BaseServlet.Context ctx)

Reinitializes the minimum required values for an existing session. Invoked by the confirmSession method.

Parameters:

ctx - (Context) The current servlet context.

useExistingSessionImpl

protected abstract void useExistingSessionImpl(BaseServlet.Context ctx)

Provides additional application-specific functionality for using an existing session. Invoked by the useExistingSession method. Subclasses should override this method to provide application-specific processing, such as for initializing any additional session or context values.

Parameters:

ctx - (Context) The current servlet context.

confirmSession

protected int confirmSession(BaseServlet.Context ctx)
                      throws java.io.IOException

Determines if the servlet is being accessed within the context of a valid session. This implementation provides very minimal functionality which is likely inadequate for actual application purposes. Subclasses should override this method to provide a more robust confirmation. Invoked by the doGet and doPost methods.

Parameters:

ctx - (Context) The current servlet context.

Returns:

int - -1 if error, 0 if redirected, 1 okay.

Throws:

java.io.IOException - - if an error occurs while confirming the session.

determineBrowser

protected void determineBrowser(BaseServlet.Context ctx)
                         throws java.io.IOException

Determines the type of browser being used (i.e. Microsoft, Netscape, etc.) and sets the ctx.requestBrowser attribute accordingly. Invoked by the confirmSession method. Subclasses can use the ctx.requestBrowser attribute to accommodate a browser's special requirements.

Parameters:

ctx - (Context) The current servlet context.

Throws:

java.io.IOException - - if an error occurs while determining the browser type.

getCookie

protected java.lang.String getCookie(BaseServlet.Context ctx,
                                     java.lang.String name)

Obtains the value of a cookie key from request object.

Parameters:

ctx - (Context) The current servlet context.

name - (String) The name of the cookie to retrieve.

Returns:

String - The retrieved cookie value or null if the cookie was not found.

getInvokerName

protected java.lang.String getInvokerName(BaseServlet.Context ctx)

Returns the name for the servlet that invoked this servlet. Does not include leading slash.

Parameters:

ctx - (Context) The current servlet context.

Returns:

String - The invoking servlet's name or an empty string if unable to determine the invoker.

getInvokerName

protected java.lang.String getInvokerName(BaseServlet.Context ctx,
                                          boolean inclSlash)

Returns the name for the servlet that invoked this servlet.

Parameters:

ctx - (Context) The current servlet context.

inclSlash - (boolean) true to include the leading slash, otherwise false.

Returns:

String - The invoking servlet's name or an empty string if unable to determine the invoker.

getInvokerParams

protected java.lang.String getInvokerParams(BaseServlet.Context ctx)

Returns the url parameters (query string) for the servlet that invoked this servlet. Includes the leading question (when parameters exist).

Parameters:

ctx - (Context) The current servlet context.

Returns:

String - The url parameters or an empty string if unable to determine the invoker or if there are no parameters.

getInvokerParams

protected java.lang.String getInvokerParams(BaseServlet.Context ctx,
                                            boolean inclQmark)

Returns the url parameters (query string) for the servlet that invoked this servlet.

Parameters:

ctx - (Context) The current servlet context.

inclQmark - (boolean) true to include the leading question mark (when parameters exist), otherwise false.

Returns:

String - The url parameters or an empty string if unable to determine the invoker or if there are no parameters.

getInvokerPath

protected java.lang.String getInvokerPath(BaseServlet.Context ctx)

Returns the path for the servlet that invoked this servlet. Does not include protocol, host, port and any parameters. Does not include leading slash.

Parameters:

ctx - (Context) The current servlet context.

Returns:

String - The invoking servlet's path or an empty string if unable to determine the invoker.

getInvokerPath

protected java.lang.String getInvokerPath(BaseServlet.Context ctx,
                                          boolean inclSlash)

Returns the path for the servlet that invoked this servlet. Does not include protocol, host, port and any parameters.

Parameters:

ctx - (Context) The current servlet context.

inclSlash - (boolean) true to include the leading slash, otherwise false.

Returns:

String - The invoking servlet's path or an empty string if unable to determine the invoker.

getInvokerURL

protected java.lang.String getInvokerURL(BaseServlet.Context ctx)

Returns the full url for the servlet that invoked this servlet. Includes protocol, host, port, path and any parameters.

Parameters:

ctx - (Context) The current servlet context.

Returns:

String - The invoking servlet's full url or an empty string if unable to determine the invoker.

getPageParams

protected java.lang.String getPageParams(BaseServlet.Context ctx)

Returns the URL parameters required to process the servlet when the template's form is posted. Invoked by the writePage method. The default implementation returns the same parameters that were used to invoke the servlet. Subclasses should override this method if different parameters are required, so when the form is posted, the subclass can re-determine the various values that were orginally used to display the template.

When parameters exist, this method prefixes the parameters with a question mark (?). Any override of this method should do the same.

Parameters:

ctx - (Context) The current servlet context.

Returns:

String - The URL's parameters.

getPageTitle

protected java.lang.String getPageTitle(BaseServlet.Context ctx)

Returns the title of the servlet page to be displayed to the user. Invoked by the writePage method. The default implementation retrieves the title from properties. Subclasses should override this method if a different title is required.

Parameters:

ctx - (Context) The current servlet context.

Returns:

String - The page's title.

getRequestURL

protected java.lang.String getRequestURL(BaseServlet.Context ctx)

Returns the current request's full url. Includes protocol, host, port, path and any parameters.

Parameters:

ctx - (Context) The current servlet context.

Returns:

String - The request's full url.

getServletParams

protected java.lang.String getServletParams(BaseServlet.Context ctx)

Returns the current servlet's url parameters (query string). Includes the leading question (when parameters exist).

Parameters:

ctx - (Context) The current servlet context.

Returns:

String - The url parameters or an empty string if there are no parameters.

getServletParams

protected java.lang.String getServletParams(BaseServlet.Context ctx,
                                            boolean inclQmark)

Returns the current servlet's url parameters (query string).

Parameters:

ctx - (Context) The current servlet context.

inclQmark - (boolean) true to include the leading question mark (when parameters exist), otherwise false.

Returns:

String - The url parameters or an empty string if there are no parameters.

getServletPath

protected java.lang.String getServletPath(BaseServlet.Context ctx)

Returns the current servlet's path. Does not include protocol, host, port and any parameters. Does not include leading slash.

Parameters:

ctx - (Context) The current servlet context.

Returns:

String - The servlet's path.

getServletPath

protected java.lang.String getServletPath(BaseServlet.Context ctx,
                                          boolean inclSlash)

Returns the current servlet's path. Does not include protocol, host, port and any parameters.

Parameters:

ctx - (Context) The current servlet context.

inclSlash - (boolean) true to include the leading slash, otherwise false.

Returns:

String - The servlet's path.

getServletName

protected java.lang.String getServletName(BaseServlet.Context ctx)

Returns the name for the current servlet. Does not include leading slash.

Parameters:

ctx - (Context) The current servlet context.

Returns:

String - The current servlet's name.

getServletName

protected java.lang.String getServletName(BaseServlet.Context ctx,
                                          boolean inclSlash)

Returns the name for the current servlet.

Parameters:

ctx - (Context) The current servlet context.

inclSlash - (boolean) true to include the leading slash, otherwise false.

Returns:

String - The current servlet's name.

getServletURL

protected java.lang.String getServletURL(BaseServlet.Context ctx)

Returns the current servlet's url. Includes path and any parameters. Does not include protocol, host and port. Does not include leading slash.

Parameters:

ctx - (Context) The current servlet context.

Returns:

String - The servlet's full url.

getServletURL

protected java.lang.String getServletURL(BaseServlet.Context ctx,
                                         boolean inclSlash)

Returns the current servlet's url. Includes path and any parameters. Does not include protocol, host and port.

Parameters:

ctx - (Context) The current servlet context.

inclSlash - (boolean) true to include the leading slash, otherwise false.

Returns:

String - The servlet's full url.

getTemplateMessage

protected java.lang.String getTemplateMessage(java.lang.String msgidsfx)

Returns the message text for a given message id suffix. Returns an error message text if the message id cannot be found.

Parameters:

msgidsfx - (String) The resource key suffix for the message to retrieve. The supplied value is automatically prefixed with "MSG." plus the invoking servlet's class name.

Returns:

String - The message text. Any log level value (DEBUG, INFO, WARN, etc.) is stripped from the configured message text and not returned.

getTemplateMessage

protected java.lang.String getTemplateMessage(java.lang.String msgidsfx,
                                              java.lang.String value)

Returns the message text for a given message id suffix with the given substitution values inserted into the message text. Substitution positions within the message text are denoted by {n} where n is a zero-based ordinal for each value to be substituted (i.e. {0} {1} {2} {3}). Returns an error message text if the message id cannot be found.

Parameters:

msgidsfx - (String) The resource key suffix for the message to retrieve. The supplied value is automatically prefixed with "MSG." plus the invoking servlet's class name.

value - (String) The value that is to be substituted into the message text.

Returns:

String - The message text. Any log level value (DEBUG, INFO, WARN, etc.) is stripped from the configured message text and not returned.

getTemplateMessage

protected java.lang.String getTemplateMessage(java.lang.String msgidsfx,
                                              java.lang.String value1,
                                              java.lang.String value2)

Returns the message text for a given message id suffix with the given substitution values inserted into the message text. Substitution positions within the message text are denoted by {n} where n is a zero-based ordinal for each value to be substituted (i.e. {0} {1} {2} {3}). Returns an error message text if the message id cannot be found.

Parameters:

msgidsfx - (String) The resource key suffix for the message to retrieve. The supplied value is automatically prefixed with "MSG." plus the invoking servlet's class name.

value1 - (String) The 1st value that is to be substituted into the message text.

value2 - (String) The 2nd value that is to be substituted into the message text.

Returns:

String - The message text. Any log level value (DEBUG, INFO, WARN, etc.) is stripped from the configured message text and not returned.

getTemplateMessage

protected java.lang.String getTemplateMessage(java.lang.String msgidsfx,
                                              java.lang.String value1,
                                              java.lang.String value2,
                                              java.lang.String value3)

Returns the message text for a given message id suffix with the given substitution values inserted into the message text. Substitution positions within the message text are denoted by {n} where n is a zero-based ordinal for each value to be substituted (i.e. {0} {1} {2} {3}). Returns an error message text if the message id cannot be found.

Parameters:

msgidsfx - (String) The resource key suffix for the message to retrieve. The supplied value is automatically prefixed with "MSG." plus the invoking servlet's class name.

value1 - (String) The 1st value that is to be substituted into the message text.

value2 - (String) The 2nd value that is to be substituted into the message text.

value3 - (String) The 3rd value that is to be substituted into the message text.

Returns:

String - The message text. Any log level value (DEBUG, INFO, WARN, etc.) is stripped from the configured message text and not returned.

getTemplateMessage

protected java.lang.String getTemplateMessage(java.lang.String msgidsfx,
                                              java.lang.String value1,
                                              java.lang.String value2,
                                              java.lang.String value3,
                                              java.lang.String value4)

Returns the message text for a given message id suffix with the given substitution values inserted into the message text. Substitution positions within the message text are denoted by {n} where n is a zero-based ordinal for each value to be substituted (i.e. {0} {1} {2} {3}). Returns an error message text if the message id cannot be found.

Parameters:

msgidsfx - (String) The resource key suffix for the message to retrieve. The supplied value is automatically prefixed with "MSG." plus the invoking servlet's class name.

value1 - (String) The 1st value that is to be substituted into the message text.

value2 - (String) The 2nd value that is to be substituted into the message text.

value3 - (String) The 3rd value that is to be substituted into the message text.

value4 - (String) The 4th value that is to be substituted into the message text.

Returns:

String - The message text. Any log level value (DEBUG, INFO, WARN, etc.) is stripped from the configured message text and not returned.

initTemplateData

protected org.apache.velocity.VelocityContext initTemplateData(BaseServlet.Context ctx,
                                                               boolean cookies)
                                                        throws java.io.IOException

Creates, initializes and returns a new set of Velocity template data.

Parameters:

ctx - (Context) The current servlet context.

cookies - (boolean) true if any relevant cookies are to be written, otherwise false.

Throws:

java.io.IOException - - if an error occurs while creating and initializing the template data.

initTemplateDataImpl

protected abstract void initTemplateDataImpl(BaseServlet.Context ctx,
                                             org.apache.velocity.VelocityContext vc,
                                             boolean cookies)

Provides additional application-specific functionality for initializing a new set of Velocity template data. Invoked by the initTemplateData method. Subclasses should override this method to provide application-specific processing, such as for adding any additional values to the Velocity template data or for adding to the HTTP response header cookies.

Parameters:

ctx - (Context) The current servlet context.

vc - (VelocityContext) The current set of Velocity template data.

cookies - (boolean) true if any relevant cookies are to be written, otherwise false.

isPrintable

protected boolean isPrintable(BaseServlet.Context ctx)

Answers if the servlet allows for a printable version to be displayed. The default is false. This method should be overridden by a subclass if the subclass allows a printable version, in which case the template name and template data are retained in the session for use in the generic Printable servlet.

Parameters:

ctx - (Context) The current servlet context.

Returns:

boolean - true if the servlet allows a printable version to be displayed.

isServerTomcat

protected boolean isServerTomcat()

Answers if the application is running in an Apache Tomcat server.

Returns:

boolean - true if Apache Tomcat server, otherwise false.

isServletURL

private boolean isServletURL(java.lang.String url)

Answers if the given URL is for a servlet vs. for a static html page.

Parameters:

url - (String) The url to check.

Returns:

boolean - true if the url is for a servlet, otherwise false.

isURLSecure

private boolean isURLSecure(java.lang.String servlet)

Answers whether a given servlet name is to use SSL. Test is based on secure property in configuration file.

Parameters:

servlet - (String) The name of the servlet.

Returns:

boolean - true if servlet is configured to require SSL.

log

protected void log(java.lang.Exception e)

Logs an exception to the log file.

Parameters:

e - (Exception) The exception that is to be logged.

qualifyURL

protected java.lang.String qualifyURL(BaseServlet.Context ctx,
                                      java.lang.String url)

Fully qualifies a static HTML URL or a servlet URL based on the current request method (GET or POST).

Parameters:

ctx - (Context) The current servlet context.

url - (String) The URL to qualify.

Returns:

String - The fully qualified URL.

qualifyURL

private java.lang.String qualifyURL(BaseServlet.Context ctx,
                                    java.lang.String url,
                                    boolean post)

Fully qualifies a static HTML URL or a servlet URL based on the given post parameter flag.

Parameters:

ctx - (Context) The current servlet context.

url - (String) The URL to qualify.

post - (boolean) true if the qualifying is to be based on a POST request, otherwise false if the qualifying is to be based on a GET request.

Returns:

String - The fully qualified URL.

qualifyURL2

private java.lang.String qualifyURL2(BaseServlet.Context ctx,
                                     java.lang.String fullURL)

Requalifies a static HTML URL or a servlet URL based on the current protocol. This method should only be invoked by qualifyURL or qualifyURL3.

The qualifying in this method is used during a POST request (vs. GET) to avoid the "you are about to be redirected to a connection that is not secure" message. The correct protocol for the request will be determined during the goGet() cycle and, if any redirection is needed due to protocol differences, the redirection will be done at that time.

Parameters:

ctx - (Context) The current servlet context.

fullURL - (String) The URL to requalify. Must include protocol, host, port and path.

Returns:

String - The requalified URL.

qualifyURL3

private java.lang.String qualifyURL3(BaseServlet.Context ctx,
                                     java.lang.String htmlURL,
                                     boolean post)

Requalifies a static HTML URL based on the given post parameter flag. This method should only be invoked by qualifyURL.

The qualifying in this method is used during a POST request (vs. GET) to avoid the "you are about to be redirected to a connection that is not secure" message. The correct protocol for the request will be determined during the goGet() cycle and, if any redirection is needed due to protocol differences, the redirection will be done at that time.

Parameters:

ctx - (Context) The current servlet context.

htmlURL - (String) The html URL to requalify.

Returns:

String - The requalified URL.

redirectURL

protected void redirectURL(BaseServlet.Context ctx,
                           java.lang.String url)
                    throws java.io.IOException

Handles redirection for static html URLs and for servlet URLs. Fully qualifies the given URL prior to redirection. Includes redirect encoding when necessary and URL encoding of any parameters. Redirections should always be performed by invoking this method.

Parameters:

ctx - (Context) The current servlet context.

url - (String) The URL to redirect.

Throws:

java.io.IOException - - if an error occurs while processing the URL redirection.

requestComplete

protected void requestComplete(BaseServlet.Context ctx,
                               boolean post)

Handles completion processing for a request, such as any housekeeping tasks that might need to be performed after all other processing for a request has been completed. Invoked by doGet and doPost as the very last action to be performed for each and every request, even if exceptions are thrown during the request's processing.

This implemention does nothing. Subclasses should override this method to provide any application-specific handling. The override code should catch and respond to any possible exceptions that might occur while the override code is being processed (i.e. write to log, etc.). Note that at this point in the processing, it is too late to redirect to an error page or other destination.

Parameters:

ctx - (Context) The current servlet context.

post - (boolean) true if the activity occurred during a POST operation, otherwise false.

requiresLogon

protected abstract boolean requiresLogon(BaseServlet.Context ctx)

Answers if the servlet requires a valid non-default user in order to continue processing. Subclasses should override this method to answer if the subclass requires logon.

Parameters:

ctx - (Context) The current servlet context.

Returns:

boolean - true if the servlet requires a non-default user, otherwise false.

setP3PCompactPolicy

public static void setP3PCompactPolicy(javax.servlet.http.HttpServletResponse response)

Sets the response header P3P compact policy for the given HTTP response. Automatically invoked for all servlets that are subclasses of this class.

Parameters:

response - (HttpServletResponse) A servlet's outgoing response.

showSiteError

protected boolean showSiteError(BaseServlet.Context ctx)

Redirects to the site error page. Logs an "unknown" error. Sets the context responseFlag variable to RESP_REDIRECTED.

Parameters:

ctx - (Context) The current servlet context.

Returns:

boolean - Always returns false.

showSiteError

protected boolean showSiteError(BaseServlet.Context ctx,
                                java.lang.String msg)

Redirects to the site error page. Logs the given message text. Sets the context responseFlag variable to RESP_REDIRECTED.

Parameters:

ctx - (Context) The current servlet context.

msg - (String) The message text to log.

Returns:

boolean - Always returns false.

showSiteError

protected boolean showSiteError(BaseServlet.Context ctx,
                                java.lang.Exception e)

Redirects to the site error page. Logs the given exception. Sets the context responseFlag variable to RESP_REDIRECTED.

Parameters:

ctx - (Context) The current servlet context.

e - (Exception) The exception to log.

Returns:

boolean - Always returns false.

switchProtocol

private boolean switchProtocol(BaseServlet.Context ctx)
                        throws java.io.IOException

Determines if the current request requires the protocol to be switched from nonsecure to secure or from secure to nonsecure. If so, the user is redirected to the appropriate protocol. Invoked by the doGet method.

Parameters:

ctx - (Context) The current servlet context.

Returns:

boolean - true if switching the protocol is necessary and the user has been redirected, otherwise false.

Throws:

java.io.IOException - - if an error occurs while processing the current request.

writeCookie

protected void writeCookie(BaseServlet.Context ctx,
                           java.lang.String name,
                           java.lang.String value)
                    throws java.io.IOException

Adds a given cookie name and value to the response header and sets the cookie to expire based on the value for "Site.Cookie.Expires" or to a quasi-permanent default of one year. Normally invoked by calls from the setCookieValues method.

Parameters:

ctx - (Context) The current servlet context.

name - (String) The name by which the cookies will be referred.

value - (String) The value associated with the cookie.

Throws:

java.io.IOException - - if an error occurs when adding the cookie to the response header.

writeCookie

protected void writeCookie(BaseServlet.Context ctx,
                           java.lang.String name,
                           java.lang.String value,
                           int age)
                    throws java.io.IOException

Adds a given cookie name and value to the response header and sets the cookie to expire based on the given age.

Parameters:

ctx - (Context) The current servlet context.

name - (String) The name by which the cookies will be referred.

value - (String) The value associated with the cookie.

age - (int) The number of seconds after which the cookie will expire. A negative age indicates the cookie is a temporary cookie (expires when the user closes their web browser). A zero age indicates the cookie is to be deleted.

Throws:

java.io.IOException - - if an error occurs when adding the cookie to the response header.

writeTempCookie

protected void writeTempCookie(BaseServlet.Context ctx,
                               java.lang.String name,
                               java.lang.String value)
                        throws java.io.IOException

Adds a given cookie name and value to the response header and sets the cookie as a temporary session cookie (expires when the user closes their web browser).

Parameters:

ctx - (Context) The current servlet context.

name - (String) The name by which the cookies will be referred.

value - (String) Then value associated with the cookie.

Throws:

java.io.IOException - - if an error occurs when adding the cookie to the response header.

writePage

private void writePage(BaseServlet.Context ctx)
                throws java.io.IOException

Writes (sends) a page of html via the TemplateProcessor class. Invoked by the doGet and doPost methods.

Parameters:

ctx - (Context) The current servlet context.

Throws:

java.io.IOException - - if an error occurs while processing the html template.

writePageImpl

protected abstract void writePageImpl(BaseServlet.Context ctx)

Provides additional application-specific functionality for writing a page. Invoked by the writePage method. Subclasses should override this method to provide application-specific processing.

Parameters:

ctx - (Context) The current servlet context.

writeURL

private void writeURL(BaseServlet.Context ctx)
               throws java.io.IOException

Writes (redirects to) a URL. Invoked by the doPost method.

Parameters:

ctx - (Context) The current servlet context.

Throws:

java.io.IOException - - if an error occurs while processing the URL redirection.

editFormFields

protected abstract boolean editFormFields(BaseServlet.Context ctx)

Edits the values from the html template's form fields. Invoked by the doPost method. Subclasses must override this method to provide support for the editing of specific form fields.

Parameters:

ctx - (Context) The current servlet context.

Returns:

boolean - true if all the edits are successful, otherwise false.

getNextURL

protected abstract java.lang.String getNextURL(BaseServlet.Context ctx)

Returns the next URL (including parameters) to be processed when this servlet's processing has been successfully completed (no edit errors, etc.). Invoked by the writeURL method. Subclasses must override this method to provide a specific URL for processing.

Parameters:

ctx - (Context) The current servlet context.

Returns:

String - The URL.

getTemplateName

protected abstract java.lang.String getTemplateName(BaseServlet.Context ctx)

Returns the name of the html template file used by the servlet. Invoked by the writePage method. Subclasses must override this method to provide the name of a specific html template to process.

Parameters:

ctx - (Context) The current servlet context.

Returns:

String - The html template's name.

readParameters

protected abstract void readParameters(BaseServlet.Context ctx,
                                       boolean post)

Reads the parameters passed to the servlet via the http request object. Invoked by the doGet and doPost method. Subclasses must override this method to provide support for the retrieval of specific request parameters.

Parameters:

ctx - (Context) The current servlet context.

post - (boolean) true if the method is invoked from doPost, otherwise false.

resetFormFields

protected abstract void resetFormFields(BaseServlet.Context ctx)

Resets the values for the html template's form fields. Invoked by the doGet and doPost methods. Subclasses must override this method to provide support for specific form fields.

Parameters:

ctx - (Context) The current servlet context.

setCookieValues

protected abstract void setCookieValues(BaseServlet.Context ctx)
                                 throws java.io.IOException

Adds one or more values to the http session cookies. Invoked by the writeURL method. Subclasses must override this method to provide support for writing specific cookie values. Calls should be made to writeCookie for each cookie that needs to be set.

Parameters:

ctx - (Context) The current servlet context.

Throws:

java.io.IOException - - if an error occurs when adding the cookie to the response header.

setSessionValues

protected abstract void setSessionValues(BaseServlet.Context ctx)

Adds one or more values to the http session object. Invoked by the writeURL method. Subclasses must override this method to provide support for specific session values.

Parameters:

ctx - (Context) The current servlet context.

setTemplateData

protected abstract void setTemplateData(BaseServlet.Context ctx)

Sets the various data required by the html template. Invoked by the writePage method. Subclasses must override this method to provide support for specific html template data.

Parameters:

ctx - (Context) The current servlet context.

createContext

protected BaseServlet.Context createContext(javax.servlet.http.HttpServletRequest request,
                                            javax.servlet.http.HttpServletResponse response)

Creates the servlet context inner class. Most servlets will override this method to provide instantiation of their subclassed context. Invoked by doPost and doGet methods.

Parameters:

request - (HttpServletRequest) The servlet's incoming request.

response - (HttpServletResponse) The servlet's outgoing response.

Returns:

Context - The servlet context.