OOP ServletWorker Version 3.1
C G I M N P S U W

C

com.bentofw.servletworker - package com.bentofw.servletworker
Creates the worker objects in ths pool and picks up the one for the HTTP request.
com.bentofw.util - package com.bentofw.util
The classes and interfaces required for APIs by OOP-Research.
containsKey(String) - Method in interface com.bentofw.util.ParsedRequestParameters
Returns true if the request parameter for the key is available in this request.
containsKey(String) - Method in interface com.bentofw.util.StoredRequestParameters
Returns true if the request parameter for the key is available in this request.

G

GET - Static variable in interface com.bentofw.util.ParsedRequestParameters
 
getContextPath() - Method in interface com.bentofw.util.ParsedRequestParameters
Returns the context path.
getDecodedBytes(String) - Method in interface com.bentofw.util.ParsedRequestParameters
Return the decoded byte array of the request parameter specified by the name.
getDecodedBytes(String) - Method in interface com.bentofw.util.StoredRequestParameters
Return the decoded byte array of the request parameter specified by the name.
getDecodedBytesInArray(String) - Method in interface com.bentofw.util.ParsedRequestParameters
Return the array of the decoded byte arrays of the request parameter specified by the name.
getDecodedBytesInList(String) - Method in interface com.bentofw.util.ParsedRequestParameters
Return the List of the decoded byte arrays of the request parameter specified by the name.
getDecodedString(String) - Method in interface com.bentofw.util.ParsedRequestParameters
Return the decoded String of the request parameter specified by the name.
getDecodedString(String, String) - Method in interface com.bentofw.util.ParsedRequestParameters
Return the decoded String of the request parameter specified by the name.
getDecodedString(String) - Method in interface com.bentofw.util.StoredRequestParameters
Return the decoded String of the request parameter specified by the name.
getDecodedString(String, String) - Method in interface com.bentofw.util.StoredRequestParameters
Return the decoded String of the request parameter specified by the name.
getDecodedStringInArray(String) - Method in interface com.bentofw.util.ParsedRequestParameters
Return the array of decoded Strings of the request parameter specified by the name.
getDecodedStringInArray(String, String) - Method in interface com.bentofw.util.ParsedRequestParameters
Return the array of decoded Strings of the request parameter specified by the name.
getDecodedStringInList(String) - Method in interface com.bentofw.util.ParsedRequestParameters
Return the List of decoded Strings of the request parameter specified by the name.
getDecodedStringInList(String, String) - Method in interface com.bentofw.util.ParsedRequestParameters
Return the List of decoded Strings of the request parameter specified by the name.
getDomain() - Method in class com.bentofw.util.UserInfo
Returns the String representing domain.
getEncodedString(String) - Method in interface com.bentofw.util.ParsedRequestParameters
Return the URL-encoded String of the request parameter specified by the name.
getEncodedStringInArray(String) - Method in interface com.bentofw.util.ParsedRequestParameters
Return the array of URL-encoded Strings of the request parameter specified by the name.
getEncodedStringInList(String) - Method in interface com.bentofw.util.ParsedRequestParameters
Return the List of URL-encoded Strings of the request parameter specified by the name.
getEncoding() - Method in interface com.bentofw.util.ParsedRequestParameters
Return the current character encoding of this HTTP request.
getEncoding() - Method in interface com.bentofw.util.StoredRequestParameters
Return the current character encoding of this HTTP request.
getGroups() - Method in class com.bentofw.util.UserInfo
Returns the set of Strings representing the groups where the user belongs to.
getGroupsAsArray() - Method in class com.bentofw.util.UserInfo
Returns the array of Strings representing the groups where the user belongs to.
getHostHeader() - Method in interface com.bentofw.util.ParsedRequestParameters
Returns the host header of the HTTP request.
getHostHeader() - Method in interface com.bentofw.util.StoredRequestParameters
Returns the host header of the HTTP request.
getHostName() - Method in class com.bentofw.util.UserInfo
Returns the host name on which this user logged.
getInstance() - Static method in class com.bentofw.servletworker.ServletWorkerMap
Returns the instance of this class.
getKeysInArray() - Method in interface com.bentofw.util.ParsedRequestParameters
Return the array of the names of the available request parameters.
getKeysInArray() - Method in interface com.bentofw.util.StoredRequestParameters
Return the array of the names of the available request parameters.
getKeysInList() - Method in interface com.bentofw.util.ParsedRequestParameters
Return the List of the names of the available request parameters.
getKeysInList() - Method in interface com.bentofw.util.StoredRequestParameters
Return the List of the names of the available request parameters.
getLastPathInfo() - Method in interface com.bentofw.util.ParsedRequestParameters
Returns the last element within the path information.
getLengthOfDecodedString(String) - Method in interface com.bentofw.util.ParsedRequestParameters
Return the length of the decoded String for the specified parameter.
getLengthOfDecodedStringInArray(String) - Method in interface com.bentofw.util.ParsedRequestParameters
Return the length of the decoded Strings for the specified parameter in the array.
getLengthOfEncodedString(String) - Method in interface com.bentofw.util.ParsedRequestParameters
Return the length of the encoded String for the specified parameter.
getLengthOfEncodedStringInArray(String) - Method in interface com.bentofw.util.ParsedRequestParameters
Return the length of the encoded Strings for the specified parameter in the array.
getLengthOfLongestDecodedString(String) - Method in interface com.bentofw.util.ParsedRequestParameters
Return the length of the longest decoded Strings for the specified parameter.
getLengthOfLongestEncodedString(String) - Method in interface com.bentofw.util.ParsedRequestParameters
Return the length of the longest encoded Strings for the specified parameter.
getMessage() - Method in exception com.bentofw.util.NestedException
Returns the error message of original Throwable.
getMethod() - Method in interface com.bentofw.util.ParsedRequestParameters
Returns the int value indicating the request method, that is GET, POST or MULTIPART.
getNumberOfRecords() - Method in interface com.bentofw.util.StoredRequestParameters
Return the number of records that were selected from SQL table.
getOriginal() - Method in exception com.bentofw.util.NestedException
Returns the original Throwable.
getPathInfo() - Method in interface com.bentofw.util.ParsedRequestParameters
Returns the path information.
getRequestPath() - Method in exception com.bentofw.servletworker.NoWorkerFoundException
 
getResponseValues() - Method in class com.bentofw.servletworker.WorkResult
Returns the Map for key-value pairs whose values are rendered on the view of the response.
getServletPath() - Method in interface com.bentofw.util.ParsedRequestParameters
Return the servlet path of the requested URL.
getStoredRequestParameters() - Method in class com.bentofw.servletworker.WorkResult
Returns the StoredRequestParameters object whose values are rendered on the view of the response.
getTransactionId() - Method in class com.bentofw.util.UserInfo
Returns the transaction ID for this user.
getUser() - Method in class com.bentofw.util.UserInfo
Returns the String representing user name.
getValidityValues() - Method in class com.bentofw.servletworker.WorkResult
The key-value pairs.
getViewCode() - Method in class com.bentofw.servletworker.WorkResult
Return int value that specifies which view will be rendered as the response.

I

isGuest() - Method in class com.bentofw.util.UserInfo
Returns true if the this user is guest.
isRoot() - Method in class com.bentofw.util.UserInfo
Returns true if the this user is root.

M

MULTIPART - Static variable in interface com.bentofw.util.ParsedRequestParameters
 

N

NestedException - Exception in com.bentofw.util
The exception for the system error.
NestedException(Throwable) - Constructor for exception com.bentofw.util.NestedException
The custructor.
NoPropertyFileException - Exception in com.bentofw.util
This exception will be thrown when the required property file is not found.
NoPropertyFileException(String) - Constructor for exception com.bentofw.util.NoPropertyFileException
The custructor.
NoWorkerFoundException - Exception in com.bentofw.servletworker
Thrown by ServletWorkerMap, when no worker is found for the HTTP request.
NoWorkerFoundException(String, String) - Constructor for exception com.bentofw.servletworker.NoWorkerFoundException
 

P

ParsedRequestParameters - Interface in com.bentofw.util
Interface for HTTP request parameters
POST - Static variable in interface com.bentofw.util.ParsedRequestParameters
 
prepare() - Method in class com.bentofw.servletworker.ServletWorkerMap
This method reads a series of XML and creates the worker object dedined in those XML.
printStackTrace() - Method in exception com.bentofw.util.NestedException
Print this Throwable and its backtrace to the standard error stream.
printStackTrace(PrintStream) - Method in exception com.bentofw.util.NestedException
Print this Throwable and its backtrace to the specified PrintStream.
printStackTrace(PrintWriter) - Method in exception com.bentofw.util.NestedException
Print this Throwable and its backtrace to the specified PrintWriter.

S

ServletWorker - Interface in com.bentofw.servletworker
The interface for the worker object.
ServletWorkerMap - Class in com.bentofw.servletworker
This class takes care of the lifecycle and usage of worker object.
setEncoding(String) - Method in interface com.bentofw.util.ParsedRequestParameters
Set the character encoding of this HTTP request.
setHostName(String) - Method in class com.bentofw.util.UserInfo
Set the host name on which this user logged.
setTransactionId(String) - Method in class com.bentofw.util.UserInfo
Set the transaction ID for this user.
SimpleException - Exception in com.bentofw.util
The exception for the logical error.
SimpleException(String) - Constructor for exception com.bentofw.util.SimpleException
The custructor.
StoredRequestParameters - Interface in com.bentofw.util
Interface for HTTP request parameters, that were stored into SQL table or other devices.

U

UserInfo - Class in com.bentofw.util
The class which represents the user information.
UserInfo(String, String, Set) - Constructor for class com.bentofw.util.UserInfo
Constructor.

W

work(HttpServletRequest, ParsedRequestParameters, UserInfo) - Method in interface com.bentofw.servletworker.ServletWorker
ServletWorkerMap.work(HttpServletRequest, ParsedRequestParameters, UserInfo, int) method picks up the worker object for the HTTP request path, and calls this methods.
work(HttpServletRequest, ParsedRequestParameters, UserInfo, int) - Method in class com.bentofw.servletworker.ServletWorkerMap
Picks up the worker object for the HTTP request path, and porcess its logic.
WorkResult - Class in com.bentofw.servletworker
ServletWorker.work(HttpServletRequest, ParsedRequestParameters, UserInfo) should return objct of this class.
WorkResult(Map, Map, int) - Constructor for class com.bentofw.servletworker.WorkResult
The constructor of this class.
WorkResult(Map, int) - Constructor for class com.bentofw.servletworker.WorkResult
The constructor of this class.
WorkResult(StoredRequestParameters, Map, Map, int) - Constructor for class com.bentofw.servletworker.WorkResult
The constructor of this class.
WorkResult(StoredRequestParameters, Map, int) - Constructor for class com.bentofw.servletworker.WorkResult
The constructor of this class.

C G I M N P S U W
OOP ServletWorker Version 3.1

ALL CONTENTS COPYRIGHT 2006, OOP-Research Corporation. All rights reserved.
Any questions and comments are welcome to OOP-Research Corporation.