PayloadWithHeaderAbstract (JWAT common 1.2.1 API)

java.lang.Object
- org.jwat.common.PayloadWithHeaderAbstract

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

HttpHeader
```
public abstract class PayloadWithHeaderAbstract
extends java.lang.Object
implements java.io.Closeable
```
Abstract base class for payload types that include a header. The header is parse and validated. If the header is valid the header is exposed as a byte array including optionally extra data implemented as fields, the rest of the payload is exposed as the complete payload of this object. If on the other hand the header is not valid the input stream is left as is so the complete payload can be read instead. Streams are also available to read the complete payload even though the header has been identified and parsed into optional extra fields.

Author:

nicl

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`bClosed` Has record been closed before.
`protected boolean`	`bIsValid` Could the header be validated.
`protected boolean`	`bNoSuchAlgorithmException` Boolean indicating no such algorithm exception under initialization.
`Diagnostics`	`diagnostics` Validation errors and warnings.
`protected byte[]`	`digest` Digest bytes.
`protected java.lang.String`	`digestAlgorithm`
`protected byte[]`	`header` The raw header read as bytes.
`protected java.io.SequenceInputStream`	`in_complete` Sequence of the header as a stream combined with the payload stream.
`protected java.security.DigestInputStream`	`in_digest` Automatic digesting of payload input stream.
`protected MaxLengthRecordingInputStream`	`in_flr` Stream used to ensure we don't use more than the pushback buffer on headers and at the same time store everything read in an array.
`protected java.io.InputStream`	`in_payload` Payload stream returned to user.
`protected ByteCountingPushBackInputStream`	`in_pb` `InputStream` to read payload.
`protected ByteCountingPushBackInputStream`	`in_pb_exposed` Pushback input stream exposed to the outside.
`protected java.security.MessageDigest`	`md` Message digest object.
`long`	`payloadLength` Object size, in bytes.
`protected long`	`totalLength` Payload length.

Constructor Summary

Constructors
Constructor and Description

PayloadWithHeaderAbstract()

Constructors
Constructor and Description
`PayloadWithHeaderAbstract()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Closes the this payload stream, skipping unread bytes in the process.
`byte[]`	`getDigest()` Returns the `MessageDigest` used on payload stream.
`byte[]`	`getHeader()` Get the raw header as bytes.
`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.io.InputStream`	`getInputStreamComplete()` Get an `InputStream` containing both the header and the payload.
`ByteCountingPushBackInputStream`	`getPayloadInputStream()` Get an `InputStream` containing only the payload.
`long`	`getPayloadLength()` Get HTTP payload length.
`long`	`getRemaining()` Get payload remaining length.
`long`	`getTotalLength()` Get payload total length, header and payload.
`long`	`getUnavailable()` Get the number of unavailable bytes missing due to unexpected EOF.
`protected void`	`initProcess()`
`boolean`	`isClosed()` Check to see if the header has been closed.
`boolean`	`isValid()` Returns the result of the header validation.
`protected abstract boolean`	`readHeader(MaxLengthRecordingInputStream in, long payloadLength)` Reads the header and updates the payloadLength field if the header is valid.

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

- Field Detail
  - bClosed
```
protected boolean bClosed
```
    Has record been closed before.
  - in_pb
```
protected ByteCountingPushBackInputStream in_pb
```
    InputStream to read payload.
  - totalLength
```
protected long totalLength
```
    Payload length.
  - digestAlgorithm
```
protected java.lang.String digestAlgorithm
```
  - bIsValid
```
protected boolean bIsValid
```
    Could the header be validated.
  - in_flr
```
protected MaxLengthRecordingInputStream in_flr
```
    Stream used to ensure we don't use more than the pushback buffer on headers and at the same time store everything read in an array.
  - header
```
protected byte[] header
```
    The raw header read as bytes.
  - md
```
protected java.security.MessageDigest md
```
    Message digest object.
  - digest
```
protected byte[] digest
```
    Digest bytes.
  - in_digest
```
protected java.security.DigestInputStream in_digest
```
    Automatic digesting of payload input stream.
  - bNoSuchAlgorithmException
```
protected boolean bNoSuchAlgorithmException
```
    Boolean indicating no such algorithm exception under initialization.
  - in_payload
```
protected java.io.InputStream in_payload
```
    Payload stream returned to user.
  - in_pb_exposed
```
protected ByteCountingPushBackInputStream in_pb_exposed
```
    Pushback input stream exposed to the outside.
  - in_complete
```
protected java.io.SequenceInputStream in_complete
```
    Sequence of the header as a stream combined with the payload stream.
  - payloadLength
```
public long payloadLength
```
    Object size, in bytes.
  - diagnostics
```
public Diagnostics diagnostics
```
    Validation errors and warnings.
- Constructor Detail
  - PayloadWithHeaderAbstract
```
public PayloadWithHeaderAbstract()
```
- Method Detail
  - initProcess
```
protected void initProcess()
                    throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - readHeader
```
protected abstract boolean readHeader(MaxLengthRecordingInputStream in,
                                      long payloadLength)
                               throws java.io.IOException
```
    Reads the header and updates the payloadLength field if the header is valid.
    
    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
  - getHeaderList
```
public java.util.List<HeaderLine> getHeaderList()
```
    Get a List of all the headers found during parsing.
    
    Returns:
    
    List of HeaderLine
  - getHeader
```
public 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.
    
    Parameters:
    
    field - header name
    
    Returns:
    
    HeaderLine structure or null
  - isValid
```
public boolean isValid()
```
    Returns the result of the header validation.
    
    Returns:
    
    the result of the header validation
  - getHeader
```
public byte[] getHeader()
```
    Get the raw header as bytes.
    
    Returns:
    
    raw header as bytes
  - getDigest
```
public byte[] getDigest()
```
    Returns the MessageDigest used on payload stream.
    
    Returns:
    
    MessageDigest used on payload stream
  - getPayloadLength
```
public long getPayloadLength()
```
    Get HTTP payload length.
    
    Returns:
    
    HTTP payload length
  - getTotalLength
```
public long getTotalLength()
```
    Get payload total length, header and payload.
    
    Returns:
    
    payload total length, header and payload
  - getUnavailable
```
public long getUnavailable()
                    throws java.io.IOException
```
    Get the number of unavailable bytes missing due to unexpected EOF. This method always returns 0 as long as the stream is open.
    
    Returns:
    
    number of unavailable bytes missing due to unexpected EOF
    
    Throws:
    
    java.io.IOException - if errors occur calling available method on stream
  - getInputStreamComplete
```
public java.io.InputStream getInputStreamComplete()
```
    Get an InputStream containing both the header and the payload.
    
    Returns:
    
    InputStream containing both the header and the payload.
  - getPayloadInputStream
```
public ByteCountingPushBackInputStream getPayloadInputStream()
```
    Get an InputStream containing only the payload.
    
    Returns:
    
    InputStream containing only the payload.
  - getRemaining
```
public long getRemaining()
                  throws java.io.IOException
```
    Get payload remaining length.
    
    Returns:
    
    payload remaining length
    
    Throws:
    
    java.io.IOException - if errors occur calling available method on stream
  - isClosed
```
public boolean isClosed()
```
    Check to see if the header has been closed.
    
    Returns:
    
    boolean indicating whether this header is closed or not
  - close
```
public void close()
           throws java.io.IOException
```
    Closes the this payload stream, skipping unread bytes in the process.
    
    Specified by:
    
    close in interface java.io.Closeable
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Throws:
    
    java.io.IOException - I/O exception in closing process

Class PayloadWithHeaderAbstract

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

bClosed

in_pb

totalLength

digestAlgorithm

bIsValid

in_flr

header

md

digest

in_digest

bNoSuchAlgorithmException

in_payload

in_pb_exposed

in_complete

payloadLength

diagnostics

Constructor Detail

PayloadWithHeaderAbstract

Method Detail

initProcess

readHeader

getHeaderList

getHeader

isValid

getHeader

getDigest

getPayloadLength

getTotalLength

getUnavailable

getInputStreamComplete

getPayloadInputStream

getRemaining

isClosed

close