org.jwat.common

Class HttpHeader

java.lang.Object

org.jwat.common.PayloadWithHeaderAbstract

org.jwat.common.HttpHeader

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class HttpHeader
extends PayloadWithHeaderAbstract

This class represents a recognized HTTP response or request header with optional payload.

Author:

lbihanic, selghissassi, nicl

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	CONTENT_TYPE Content-type header name.
java.lang.String	contentType HTTP content Content-type.
protected java.util.List<HeaderLine>	headerList List of parsed header fields.
protected java.util.Map<java.lang.String,HeaderLine>	headerMap Map of parsed header fields.
int	headerType Header type of this object.
static int	HT_REQUEST Request header type.
static int	HT_RESPONSE Response header type.
protected static java.lang.String	HTTP_VERSION_SUFFIX HTTP Version suffix.
java.lang.String	httpVersion HTTP-Version.
java.lang.Integer	httpVersionMajor HTTP-Version major.
java.lang.Integer	httpVersionMinor HTTP-Version minor.
java.lang.String	method HTTP Method.
static java.lang.String	PROTOCOL_HTTP HTTP scheme.
static java.lang.String	PROTOCOL_HTTPS HTTPS scheme.
java.lang.String	reasonPhrase HTTP Reason-Phrase.
java.lang.String	requestUri HTTP Request-URI.
java.lang.Integer	statusCode HTTP Status-Code.
java.lang.String	statusCodeStr HTTP Status-Code.

Fields inherited from class org.jwat.common.PayloadWithHeaderAbstract

bClosed, bIsValid, bNoSuchAlgorithmException, diagnostics, digest, digestAlgorithm, header, in_complete, in_digest, in_flr, in_payload, in_pb, in_pb_exposed, md, payloadLength, totalLength

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HttpHeader() Non public constructor.

Method Summary

Modifier and Type	Method and Description
HeaderLine	getHeader(java.lang.String field) Get a header line structure or null, if no header line structure is stored with the given header name.
java.util.List<HeaderLine>	getHeaderList() Get a List of all the headers found during parsing.
java.lang.String	getProtocolContentType() Content-Type getter
java.lang.Integer	getProtocolStatusCode() Result-Code integer getter
java.lang.String	getProtocolStatusCodeStr() Result-Code string getter
java.lang.String	getProtocolVersion() protocolVersion getter
protected boolean	isHttpRequestLineValid(java.lang.String requestLine) Checks a HTTP Request Request-Line for validity.
protected boolean	isHttpStatusLineValid(java.lang.String statusLine) Checks a HTTP Response Status-Line for validity.
protected boolean	isHttpVersionValid(java.lang.String versionString) Checks a HTTP-Version string for validity.
static boolean	isSupported(java.lang.String protocol) Boolean indicating whether a protocol is supported by this payload inspector.
static HttpHeader	processPayload(int headerType, ByteCountingPushBackInputStream pbin, long length, java.lang.String digestAlgorithm) Reads the HTTP protocol response or request and returns it as an object.
protected boolean	readHeader(MaxLengthRecordingInputStream in, long payloadLength) Reads the header and updates the payloadLength field if the header is valid.
java.lang.String	toString()

Methods inherited from class org.jwat.common.PayloadWithHeaderAbstract

close, getDigest, getHeader, getInputStreamComplete, getPayloadInputStream, getPayloadLength, getRemaining, getTotalLength, getUnavailable, initProcess, isClosed, isValid

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

HT_RESPONSE

public static final int HT_RESPONSE

Response header type.

See Also:

Constant Field Values

HT_REQUEST

public static final int HT_REQUEST

Request header type.

See Also:

Constant Field Values

PROTOCOL_HTTP

public static final java.lang.String PROTOCOL_HTTP

HTTP scheme.

See Also:

Constant Field Values

PROTOCOL_HTTPS

public static final java.lang.String PROTOCOL_HTTPS

HTTPS scheme.

See Also:

Constant Field Values

HTTP_VERSION_SUFFIX

protected static final java.lang.String HTTP_VERSION_SUFFIX

HTTP Version suffix.

See Also:

Constant Field Values

CONTENT_TYPE

protected static final java.lang.String CONTENT_TYPE

Content-type header name.

headerType

public int headerType

Header type of this object.

method

public java.lang.String method

HTTP Method.

requestUri

public java.lang.String requestUri

HTTP Request-URI.

httpVersion

public java.lang.String httpVersion

HTTP-Version.

httpVersionMajor

public java.lang.Integer httpVersionMajor

HTTP-Version major.

httpVersionMinor

public java.lang.Integer httpVersionMinor

HTTP-Version minor.

statusCodeStr

public java.lang.String statusCodeStr

HTTP Status-Code.

statusCode

public java.lang.Integer statusCode

HTTP Status-Code.

reasonPhrase

public java.lang.String reasonPhrase

HTTP Reason-Phrase.

headerList

protected java.util.List<HeaderLine> headerList

List of parsed header fields.

headerMap

protected java.util.Map<java.lang.String,HeaderLine> headerMap

Map of parsed header fields.

contentType

public java.lang.String contentType

HTTP content Content-type.

Constructor Detail

HttpHeader

protected HttpHeader()

Non public constructor.

Method Detail

isSupported

public static boolean isSupported(java.lang.String protocol)

Boolean indicating whether a protocol is supported by this payload inspector.

Parameters:

protocol - protocol name

Returns:

true/false if the protocol is supported or not.

processPayload

public static HttpHeader processPayload(int headerType,
                                        ByteCountingPushBackInputStream pbin,
                                        long length,
                                        java.lang.String digestAlgorithm)
                                 throws java.io.IOException

Reads the HTTP protocol response or request and returns it as an object. It is important to understand that the maximum size of a parsed header is equal to the size of the PushbackInputStream's buffer!

Parameters:

headerType - HTTP header type to parse, request or response

pbin - payload input stream

length - payload length

digestAlgorithm - digest algorithm to use on payload or null if we don't want a digest of the payload

Returns:

HttpResponse based on the http headers

Throws:

java.io.IOException - if an error occur while processing http header.

readHeader

protected boolean readHeader(MaxLengthRecordingInputStream in,
                             long payloadLength)
                      throws java.io.IOException

Description copied from class: PayloadWithHeaderAbstract

Reads the header and updates the payloadLength field if the header is valid.

Specified by:

readHeader in class PayloadWithHeaderAbstract

Parameters:

in - the input stream to parse.

payloadLength - the record length.

Returns:

boolean indicating whether the header could be read

Throws:

java.io.IOException - I/O exception while reading headers

isHttpStatusLineValid

protected boolean isHttpStatusLineValid(java.lang.String statusLine)

Checks a HTTP Response Status-Line for validity.

Parameters:

statusLine - the Status-Line of the HTTP Response

Returns:

true/false based on whether the Status-Line is valid or not.

isHttpVersionValid

protected boolean isHttpVersionValid(java.lang.String versionString)

Checks a HTTP-Version string for validity.

Parameters:

versionString - the HTTP-Version of the HTTP header

Returns:

true/false based on whether the HTTP-Version is valid or not.

isHttpRequestLineValid

protected boolean isHttpRequestLineValid(java.lang.String requestLine)

Checks a HTTP Request Request-Line for validity.

Parameters:

requestLine - the Request-Line of the HTTP Request

Returns:

true/false based on whether the Request-Line is valid or not.

getHeaderList

public java.util.List<HeaderLine> getHeaderList()

Description copied from class: PayloadWithHeaderAbstract

Get a List of all the headers found during parsing.

Overrides:

getHeaderList in class PayloadWithHeaderAbstract

Returns:

List of HeaderLine

getHeader

public HeaderLine getHeader(java.lang.String field)

Description copied from class: PayloadWithHeaderAbstract

Get a header line structure or null, if no header line structure is stored with the given header name.

Overrides:

getHeader in class PayloadWithHeaderAbstract

Parameters:

field - header name

Returns:

HeaderLine structure or null

getProtocolStatusCodeStr

public java.lang.String getProtocolStatusCodeStr()

Result-Code string getter

Returns:

the ResultCode

getProtocolStatusCode

public java.lang.Integer getProtocolStatusCode()

Result-Code integer getter

Returns:

the ResultCode

getProtocolVersion

public java.lang.String getProtocolVersion()

protocolVersion getter

Returns:

the protocolVersion

getProtocolContentType

public java.lang.String getProtocolContentType()

Content-Type getter

Returns:

the Content-Type

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object