HttpRequestService (BellaDati Extensions API 1.1 API)

```
public interface HttpRequestService
```
Generic version of HttpServletRequest, used to encapsulate the Servlet API version, and to help bridge the differences between Servlet API and Porlet API.

Author:

BellaDati Inc.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Object`	`getAttribute(String name)` Returns the value of the named attribute as an Object, or null if no attribute of the given name exists.
`String`	`getContextPath()` Returns the context path.
`String`	`getHeader(String name)` Returns the named header as a string, or null if not found.
`List<String>`	`getHeaderNames()` Returns the names of all headers in the request.
`String`	`getLocale()` Returns the locale of the client as determined from the request headers.
`int`	`getLocalPort()` Returns the Internet Protocol (IP) port number of the interface on which the request was received.
`String`	`getMethod()` Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT.
`String`	`getParameter(String name)` Returns the query parameter value for the given name.
`List<String>`	`getParameterNames()` Returns a list of query parameter names, in alphabetical order.
`String[]`	`getParameters(String name)` Returns the parameter values for the given name.
`String`	`getPath()` Returns the path portion of the request, which starts with a "/" and contains everything up to the start of the query parameters.
`String`	`getRemoteHost()` Returns the fully qualified name of the client or the last proxy that sent the request.
`String`	`getServerName()` Returns the host name of the server to which the request was sent.
`int`	`getServerPort()` Returns the port number to which the request was sent.
`Session`	`getSession(boolean create)` Gets the `Session`
`boolean`	`isRequestedSessionIdValid()` Checks whether the requested session ID is still valid.
`boolean`	`isSecure()` Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.
`boolean`	`isXHR()` Returns true if the request originated on the client using XmlHttpRequest (the core of any Ajax behavior).
`void`	`setAttribute(String name, Object value)` Stores an attribute in this request.

- Method Detail
  - getAttribute
```
Object getAttribute(String name)
```
    Returns the value of the named attribute as an Object, or null if no attribute of the given name exists.
    
    Parameters:
    
    name - name of the attribute
    
    Returns:
    
    attribute value
  - getContextPath
```
String getContextPath()
```
    Returns the context path.
    
    Returns:
    
    context path
  - getHeader
```
String getHeader(String name)
```
    Returns the named header as a string, or null if not found.
    
    Parameters:
    
    name - header name
    
    Returns:
    
    header value
  - getHeaderNames
```
List<String> getHeaderNames()
```
    Returns the names of all headers in the request.
    
    Returns:
    
    List of header names
  - getLocale
```
String getLocale()
```
    Returns the locale of the client as determined from the request headers.
    
    Returns:
    
    locale string
  - getLocalPort
```
int getLocalPort()
```
    Returns the Internet Protocol (IP) port number of the interface on which the request was received.
    
    Returns:
    
    local port
  - getMethod
```
String getMethod()
```
    Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT.
    
    Returns:
    
    HTTP method
  - getParameter
```
String getParameter(String name)
```
    Returns the query parameter value for the given name.
    
    Parameters:
    
    name - parameter name
    
    Returns:
    
    value of the parameter or null
  - getParameterNames
```
List<String> getParameterNames()
```
    Returns a list of query parameter names, in alphabetical order.
    
    Returns:
    
    List of parameter names
  - getParameters
```
String[] getParameters(String name)
```
    Returns the parameter values for the given name.
    
    Parameters:
    
    name - array of parameter values
    
    Returns:
    
    array of Strings
  - getPath
```
String getPath()
```
    Returns the path portion of the request, which starts with a "/" and contains everything up to the start of the query parameters.
    
    Returns:
    
    path of the request
  - getRemoteHost
```
String getRemoteHost()
```
    Returns the fully qualified name of the client or the last proxy that sent the request.
    
    Returns:
    
    remote host
  - getServerName
```
String getServerName()
```
    Returns the host name of the server to which the request was sent.
    
    Returns:
    
    server name
  - getServerPort
```
int getServerPort()
```
    Returns the port number to which the request was sent.
    
    Returns:
    
    server port
  - getSession
```
Session getSession(boolean create)
```
    Gets the Session
    
    Parameters:
    
    create - determines whether to create session if it does not exist
    
    Returns:
    
    Session object
  - isRequestedSessionIdValid
```
boolean isRequestedSessionIdValid()
```
    Checks whether the requested session ID is still valid.
    
    Returns:
    
    determines whether requested session ID is still valid
  - isSecure
```
boolean isSecure()
```
    Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.
    
    Returns:
    
    whether is connection secured
  - isXHR
```
boolean isXHR()
```
    Returns true if the request originated on the client using XmlHttpRequest (the core of any Ajax behavior).
    
    Returns:
    
    Returns true if the request originated on the client using XmlHttpRequest (the core of any Ajax behavior).
  - setAttribute
```
void setAttribute(String name,
                  Object value)
```
    Stores an attribute in this request.
    
    Parameters:
    
    name - attribute name
    
    value - attribute value

Interface HttpRequestService

Method Summary

Method Detail

getAttribute

getContextPath

getHeader

getHeaderNames

getLocale

getLocalPort

getMethod

getParameter

getParameterNames

getParameters

getPath

getRemoteHost

getServerName

getServerPort

getSession

isRequestedSessionIdValid

isSecure

isXHR

setAttribute