All Packages  Class Hierarchy

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Index of all Fields and Methods

A

Action(). Constructor for class com.expershop.esapi.Action
addColumn(String, int, String). Method in class com.expershop.esapi.DbObject
Add a new column to this DbObject.
addParameter(String, String). Method in class com.expershop.esapi.ServletRequest
Add a new parameter, or set the value of an existing one.
addParameterValues(String, String[]). Method in class com.expershop.esapi.ServletRequest
Add a new multi-valued parameter, or set the value(s) of an existing one.

C

checkParameters(String[], boolean). Method in class com.expershop.esapi.ServletRequest
Check the presence of a list of parameters
clearValues(). Method in class com.expershop.esapi.DbObject
Reset all column values: Numeric columns are set to 0, String columns are set to "" (empty string).

D

debug(String). Method in class com.expershop.esapi.Session
Print a debug message (depends on the tracelevel and tracefile properties in the application's configuration file).
deleteQuery(String). Method in class com.expershop.esapi.DbObject
Generate a DELETE SQL request, and return it as a String.
The request is for later use, deleteQuery() DOES NOT AFFECT the database.

G

get(String). Method in class com.expershop.esapi.AppConfiguration
Get a configuration parameter, given its name.
get(String). Method in class com.expershop.esapi.Cookie
Get a client session information: equivalent to $Cookie:name$ in the templates.
get(String). Method in class com.expershop.esapi.DbObject
Retrieve a column's value, as a String.
getAdminPassword(String). Method in class com.expershop.esapi.AppConfiguration
Get this application's administrator password
getAllParams(). Method in class com.expershop.esapi.ServletRequest
Get all the parameters.
getAppConfiguration(). Method in class com.expershop.esapi.Session
Get the applications's configuration
getClientId(). Method in class com.expershop.esapi.Session
Get the session Id (to recognize who is connected)
getCookie(). Method in class com.expershop.esapi.Session
Get the client info
getDouble(String). Method in class com.expershop.esapi.AppConfiguration
Get a configuration parameter, given its name.
getDouble(String). Method in class com.expershop.esapi.DbObject
Retrieve a column's value, as a double.
getDoubleParam(String, double). Method in class com.expershop.esapi.ServletRequest
Equivalent to getParameter(), but for double values only.
Returns the double parameter value, or the value specified in the errval parameter if an error occurs (like a parse error, if the parameter is not a double).
getIntParam(String, int). Method in class com.expershop.esapi.ServletRequest
Equivalent to getParameter(), but for integer values only.
Returns the integer parameter value, or the value specified in the errval parameter if an error occurs (like a parse error, if the parameter is not an integer).
getJdbcConnection(). Method in class com.expershop.esapi.Session
Get the current JDBC connection to the database
getJdbcDriverClass(). Method in class com.expershop.esapi.AppConfiguration
getJdbcPassword(). Method in class com.expershop.esapi.AppConfiguration
getJdbcUrl(). Method in class com.expershop.esapi.AppConfiguration
getJdbcUser(). Method in class com.expershop.esapi.AppConfiguration
getLocale(). Method in class com.expershop.esapi.AppConfiguration
Get the Locale
getMaxConn(). Method in class com.expershop.esapi.AppConfiguration
getName(). Method in class com.expershop.esapi.AppConfiguration
Get this application's name
getParameter(String). Method in class com.expershop.esapi.ServletRequest
Get a parameter value, given its name.
Parameters can be HTTP parameters (for example, submitted in an HTML form) or parameters set using either $Assign in a template or the addParameter() method.
getParameterNames(). Method in class com.expershop.esapi.ServletRequest
Get all the parameter names.
getParameterValues(String). Method in class com.expershop.esapi.ServletRequest
Get a multi-valued parameter's values.
getRootDir(). Method in class com.expershop.esapi.AppConfiguration
Get this application's root directory (shop.RootDir property)
getServletRequest(). Method in class com.expershop.esapi.ServletRequest
Get the servlet's HttpServletRequest.
The HttpServletRequest contains only the HTTP parameters.
getTimeout(). Method in class com.expershop.esapi.AppConfiguration

I

insertQuery(). Method in class com.expershop.esapi.DbObject
Generate an INSERT SQL request to create the current object in the database, and return it as a String.
The request is for later use, insertQuery() DOES NOT AFFECT the database.

N

newDbObject(String, ResultSet). Method in class com.expershop.esapi.Session
Obtain a DbObject instance: useful for database manipulations.

P

present(String). Method in class com.expershop.esapi.DbObject
Check if a column exists (is present).
processRequest(ESClient, ESServletRequest, Object). Method in class com.expershop.esapi.Action
INTERNAL USE: DO NOT OVERRIDE THIS METHOD

Q

queryDB(String). Method in class com.expershop.esapi.Session
Query the application's database

S

saveChanges(String). Method in class com.expershop.esapi.DbObject
Update the database so it reflects the changes in the current DbObject.
This method WILL ISSUE AN UPDATE REQUEST TO THE DATABASE, so it will certainly affect the database content.
This method uses the updateQuery() method to generate the UPDATE query.
serverSide(). Method in class com.expershop.esapi.Action
Tells if the action is a server-side only action or not.
Server-side actions can only be invoked in the templates using $Action, and can't be passed as HTTP parameters.
service(Session, ServletRequest, Object). Method in class com.expershop.esapi.Action
This method should be overridden by programmers, to implement the action.
set(String, double). Method in class com.expershop.esapi.DbObject
Set a column's value, for columns of type double.
set(String, int). Method in class com.expershop.esapi.DbObject
Set a column's value, for columns of type int.
set(String, long). Method in class com.expershop.esapi.DbObject
Set a column's value, for columns of type long.
set(String, String). Method in class com.expershop.esapi.Cookie
Set a client session information: equivalent to $SetCookie in the templates.
set(String, String). Method in class com.expershop.esapi.DbObject
Set a column's value, for columns of type String.
setAdministrator(boolean). Method in class com.expershop.esapi.Session
Decide wether this session is an administrator session or not.
By default, sessions do not have administrator rights (false).
setCookie(ServletRequest). Method in class com.expershop.esapi.Cookie
Re-initialize the cookie's value according to the parameters present in a given ServletRequest.
setFromRequest(ServletRequest). Method in class com.expershop.esapi.DbObject
Set column's values according to parameters in a ServletRequest.
Column names and ServletRequest parameter names are matched: when a ServletRequest parameter's name matches a writable column's name, the column's value is set according to the ServletRequest parameter's value.
setSqlEncode(boolean). Method in class com.expershop.esapi.DbObject
Decide to implicitly SQL-encode column values when they are set, or not; By default, implicit SQL-encoding is enabled.
This method influences the behavoiur of the set() methods.
SQL encoding replaces special characters, like quotes, with characters accepted in database column values.
SQL encoding rules are specified in the application's configuration file (sqlencode.Substitutions property).
Rules syntax: c1=s1;c2=s2;...cn=sn (replace char1 with string1, etc...)
setWritable(String, boolean). Method in class com.expershop.esapi.DbObject
Tell if a column is writable or not: by default, columns are writable.
sqlEncode(String). Method in class com.expershop.esapi.Session
Encode a string into an SQL column value.
Useful for column values that contain special characters, like quotes.

T

toString(). Method in class com.expershop.esapi.ServletRequest
Convert this object into a String, mostly for debug purposes.
trace(String). Method in class com.expershop.esapi.Session
Print a trace message (depends on the tracelevel and tracefile properties in the application's configuration file).

U

updateDB(String). Method in class com.expershop.esapi.Session
Update the application's database
updateQuery(String). Method in class com.expershop.esapi.DbObject
Generate an UPDATE SQL request that reflects the current object's changes, and return it as a String.
The request is for later use, updateQuery() DOES NOT AFFECT the database.
If you need to update the database, you may want to use the saveChanges() method instead.