com.ds.fw.servlet
Class FwBaseServlet

java.lang.Object
  |
  +--javax.servlet.GenericServlet
        |
        +--javax.servlet.http.HttpServlet
              |
              +--com.ds.fw.servlet.FwBaseServlet

All Implemented Interfaces:

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

public abstract class FwBaseServlet

extends javax.servlet.http.HttpServlet

This class is an abstract class that simplifies writing HTTP servlets. It extands the HttpServlet class and provides a framework for handling the HTTP protocol. Because it is an abstract class, servlet writers must subclass it and override at least one method.

See Also:

Serialized Form

Field Summary

static boolean	DEBUG_HANDLERS
static boolean	DEBUG_SERVLETS
protected com.ds.fw.types.FwHashVector	handlers

Constructor Summary

FwBaseServlet()

Method Summary

boolean	checkAccessibleUserRoles(com.ds.fw.user.FwUserRoles userRoles)
com.ds.fw.servlet.FwAdapter	createAdapter(com.ds.fw.servlet.FwRequestContext req, com.ds.fw.servlet.FwResponseContext res)
com.ds.fw.servlet.FwAdapter	createAdapter(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
void	doGet(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Performs the HTTP GET operation.
void	doPost(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Performs the HTTP POST operation.
void	finalize() Kills all of the Connection Pools, releases all the resources.
com.ds.fw.user.FwUserRoles	getAccessibleUserRoles()
com.ds.fw.co.FwCo	getCO()
com.ds.fw.co.servletbroker.FwCoHandler	getHandler(com.ds.fw.servlet.base.FwSelectable k)
com.ds.fw.co.servletbroker.FwCoHandler	getHandler(java.lang.String hendlerName)
com.ds.fw.servlet.base.FwHandler	getHandlerClass(com.ds.fw.servlet.base.FwSelectable k)
com.ds.fw.servlet.base.FwHandler	getHandlerClass(java.lang.String hendlerName)
java.lang.String	getHandlerName(com.ds.fw.servlet.base.FwSelectable k)
java.lang.String	getHandlerType(java.lang.String hendlerName)
java.lang.String	getName()
java.lang.String	getRequestString(java.lang.String name, com.ds.fw.servlet.FwAdapter adapter) The getRequestString method returns form data sent by the web browser back to the servlet.
java.util.Enumeration	getRequestStringNames(com.ds.fw.servlet.FwAdapter adapter) The getRequestStringNames method returns an enumeration of strings containing the names of all form parameters (request) that were sent by the users web browser.
java.lang.String[]	getRequestStrings(java.lang.String name, com.ds.fw.servlet.FwAdapter adapter) The getRequestStrings method returns an array of form data sent by the web browser back to the servlet.
com.ds.fw.co.servletbroker.FwCoServlet	getServletConfigData()
com.ds.fw.co.servletbroker.FwCoServletBroker	getServletsConfigData()
com.ds.fw.servlet.base.FwSelectable	hasHandler(com.ds.fw.servlet.base.FwSelectable k)
void	initServlet()
void	process(com.ds.fw.servlet.FwAdapter adapter)
void	process(com.ds.fw.servlet.FwRequestContext request, com.ds.fw.servlet.FwResponseContext response) An empty method.
void	processHandler(com.ds.fw.servlet.FwAdapter adapter) Process Handler method. If any all previous process methods is overriden it not be executed.
void	sendRedirect(java.lang.String page, com.ds.fw.servlet.FwAdapter adapter) Redirects the current program flow to the given page, forwarding the given adapter request and response objects.
void	sendRedirectErrorGeneral(com.ds.fw.servlet.FwAdapter adapter)
void	sendRedirectErrorPermition(com.ds.fw.servlet.FwAdapter adapter)
void	sendRedirectErrorSesion(com.ds.fw.servlet.FwAdapter adapter)
void	sendRedirectErrorSesionExpire(com.ds.fw.servlet.FwAdapter adapter)
void	setAccessibleUserRoles(com.ds.fw.user.FwUserRoles a)
void	setAdapter(com.ds.fw.servlet.FwAdapter a)
void	setHandler(com.ds.fw.co.servletbroker.FwCoHandler data)
void	setHandler(com.ds.fw.servlet.base.FwSelectable k, com.ds.fw.co.servletbroker.FwCoHandler data)
void	setHandler(java.lang.String selector, java.lang.String command, com.ds.fw.co.servletbroker.FwCoHandler data)
void	setName(java.lang.String n)

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, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEBUG_HANDLERS

public static boolean DEBUG_HANDLERS

DEBUG_SERVLETS

public static boolean DEBUG_SERVLETS

handlers

protected com.ds.fw.types.FwHashVector handlers

Constructor Detail

FwBaseServlet

public FwBaseServlet()

Method Detail

getCO

public com.ds.fw.co.FwCo getCO()

getServletsConfigData

public com.ds.fw.co.servletbroker.FwCoServletBroker getServletsConfigData()

getServletConfigData

public com.ds.fw.co.servletbroker.FwCoServlet getServletConfigData()

initServlet

public void initServlet()

setHandler

public void setHandler(com.ds.fw.servlet.base.FwSelectable k,
                       com.ds.fw.co.servletbroker.FwCoHandler data)

setHandler

public void setHandler(com.ds.fw.co.servletbroker.FwCoHandler data)

setHandler

public void setHandler(java.lang.String selector,
                       java.lang.String command,
                       com.ds.fw.co.servletbroker.FwCoHandler data)

getHandler

public com.ds.fw.co.servletbroker.FwCoHandler getHandler(com.ds.fw.servlet.base.FwSelectable k)

getHandler

public com.ds.fw.co.servletbroker.FwCoHandler getHandler(java.lang.String hendlerName)

hasHandler

public com.ds.fw.servlet.base.FwSelectable hasHandler(com.ds.fw.servlet.base.FwSelectable k)

getHandlerClass

public com.ds.fw.servlet.base.FwHandler getHandlerClass(com.ds.fw.servlet.base.FwSelectable k)
                                                 throws java.lang.ClassNotFoundException,
                                                        java.lang.InstantiationException,
                                                        java.lang.IllegalAccessException

java.lang.ClassNotFoundException

java.lang.InstantiationException

java.lang.IllegalAccessException

getHandlerClass

public com.ds.fw.servlet.base.FwHandler getHandlerClass(java.lang.String hendlerName)
                                                 throws java.lang.ClassNotFoundException,
                                                        java.lang.InstantiationException,
                                                        java.lang.IllegalAccessException

java.lang.ClassNotFoundException

java.lang.InstantiationException

java.lang.IllegalAccessException

getHandlerType

public java.lang.String getHandlerType(java.lang.String hendlerName)

getHandlerName

public java.lang.String getHandlerName(com.ds.fw.servlet.base.FwSelectable k)

setAccessibleUserRoles

public void setAccessibleUserRoles(com.ds.fw.user.FwUserRoles a)

getAccessibleUserRoles

public com.ds.fw.user.FwUserRoles getAccessibleUserRoles()

checkAccessibleUserRoles

public boolean checkAccessibleUserRoles(com.ds.fw.user.FwUserRoles userRoles)

setAdapter

public void setAdapter(com.ds.fw.servlet.FwAdapter a)

createAdapter

public com.ds.fw.servlet.FwAdapter createAdapter(javax.servlet.http.HttpServletRequest req,
                                                 javax.servlet.http.HttpServletResponse res)

createAdapter

public com.ds.fw.servlet.FwAdapter createAdapter(com.ds.fw.servlet.FwRequestContext req,
                                                 com.ds.fw.servlet.FwResponseContext res)

getName

public java.lang.String getName()

setName

public void setName(java.lang.String n)

doPost

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

Performs the HTTP POST operation. This method just redirects its call to the doGet() method.

Overrides:

doPost in class javax.servlet.http.HttpServlet

Parameters:

req - HttpServletRequest that encapsulates the request to the servlet

res - HttpServletResponse that encapsulates the response from the servlet

Throws:

javax.servlet.ServletException - if the request could not be handled

java.io.IOException - if detected when handling the request

See Also:

doGet(HttpServletRequest, HttpServletResponse)

doGet

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

Performs the HTTP GET operation. This method checks if there is a valid session associated with the request and if there is one, calls the process() method.

Overrides:

doGet in class javax.servlet.http.HttpServlet

Parameters:

req - HttpServletRequest that encapsulates the request to the servlet

res - HttpServletResponse that encapsulates the response from the servlet

Throws:

javax.servlet.ServletException - if the request could not be handled

java.io.IOException - if detected when handling the request

See Also:

#process(HttpServletRequest, HttpServletResponse)

process

public void process(com.ds.fw.servlet.FwRequestContext request,
                    com.ds.fw.servlet.FwResponseContext response)
             throws FwApplicationException

An empty method. This method is supposed to be overloaded in descendend classes. Its purpose is to process the request's commands.

Parameters:

request - HttpServletRequest that encapsulates the request to the servlet

response - HttpServletResponse that encapsulates the response from the servlet

Throws:

java.lang.Exception - if the method is invoked but not implemented in the descended class

FwApplicationException

process

public void process(com.ds.fw.servlet.FwAdapter adapter)
             throws FwApplicationException

FwApplicationException

processHandler

public void processHandler(com.ds.fw.servlet.FwAdapter adapter)
                    throws FwApplicationException

Process Handler method.
If any all previous process methods is overriden it not be executed. If it be executed method select exactly Handler and processes this Handler.

FwApplicationException

sendRedirect

public void sendRedirect(java.lang.String page,
                         com.ds.fw.servlet.FwAdapter adapter)

Redirects the current program flow to the given page, forwarding the given adapter request and response objects.

Parameters:

page - the page to be redirected to

adapter - an adapter object

sendRedirectErrorSesion

public void sendRedirectErrorSesion(com.ds.fw.servlet.FwAdapter adapter)

sendRedirectErrorGeneral

public void sendRedirectErrorGeneral(com.ds.fw.servlet.FwAdapter adapter)

sendRedirectErrorPermition

public void sendRedirectErrorPermition(com.ds.fw.servlet.FwAdapter adapter)

sendRedirectErrorSesionExpire

public void sendRedirectErrorSesionExpire(com.ds.fw.servlet.FwAdapter adapter)

finalize

public void finalize()

Kills all of the Connection Pools, releases all the resources.

Overrides:

finalize in class java.lang.Object

getRequestString

public java.lang.String getRequestString(java.lang.String name,
                                         com.ds.fw.servlet.FwAdapter adapter)

The getRequestString method returns form data sent by the web browser back to the servlet. The data within the context is in name value pairs. A string value is returned if the given form data parameter name was sent by the browser. A null is returned if a value does not exist for the specified name.

getRequestStrings

public java.lang.String[] getRequestStrings(java.lang.String name,
                                            com.ds.fw.servlet.FwAdapter adapter)

The getRequestStrings method returns an array of form data sent by the web browser back to the servlet. The data within the context is in name value pairs, but there may be multiple values for any given name. Use this method if the form parameter name may have more than one value. A null is returned if values do not exist for the specified name. If only one value exist for the given name then an array of length one will be returned.

getRequestStringNames

public java.util.Enumeration getRequestStringNames(com.ds.fw.servlet.FwAdapter adapter)

The getRequestStringNames method returns an enumeration of strings containing the names of all form parameters (request) that were sent by the users web browser.