|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.cocoon.components.language.markup.xsp.XSPRequestHelper
The Request
object helper
Constructor Summary | |
XSPRequestHelper()
|
Method Summary | |
static java.lang.Object |
getAttribute(java.util.Map objectModel,
java.lang.String name)
Get the specified attribute |
static void |
getAttributeNames(java.util.Map objectModel,
org.xml.sax.ContentHandler contentHandler)
Output attribute names for a given request |
static java.lang.String |
getContextPath(java.util.Map objectModel)
Obtain the portion of the request URI that indicates the context of the request |
static void |
getContextPath(java.util.Map objectModel,
org.xml.sax.ContentHandler contentHandler)
Obtain the portion of the request URI that indicates the context of the request |
static void |
getHeader(java.util.Map objectModel,
org.xml.sax.ContentHandler contentHandler,
java.lang.String name)
Output the request header value for a given name |
static java.lang.String |
getHeader(java.util.Map objectModel,
java.lang.String name)
Return the request header value for a given name |
static void |
getHeaderNames(java.util.Map objectModel,
org.xml.sax.ContentHandler contentHandler)
Output the header names for a given request |
static java.lang.String |
getMethod(java.util.Map objectModel)
Output the name of the HTTP method with which the request was made, |
static void |
getMethod(java.util.Map objectModel,
org.xml.sax.ContentHandler contentHandler)
Output the name of the HTTP method with which the request was made, |
static void |
getParameter(java.util.Map objectModel,
org.xml.sax.ContentHandler contentHandler,
java.lang.String name,
java.lang.String defaultValue)
Output the given request parameter value or a user-provided default if none was specified. |
static void |
getParameter(java.util.Map objectModel,
org.xml.sax.ContentHandler contentHandler,
java.lang.String name,
java.lang.String defaultValue,
java.lang.String form_encoding,
java.lang.String container_encoding)
Output the given request parameter value or a user-provided default if none was specified. |
static java.lang.String |
getParameter(java.util.Map objectModel,
java.lang.String name,
java.lang.String defaultValue)
Return the given request parameter value or a user-provided default if none was specified. |
static java.lang.String |
getParameter(java.util.Map objectModel,
java.lang.String name,
java.lang.String defaultValue,
java.lang.String form_encoding,
java.lang.String container_encoding)
Return the given request parameter value or a user-provided default if none was specified. |
static void |
getParameterNames(java.util.Map objectModel,
org.xml.sax.ContentHandler contentHandler)
Output parameter names for a given request |
static void |
getParameterValues(java.util.Map objectModel,
org.xml.sax.ContentHandler contentHandler,
java.lang.String name)
Output the request parameter values for a given name |
static void |
getParameterValues(java.util.Map objectModel,
org.xml.sax.ContentHandler contentHandler,
java.lang.String name,
java.lang.String form_encoding,
java.lang.String container_encoding)
Output the request parameter values for a given name |
static java.lang.String[] |
getParameterValues(java.util.Map objectModel,
java.lang.String name,
java.lang.String form_encoding,
java.lang.String container_encoding)
return the request parameter values for a given name as array |
static java.lang.String |
getProtocol(java.util.Map objectModel)
Output the name and version of the protocol the request uses in the form of protocol/majorVersion.minorVersion, |
static void |
getProtocol(java.util.Map objectModel,
org.xml.sax.ContentHandler contentHandler)
Output the name and version of the protocol the request uses in the form of protocol/majorVersion.minorVersion, |
static java.lang.String |
getQueryString(java.util.Map objectModel)
Output the query string that is contained in the request URL after the path, |
static void |
getQueryString(java.util.Map objectModel,
org.xml.sax.ContentHandler contentHandler)
Output the query string that is contained in the request URL after the path, |
static java.lang.String |
getRemoteAddr(java.util.Map objectModel)
Output the IP address of the client that sent the request |
static void |
getRemoteAddr(java.util.Map objectModel,
org.xml.sax.ContentHandler contentHandler)
Output the IP address of the client that sent the request |
static java.lang.String |
getRemoteHost(java.util.Map objectModel)
Output the fully qualified name of the client that sent the request, or the IP address of the client if the name cannot be determined, given Request |
static void |
getRemoteHost(java.util.Map objectModel,
org.xml.sax.ContentHandler contentHandler)
Output the fully qualified name of the client that sent the request, or the IP address of the client if the name cannot be determined, given Request |
static java.lang.String |
getRemoteUser(java.util.Map objectModel)
Output the login of the user making the request Could be null if user is not authenticated. |
static void |
getRemoteUser(java.util.Map objectModel,
org.xml.sax.ContentHandler contentHandler)
Output the login of the user making the request Could be null if user is not authenticated. |
static java.lang.String |
getRequestedURL(java.util.Map objectModel)
|
static void |
getRequestURI(java.util.Map objectModel,
org.xml.sax.ContentHandler contentHandler)
Output the uri associated with the given Request |
static java.lang.String |
getServerName(java.util.Map objectModel)
Remove the specified attribute |
static int |
getServerPort(java.util.Map objectModel)
Remove the specified attribute |
static void |
getSessionAttribute(java.util.Map objectModel,
org.xml.sax.ContentHandler contentHandler,
java.lang.String name,
java.lang.Object defaultValue)
Output the given session attribute value or a user-provided default if none was specified. |
static java.lang.Object |
getSessionAttribute(java.util.Map objectModel,
java.lang.String name)
Return the given session attribute value or a user-provided default if none was specified. |
static java.lang.Object |
getSessionAttribute(java.util.Map objectModel,
java.lang.String name,
java.lang.Object defaultValue)
Return the given session attribute value or a user-provided default if none was specified. |
static java.util.List |
getSessionAttributeNames(java.util.Map objectModel)
Get the session attribute names. |
static long |
getSessionCreationTime(java.util.Map objectModel)
Get the session creation time |
static java.lang.String |
getSessionId(java.util.Map objectModel)
Get the session id |
static long |
getSessionLastAccessedTime(java.util.Map objectModel)
Get the session last accessed time |
static long |
getSessionMaxInactiveInterval(java.util.Map objectModel)
Get the session max inactive interval |
static java.lang.String |
getSitemapURI(java.util.Map objectModel)
Outputs the sitemap uri associated with the given objectModel |
static void |
getSitemapURI(java.util.Map objectModel,
org.xml.sax.ContentHandler handler)
Outputs the sitemap uri associated with the given objectModel |
static java.lang.String |
getURI(java.util.Map objectModel)
Output the uri associated with the given objectModel |
static void |
getURI(java.util.Map objectModel,
org.xml.sax.ContentHandler handler)
Output the uri associated with the given objectModel |
static void |
invalidateSession(java.util.Map objectModel)
Invalidate the session |
static boolean |
isSecure(java.util.Map objectModel)
Checks the secure flag |
static boolean |
isSessionNew(java.util.Map objectModel)
Checks the isNew flag |
static void |
removeAttribute(java.util.Map objectModel,
java.lang.String name)
Remove the specified attribute |
static void |
removeSessionAttribute(java.util.Map objectModel,
java.lang.String name)
Remove the specified attribute |
static void |
setAttribute(java.util.Map objectModel,
java.lang.String name,
java.lang.Object value)
Set the specified attribute |
static void |
setSessionAttribute(java.util.Map objectModel,
java.lang.String name,
java.lang.Object content)
Sets the given session attribute value |
static void |
setSessionMaxInactiveInterval(java.util.Map objectModel,
int interval)
Set the session max inactive interval |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public XSPRequestHelper()
Method Detail |
public static void getRequestURI(java.util.Map objectModel, org.xml.sax.ContentHandler contentHandler) throws org.xml.sax.SAXException
Request
objectModel
- The Map objectModelcontentHandler
- The SAX content handlerorg.xml.sax.SAXException
- If a SAX error occurspublic static java.lang.String getURI(java.util.Map objectModel)
objectModel
- The Map objectModelpublic static void getURI(java.util.Map objectModel, org.xml.sax.ContentHandler handler) throws org.xml.sax.SAXException
objectModel
- The Map objectModelpublic static java.lang.String getSitemapURI(java.util.Map objectModel)
objectModel
- the Map objectModelpublic static void getSitemapURI(java.util.Map objectModel, org.xml.sax.ContentHandler handler) throws org.xml.sax.SAXException
objectModel
- the Map objectModelpublic static java.lang.String getParameter(java.util.Map objectModel, java.lang.String name, java.lang.String defaultValue)
objectModel
- The Map objectModelname
- The parameter namedefaultValue
- Value to substitute in absence of a parameter valuepublic static java.lang.String getParameter(java.util.Map objectModel, java.lang.String name, java.lang.String defaultValue, java.lang.String form_encoding, java.lang.String container_encoding)
objectModel
- The Map objectModelname
- The parameter namedefaultValue
- Value to substitute in absence of a parameter valueform_encoding
- The supposed encoding of the request parameter.container_encoding
- The encoding used by container.public static void getParameter(java.util.Map objectModel, org.xml.sax.ContentHandler contentHandler, java.lang.String name, java.lang.String defaultValue) throws org.xml.sax.SAXException
objectModel
- The Map objectModelcontentHandler
- The SAX content handlername
- The parameter namedefaultValue
- Value to substitute in absence of a parameter valueorg.xml.sax.SAXException
- If a SAX error occurspublic static void getParameter(java.util.Map objectModel, org.xml.sax.ContentHandler contentHandler, java.lang.String name, java.lang.String defaultValue, java.lang.String form_encoding, java.lang.String container_encoding) throws org.xml.sax.SAXException
objectModel
- The Map objectModelcontentHandler
- The SAX content handlername
- The parameter namedefaultValue
- Value to substitute in absence of a parameter valueform_encoding
- The supposed encoding of the request parameter.container_encoding
- The encoding used by container.org.xml.sax.SAXException
- If a SAX error occurspublic static void getParameterValues(java.util.Map objectModel, org.xml.sax.ContentHandler contentHandler, java.lang.String name) throws org.xml.sax.SAXException
objectModel
- The Map objectModelcontentHandler
- The SAX content handlerorg.xml.sax.SAXException
- If a SAX error occurspublic static void getParameterValues(java.util.Map objectModel, org.xml.sax.ContentHandler contentHandler, java.lang.String name, java.lang.String form_encoding, java.lang.String container_encoding) throws org.xml.sax.SAXException
objectModel
- The Map objectModelcontentHandler
- The SAX content handlerform_encoding
- The supposed encoding of the request parameter.container_encoding
- The encoding used by container.org.xml.sax.SAXException
- If a SAX error occurspublic static java.lang.String[] getParameterValues(java.util.Map objectModel, java.lang.String name, java.lang.String form_encoding, java.lang.String container_encoding)
objectModel
- The Map objectModelcontentHandler
- The SAX content handlerform_encoding
- The supposed encoding of the request parameter.container_encoding
- The encoding used by container.public static void getParameterNames(java.util.Map objectModel, org.xml.sax.ContentHandler contentHandler) throws org.xml.sax.SAXException
objectModel
- The Map objectModelcontentHandler
- The SAX content handlerorg.xml.sax.SAXException
- If a SAX error occurspublic static java.lang.String getHeader(java.util.Map objectModel, java.lang.String name)
objectModel
- The Map objectModelname
- The parameter namepublic static void getHeader(java.util.Map objectModel, org.xml.sax.ContentHandler contentHandler, java.lang.String name) throws org.xml.sax.SAXException
objectModel
- The Map objectModelcontentHandler
- The SAX content handlername
- The parameter nameorg.xml.sax.SAXException
- If a SAX error occurspublic static void getHeaderNames(java.util.Map objectModel, org.xml.sax.ContentHandler contentHandler) throws org.xml.sax.SAXException
objectModel
- The Map objectModelcontentHandler
- The SAX content handlerorg.xml.sax.SAXException
- If a SAX error occurspublic static void setSessionAttribute(java.util.Map objectModel, java.lang.String name, java.lang.Object content)
objectModel
- The Map objectModelname
- The parameter namecontent
- The parameter valuepublic static java.lang.Object getSessionAttribute(java.util.Map objectModel, java.lang.String name)
objectModel
- The Map objectModelname
- The parameter namepublic static java.lang.Object getSessionAttribute(java.util.Map objectModel, java.lang.String name, java.lang.Object defaultValue)
objectModel
- The Map objectModelname
- The parameter namedefaultValue
- Value to substitute in absence of a parameter valuepublic static void removeAttribute(java.util.Map objectModel, java.lang.String name)
objectModel
- The Map objectModelname
- The parameter namepublic static java.lang.Object getAttribute(java.util.Map objectModel, java.lang.String name)
objectModel
- The Map objectModelname
- The parameter namepublic static void getAttributeNames(java.util.Map objectModel, org.xml.sax.ContentHandler contentHandler) throws org.xml.sax.SAXException
objectModel
- The Map objectModelcontentHandler
- The SAX content handlerorg.xml.sax.SAXException
- If a SAX error occurspublic static void setAttribute(java.util.Map objectModel, java.lang.String name, java.lang.Object value)
objectModel
- The Map objectModelname
- The parameter namepublic static java.lang.String getRemoteUser(java.util.Map objectModel)
objectModel
- The Map objectModelpublic static void getRemoteUser(java.util.Map objectModel, org.xml.sax.ContentHandler contentHandler) throws org.xml.sax.SAXException
objectModel
- The Map objectModelcontentHandler
- The SAX content handlerorg.xml.sax.SAXException
- If a SAX error occurspublic static java.lang.String getMethod(java.util.Map objectModel)
objectModel
- The Map objectModelpublic static void getMethod(java.util.Map objectModel, org.xml.sax.ContentHandler contentHandler) throws org.xml.sax.SAXException
objectModel
- The Map objectModelcontentHandler
- The SAX content handlerorg.xml.sax.SAXException
- If a SAX error occurspublic static java.lang.String getQueryString(java.util.Map objectModel)
objectModel
- The Map objectModelpublic static void getQueryString(java.util.Map objectModel, org.xml.sax.ContentHandler contentHandler) throws org.xml.sax.SAXException
objectModel
- The Map objectModelcontentHandler
- The SAX content handlerorg.xml.sax.SAXException
- If a SAX error occurspublic static java.lang.String getProtocol(java.util.Map objectModel)
objectModel
- The Map objectModelpublic static void getProtocol(java.util.Map objectModel, org.xml.sax.ContentHandler contentHandler) throws org.xml.sax.SAXException
objectModel
- The Map objectModelcontentHandler
- The SAX content handlerorg.xml.sax.SAXException
- If a SAX error occurspublic static java.lang.String getRemoteHost(java.util.Map objectModel)
Request
objectModel
- The Map objectModelpublic static void getRemoteHost(java.util.Map objectModel, org.xml.sax.ContentHandler contentHandler) throws org.xml.sax.SAXException
Request
objectModel
- The Map objectModelcontentHandler
- The SAX content handlerorg.xml.sax.SAXException
- If a SAX error occurspublic static java.lang.String getRemoteAddr(java.util.Map objectModel)
objectModel
- The Map objectModelpublic static void getRemoteAddr(java.util.Map objectModel, org.xml.sax.ContentHandler contentHandler) throws org.xml.sax.SAXException
objectModel
- The Map objectModelcontentHandler
- The SAX content handlerorg.xml.sax.SAXException
- If a SAX error occurspublic static boolean isSecure(java.util.Map objectModel)
objectModel
- The Map objectModelpublic static java.lang.String getServerName(java.util.Map objectModel)
objectModel
- The Map objectModelpublic static int getServerPort(java.util.Map objectModel)
objectModel
- The Map objectModelpublic static java.lang.String getRequestedURL(java.util.Map objectModel)
public static java.util.List getSessionAttributeNames(java.util.Map objectModel)
objectModel
- The Map objectModelpublic static void getSessionAttribute(java.util.Map objectModel, org.xml.sax.ContentHandler contentHandler, java.lang.String name, java.lang.Object defaultValue) throws org.xml.sax.SAXException
objectModel
- The Map objectModelcontentHandler
- The SAX content handlername
- The parameter namedefaultValue
- Value to substitute in absence of a parameter valueorg.xml.sax.SAXException
- If a SAX error occurspublic static long getSessionCreationTime(java.util.Map objectModel)
objectModel
- The Map objectModelpublic static java.lang.String getSessionId(java.util.Map objectModel)
objectModel
- The Map objectModelpublic static long getSessionLastAccessedTime(java.util.Map objectModel)
objectModel
- The Map objectModelpublic static long getSessionMaxInactiveInterval(java.util.Map objectModel)
objectModel
- The Map objectModelpublic static void setSessionMaxInactiveInterval(java.util.Map objectModel, int interval)
objectModel
- The Map objectModelinterval
- max inactive intervalpublic static void invalidateSession(java.util.Map objectModel)
objectModel
- The Map objectModelpublic static boolean isSessionNew(java.util.Map objectModel)
objectModel
- The Map objectModelpublic static void removeSessionAttribute(java.util.Map objectModel, java.lang.String name)
objectModel
- The Map objectModelname
- The parameter namepublic static java.lang.String getContextPath(java.util.Map objectModel)
objectModel
- The Map objectModelpublic static void getContextPath(java.util.Map objectModel, org.xml.sax.ContentHandler contentHandler) throws org.xml.sax.SAXException
objectModel
- The Map objectModelcontentHandler
- The SAX content handlerorg.xml.sax.SAXException
- If a SAX error occurs
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |