planetj.dataengine
Class DataEngineServlet

java.lang.Object
  |
  +--javax.servlet.GenericServlet
        |
        +--javax.servlet.http.HttpServlet
              |
              +--planetj.dataengine.DataEngineServlet

All Implemented Interfaces:

IApplicationJSPs, IDataEngine, IJSPPages, INavigation, IServletParameters, IWOWJSPs, Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

Direct Known Subclasses:

DataEngineAdminServlet, DataEngineApplicationBuilderServlet, DataEngineApplicationServlet, DataExplorerServlet, DETestServlet, FDManagerServlet, JETestS, SignOnAndRegistrationServlet

public abstract class DataEngineServlet

extends javax.servlet.http.HttpServlet

implements IDataEngine

Handle general services such as sorting, subrowing, summing, navigating Creation date: (12/1/2001 2:57:18 PM)

See Also:

Serialized Form

Field Summary

static String

className Class name.

Fields inherited from interface planetj.dataengine.IDataEngine

ACTION, ADMIN_MAGIC_REQUEST, ALL_SERVLET_PATHS, ALLOW_MULTIPLE_DELETES, ALLOW_MULTIPLE_SELECTION, APPLICATION, COMPANY, CONTEXT, CONTEXT_KEY, CONTROLLER_SERVLET_PATH, CONTROLLER_SERVLET_URI, CURRENT_SQL_CONTEXT, CURRENT_SQL_RECORD_COUNT, CURRENT_SQL_STRING, CURRENT_TOC, DATA_ENGINE_MESSAGE, DATAENGINE_ADMIN_SERVLET_PATH, DATAENGINE_APPLICATION_BUILDER_SERVLET_PATH, DATAENGINE_APPLICATION_SERVLET_PATH, DATAEXPLORER_SERVLET_PATH, DE_ACTION_CATEGORY, DE_ACTION_SIGN_ON, DEFAULT_LAYOUT_DISPLAY_PROPERTIES, DEFAULT_RESULTS_KEY, DEFAULT_USER_LIBRARY, DETAILS, EDITABLE_OPERATIONS, ENVIRONMENT_MODE_DEVELOPMENT, ENVIRONMENT_MODE_PRODUCTION, ERROR_APPLICATION_INVALID, ERROR_COMPANY_INVALID, ERROR_MESSAGE, EXCEPTION, EXCEPTION_JSP_KEY, FIELD, FIELD_DESCRIPTOR_SERVLET_PATH, FIELD_LIST, FIELD_NAMES, FIELDS, FORM_LIB_TBL_FLD, FUNCTION, HIDDEN_APPLICATION_ID, HIDDEN_APPLICATION_METADATA_ALIAS, IGNORE_MAGIC_REQUEST, KEEP_INSERT_VALUES, LAST_JSP_CALLED, LAUNCHED_FROM_BUILDER, LIBRARY, LIBRARY_LIST, MAGIC_ACTION_ROW, MODE, MODE_COPY, MODE_DELETE, MODE_EDIT, MODE_INSERT, MODE_SEARCH, MODE_UNKNOWN, MODE_VIEW, MULTIPLESELECTION, NEW_ROW, NEW_WINDOW_FOR_RESULTS, NEXT_PAGE, NOSELECTION, OPERATION, OPERATION_KEY, OWNER_ID, PAGE, PAGE_REQUEST_EXECUTED, PAGE_VALIDATION_REQUIRED, PARAMETER_VALUE_PREFIX, PREVIOUS_PAGE, RESERVED_PARAMETERS, RETRIEVE_ALL_COLUMNS_ON_COPY, RETRIEVE_ALL_COLUMNS_ON_EDIT, RETRIEVE_ALL_COLUMNS_ON_VIEW, RETRIEVE_FIELDS, RETRIEVE_TABLES, RETURN_URI, ROW, ROW_ALTERNATE_KEY, ROW_COLLECTION, ROW_COLLECTION_KEY, ROW_KEY, ROW_KEY_FOR_DETAILS, ROW_SELECTION_JS_INCLUDED, ROWS_ALTERED_COUNT, SELECTED_ROW, SELECTED_ROW_COLLECTION, SELECTEDOBJECTS, SERVLET_CONTEXT, SESSION_RANDOM_NUMBER, SESSION_SIGNED_OFF, SESSION_SIGNON_RECEIPT_KEY, SESSION_TIMED_OUT, SHOW_FD_QUICK_LINKS, SHOW_UPDATABLE_TABLES, SHOW_UPDATEABLE_ROW, SIGN_ON_CALLER, SIGNON, SIGNON_AND_REGISTRATION_SERVLET_PATH, SINGLESELECTION, STATEMENT, SYSTEM, SYSTEMS_LIST, TABLE, TABLE_LIST, TRANSIENT, UNSUPPORTED, USER_LIBRARY_HTTP_PARAMETER, USER_LIBRARY_HTTP_SESSION_KEY, USER_MESSAGE, USER_PREFERENCES, VALID_SIGNON, WINDOW_CLOSE, WINDOW_NORMAL, WINDOW_POPUP, WINDOW_TYPE_PARAM

Fields inherited from interface planetj.dataengine.INavigation

CHILD_PREFIX, GROUP_ATTRIBUTES, GROUP_ID, INITIAL_GROUP_ID, INITIAL_PAGE_ID, INITIAL_REQUEST_ID, NAVIGATION_CHECKED, NAVIGATION_OBJECT_LIST_PREFIX, NEW_GROUP_ID, NEW_REQUEST_ID, NEW_SESSION_ID, PAGE_ATTRIBUTES, PAGE_ID, PARENT_PREFIX, PERSISTENT_ATTRIBUTES, PREVIOUS_ATTRIBUTES, PREVIOUS_GROUP_ID, PREVIOUS_PAGE_ID, PREVIOUS_REQUEST_ID, REQUEST_ID, RESET_GROUP_ID, RESET_NAVIGATION_IDS, RESET_NAVIGATION_IDS_COMPLETED, RESET_PAGE_ID, RESET_REQUEST_ID, RESET_SESSION_ID, SESSION_ID

Fields inherited from interface planetj.dataengine.IServletParameters

ALL, AUTO_RUN, BASE_URL, CACHE_TRACK_ON, CACHE_TRACK_WRITE_TO_FILE, CLEAN_UP_TIME, DATABASE, DRIVER, ENVIRONMENT_MODE, JDBC_OPTIMIZATIONS, MAX_CONNECTIONS, METADATA_LIBRARY, MIN_CONNECTIONS, ORPHAN_TIMEOUT, PASSWORD, PORT, SYSTEM_ALIAS, SYSTEM_ALIAS_PARAM, SYSTEM_URL, USER_ID, USER_PASSWORD

Fields inherited from interface planetj.dataengine.IJSPPages

CUSTOM_LOG_ON_JSP, DEFAULT_ADD_BODY_JSP, DEFAULT_EDIT_BODY_JSP, DEFAULT_PARAMS_JSP, DEFAULT_PRINT_PAGE_JSP, DEFAULT_RESULTS_JSP, DEFAULT_ROW_DETAILS, DEFAULT_SQL_OPERATION_RESULTS_JSP, DEFAULT_VIEW_BODY_JSP, DETAILS_JSP, DISPLAY_EXCEPTION_JSP, INITIAL_JSP, SIGN_ON_BODY_JSP, SIGN_ON_JSP, SIGNON_PARAMS_JSP

Fields inherited from interface planetj.dataengine.application.IApplicationJSPs

APPLICATION_ADD_JSP, APPLICATION_DETAILS_JSP, APPLICATION_EDIT_JSP, APPLICATION_ERROR_JSP, APPLICATION_HEADER_JSP, APPLICATION_INVALID_LICENSE_JSP, APPLICATION_JSP, APPLICATION_MESSAGE_JSP, APPLICATION_OPERATIONS_TOC, APPLICATION_RESULTS_JSP, APPLICATION_SIGN_ON_JSP, APPLICATION_TEMPLATE_JSP, APPLICATION_TOC_JSP, APPLICATION_VIEW_JSP

Fields inherited from interface planetj.dataengine.application.IWOWJSPs

WOW_MAIN_EXCEPTION_JSP, WOW_MANAGE_OPERATIONS_JSP, WOW_STEPS_JSP, WOW_TOC, WOW_VIEW_APPLICATIONS_JSP, WOW_VIEW_CONNECTIONS_JSP

Constructor Summary

DataEngineServlet()
DataEngineServlet constructor comment.

Method Summary

void	addCookie(javax.servlet.http.HttpServletResponse pResponse, javax.servlet.http.Cookie pCookie) Adds the specified Cookie to the HttpServletResponse.
void	doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Generically reroute to performRequest method.
void	doPost(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Generically reroute to performRequest method.
static String	dumpParameters(javax.servlet.http.HttpServletRequest request) Returns a String containing a listing of all the request's parameters.
void	forward(String uri, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Forward to the specified URI.
javax.servlet.http.Cookie	getCookie(javax.servlet.http.HttpServletRequest pRequest, String pName, String pPath) Gets the Cookie with the specified name and path from the HttpServletRequest.
javax.servlet.http.Cookie[]	getCookies(javax.servlet.http.HttpServletRequest pRequest) Gets all the Cookies in the HttpServletRequest.
static String	getErrorMessage(javax.servlet.http.HttpServletRequest request)
static DataEngineInitializationException	getInitializationException() Gets the initialization exception
abstract String	getInitialPage(javax.servlet.http.HttpServletRequest req) Force subclasses to return an initial jsp/servlet.
String	getLastJSPPath(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Deprecated. no longer used
static ILicense	getLicense(ExecutingContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Deprecated. replaced with DataEngine.getLicense()
String	getLoggingPath() Path to initialize the log file.
static Object	getRequestAttribute(String key, javax.servlet.http.HttpServletRequest request) Gets the attribute in the request for the given key.
static String	getRequestParameter(String key, javax.servlet.http.HttpServletRequest request) Gets the specified parameter from the HTTPRequest.
static String[]	getRequestParameterValues(String key, javax.servlet.http.HttpServletRequest request) Gets the specified parameter from the HTTPRequest.
String	getRowCollectionJsp() Deprecated. didn't know if being used, should this even be here?
IRowEventListener	getRowEventListener(javax.servlet.http.HttpServletRequest req) Each Servlet may have its own RowEventListener defined, so they would override this method and return the appropriate Listener Creation date: (7/11/2002 10:30:18 AM)
String	getServiceRequestOverride(String pServiceReq, javax.servlet.http.HttpServletRequest httpReq, javax.servlet.http.HttpServletResponse httpRes) Return a new String used to lookup the magic service request.
static String	getServletPath(String servletName) Get the path used to call the Servlet with the given name.
static String	getServletPath(String servletName, boolean includeContextPath, javax.servlet.http.HttpServletRequest request) Get the path used to call the Servlet with the given name.
static Object	getSessionAttribute(String key, javax.servlet.http.HttpServletRequest request) Gets the specified object in the HTTPSession.
static Object	getSessionSharedAttribute(String key, javax.servlet.http.HttpServletRequest request) Gets the specified object in the HttpSession.
static String	getUserMessage(javax.servlet.http.HttpServletRequest request)
boolean	handleServiceRequest(javax.servlet.http.HttpServletRequest httpReq, javax.servlet.http.HttpServletResponse httpRes) Handle generic dataengine service requests.
void	init() Initialize the log
boolean	isLicenseValid(String pServletRoot, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Deprecated. replaced with DataEngine.isLicenseValid()
static boolean	isRunningInVA() If we are running in VA or not
static boolean	isServletPath(String servletName) Tests if the String identifies a DataEngine Servlet
boolean	preHandleServiceRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	printParameterTrace(javax.servlet.http.HttpServletRequest req) Technical support method which prints the HttpServletRequest parms out Creation date: (11/7/2001 3:58:05 PM)
abstract void	processRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Handles servlet actions.
void	removeRequestAttribute(javax.servlet.http.HttpServletRequest req, String parmKey) Deprecated. replaced with removeRequestAttribute(String, HttpServletRequest)
static Object	removeRequestAttribute(String key, javax.servlet.http.HttpServletRequest request) Removes the specified object in the HTTPRequest.
void	removeRequestData(javax.servlet.http.HttpServletRequest req, String parmKey) Deprecated. replaced with removeRequestAttribute(String, HttpServletRequest)
void	removeSessionAttribute(javax.servlet.http.HttpServletRequest pRequest, String pKey) Deprecated. replaced with removeSessionAttribute(String, HttpServletRequest)
static Object	removeSessionAttribute(String key, javax.servlet.http.HttpServletRequest request) Removes the specified object in the HttpSession.
static Object	removeSessionSharedAttribute(String key, javax.servlet.http.HttpServletRequest request) Removes the specified object in the HttpSession.
void	removeSharedSessionAttribute(javax.servlet.http.HttpServletRequest pRequest, String pKey) Deprecated. replaced with removeSessionSharedAttribute(String, HttpServletRequest)
void	service(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method handles generic DataEngine service requests.
static void	setErrorMessage(String message, javax.servlet.http.HttpServletRequest request)
static void	setLayoutProperties(LayoutDisplayPropertyGroup layoutProperties, javax.servlet.http.HttpServletRequest request) Deprecated.
static void	setRequestGroupAttribute(String pKey, Object pValue, javax.servlet.http.HttpServletRequest pReq)
static void	setRequestPageAttribute(String pKey, Object pValue, javax.servlet.http.HttpServletRequest pReq) Sets an attribute on the request that is associated with this page.
static void	setRequestPersistentAttribute(String pKey, Object pValue, javax.servlet.http.HttpServletRequest pReq) Sets an attribute on the request that will be persisted.
static void	setRequestTransientAttribute(String key, Object value, javax.servlet.http.HttpServletRequest request) Sets an attriubte on the request that will not be automatically transferred to another request.
static void	setServletPath(String servletDefaultName, String servletMap) Sets a String to use to call a Servlet from another Servlet.
static void	setServletURI(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Deprecated. - temporarily to find where called
static void	setSessionAttribute(String key, Object value, javax.servlet.http.HttpServletRequest request) Sets the specified object in the HttpSession.
static void	setSessionSharedAttribute(String key, Object value, javax.servlet.http.HttpServletRequest request) Sets the specified object in the HttpSession.
static void	setUserMessage(String message, javax.servlet.http.HttpServletRequest request)

Methods inherited from class javax.servlet.http.HttpServlet

service

Methods inherited from class javax.servlet.GenericServlet

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

Methods inherited from class java.lang.Object

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

Field Detail

className

public static final String className

Class name.

Constructor Detail

DataEngineServlet

public DataEngineServlet()

DataEngineServlet constructor comment.

Method Detail

dumpParameters

public static String dumpParameters(javax.servlet.http.HttpServletRequest request)

Returns a String containing a listing of all the request's parameters.

getErrorMessage

public static String getErrorMessage(javax.servlet.http.HttpServletRequest request)

getInitializationException

public static DataEngineInitializationException getInitializationException()

Gets the initialization exception

getLicense

public static ILicense getLicense(ExecutingContext context,
                                  javax.servlet.http.HttpServletRequest req,
                                  javax.servlet.http.HttpServletResponse res)

Deprecated. replaced with DataEngine.getLicense()

Creation date: (4/8/2003 2:37:06 PM)

getRequestAttribute

public static Object getRequestAttribute(String key,
                                         javax.servlet.http.HttpServletRequest request)

Gets the attribute in the request for the given key. Provides a single place for potential error logging and programatic debugging.

Parameters:

key -

request - HttpServletRequest

getRequestParameter

public static String getRequestParameter(String key,
                                         javax.servlet.http.HttpServletRequest request)

Gets the specified parameter from the HTTPRequest. This provides a single place with potential error logging and programatic debug instead of all users getting their own parameters.

getRequestParameterValues

public static String[] getRequestParameterValues(String key,
                                                 javax.servlet.http.HttpServletRequest request)

Gets the specified parameter from the HTTPRequest. This provides a single place with potential error logging and programatic debug instead of all users getting their own parameters.

getServletPath

public static String getServletPath(String servletName)

Get the path used to call the Servlet with the given name. (The context info is not included.) This method does not require the HttpServletRequest to be passed in

Parameters:

servletName - the name of the servlet to get the path needed to call the servlet

Returns:

The name the servlet is mapped to

getServletPath

public static String getServletPath(String servletName,
                                    boolean includeContextPath,
                                    javax.servlet.http.HttpServletRequest request)

Get the path used to call the Servlet with the given name.

Parameters:

servletName - the name of the servlet to get the path needed to call the servlet

includeContextPath - true if the context path should be included in the path to call the servlet (context path should be include when the servlet will be called from HTML); false otherwise (when the the servlet will be called from another servlet)

request - the HttpServletRequest object that containing the client's request

getSessionAttribute

public static Object getSessionAttribute(String key,
                                         javax.servlet.http.HttpServletRequest request)

Gets the specified object in the HTTPSession. This provides a single place with potential error logging and programatic debug instead of all users getting objects from the Session.

Returns:

object from the session

getSessionSharedAttribute

public static Object getSessionSharedAttribute(String key,
                                               javax.servlet.http.HttpServletRequest request)

Gets the specified object in the HttpSession. This provides a single place with potential error logging and programatic debug instead of all users getting objects from the Session.

Returns:

object from the session

getUserMessage

public static String getUserMessage(javax.servlet.http.HttpServletRequest request)

isRunningInVA

public static final boolean isRunningInVA()

If we are running in VA or not

isServletPath

public static boolean isServletPath(String servletName)

Tests if the String identifies a DataEngine Servlet

removeRequestAttribute

public static Object removeRequestAttribute(String key,
                                            javax.servlet.http.HttpServletRequest request)

Removes the specified object in the HTTPRequest. This provides a single place with potential error logging and programatic debug instead of all users setting objects into the Request

removeSessionAttribute

public static Object removeSessionAttribute(String key,
                                            javax.servlet.http.HttpServletRequest request)

Removes the specified object in the HttpSession. This provides a single place with potential error logging and programatic debug instead of all users setting objects into the Session.

removeSessionSharedAttribute

public static Object removeSessionSharedAttribute(String key,
                                                  javax.servlet.http.HttpServletRequest request)

Removes the specified object in the HttpSession. This provides a single place with potential error logging and programatic debug instead of all users setting objects into the Session.

setErrorMessage

public static void setErrorMessage(String message,
                                   javax.servlet.http.HttpServletRequest request)

setLayoutProperties

public static void setLayoutProperties(LayoutDisplayPropertyGroup layoutProperties,
                                       javax.servlet.http.HttpServletRequest request)

Deprecated.

Gets the current layout properties from the session.

setRequestGroupAttribute

public static void setRequestGroupAttribute(String pKey,
                                            Object pValue,
                                            javax.servlet.http.HttpServletRequest pReq)

setRequestPageAttribute

public static void setRequestPageAttribute(String pKey,
                                           Object pValue,
                                           javax.servlet.http.HttpServletRequest pReq)

Sets an attribute on the request that is associated with this page. If the user navigates away from the page displayed from this request, and then returns via the "Cancel" button or other backwards navigation, any attributes stored in the request with this method will be restored to the request.

setRequestPersistentAttribute

public static void setRequestPersistentAttribute(String pKey,
                                                 Object pValue,
                                                 javax.servlet.http.HttpServletRequest pReq)

Sets an attribute on the request that will be persisted. If the user navigates via a MagicRequest, any attribute set via this method will be propagated to the next HttpServletRequest.

setRequestTransientAttribute

public static void setRequestTransientAttribute(String key,
                                                Object value,
                                                javax.servlet.http.HttpServletRequest request)

Sets an attriubte on the request that will not be automatically transferred to another request. This is how request attributes "normally" work.

Parameters:

key -

value -

request - HttpServletRequest

setServletPath

public static void setServletPath(String servletDefaultName,
                                  String servletMap)

Sets a String to use to call a Servlet from another Servlet. Example: WebSphere URI config for a servlet may be: /PJ/DataExplorer In this example, the webapplication was configured to use a context path of "/PJ" and has a servlet map of "/DataExplorer". This method should set the path to "/DataExplorer" which is what is needed when calling servlets or jsps from other servlets or jsps. When calling from HTML you need to have the context path.

Returns:

String

setServletURI

public static void setServletURI(javax.servlet.http.HttpServletRequest req,
                                 javax.servlet.http.HttpServletResponse res)
                          throws javax.servlet.ServletException

Deprecated. - temporarily to find where called

Set the servlet URI in the request. This is used by JSPs when determining the servlet url to call for Service requests. Problems occur in JSPs if the "hardcode" the servlet url because it changes depending on the web app configuration. author: Paul Holm

javax.servlet.ServletException

setSessionAttribute

public static void setSessionAttribute(String key,
                                       Object value,
                                       javax.servlet.http.HttpServletRequest request)

Sets the specified object in the HttpSession. This provides a single place with potential error logging and programatic debug instead of all users setting objects into the Session.

setSessionSharedAttribute

public static void setSessionSharedAttribute(String key,
                                             Object value,
                                             javax.servlet.http.HttpServletRequest request)

Sets the specified object in the HttpSession. This provides a single place with potential error logging and programatic debug instead of all users setting objects into the Session.

setUserMessage

public static void setUserMessage(String message,
                                  javax.servlet.http.HttpServletRequest request)

addCookie

public void addCookie(javax.servlet.http.HttpServletResponse pResponse,
                      javax.servlet.http.Cookie pCookie)

Adds the specified Cookie to the HttpServletResponse.

Parameters:

pResponse -

pCookie - Cookie to set in the HttpServletResponse

doGet

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

Generically reroute to performRequest method.

Overrides:

doGet in class javax.servlet.http.HttpServlet

javax.servlet.ServletException

IOException

doPost

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

Generically reroute to performRequest method.

Overrides:

doPost in class javax.servlet.http.HttpServlet

Parameters:

request - request

response - response

javax.servlet.ServletException

IOException

forward

public void forward(String uri,
                    javax.servlet.http.HttpServletRequest request,
                    javax.servlet.http.HttpServletResponse response)
             throws DataEngineException

Forward to the specified URI.

DataEngineException

getCookie

public javax.servlet.http.Cookie getCookie(javax.servlet.http.HttpServletRequest pRequest,
                                           String pName,
                                           String pPath)

Gets the Cookie with the specified name and path from the HttpServletRequest. Null is returned if the Cookie is not found.

Parameters:

pRequest - request

pName - name of the cookie to get

pPath - path of the cookie to get

Returns:

the cookie with the specified name

getCookies

public javax.servlet.http.Cookie[] getCookies(javax.servlet.http.HttpServletRequest pRequest)

Gets all the Cookies in the HttpServletRequest.

Parameters:

pRequest - request

Returns:

all the Cookies in the HttpServletRequest.

getInitialPage

public abstract String getInitialPage(javax.servlet.http.HttpServletRequest req)
                               throws CMException

Force subclasses to return an initial jsp/servlet. We need this incase potential errors timeout occur while running generic services. For example, the web browser brings up a page and then sits for 5 hours then tries a DataEngineServlet service method such as sorting. The DataEngineServlet session has been lost (invalidated) so we are dead in the water so we'll ask the subclass servlet where we should take the user to resignon.

CMException

getLastJSPPath

public String getLastJSPPath(javax.servlet.http.HttpServletRequest req,
                             javax.servlet.http.HttpServletResponse res)
                      throws javax.servlet.ServletException,
                             CMException

Deprecated. no longer used

get the JSP that was last called so that we know how to get back for magic services. author: Paul Holm

javax.servlet.ServletException

CMException

getLoggingPath

public String getLoggingPath()
                      throws javax.servlet.ServletException

Path to initialize the log file. The DataEngine default logging conf file is used for logging. Subclasses of DataEngineServlet may override this method to specify another logging config file.

javax.servlet.ServletException

getRowCollectionJsp

public String getRowCollectionJsp()

Deprecated. didn't know if being used, should this even be here?

Gets the JSP that should be used for displaying a RowCollection

getRowEventListener

public IRowEventListener getRowEventListener(javax.servlet.http.HttpServletRequest req)

Each Servlet may have its own RowEventListener defined, so they would override this method and return the appropriate Listener Creation date: (7/11/2002 10:30:18 AM)

getServiceRequestOverride

public String getServiceRequestOverride(String pServiceReq,
                                        javax.servlet.http.HttpServletRequest httpReq,
                                        javax.servlet.http.HttpServletResponse httpRes)
                                 throws javax.servlet.ServletException,
                                        IOException

Return a new String used to lookup the magic service request. This can be used by subclasses to override the WOW generated value when special processing is needed. For example, when the service_request is "Op24" a MagicRequest object in the session with the key "Op24" will be looked up and ran.

Returns:

String

javax.servlet.ServletException

IOException

handleServiceRequest

public boolean handleServiceRequest(javax.servlet.http.HttpServletRequest httpReq,
                                    javax.servlet.http.HttpServletResponse httpRes)
                             throws javax.servlet.ServletException,
                                    IOException

Handle generic dataengine service requests. Checks to see if there is a DataEngine "Magic" Service request. A DataEngine service is a generated service request such as column sorting. If there is a service request, the service is carried out and controll is returned to the caller.

Returns:

if a MagicRequest was serviced.

javax.servlet.ServletException

IOException

init

public void init()
          throws javax.servlet.ServletException

Initialize the log

Overrides:

init in class javax.servlet.GenericServlet

javax.servlet.ServletException

isLicenseValid

public boolean isLicenseValid(String pServletRoot,
                              javax.servlet.http.HttpServletRequest req,
                              javax.servlet.http.HttpServletResponse res)

Deprecated. replaced with DataEngine.isLicenseValid()

Check the license manager to see is license is valid. Creation date: (4/8/2003 2:37:06 PM)

preHandleServiceRequest

public boolean preHandleServiceRequest(javax.servlet.http.HttpServletRequest request,
                                       javax.servlet.http.HttpServletResponse response)

printParameterTrace

public void printParameterTrace(javax.servlet.http.HttpServletRequest req)

Technical support method which prints the HttpServletRequest parms out Creation date: (11/7/2001 3:58:05 PM)

Parameters:

req - javax.servlet.http.HttpServletRequest

processRequest

public abstract void processRequest(javax.servlet.http.HttpServletRequest request,
                                    javax.servlet.http.HttpServletResponse response)
                             throws javax.servlet.ServletException,
                                    IOException

Handles servlet actions. Subclasses should provide the logic to handle actions. for an example, see DETemplateServlet.

Parameters:

request - request

response - response

javax.servlet.ServletException

IOException

removeRequestAttribute

public void removeRequestAttribute(javax.servlet.http.HttpServletRequest req,
                                   String parmKey)

Deprecated. replaced with removeRequestAttribute(String, HttpServletRequest)

Removes the specified object in the HTTPRequest. This provides a single place with potential error logging and programatic debug instead of all users setting objects into the Request

removeRequestData

public void removeRequestData(javax.servlet.http.HttpServletRequest req,
                              String parmKey)

Deprecated. replaced with removeRequestAttribute(String, HttpServletRequest)

Removes the specified object in the HTTPRequest. This provides a single place with potential error logging and programatic debug instead of all users setting objects into the Request

removeSessionAttribute

public void removeSessionAttribute(javax.servlet.http.HttpServletRequest pRequest,
                                   String pKey)
                            throws DataEngineException

Deprecated. replaced with removeSessionAttribute(String, HttpServletRequest)

Removes the specified object in the HttpSession. This provides a single place with potential error logging and programatic debug instead of all users setting objects into the Session.

Parameters:

pRequest - request containing session to put attribute into

pKey - key used to store the object in the session

DataEngineException

removeSharedSessionAttribute

public void removeSharedSessionAttribute(javax.servlet.http.HttpServletRequest pRequest,
                                         String pKey)
                                  throws DataEngineException

Deprecated. replaced with removeSessionSharedAttribute(String, HttpServletRequest)

Removes the specified object in the HttpSession. This provides a single place with potential error logging and programatic debug instead of all users setting objects into the Session.

Parameters:

pRequest - request containing session to put attribute into

pKey - key used to store the object in the session

DataEngineException

service

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

This method handles generic DataEngine service requests. As well as ensures the application being called has its unique session identifier set.

Overrides:

service in class javax.servlet.http.HttpServlet

javax.servlet.ServletException

IOException