Package com.predic8.membrane.core.http

Class Header

java.lang.Object

com.predic8.membrane.core.http.Header

public class Header
extends Object

The headers of an HTTP message.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
Header()
Header(Header header)
Header(InputStream in)
Header(String header)

Method Summary

Modifier and Type	Method	Description
void	add(HeaderField field)
void	add(String key, String val)
void	addCookieSession(String cookieName, String value)
void	addRawCookieSession(String cookie)
void	clear()
boolean	contains(HeaderName header)
boolean	contains(String header)
int	estimateHeapSize()
String	getAccept()
HeaderField[]	getAllHeaderFields()
String	getAuthorization()
String	getCharset()
String	getConnection()
String	getContentEncoding()
long	getContentLength()
String	getContentType()
jakarta.mail.internet.ContentType	getContentTypeObject()
String	getFirstCookie(String cookieName)
String	getFirstValue(HeaderName name)
String	getFirstValue(String name)
String	getHost()
String	getLocation()
String	getNormalizedValue(String headerName)
int	getNumberOf(String headerName)
String	getProxyConnection()
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()	Method can be used from Groovy or Javascripts
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 type)
void	setHost(String value)
void	setLocation(String location)
void	setNoCacheResponseHeaders()
void	setProxyAuthorization(String value)
void	setSOAPAction(String value)
void	setValue(String name, String value)
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 Details

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 Details

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 Details

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)

getFirstValue

public String getFirstValue(HeaderName name)

getAllHeaderFields

public HeaderField[] getAllHeaderFields()

contains

public boolean contains(String header)

contains

public boolean contains(HeaderName header)

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)

setProxyAuthorization

public void setProxyAuthorization(String value)

isChunked

public boolean isChunked()

getContentLength

public long getContentLength()

getContentType

public String getContentType()

getUserAgent

public String getUserAgent()

getContentTypeObject

public jakarta.mail.internet.ContentType getContentTypeObject()
                                                       throws jakarta.mail.internet.ParseException

Returns:

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

Throws:

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

setContentType

public void setContentType(String type)

setLocation

public void setLocation(String location)

getLocation

public String getLocation()

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()

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)

setXForwardedFor

public void setXForwardedFor(String value)

getXForwardedFor

public String getXForwardedFor()

setXForwardedProto

public void setXForwardedProto(String value)

getXForwardedProto

public String getXForwardedProto()

getContentEncoding

public String getContentEncoding()

getCharset

public String getCharset()

addCookieSession

public void addCookieSession(String cookieName,
 String value)

addRawCookieSession

public void addRawCookieSession(String cookie)

getFirstCookie

public String getFirstCookie(String cookieName)

estimateHeapSize

public int estimateHeapSize()

getNumberOf

public int getNumberOf(String headerName)

parseKeepAliveHeader

public static long parseKeepAliveHeader(String keepAliveHeaderValue,
 String paramName)

Parameters:

keepAliveHeaderValue - the value of the Keep-Alive header

paramName - either TIMEOUT or MAX.

Returns:

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

clear

public void clear()

setNoCacheResponseHeaders

public void setNoCacheResponseHeaders()

getAuthorization

public String getAuthorization()

getWwwAuthenticate

public String getWwwAuthenticate()

getNormalizedValue

public String getNormalizedValue(String headerName)

isBinaryContentType

public boolean isBinaryContentType()

getXForwardedHost

public String getXForwardedHost()

setXForwardedHost

public void setXForwardedHost(String xForwardedHostHeaderValue)

isUserAgentSupportsSNI

public boolean isUserAgentSupportsSNI()

Method can be used from Groovy or Javascripts