HttpRequest (comsat-actors-api 0.1.0 API)

java.lang.Object
- co.paralleluniverse.actors.behaviors.ActorMessage
- - co.paralleluniverse.comsat.webactors.WebMessage
  - - co.paralleluniverse.comsat.webactors.HttpMessage
    - - co.paralleluniverse.comsat.webactors.HttpRequest

All Implemented Interfaces:

FromMessage, Serializable
```
public abstract class HttpRequest
extends HttpMessage
```
An HTTP request message.

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

HttpRequest()

Constructors
Constructor and Description
`HttpRequest()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected String`	`contentString()`
`abstract Map<String,Object>`	`getAtrributes()` Returns the names values of all attributed associated with this request.
`Object`	`getAttribute(String name)` Returns the value of the given attribute.
`abstract String`	`getContextPath()` The portion of the request URI that indicates the context of the request.
`abstract long`	`getDateHeader(String name)` Returns the value of the specified request header as a `long` value that represents a `Date` object.
`abstract ActorRef<HttpResponse>`	`getFrom()` Returns an actor representing the client to which an `HttpResponse` should be sent as a response to this request.
`abstract String`	`getMethod()` The name of the HTTP method with which this request was made; for example, GET, POST, or PUT.
`String`	`getParameter(String name)` Returns the value of the given parameter.
`abstract Multimap<String,String>`	`getParameters()` A multimap of the parameters contained in this message and (all) their values.
`Collection<String>`	`getParametersValues(String name)` Returns all values associated with the given parameter
`abstract String`	`getPathInfo()` Returns any extra path information associated with the URL the client sent when it made this request.
`abstract String`	`getQueryString()` The query string that is contained in the request URL after the path, or `null` if the URL does not have a query string.
`abstract String`	`getRequestURI()` Returns the part of this request’s URL from the protocol name up to the query string in the first line of the HTTP request.
`abstract String`	`getServerName()` The host name of the server to which the request was sent.
`abstract int`	`getServerPort()` The port number to which the request was sent.

Methods inherited from class co.paralleluniverse.comsat.webactors.HttpMessage
getCharacterEncoding, getContentLength, getContentType, getCookies, getHeader, getHeaders, getHeaderValues

Methods inherited from class co.paralleluniverse.comsat.webactors.WebMessage
getByteBufferBody, getStringBody

Methods inherited from class co.paralleluniverse.actors.behaviors.ActorMessage
toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - HttpRequest
```
public HttpRequest()
```
- Method Detail
  - getParameters
```
public abstract Multimap<String,String> getParameters()
```
    A multimap of the parameters contained in this message and (all) their values. If the request has no parameters, returns an empty multimap.
  - getAtrributes
```
public abstract Map<String,Object> getAtrributes()
```
    Returns the names values of all attributed associated with this request.
    The container may set attributes to make available custom information about a request. For example, for requests made using HTTPS, the attribute javax.servlet.request.X509Certificate can be used to retrieve information on the certificate of the client.
    
    Returns:
    an Object containing the value of the attribute, or null if the attribute does not exist
  - getParametersValues
```
public Collection<String> getParametersValues(String name)
```
    Returns all values associated with the given parameter
    
    Parameters:
    name - the parameter name
    
    Returns:
    all values associated with the given parameter
  - getParameter
```
public String getParameter(String name)
```
    Returns the value of the given parameter. If the parameter is not found in the message, this method returns null. If the parameter has more than one value, this method returns the first value.
    
    Parameters:
    name - the parameter name
    
    Returns:
    the (first) value of the given parameter name; null if the parameter is not found
  - getAttribute
```
public Object getAttribute(String name)
```
    Returns the value of the given attribute. If the attribute is not found in the message, this method returns null.
    
    Parameters:
    name - the attribute name
    
    Returns:
    the value of the given attribute; null if the attribute is not found
  - getMethod
```
public abstract String getMethod()
```
    The name of the HTTP method with which this request was made; for example, GET, POST, or PUT.
    
    Returns:
    the name of the method with which this request was made
  - getDateHeader
```
public abstract long getDateHeader(String name)
```
    Returns the value of the specified request header as a long value that represents a Date object. Use this method with headers that contain dates, such as If-Modified-Since.
    The date is returned as the number of milliseconds since January 1, 1970 GMT.
    If the request does not have a header of the specified name, this method returns -1. If the header can’t be converted to a date, the method throws an IllegalArgumentException.
    
    Parameters:
    name - the name of the header
    
    Returns:
    a long value representing the date specified in the header expressed as the number of milliseconds since January 1, 1970 GMT, or -1 if the named header was not included with the request
    
    Throws:
    
    IllegalArgumentException - If the header value can’t be converted to a date
  - getPathInfo
```
public abstract String getPathInfo()
```
    Returns any extra path information associated with the URL the client sent when it made this request. The extra path information follows the servlet path but precedes the query string and will start with a “/” character.
    This method returns null if there was no extra path information.
    
    Returns:
    a String decoded by the web container, specifying extra path information that comes after the servlet path but before the query string in the request URL; or null if the URL does not have any extra path information
  - getContextPath
```
public abstract String getContextPath()
```
    The portion of the request URI that indicates the context of the request. The context path always comes first in a request URI. The path starts with a “/” character but does not end with a “/” character. For servlets in the default (root) context, this method returns "". The container does not decode this string.
    It is possible that a container may match a context by more than one context path. In such cases this method will return the actual context path used by the request.
    
    Returns:
    the portion of the request URI that indicates the context of the request
  - getQueryString
```
public abstract String getQueryString()
```
    The query string that is contained in the request URL after the path, or null if the URL does not have a query string.
  - getRequestURI
```
public abstract String getRequestURI()
```
    Returns the part of this request’s URL from the protocol name up to the query string in the first line of the HTTP request. The web container does not decode this string. For example:
    
    First line of HTTP request Returned Value
    POST /some/path.html HTTP/1.1 /some/path.html
    GET http://foo.bar/a.html HTTP/1.0 /a.html
    HEAD /xyz?a=b HTTP/1.1 /xyz
    
    Returns:
    the part of the URL from the protocol name up to the query string
  - getServerName
```
public abstract String getServerName()
```
    The host name of the server to which the request was sent. It is the value of the part before “:” in the Host header value, if any, or the resolved server name, or the server IP address.
  - getServerPort
```
public abstract int getServerPort()
```
    The port number to which the request was sent. It is the value of the part after “:” in the Host header value, if any, or the server port where the client connection was accepted on.
    
    Returns:
    the port number
  - getFrom
```
public abstract ActorRef<HttpResponse> getFrom()
```
    Returns an actor representing the client to which an HttpResponse should be sent as a response to this request. All HttpRequests from the same session will have the same sender. It will appear to have died (i.e. send an ExitMessage if watched) when the session is terminated.
    
    Specified by:
    
    getFrom in interface FromMessage
    
    Specified by:
    
    getFrom in class WebMessage
    
    Returns:
    an actor representing the client
  - contentString
```
protected String contentString()
```
    Overrides:
    
    contentString in class WebMessage

First line of HTTP request	Returned Value
POST /some/path.html HTTP/1.1		/some/path.html
GET http://foo.bar/a.html HTTP/1.0		/a.html
HEAD /xyz?a=b HTTP/1.1		/xyz

Class HttpRequest

Constructor Summary

Method Summary

Methods inherited from class co.paralleluniverse.comsat.webactors.HttpMessage

Methods inherited from class co.paralleluniverse.comsat.webactors.WebMessage

Methods inherited from class co.paralleluniverse.actors.behaviors.ActorMessage

Methods inherited from class java.lang.Object

Constructor Detail

HttpRequest

Method Detail

getParameters

getAtrributes

getParametersValues

getParameter

getAttribute

getMethod

getDateHeader

getPathInfo

getContextPath

getQueryString

getRequestURI

getServerName

getServerPort

getFrom

contentString