|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.opensymphony.web.Parameters
Utility wrapper class for extracting values from a HttpServletRequest
.
(in html page)(in servlet method) Parameters p = new Parameters(request); String name = p.getString("name"); int age = p.getInt("age");
Constructor Summary | |
Parameters(javax.servlet.http.HttpServletRequest request)
Create wrapper to access original request. |
|
Parameters(javax.servlet.http.HttpServletRequest request,
int maxFileSize)
Create wrapper to access original request. |
Method Summary | |
boolean |
getBoolean(java.lang.String name)
Get boolean request parameter. |
java.util.Collection |
getCollection(java.lang.String name)
Return a Collection of values from a page. |
java.util.Collection |
getCollection(java.lang.String name,
ParameterConverter converter)
Return a Collection of values from a page, converting each parameter into an appropriate object. |
java.util.Date |
getDate(java.lang.String name)
Get Date request parameter. |
double |
getDouble(java.lang.String name)
Get double request parameter. |
javax.ejb.EJBObject |
getEjb(java.lang.String name,
javax.ejb.EJBHome home)
Deprecated. use getEJB(java.lang.String,javax.ejb.EJBHome) |
javax.ejb.EJBObject |
getEJB(java.lang.String name,
javax.ejb.EJBHome home)
Lookup an Entity bean based on the primary key of the parameter passed across. |
javax.ejb.EJBObject |
getEjb(java.lang.String name,
java.lang.String jndi)
Deprecated. use getEJB(java.lang.String,java.lang.String) |
javax.ejb.EJBObject |
getEJB(java.lang.String name,
java.lang.String jndiLocation)
Lookup an Entity bean based on the primary key of the parameter passed across. |
java.util.Collection |
getEjbCollection(java.lang.String name,
javax.ejb.EJBHome home)
Deprecated. use getEJBCollection(java.lang.String,javax.ejb.EJBHome) |
java.util.Collection |
getEJBCollection(java.lang.String name,
javax.ejb.EJBHome home)
Lookup a Collection of entity EJB's based on the primary keys passed across in request. |
java.util.Collection |
getEjbCollection(java.lang.String name,
java.lang.String jndi)
Deprecated. use getEJBCollection(java.lang.String,java.lang.String) |
java.util.Collection |
getEJBCollection(java.lang.String name,
java.lang.String jndiLocation)
Lookup a Collection of entity EJB's based on the primary keys passed across in request. |
java.io.File |
getFile(java.lang.String fileName)
|
java.lang.String |
getFileContentType(java.lang.String fileName)
|
java.lang.String[] |
getFileNames()
|
float |
getFloat(java.lang.String name)
Get float request parameter. |
int |
getInt(java.lang.String name)
Get int request parameter. |
long |
getLong(java.lang.String name)
Get long request parameter. |
java.lang.Object |
getPathEjb(int item,
javax.ejb.EJBHome home)
|
java.lang.Object |
getPathEjb(int item,
java.lang.String jndiLocation)
|
java.lang.String[] |
getPathElements()
Get the Path Info from the request, and return as array of elements. |
int |
getPathInt(int item)
|
long |
getPathLong(int item)
|
java.lang.String |
getPathString(int item)
|
javax.servlet.http.HttpServletRequest |
getRequest()
Return original HttpServletRequest object. |
java.lang.String |
getString(java.lang.String name)
Get String request parameter. |
boolean |
isSet(java.lang.String name)
Check paramater has been set to something. |
void |
populateBean(java.lang.Object obj)
Populate the properties of a bean using any parameter value that has a valid setter method in the bean. |
void |
populateBean(java.lang.Object obj,
java.lang.String[] allowedProperties)
Populate the properties of a bean using any parameter value that has a valid setter method in the bean. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public Parameters(javax.servlet.http.HttpServletRequest request)
request
- Servlet request attribute.public Parameters(javax.servlet.http.HttpServletRequest request, int maxFileSize)
request
- Servlet request attribute.maxFileSize
- Maximum allowed file size of uploaded files (in bytes).Method Detail |
public boolean isSet(java.lang.String name)
public java.lang.String getString(java.lang.String name)
name
- Name of request parameter.public int getInt(java.lang.String name)
name
- Name of request parameter.public long getLong(java.lang.String name)
name
- Name of request parameter.public float getFloat(java.lang.String name)
name
- Name of request parameter.public double getDouble(java.lang.String name)
name
- Name of request parameter.public boolean getBoolean(java.lang.String name)
name
- Name of request parameter.public java.util.Date getDate(java.lang.String name)
If the parameter passed across is 'blah', the value of the date will be retrieved by accessing 'blah.year' (4 digit), 'blah.month' (1 or 2 digit, or String), and 'blah.day' (1 or 2 digit - postfix allowed). If month or day are missing, 1 will be used.
name
- Name of request parameter.TextUtils.parseDate(java.lang.String,java.lang.String,java.lang.String)
public java.util.Collection getCollection(java.lang.String name)
name
- Name of request parameters.public java.util.Collection getCollection(java.lang.String name, ParameterConverter converter)
name
- Name of request parameters.getCollection(String)
,
ParameterConverter
public javax.ejb.EJBObject getEJB(java.lang.String name, javax.ejb.EJBHome home)
name
- Name of request parameter containing primary key.home
- EJBHome interface.EJBUtils.findEntity(javax.ejb.EJBHome, String)
public javax.ejb.EJBObject getEJB(java.lang.String name, java.lang.String jndiLocation)
name
- Name of request parameter containing primary key.jndiLocation
- JNDI location of EJBHome interface.EJBUtils.findEntity(javax.ejb.EJBHome, String)
public java.util.Collection getEJBCollection(java.lang.String name, javax.ejb.EJBHome home)
name
- Name of parameterhome
- Home interface for EJBgetEjb(String,javax.ejb.EJBHome)
,
getCollection(String)
,
EJBUtils.findEntity(javax.ejb.EJBHome,String)
public java.util.Collection getEJBCollection(java.lang.String name, java.lang.String jndiLocation)
name
- Name of parameterhome
- Home interface for EJBgetEjb(String,String)
,
getCollection(String)
,
EJBUtils.findEntity(javax.ejb.EJBHome,String)
,
EJBUtils.lookup(String)
public javax.ejb.EJBObject getEjb(java.lang.String name, javax.ejb.EJBHome home)
getEJB(java.lang.String,javax.ejb.EJBHome)
public javax.ejb.EJBObject getEjb(java.lang.String name, java.lang.String jndi)
getEJB(java.lang.String,java.lang.String)
public java.util.Collection getEjbCollection(java.lang.String name, javax.ejb.EJBHome home)
getEJBCollection(java.lang.String,javax.ejb.EJBHome)
public java.util.Collection getEjbCollection(java.lang.String name, java.lang.String jndi)
getEJBCollection(java.lang.String,java.lang.String)
public java.lang.String[] getPathElements()
"/ab/cd/ef" -> {"ab","cd","ef"} "/ab/cd/ef/" -> {"ab","cd","ef"} "/a//b/" -> {"a","","b"} "/" -> {} "" -> {} null -> {}
HttpServletRequest.getPathInfo()
public java.lang.String getPathString(int item)
public int getPathInt(int item)
public long getPathLong(int item)
public java.lang.Object getPathEjb(int item, javax.ejb.EJBHome home)
public java.lang.Object getPathEjb(int item, java.lang.String jndiLocation)
public java.io.File getFile(java.lang.String fileName)
public java.lang.String[] getFileNames()
public java.lang.String getFileContentType(java.lang.String fileName)
public void populateBean(java.lang.Object obj)
public void populateBean(java.lang.Object obj, java.lang.String[] allowedProperties)
public javax.servlet.http.HttpServletRequest getRequest()
HttpServletRequest
object.
|
See www.opensymphony.com for more information. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |