Header (service-proxy-core 4.6.2 API)

java.lang.Object
- com.predic8.membrane.core.http.Header

```
public class Header
extends Object
```
The headers of a HTTP message.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACCEPT`
`static String`	`ACCESS_CONTROL_ALLOW_ORIGIN`
`static String`	`AUTHORIZATION`
`static String`	`CACHE_CONTROL`
`static String`	`CHUNKED`
`static String`	`CLOSE`
`static String`	`CONNECTION`
`static String`	`CONTENT_ENCODING`
`static String`	`CONTENT_LENGTH`
`static String`	`CONTENT_TYPE`
`static String`	`COOKIE`
`static String`	`DESTINATION`
`static String`	`EXPECT`
`static String`	`EXPIRES`
`static String`	`HOST`
`static String`	`IF_MODIFIED_SINCE`
`static String`	`KEEP_ALIVE`
`static String`	`LAST_MODIFIED`
`static String`	`LOCATION`
`static String`	`MAX`
`static String`	`ORIGIN`
`static String`	`PRAGMA`
`static String`	`PROXY_AUTHORIZATION`
`static String`	`PROXY_CONNECTION`
`static String`	`SERVER`
`static String`	`SET_COOKIE`
`static String`	`SOAP_ACTION`
`static String`	`TIMEOUT`
`static String`	`TRANSFER_ENCODING`
`static String`	`UPGRADE`
`static String`	`USER_AGENT`
`static String`	`VALIDATION_ERROR_SOURCE`
`static String`	`WWW_AUTHENTICATE`
`static String`	`X_FORWARDED_FOR`
`static String`	`X_FORWARDED_HOST`
`static String`	`X_FORWARDED_PROTO`
`static String`	`X_HTTP_METHOD_OVERRIDE`
`static String`	`X_REQUESTED_WITH`

Constructor Summary

Constructors
Constructor and Description

Header()

Header(Header header)

Header(InputStream in)

Header(String header)

Constructors
Constructor and Description
`Header()`
`Header(Header header)`
`Header(InputStream in)`
`Header(String header)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(HeaderField field)`
`void`	`add(String key, String val)`
`void`	`addCookieSession(String cookieName, String value)`
`void`	`clear()`
`static org.springframework.http.MediaType[]`	`convertStringsToMediaType(String[] mediaTypes)`
`int`	`estimateHeapSize()`
`String`	`getAccept()`
`HeaderField[]`	`getAllHeaderFields()`
`String`	`getAuthorization()`
`int`	`getBestAcceptedType(org.springframework.http.MediaType[] supported)` Tries to determines the index of the best content type.
`String`	`getCharset()`
`String`	`getConnection()`
`String`	`getContentEncoding()`
`long`	`getContentLength()`
`String`	`getContentType()`
`javax.mail.internet.ContentType`	`getContentTypeObject()`
`String`	`getFirstCookie(String cookieName)`
`String`	`getFirstValue(String name)`
`String`	`getHost()`
`String`	`getNormalizedValue(String headerName)`
`int`	`getNumberOf(String headerName)`
`String`	`getProxyConnection()`
`String`	`getSOAPAction()`
`String`	`getUserAgent()`
`List<HeaderField>`	`getValues(HeaderName headerName)`
`String`	`getWwwAuthenticate()`
`String`	`getXForwardedFor()`
`String`	`getXForwardedHost()`
`String`	`getXForwardedProto()`
`boolean`	`hasContentLength()`
`boolean`	`is100ContinueExpected()`
`boolean`	`isBinaryContentType()`
`boolean`	`isChunked()`
`boolean`	`isConnectionClose()`
`boolean`	`isProxyConnectionClose()`
`boolean`	`isUserAgentSupportsSNI()`
`static long`	`parseKeepAliveHeader(String keepAliveHeaderValue, String paramName)`
`void`	`remove(HeaderField field)`
`void`	`removeFields(String name)`
`void`	`setAccept(String value)`
`void`	`setAuthorization(String user, String password)`
`void`	`setConnection(String connection)`
`void`	`setContentLength(long length)`
`void`	`setContentType(String value)`
`void`	`setHost(String value)`
`void`	`setNoCacheResponseHeaders()`
`void`	`setProxyAutorization(String value)`
`void`	`setProxyConnection(String connection)`
`void`	`setSOAPAction(String value)`
`void`	`setValue(String name, String value)`
`void`	`setWwwAuthenticate(String params)`
`void`	`setXForwardedFor(String value)`
`void`	`setXForwardedHost(String xForwardedHostHeaderValue)`
`void`	`setXForwardedProto(String value)`
`String`	`toString()`
`void`	`write(OutputStream out)` Since `HttpUtil.readLine(InputStream)` assembles the String byte-by-byte converting it to char-by-char, we use ISO-8859-1 for output here.

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

Field Detail

TRANSFER_ENCODING

public static final String TRANSFER_ENCODING

See Also:: Constant Field Values

CONTENT_ENCODING

public static final String CONTENT_ENCODING

See Also:: Constant Field Values

CONTENT_LENGTH

public static final String CONTENT_LENGTH

See Also:: Constant Field Values

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:: Constant Field Values

CONNECTION
```
public static final String CONNECTION
```
See Also:

Constant Field Values

PROXY_CONNECTION

public static final String PROXY_CONNECTION

See Also:: Constant Field Values

HOST
```
public static final String HOST
```
See Also:

Constant Field Values

EXPECT
```
public static final String EXPECT
```
See Also:

Constant Field Values

X_FORWARDED_FOR

public static final String X_FORWARDED_FOR

See Also:: Constant Field Values

X_FORWARDED_PROTO

public static final String X_FORWARDED_PROTO

See Also:: Constant Field Values

X_FORWARDED_HOST

public static final String X_FORWARDED_HOST

See Also:: Constant Field Values

PROXY_AUTHORIZATION

public static final String PROXY_AUTHORIZATION

See Also:: Constant Field Values

SOAP_ACTION
```
public static final String SOAP_ACTION
```
See Also:

Constant Field Values

ACCEPT
```
public static final String ACCEPT
```
See Also:

Constant Field Values

LOCATION
```
public static final String LOCATION
```
See Also:

Constant Field Values

AUTHORIZATION

public static final String AUTHORIZATION

See Also:: Constant Field Values

SET_COOKIE
```
public static final String SET_COOKIE
```
See Also:

Constant Field Values

COOKIE
```
public static final String COOKIE
```
See Also:

Constant Field Values

DESTINATION
```
public static final String DESTINATION
```
See Also:

Constant Field Values

VALIDATION_ERROR_SOURCE

public static final String VALIDATION_ERROR_SOURCE

See Also:: Constant Field Values

USER_AGENT
```
public static final String USER_AGENT
```
See Also:

Constant Field Values

X_REQUESTED_WITH

public static final String X_REQUESTED_WITH

See Also:: Constant Field Values

EXPIRES
```
public static final String EXPIRES
```
See Also:

Constant Field Values

KEEP_ALIVE
```
public static final String KEEP_ALIVE
```
See Also:

Constant Field Values

SERVER
```
public static final String SERVER
```
See Also:

Constant Field Values

PRAGMA
```
public static final String PRAGMA
```
See Also:

Constant Field Values

CACHE_CONTROL

public static final String CACHE_CONTROL

See Also:: Constant Field Values

UPGRADE
```
public static final String UPGRADE
```
See Also:

Constant Field Values

LAST_MODIFIED

public static final String LAST_MODIFIED

See Also:: Constant Field Values

IF_MODIFIED_SINCE

public static final String IF_MODIFIED_SINCE

See Also:: Constant Field Values

WWW_AUTHENTICATE

public static final String WWW_AUTHENTICATE

See Also:: Constant Field Values

ACCESS_CONTROL_ALLOW_ORIGIN

public static final String ACCESS_CONTROL_ALLOW_ORIGIN

See Also:: Constant Field Values

ORIGIN
```
public static final String ORIGIN
```
See Also:

Constant Field Values

X_HTTP_METHOD_OVERRIDE

public static final String X_HTTP_METHOD_OVERRIDE

See Also:: Constant Field Values

CHUNKED
```
public static final String CHUNKED
```
See Also:

Constant Field Values

TIMEOUT
```
public static final String TIMEOUT
```
See Also:

Constant Field Values

MAX
```
public static final String MAX
```
See Also:

Constant Field Values

CLOSE
```
public static final String CLOSE
```
See Also:

Constant Field Values

Constructor Detail

Header
```
public Header()
```

Header

public Header(InputStream in)
       throws IOException,
              EndOfStreamException

Throws:: IOException; EndOfStreamException

Header

public Header(String header)
       throws IOException,
              EndOfStreamException

Throws:: IOException; EndOfStreamException

Header
```
public Header(Header header)
```

Method Detail

add

public void add(String key,
                String val)

add
```
public void add(HeaderField field)
```

remove

public void remove(HeaderField field)

removeFields

public void removeFields(String name)

getValues

public List<HeaderField> getValues(HeaderName headerName)

getFirstValue

public String getFirstValue(String name)

getAllHeaderFields

public HeaderField[] getAllHeaderFields()

write
```
public void write(OutputStream out)
           throws IOException
```
Since HttpUtil.readLine(InputStream) assembles the String byte-by-byte converting it to char-by-char, we use ISO-8859-1 for output here.

Throws:

IOException

setValue

public void setValue(String name,
                     String value)

setHost
```
public void setHost(String value)
```

setContentLength

public void setContentLength(long length)

setProxyAutorization

public void setProxyAutorization(String value)

isChunked
```
public boolean isChunked()
```

getContentLength
```
public long getContentLength()
```

getContentType
```
public String getContentType()
```

getContentTypeObject
```
public javax.mail.internet.ContentType getContentTypeObject()
                                                     throws javax.mail.internet.ParseException
```
Returns:

An object describing the value of the "Content-Type" HTTP header. Null, if the header is not present.

Throws:

javax.mail.internet.ParseException - if the value of the header could not be parsed.

setContentType

public void setContentType(String value)

getSOAPAction
```
public String getSOAPAction()
```

setSOAPAction

public void setSOAPAction(String value)

getAccept
```
public String getAccept()
```

setAccept
```
public void setAccept(String value)
```

getConnection
```
public String getConnection()
```

setConnection

public void setConnection(String connection)

getProxyConnection
```
public String getProxyConnection()
```

setProxyConnection

public void setProxyConnection(String connection)

isProxyConnectionClose

public boolean isProxyConnectionClose()

isConnectionClose
```
public boolean isConnectionClose()
```

hasContentLength
```
public boolean hasContentLength()
```

getHost
```
public String getHost()
```

is100ContinueExpected

public boolean is100ContinueExpected()

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

toString in class Object

setAuthorization

public void setAuthorization(String user,
                             String password)
                      throws UnsupportedEncodingException

Throws:: UnsupportedEncodingException

setXForwardedFor

public void setXForwardedFor(String value)

getXForwardedFor
```
public String getXForwardedFor()
```

setXForwardedProto

public void setXForwardedProto(String value)

getXForwardedProto
```
public String getXForwardedProto()
```

getContentEncoding
```
public String getContentEncoding()
```

getUserAgent
```
public String getUserAgent()
```

getCharset
```
public String getCharset()
```

addCookieSession

public void addCookieSession(String cookieName,
                             String value)

getFirstCookie

public String getFirstCookie(String cookieName)

estimateHeapSize
```
public int estimateHeapSize()
```

getBestAcceptedType

public int getBestAcceptedType(org.springframework.http.MediaType[] supported)

Tries to determines the index of the best content type.

convertStringsToMediaType

public static org.springframework.http.MediaType[] convertStringsToMediaType(String[] mediaTypes)

getNumberOf

public int getNumberOf(String headerName)

parseKeepAliveHeader
```
public static long parseKeepAliveHeader(String keepAliveHeaderValue,
                                        String paramName)
```
Parameters:

keepAliveHeaderValue - the value of the "Keep-Alive" header, see http://www.w3.org/Protocols/HTTP/1.1/draft-ietf-http-v11-spec-01.html#Keep-Alive

paramName - either TIMEOUT or MAX.

Returns:

the extracted parameter value of the "Keep-Alive" header

clear
```
public void clear()
```

isUserAgentSupportsSNI

public boolean isUserAgentSupportsSNI()

setNoCacheResponseHeaders

public void setNoCacheResponseHeaders()

getAuthorization
```
public String getAuthorization()
```

setWwwAuthenticate

public void setWwwAuthenticate(String params)

getWwwAuthenticate
```
public String getWwwAuthenticate()
```

getNormalizedValue

public String getNormalizedValue(String headerName)

isBinaryContentType
```
public boolean isBinaryContentType()
```

getXForwardedHost
```
public String getXForwardedHost()
```

setXForwardedHost

public void setXForwardedHost(String xForwardedHostHeaderValue)

Class Header

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TRANSFER_ENCODING

CONTENT_ENCODING

CONTENT_LENGTH

CONTENT_TYPE

CONNECTION

PROXY_CONNECTION

HOST

EXPECT

X_FORWARDED_FOR

X_FORWARDED_PROTO

X_FORWARDED_HOST

PROXY_AUTHORIZATION

SOAP_ACTION

ACCEPT

LOCATION

AUTHORIZATION

SET_COOKIE

COOKIE

DESTINATION

VALIDATION_ERROR_SOURCE

USER_AGENT

X_REQUESTED_WITH

EXPIRES

KEEP_ALIVE

SERVER

PRAGMA

CACHE_CONTROL

UPGRADE

LAST_MODIFIED

IF_MODIFIED_SINCE

WWW_AUTHENTICATE

ACCESS_CONTROL_ALLOW_ORIGIN

ORIGIN

X_HTTP_METHOD_OVERRIDE

CHUNKED

TIMEOUT

MAX

CLOSE

Constructor Detail

Header

Header

Header

Header

Method Detail

add

add

remove

removeFields

getValues

getFirstValue

getAllHeaderFields

write

setValue

setHost

setContentLength

setProxyAutorization

isChunked

getContentLength

getContentType

getContentTypeObject

setContentType

getSOAPAction

setSOAPAction

getAccept

setAccept

getConnection

setConnection

getProxyConnection

setProxyConnection

isProxyConnectionClose

isConnectionClose

hasContentLength

getHost

is100ContinueExpected