planetj.dataengine.webservices
Class DataEngineWebServiceServlet

java.lang.Object
  |
  +--javax.servlet.GenericServlet
        |
        +--javax.servlet.http.HttpServlet
              |
              +--planetj.dataengine.DataEngineServlet
                    |
                    +--planetj.dataengine.application.DataEngineApplicationServlet
                          |
                          +--planetj.dataengine.webservices.DataEngineWebServiceServlet

All Implemented Interfaces:

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

public class DataEngineWebServiceServlet

extends DataEngineApplicationServlet

implements IDistributedConsts

Insert the type's description here. Creation date: (1/14/2003 11:40:18 AM)

See Also:

Serialized Form

Field Summary

Fields inherited from class planetj.dataengine.application.DataEngineApplicationServlet

ID, REFRESH_APPS, VIEW_HTTP_ID

Fields inherited from class planetj.dataengine.DataEngineServlet

className

Fields inherited from interface planetj.dataengine.webservices.IDistributedConsts

SESSION_ID, SIGN_ON, USER_NAME

Fields inherited from interface planetj.dataengine.application.IApplication

APPLICATION_CLASS, APPLICATION_HTTP_ID, APPLICATION_ID, APPLICATION_JSP_FILE, APPLICATION_METADATA_ALIAS, APPLICATION_NAME, APPLICATION_RESULTS_KEY, APPLICATION_TABLE_NAME, AUTO_RUN_STATUS, COMPANY_ID, COMPANY_NAME, CONNECTION_ALIAS, CURRENT_EXECUTING_APPLICATION, CURRENT_WOW_APPLICATION, DESCRIPTION, ERROR_JSP_FILE, INITIAL_VIEW, MANAGE, OPTIONAL_SIGNON, OWNER_ID, PASSWORD, PROPERTIES, SERVLET_URI, SIGN_ON_CLASS, SIGN_ON_OP_ID, SIGN_ON_URI, THEME_ID, USER_ID, VERIFY_CONNECTION

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

DataEngineWebServiceServlet()

Method Summary

void	processDistributedContext(DistributedContext context, DirectOperationRequest pSQLOperationData, javax.servlet.http.HttpServletRequest pReq, javax.servlet.http.HttpServletResponse pRes) Assuming right now that the context contains an operation.
void	processDistributedObject(DirectOperationRequest pSQLOperationData, javax.servlet.http.HttpServletRequest pReq, javax.servlet.http.HttpServletResponse pRes)
void	processSQLOperation(DirectOperationRequest pOperationData, javax.servlet.http.HttpServletRequest pReq, javax.servlet.http.HttpServletResponse pRes)
void	processURLRequest(DirectOperationRequest pOperationData, javax.servlet.http.HttpServletRequest pReq, javax.servlet.http.HttpServletResponse pRes)
void	returnObjectToRequestor(Serializable obj, javax.servlet.http.HttpServletResponse pRes)
void	service(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method handles generic DataEngine service requests.

Methods inherited from class planetj.dataengine.application.DataEngineApplicationServlet

getInitialPage, getInitialURL, getRequestedOperationData, getRowEventListener, init, isSignOnNecessary, preHandleServiceRequest, processApplication, processRequest, processSQLOperation, verifySignOn

Methods inherited from class planetj.dataengine.DataEngineServlet

addCookie, doGet, doPost, dumpParameters, forward, getCookie, getCookies, getErrorMessage, getInitializationException, getLastJSPPath, getLicense, getLoggingPath, getRequestAttribute, getRequestParameter, getRequestParameterValues, getRowCollectionJsp, getServiceRequestOverride, getServletPath, getServletPath, getSessionAttribute, getSessionSharedAttribute, getUserMessage, handleServiceRequest, isLicenseValid, isRunningInVA, isServletPath, printParameterTrace, removeRequestAttribute, removeRequestAttribute, removeRequestData, removeSessionAttribute, removeSessionAttribute, removeSessionSharedAttribute, removeSharedSessionAttribute, setErrorMessage, setLayoutProperties, setRequestGroupAttribute, setRequestPageAttribute, setRequestPersistentAttribute, setRequestTransientAttribute, setServletPath, setServletURI, setSessionAttribute, setSessionSharedAttribute, setUserMessage

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

Constructor Detail

DataEngineWebServiceServlet

public DataEngineWebServiceServlet()

Method Detail

returnObjectToRequestor

public void returnObjectToRequestor(Serializable obj,
                                    javax.servlet.http.HttpServletResponse pRes)
                             throws DataEngineException

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 DataEngineServlet

javax.servlet.ServletException

IOException

processDistributedContext

public void processDistributedContext(DistributedContext context,
                                      DirectOperationRequest pSQLOperationData,
                                      javax.servlet.http.HttpServletRequest pReq,
                                      javax.servlet.http.HttpServletResponse pRes)
                               throws DataEngineException

Assuming right now that the context contains an operation.

DataEngineException

processDistributedObject

public void processDistributedObject(DirectOperationRequest pSQLOperationData,
                                     javax.servlet.http.HttpServletRequest pReq,
                                     javax.servlet.http.HttpServletResponse pRes)
                              throws DataEngineException

DataEngineException

processSQLOperation

public void processSQLOperation(DirectOperationRequest pOperationData,
                                javax.servlet.http.HttpServletRequest pReq,
                                javax.servlet.http.HttpServletResponse pRes)
                         throws DataEngineException

DataEngineException

processURLRequest

public void processURLRequest(DirectOperationRequest pOperationData,
                              javax.servlet.http.HttpServletRequest pReq,
                              javax.servlet.http.HttpServletResponse pRes)
                       throws DataEngineException

DataEngineException