java.lang.Object | +--com.ibm.commerce.server.ServletHelper | +--com.ibm.commerce.server.JSPHelper
A JSP Helper class to helper Jsp writers in retrieving data from a HttpServletRequest It will look for the parameter either from the request attribute or request parameters so that the user have no need to distinguish between a jsp that is invoked through the use of a forward or a redirect.
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT IBM copyright notice field. |
Constructor Summary | |
---|---|
JSPHelper(javax.servlet.http.HttpServletRequest httpReq) Constructor for JspHelper. |
Method Summary | |
---|---|
static java.lang.String |
getParameter(HttpServletRequest req,
java.lang.String paramName) Returns a parameter as String from the request object. |
java.lang.String |
getParameter(java.lang.String paramName) Returns a parameter as String from the request object. |
static java.lang.String[] |
getParameterValues(HttpServletRequest req,
java.lang.String paramName) Returns a parameter as a String array from the request object. |
java.lang.String[] |
getParameterValues(java.lang.String paramName) Returns a parameter as a String array from the request object. |
static java.util.PropertyResourceBundle |
getPropertyResourceBundle(ServletContext servletContext,
HttpServletRequest request) Returns the PropertyResourceBundle for JSP in runtime default locale This will pick up properties files located relative to the location of the JSP Usage java.util.ResourceBundle thisResources =
com.ibm.commerce.server.JSPHelper.getPropertyResourceBundle(getServletContext(),
request); |
static java.util.PropertyResourceBundle |
getPropertyResourceBundle(java.lang.String sfilename) Returns the PropertyResourceBundle for JSP of the properties files sfilename in runtime default locale |
static java.util.PropertyResourceBundle |
getPropertyResourceBundle(java.lang.String sfilename,
ServletContext servletContext, HttpServletRequest request) Returns the PropertyResourceBundle for JSP of the properties files sfilename in runtime default locale This will pick up properties files located relative to the location of the JSP Usage java.util.ResourceBundle thisResources =
com.ibm.commerce.server.JSPHelper.getPropertyResourceBundle("MyProperties",
getServletContext(), request); |
static java.util.PropertyResourceBundle |
getPropertyResourceBundle(java.lang.String sfilename,
ServletContext servletContext, HttpServletRequest request,
java.util.Locale locale) Returns the PropertyResourceBundle for JSP of the properties files sfilename in locale locale. |
static java.util.ResourceBundle |
getResourceBundle(HttpServletRequest request) Returns the ResourceBundle for JSP in runtime default locale |
static java.util.ResourceBundle |
getResourceBundle(java.lang.String sfilename,
HttpServletRequest request) Returns the ResourceBundle for JSP of the properties files sfilename in runtime default locale |
static java.util.ResourceBundle |
getResourceBundle(java.lang.String sfilename,
HttpServletRequest request, java.util.Locale locale) Returns the ResourceBundle for JSP of the properties files sfilename in locale locale. |
static java.lang.String |
htmlTextEncoder(java.lang.String iString) Encodes an String for html. |
static void |
markTransactionToRollback() Marks a transaction for rollback when an exception is caught in a JSP page. |
static void |
rollbackTransaction() Rolls back the current transaction. |
void |
rollbackTransaction(boolean flag) Rolls back the current transaction and also mark the current page to be not cachable. |
static void |
rollbackTransaction(HttpServletRequest req, boolean flag) This method rolls back the current transaction and also mark the current page to be not cachable. |
void |
setCachePage(boolean flag) Deprecated. Please use setUncacheable |
void |
setUncacheable(boolean flag) Sets the flag to indicate whether output page is cacheable. |
static void |
setUncacheable(HttpServletRequest req, boolean flag) Sets the flag to indicate whether output page is uncacheable. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll,
toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String COPYRIGHT
Constructor Detail |
---|
public JSPHelper(javax.servlet.http.HttpServletRequest httpReq)
httpReq
- Http servlet requestMethod Detail |
---|
public java.lang.String getParameter(java.lang.String paramName)
paramName
- name of parameterpublic static java.lang.String getParameter(HttpServletRequest req, java.lang.String paramName)
req
- Http servlet requestparamName
- name of parameterpublic java.lang.String[] getParameterValues(java.lang.String paramName)
paramName
- parameter namepublic static java.lang.String[] getParameterValues(HttpServletRequest req, java.lang.String paramName)
req
- Http servlet requestparamName
- parameter namepublic static java.util.PropertyResourceBundle getPropertyResourceBundle(java.lang.String sfilename) throws java.io.IOException
sfilename
- file namejava.io.IOException
public static java.util.PropertyResourceBundle getPropertyResourceBundle(java.lang.String sfilename, ServletContext servletContext, HttpServletRequest request) throws java.io.IOException
java.util.ResourceBundle thisResources =
com.ibm.commerce.server.JSPHelper.getPropertyResourceBundle("MyProperties",
getServletContext(), request);
sfilename
- file nameservletContext
- servlet contextrequest
- Http servlet requestjava.io.IOException
public static java.util.PropertyResourceBundle getPropertyResourceBundle(java.lang.String sfilename, ServletContext servletContext, HttpServletRequest request, java.util.Locale locale) throws java.io.IOException
java.util.ResourceBundle thisResources =
com.ibm.commerce.server.JSPHelper.getPropertyResourceBundle("MyProperties",
getServletContext(), request, locale);
sfilename
- file nameservletContext
- servlet contextrequest
- Http servlet requestlocale
- Locale used for the resource bundlejava.io.IOException
public static java.util.PropertyResourceBundle getPropertyResourceBundle(ServletContext servletContext, HttpServletRequest request) throws java.io.IOException
java.util.ResourceBundle thisResources =
com.ibm.commerce.server.JSPHelper.getPropertyResourceBundle(getServletContext(),
request);
servletContext
- servlet contextrequest
- Http servlet requestjava.io.IOException
public static java.util.ResourceBundle getResourceBundle(java.lang.String sfilename, HttpServletRequest request)
sfilename
- file namerequest
- servlet requestpublic static java.util.ResourceBundle getResourceBundle(java.lang.String sfilename, HttpServletRequest request, java.util.Locale locale)
sfilename
- file namerequest
- servlet requestlocale
- Locale used for the resource bundlepublic static java.util.ResourceBundle getResourceBundle(HttpServletRequest request)
request
- servlet requestpublic static java.lang.String htmlTextEncoder(java.lang.String iString)
public static void markTransactionToRollback()
public static void rollbackTransaction()
public void rollbackTransaction(boolean flag)
flag
- true for caching the page false for not caching the
pagepublic static void rollbackTransaction(HttpServletRequest req, boolean flag)
req
- http servlet request objectflag
- true for caching the page false for not caching the
pagepublic void setCachePage(boolean flag)
flag
- true if page is to be cached; false
otherwisepublic static void setUncacheable(HttpServletRequest req, boolean flag)
req
- http servlet request objectflag
- true to disable caching the page; false
otherwisepublic void setUncacheable(boolean flag)
flag
- true to disable caching the page; false
otherwise