HttpHeader (BandM metatools API doc)

java.lang.Object
- eu.bandm.tools.util.HttpHeader

```
public class HttpHeader
extends Object
```
Consumes input from an Inputstream and stores it in key/value pairs, as long as no empty line is found. Typical usage pattern is new HttpHeader().read(socket.getInputStream()); The InputStream is left for further reading. The first line in split into the pseudo-header-parameters method, uri and httpVersion.

Field Summary

Fields
Modifier and Type	Field and Description
`static char`	`BL`
`protected char`	`c`
`static char`	`colon`
`static char`	`CR`
`static String`	`CRLF`
`static char`	`DOT`
`static char`	`EQUAL`
`static char`	`HASH`
`protected InputStream`	`in`
`static String`	`KEY_allcookies`
`static String`	`KEY_contentLength`
`static String`	`KEY_contentType`
`static String`	`KEY_httpVersion`
`static String`	`KEY_method`
`static String`	`KEY_uri` uri is the FULL uri with fragment id AND parameters! For retrievig SUB-PARTICLES access methods are MISSING.
`Map<String,String>`	`keyValue`
`static char`	`LF`
`static String`	`method_CONNECT`
`static String`	`method_DELETE`
`static String`	`method_GET`
`static String`	`method_HEAD`
`static String`	`method_OPTIONS`
`static String`	`method_POST`
`static String`	`method_PUT`
`static String`	`method_TRACE`
`static String`	`MULTISEP`
`static char`	`QUEST`
`static char`	`SEMI`
`static char`	`SLASH`
`static String`	`statusline_404`
`static String`	`statusline_OK`
`static char`	`TAB`
`protected String`	`uri`

Constructor Summary

Constructors
Constructor and Description

HttpHeader()

Constructors
Constructor and Description
`HttpHeader()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected String`	`afterFirstOrEmpty(String s, char c)`
`protected String`	`afterLastOrAll(String s, char c)`
`protected String`	`afterLastOrEmpty(String s, char c)`
`protected String`	`afterOrAlternative(String s, String alt, int i)`
`protected String`	`beforeFirstOrAll(String s, char c)`
`protected String`	`beforeLastOrAll(String s, char c)`
`protected String`	`beforeOrAlternative(String s, String alt, int i)`
`String`	`extractCookie(String name)` ASSUME cookies come in simple form, no attributes, paths etc.
`String`	`get(String key)` return the value of a certain key from the html header, null in case there is no entry.
`int`	`getContentLength()` return the value of the parameter with name `KEY_contentLength`.
`static boolean`	`isBlank(char c)`
`void`	`read(InputStream in)`
`protected void`	`readC()`
`protected String`	`readToken(String key)`
`String`	`toString()`
`String`	`uriFragment()` Return only fragment part of uri
`String`	`uriLowestFilename()`
`String`	`uriLowestFilenameNoSuffix()`
`String`	`uriLowestSuffix()`
`String`	`uriNoFragment()` Strip fragment from the uri.
`String`	`uriNoParametersNorFragment()` Strip parameters and fragment from the uri.
`String`	`uriParameters()` Return only parameters part of uri
`String`	`uriPathOnly()` Returns only the path component.
`String`	`uriPathOnlyNoSuffix()`

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

Field Detail
- KEY_method
```
public static final String KEY_method
```
  See Also:
  
  Constant Field Values
- KEY_uri
```
public static final String KEY_uri
```
  uri is the FULL uri with fragment id AND parameters! For retrievig SUB-PARTICLES access methods are MISSING. FIXME.
  
  See Also:
  
  Constant Field Values
- KEY_httpVersion
```
public static final String KEY_httpVersion
```
  See Also:
  
  Constant Field Values
- KEY_contentLength
```
public static final String KEY_contentLength
```
  See Also:
  
  Constant Field Values
- KEY_contentType
```
public static final String KEY_contentType
```
  See Also:
  
  Constant Field Values
- KEY_allcookies
```
public static final String KEY_allcookies
```
  See Also:
  
  Constant Field Values
- LF
```
public static final char LF
```
  See Also:
  
  Constant Field Values
- CR
```
public static final char CR
```
  See Also:
  
  Constant Field Values
- colon
```
public static final char colon
```
  See Also:
  
  Constant Field Values
- BL
```
public static final char BL
```
  See Also:
  
  Constant Field Values
- TAB
```
public static final char TAB
```
  See Also:
  
  Constant Field Values
- MULTISEP
```
public static final String MULTISEP
```
  See Also:
  
  Constant Field Values
- QUEST
```
public static final char QUEST
```
  See Also:
  
  Constant Field Values
- HASH
```
public static final char HASH
```
  See Also:
  
  Constant Field Values
- SLASH
```
public static final char SLASH
```
  See Also:
  
  Constant Field Values
- DOT
```
public static final char DOT
```
  See Also:
  
  Constant Field Values
- EQUAL
```
public static final char EQUAL
```
  See Also:
  
  Constant Field Values
- SEMI
```
public static final char SEMI
```
  See Also:
  
  Constant Field Values
- method_OPTIONS
```
public static final String method_OPTIONS
```
  See Also:
  
  Constant Field Values
- method_GET
```
public static final String method_GET
```
  See Also:
  
  Constant Field Values
- method_HEAD
```
public static final String method_HEAD
```
  See Also:
  
  Constant Field Values
- method_POST
```
public static final String method_POST
```
  See Also:
  
  Constant Field Values
- method_PUT
```
public static final String method_PUT
```
  See Also:
  
  Constant Field Values
- method_DELETE
```
public static final String method_DELETE
```
  See Also:
  
  Constant Field Values
- method_TRACE
```
public static final String method_TRACE
```
  See Also:
  
  Constant Field Values
- method_CONNECT
```
public static final String method_CONNECT
```
  See Also:
  
  Constant Field Values
- statusline_OK
```
public static final String statusline_OK
```
  See Also:
  
  Constant Field Values
- statusline_404
```
public static final String statusline_404
```
  See Also:
  
  Constant Field Values
- CRLF
```
public static final String CRLF
```
  See Also:
  
  Constant Field Values
- c
```
protected char c
```
- in
```
protected InputStream in
```
- uri
```
protected String uri
```
- keyValue
```
public final Map<String,String> keyValue
```

Constructor Detail
- HttpHeader
```
public HttpHeader()
```

Method Detail

isBlank

public static boolean isBlank(char c)

toString
```
public String toString()
```
Overrides:

toString in class Object

get
```
public String get(String key)
```
return the value of a certain key from the html header, null in case there is no entry.

getContentLength
```
public int getContentLength()
                     throws IOException
```
return the value of the parameter with name KEY_contentLength. May only be called if such is present. Throws IOException if not parsable as integer value.

Throws:

IOException

beforeOrAlternative

protected String beforeOrAlternative(String s,
                                     String alt,
                                     int i)

afterOrAlternative

protected String afterOrAlternative(String s,
                                    String alt,
                                    int i)

beforeFirstOrAll

protected String beforeFirstOrAll(String s,
                                  char c)

afterFirstOrEmpty

protected String afterFirstOrEmpty(String s,
                                   char c)

beforeLastOrAll

protected String beforeLastOrAll(String s,
                                 char c)

afterLastOrAll

protected String afterLastOrAll(String s,
                                char c)

afterLastOrEmpty

protected String afterLastOrEmpty(String s,
                                  char c)

uriNoFragment
```
public String uriNoFragment()
```
Strip fragment from the uri.

uriNoParametersNorFragment
```
public String uriNoParametersNorFragment()
```
Strip parameters and fragment from the uri.

uriFragment
```
public String uriFragment()
```
Return only fragment part of uri

uriParameters
```
public String uriParameters()
```
Return only parameters part of uri

uriPathOnly
```
public String uriPathOnly()
                   throws IOException
```
Returns only the path component. Assume a server identification must be thrown away ONLY when "http://" is head of the string.

Throws:

IOException

uriLowestFilename

public String uriLowestFilename()
                         throws IOException

Throws:: IOException

uriLowestSuffix

public String uriLowestSuffix()
                       throws IOException

Throws:: IOException

uriLowestFilenameNoSuffix

public String uriLowestFilenameNoSuffix()
                                 throws IOException

Throws:: IOException

uriPathOnlyNoSuffix

public String uriPathOnlyNoSuffix()
                           throws IOException

Throws:: IOException

extractCookie
```
public String extractCookie(String name)
```
ASSUME cookies come in simple form, no attributes, paths etc. are decoded. Lead-in for cookie parameter is KEY_cookie.

readC

protected void readC()
              throws IOException

Throws:: IOException

readToken

protected String readToken(String key)
                    throws IOException

Throws:: IOException

read

public void read(InputStream in)
          throws IOException

Throws:: IOException

Class HttpHeader

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

KEY_method

KEY_uri

KEY_httpVersion

KEY_contentLength

KEY_contentType

KEY_allcookies

LF

CR

colon

BL

TAB

MULTISEP

QUEST

HASH

SLASH

DOT

EQUAL

SEMI

method_OPTIONS

method_GET

method_HEAD

method_POST

method_PUT

method_DELETE

method_TRACE

method_CONNECT

statusline_OK

statusline_404

CRLF

c

in

uri

keyValue

Constructor Detail

HttpHeader

Method Detail

isBlank

toString

get

getContentLength

beforeOrAlternative

afterOrAlternative

beforeFirstOrAll

afterFirstOrEmpty

beforeLastOrAll

afterLastOrAll

afterLastOrEmpty

uriNoFragment

uriNoParametersNorFragment

uriFragment

uriParameters

uriPathOnly

uriLowestFilename

uriLowestSuffix

uriLowestFilenameNoSuffix

uriPathOnlyNoSuffix

extractCookie

readC

readToken

read