HATS 7.5.1 Web API Reference

Publicly accessible methods not documented here are for IBM internal use only and may change in a future release of the product.

com.ibm.hats.runtime
Interface IRequest

All Known Implementing Classes:
WebRequest

public interface IRequest

Class Name: IRequest
Class Type:
Interface
Base Class:
None
Intf Class:
None
Description:
Provides a generic interface for the implementing request objects.


Field Summary
static String CLASSNAME
          The fully-qualified name of this class.
 
Method Summary
 String getApplicationId()
          Retrieve the application ID.
 Object getAttribute(String key)
          Retrieve the specified attribute.
 String getCharacterEncoding()
          Return the character encoding.
 String getContextPath()
          Retrieve the context path.
 String getHeader(String key)
          Retrieve the specified header.
 Enumeration getHeaderNames()
          Retrieve an Enumeration of the header names.
 Locale getLocale()
          Retrieve the Locale.
 String getParameter(String key)
          Retrieve the specified parameter.
 Map getParameterMap()
          Retrieve the parameter Map.
 Enumeration getParameterNames()
          Retrieve an Enumeration of the parameter names.
 String[] getParameterValues(String key)
          Retrieve the specified array containing parameter values.
 String getPathInfo()
          Retrieve the path information.
 String getQueryString()
          Retrieve the query string.
 String getRemoteAddr()
          Retrieve the remote address.
 IRequestDispatcher getRequestDispatcher(String key)
          Retrieve the specified request dispatcher.
 String getRequestedSessionId()
          Retrieve the requested session ID.
 String getRequestURI()
          Retrieve the request URI.
 StringBuffer getRequestURL()
          Retriee the request URL.
 String getServletPath()
          Retrieve the servlet path.
 ISession getSession()
          Retrieve the session.
 ISession getSession(boolean create)
          Retrieve the specified session.
 ISessionService getSessionService()
          This method is not implemented and will throw a runtime UnsupportedOperationException if invoked.
 String getViewId()
          Returns unique ID that identifies the view into the application.
 void setAttribute(String attribute, Object key)
          Set the attribute for the key.
 

Field Detail

CLASSNAME

static final String CLASSNAME
The fully-qualified name of this class.

Method Detail

getApplicationId

String getApplicationId()
Retrieve the application ID.

Returns:
The application ID.
See Also:
IRequest.getApplicationId()

getAttribute

Object getAttribute(String key)
Retrieve the specified attribute.

Parameters:
key - The key of the attribute being retrieved.
Returns:
The attribute.

getCharacterEncoding

String getCharacterEncoding()
Return the character encoding.

Returns:
The character encoding.

getContextPath

String getContextPath()
Retrieve the context path.

Returns:
The context path.

getHeader

String getHeader(String key)
Retrieve the specified header.

Parameters:
key - The header key.
Returns:
The specified header.

getHeaderNames

Enumeration getHeaderNames()
Retrieve an Enumeration of the header names.

Returns:
An Enumeration of the header names.

getLocale

Locale getLocale()
Retrieve the Locale.

Returns:
The Locale.

getParameter

String getParameter(String key)
Retrieve the specified parameter.

Parameters:
key - The key for the parameter being retrieved.
Returns:
The specified parameter.

getParameterMap

Map getParameterMap()
Retrieve the parameter Map.

Returns:
The parameter Map.

getParameterNames

Enumeration getParameterNames()
Retrieve an Enumeration of the parameter names.

Returns:
An Enumeration of the parameter names.

getParameterValues

String[] getParameterValues(String key)
Retrieve the specified array containing parameter values.

Parameters:
key - The key for the array being retrieved.
Returns:
The specified array containing parameter values.

getPathInfo

String getPathInfo()
Retrieve the path information.

Returns:
The path information.
See Also:
HttpServletRequest.getPathInfo()

getQueryString

String getQueryString()
Retrieve the query string.

Returns:
The query string.

getRemoteAddr

String getRemoteAddr()
Retrieve the remote address.

Returns:
The remote address.

getRequestDispatcher

IRequestDispatcher getRequestDispatcher(String key)
Retrieve the specified request dispatcher.

Parameters:
key - The key for the requested dispatcher.
Returns:
The key for the dispatcher being retrieved.

getRequestedSessionId

String getRequestedSessionId()
Retrieve the requested session ID.

Returns:
The requested session ID.

getRequestURI

String getRequestURI()
Retrieve the request URI.

Returns:
The request URI.

getRequestURL

StringBuffer getRequestURL()
Retriee the request URL.

Returns:
The request URL.

getServletPath

String getServletPath()
Retrieve the servlet path.

Returns:
The servlet path.

getSession

ISession getSession()
Retrieve the session.

Returns:
The session.

getSession

ISession getSession(boolean create)
Retrieve the specified session.

Parameters:
create - Indicating if a new session should be created.
Returns:
The specified session.

getSessionService

ISessionService getSessionService()
This method is not implemented and will throw a runtime UnsupportedOperationException if invoked.

Returns:
Nothing. This method is not implemented and will throw a runtime UnsupportedOperationException if invoked.

getViewId

String getViewId()
Returns unique ID that identifies the view into the application.

Returns:
The view ID. In the case of a WebRequest, the view ID isn't used and returns an empty String.

setAttribute

void setAttribute(String attribute,
                  Object key)
Set the attribute for the key.

Parameters:
attribute - The attribute to be set.
key - The key used to save the attribute.

HATS 7.5.1 (201005110649)