RequestHeader (MtGox Java API 0.1.8 API)

java.lang.Object
- org.jwebsocket.kit.RequestHeader

```
public final class RequestHeader
extends Object
```
Holds the header of the initial WebSocket request from the client to the server. The RequestHeader internally maintains a FastMap to store key/values pairs.

Version:

$Id: RequestHeader.java 596 2010-06-22 17:09:54Z fivefeetfurther $

Author:

aschulze, jang

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`TIMEOUT`
`static String`	`URL_ARGS`
`static String`	`USER_AGENT`
`static String`	`WS_COOKIES`
`static String`	`WS_DRAFT`
`static String`	`WS_HOST`
`static String`	`WS_LOCATION`
`static String`	`WS_ORIGIN`
`static String`	`WS_PATH`
`static String`	`WS_PROTOCOL`
`static String`	`WS_SEARCHSTRING`
`static String`	`WS_SECKEY`
`static String`	`WS_SECKEY1`
`static String`	`WS_SECKEY2`
`static String`	`WS_VERSION`

Constructor Summary

Constructors
Constructor and Description

RequestHeader()

Constructors
Constructor and Description
`RequestHeader()`

Method Summary

Methods
Modifier and Type	Method and Description
`Object`	`get(String aKey)` Returns the object value for the given key or `null` if the key does not exist in the header.
`Map`	`getArgs()` Returns a Map of the optional URL arguments passed by the client.
`Map`	`getCookies()`
`String`	`getFormat()` Returns the subprotocol format in which messages are exchanged between client and server.
`String`	`getString(String aKey)` Returns the string value for the given key or `null` if the key does not exist in the header.
`String`	`getSubProtocol()` Returns the sub protocol passed by the client or a default value if no sub protocol has been passed either in the header or in the URL arguments.
`Integer`	`getTimeout(Integer aDefault)` Returns the session timeout passed by the client or a default value if no session timeout has been passed either in the header or in the URL arguments.
`int`	`getVersion()`
`void`	`put(String aKey, Object aValue)` Puts a new object value to the request header.

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

- Field Detail
  - WS_PROTOCOL
```
public static final String WS_PROTOCOL
```
    See Also:
    Constant Field Values
  - WS_DRAFT
```
public static final String WS_DRAFT
```
    See Also:
    Constant Field Values
  - WS_VERSION
```
public static final String WS_VERSION
```
    See Also:
    Constant Field Values
  - WS_ORIGIN
```
public static final String WS_ORIGIN
```
    See Also:
    Constant Field Values
  - WS_LOCATION
```
public static final String WS_LOCATION
```
    See Also:
    Constant Field Values
  - WS_PATH
```
public static final String WS_PATH
```
    See Also:
    Constant Field Values
  - WS_SEARCHSTRING
```
public static final String WS_SEARCHSTRING
```
    See Also:
    Constant Field Values
  - WS_HOST
```
public static final String WS_HOST
```
    See Also:
    Constant Field Values
  - WS_SECKEY
```
public static final String WS_SECKEY
```
    See Also:
    Constant Field Values
  - WS_SECKEY1
```
public static final String WS_SECKEY1
```
    See Also:
    Constant Field Values
  - WS_SECKEY2
```
public static final String WS_SECKEY2
```
    See Also:
    Constant Field Values
  - WS_COOKIES
```
public static final String WS_COOKIES
```
    See Also:
    Constant Field Values
  - URL_ARGS
```
public static final String URL_ARGS
```
    See Also:
    Constant Field Values
  - TIMEOUT
```
public static final String TIMEOUT
```
    See Also:
    Constant Field Values
  - USER_AGENT
```
public static final String USER_AGENT
```
    See Also:
    Constant Field Values
- Constructor Detail
  - RequestHeader
```
public RequestHeader()
```
- Method Detail
  - put
```
public void put(String aKey,
       Object aValue)
```
    Puts a new object value to the request header.
    
    Parameters:
    aKey -
    aValue -
  - get
```
public Object get(String aKey)
```
    Returns the object value for the given key or null if the key does not exist in the header.
    
    Parameters:
    aKey -
    
    Returns:
    object value for the given key or null.
  - getString
```
public String getString(String aKey)
```
    Returns the string value for the given key or null if the key does not exist in the header.
    
    Parameters:
    aKey -
    
    Returns:
    String value for the given key or null.
  - getArgs
```
public Map getArgs()
```
    Returns a Map of the optional URL arguments passed by the client.
    
    Returns:
    Map of the optional URL arguments.
  - getSubProtocol
```
public String getSubProtocol()
```
    Returns the sub protocol passed by the client or a default value if no sub protocol has been passed either in the header or in the URL arguments.
    
    Returns:
    Sub protocol passed by the client or default value.
  - getFormat
```
public String getFormat()
```
    Returns the subprotocol format in which messages are exchanged between client and server.
    
    Returns:
    subprotocol format passed by the client or default value
  - getTimeout
```
public Integer getTimeout(Integer aDefault)
```
    Returns the session timeout passed by the client or a default value if no session timeout has been passed either in the header or in the URL arguments.
    
    Parameters:
    aDefault -
    
    Returns:
    Session timeout passed by the client or default value.
  - getVersion
```
public int getVersion()
```
  - getCookies
```
public Map getCookies()
```

Class RequestHeader

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

WS_PROTOCOL

WS_DRAFT

WS_VERSION

WS_ORIGIN

WS_LOCATION

WS_PATH

WS_SEARCHSTRING

WS_HOST

WS_SECKEY

WS_SECKEY1

WS_SECKEY2

WS_COOKIES

URL_ARGS

TIMEOUT

USER_AGENT

Constructor Detail

RequestHeader

Method Detail

put

get

getString

getArgs

getSubProtocol

getFormat

getTimeout

getVersion

getCookies