HttpHeaderFields (NetPhantom® 7.7 Java API Specification)

java.lang.Object
- se.entra.phantom.server.http.HttpHeaderFields

public class HttpHeaderFields
extends Object

Handles the header fields in a HTTP request.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SHF_Accept`
`static String`	`SHF_Accept_Charset`
`static String`	`SHF_Accept_Encoding`
`static String`	`SHF_Accept_Language`
`static String`	`SHF_Authorization`
`static String`	`SHF_Connection`
`static String`	`SHF_Content_Length`
`static String`	`SHF_Content_Type`
`static String`	`SHF_Expect`
`static String`	`SHF_From`
`static String`	`SHF_Host`
`static String`	`SHF_If_Match`
`static String`	`SHF_If_Modified_Since`
`static String`	`SHF_If_None_Match`
`static String`	`SHF_If_Range`
`static String`	`SHF_If_Unmodified_Since`
`static String`	`SHF_Location`
`static String`	`SHF_Max_Forwards`
`static String`	`SHF_Proxy_Authorization`
`static String`	`SHF_Range`
`static String`	`SHF_Referer`
`static String`	`SHF_TE`
`static String`	`SHF_User_Agent`
`static String`	`SHF_WWW_Authorization`

Constructor Summary

Constructors
Constructor and Description

HttpHeaderFields(String[] headerLines)
Creates the header fields from a string array of the HTTP header.

Constructors
Constructor and Description
`HttpHeaderFields(String[] headerLines)` Creates the header fields from a string array of the HTTP header.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`LinkedHashMap<String,String[]>`	`getAllHeaderFields()` Gets all the first header fields of each type into a new LinkedHashMap.
`int`	`getContentLength()` Gets the contents length.
`Vector<HttpCookie>`	`getCookies()` Gets the cookies associated with the request.
`String`	`getHeader(String name)` Get the header first of a certain index in the SHF_* strings or another user defined string.
`Set<Map.Entry<String,String>>`	`getHeaderEntrySet()` Deprecated. "for-removal"
`LinkedHashMap<String,String>`	`getHeaderFields()` Deprecated. "for-removal"
`Enumeration<String>`	`getHeaders()` Deprecated. "for-removal"
`String[]`	`getHeaders(String name)` Get all header fields of a certain index in the SHF_* strings or another user defined string.
`Iterator<String>`	`getHeadersIterator()` Gets the Iterator of header field keys.
`Set<String>`	`getHeadersSet()` Get enumeration of header field keys.
`String`	`getHostAddress()` Gets the host address of a GET request.
`String`	`getMultipartBoundary()` Get the multipart Content-type boundary.
`String[]`	`getRawHeaderLines()` Gets the raw header lines strings array.
`boolean`	`hasHostAddress()` Checks if the header fields contains the "Host: address" header field that makes it value for a GET.
`boolean`	`isFormData()` Checks if the data is used in conjuction with HTML forms, i.e.
`boolean`	`isKeepAlive()` Checks if the request is of "Keep-Alive" type.
`boolean`	`isMultipartFormData()` Checks if the data is used in conjuction with HTML forms, i.e.

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

- Field Detail
  - SHF_Accept
```
public static final String SHF_Accept
```
    See Also:
    
    Constant Field Values
  - SHF_Accept_Charset
```
public static final String SHF_Accept_Charset
```
    See Also:
    
    Constant Field Values
  - SHF_Accept_Encoding
```
public static final String SHF_Accept_Encoding
```
    See Also:
    
    Constant Field Values
  - SHF_Accept_Language
```
public static final String SHF_Accept_Language
```
    See Also:
    
    Constant Field Values
  - SHF_Authorization
```
public static final String SHF_Authorization
```
    See Also:
    
    Constant Field Values
  - SHF_Connection
```
public static final String SHF_Connection
```
    See Also:
    
    Constant Field Values
  - SHF_Content_Length
```
public static final String SHF_Content_Length
```
    See Also:
    
    Constant Field Values
  - SHF_Content_Type
```
public static final String SHF_Content_Type
```
    See Also:
    
    Constant Field Values
  - SHF_Expect
```
public static final String SHF_Expect
```
    See Also:
    
    Constant Field Values
  - SHF_From
```
public static final String SHF_From
```
    See Also:
    
    Constant Field Values
  - SHF_Host
```
public static final String SHF_Host
```
    See Also:
    
    Constant Field Values
  - SHF_Location
```
public static final String SHF_Location
```
    See Also:
    
    Constant Field Values
  - SHF_If_Match
```
public static final String SHF_If_Match
```
    See Also:
    
    Constant Field Values
  - SHF_If_Modified_Since
```
public static final String SHF_If_Modified_Since
```
    See Also:
    
    Constant Field Values
  - SHF_If_None_Match
```
public static final String SHF_If_None_Match
```
    See Also:
    
    Constant Field Values
  - SHF_If_Range
```
public static final String SHF_If_Range
```
    See Also:
    
    Constant Field Values
  - SHF_If_Unmodified_Since
```
public static final String SHF_If_Unmodified_Since
```
    See Also:
    
    Constant Field Values
  - SHF_Max_Forwards
```
public static final String SHF_Max_Forwards
```
    See Also:
    
    Constant Field Values
  - SHF_Proxy_Authorization
```
public static final String SHF_Proxy_Authorization
```
    See Also:
    
    Constant Field Values
  - SHF_Range
```
public static final String SHF_Range
```
    See Also:
    
    Constant Field Values
  - SHF_Referer
```
public static final String SHF_Referer
```
    See Also:
    
    Constant Field Values
  - SHF_TE
```
public static final String SHF_TE
```
    See Also:
    
    Constant Field Values
  - SHF_User_Agent
```
public static final String SHF_User_Agent
```
    See Also:
    
    Constant Field Values
  - SHF_WWW_Authorization
```
public static final String SHF_WWW_Authorization
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - HttpHeaderFields
```
public HttpHeaderFields(String[] headerLines)
```
    Creates the header fields from a string array of the HTTP header.
    Each field start at the beginning of the line and is directly followed by a colon, optional white space (in our case always a space, because Tab has already been converted) and then an optional value.
    The first header string is skipped because it contains the request line.
- Method Detail
  - getRawHeaderLines
```
public String[] getRawHeaderLines()
```
    Gets the raw header lines strings array.
    
    Returns:
    
    A copy of the raw header lines strings array.
  - getCookies
```
public Vector<HttpCookie> getCookies()
```
    Gets the cookies associated with the request. The vector returned contains HttpCookie objects.
    The HttpCookie object only has the NAME and VALUE members set. Optionally the PATH and DOMAIN members are set for Version 1 cookies. All other members are null. Note: duplicate names may exist, typically with different paths or domains.
    
    Returns:
    
    The vector of cookies, but may be empty if no valid cookie definition was found.
    
    See Also:
    
    HttpCookie
  - getHeader
```
public String getHeader(String name)
```
    Get the header first of a certain index in the SHF_* strings or another user defined string.
    
    Parameters:
    
    name - The name of the header.
    
    Returns:
    
    null if not defined in the HTTP header.
  - getHeaders
```
public String[] getHeaders(String name)
```
    Get all header fields of a certain index in the SHF_* strings or another user defined string.
    
    Parameters:
    
    name - The name of the header.
    
    Returns:
    
    null if not defined in the HTTP header.
  - getHeaderFields
```
@Deprecated
public LinkedHashMap<String,String> getHeaderFields()
```
    Deprecated. "for-removal"
    
    Gets all the header fields into a (Hash)Map. The first request line is not included. All names (keys) are in lower case.
    
    See Also:
    
    #getAllHeaderFields()}
  - getAllHeaderFields
```
public LinkedHashMap<String,String[]> getAllHeaderFields()
```
    Gets all the first header fields of each type into a new LinkedHashMap. The first request line is not included. All names (keys) are in lower case.
    
    Returns:
    
    A new LinkedHashMap with the array of header fields values as array (no array is smaller than 1).
  - hasHostAddress
```
public boolean hasHostAddress()
```
    Checks if the header fields contains the "Host: address" header field that makes it value for a GET.
  - getHostAddress
```
public String getHostAddress()
```
    Gets the host address of a GET request.
    
    Returns:
    
    null if no such field is specified.
  - isFormData
```
public boolean isFormData()
```
    Checks if the data is used in conjuction with HTML forms, i.e. if the "Content-type" is "application/x-www-form-urlencoded".
  - isMultipartFormData
```
public boolean isMultipartFormData()
```
    Checks if the data is used in conjuction with HTML forms, i.e. if the "Content-type" is "multipart/form-data".
  - getMultipartBoundary
```
public String getMultipartBoundary()
```
    Get the multipart Content-type boundary.
  - isKeepAlive
```
public boolean isKeepAlive()
```
    Checks if the request is of "Keep-Alive" type. i.e. if the "Connection" is "Keep-Alive".
  - getContentLength
```
public int getContentLength()
```
    Gets the contents length.
    
    Returns:
    
    -1 if the header fields do not include a "Content-length" or the value cannot be read (and positive).
  - getHeadersIterator
```
public Iterator<String> getHeadersIterator()
```
    Gets the Iterator of header field keys.
  - getHeadersSet
```
public Set<String> getHeadersSet()
```
    Get enumeration of header field keys.
  - getHeaderEntrySet
```
@Deprecated
public Set<Map.Entry<String,String>> getHeaderEntrySet()
```
    Deprecated. "for-removal"
    
    Gets the entry set of header fields.
    
    See Also:
    
    #getAllHeaderFields()}
  - getHeaders
```
@Deprecated
public Enumeration<String> getHeaders()
```
    Deprecated. "for-removal"
    
    Get enumeration of header field keys.
    
    See Also:
    
    #getHeadersIterator()}

Class HttpHeaderFields

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SHF_Accept

SHF_Accept_Charset

SHF_Accept_Encoding

SHF_Accept_Language

SHF_Authorization

SHF_Connection

SHF_Content_Length

SHF_Content_Type

SHF_Expect

SHF_From

SHF_Host

SHF_Location

SHF_If_Match

SHF_If_Modified_Since

SHF_If_None_Match

SHF_If_Range

SHF_If_Unmodified_Since

SHF_Max_Forwards

SHF_Proxy_Authorization

SHF_Range

SHF_Referer

SHF_TE

SHF_User_Agent

SHF_WWW_Authorization

Constructor Detail

HttpHeaderFields

Method Detail

getRawHeaderLines

getCookies

getHeader

getHeaders

getHeaderFields

getAllHeaderFields

hasHostAddress

getHostAddress

isFormData

isMultipartFormData

getMultipartBoundary

isKeepAlive

getContentLength

getHeadersIterator

getHeadersSet

getHeaderEntrySet

getHeaders