Payload (JWAT common 1.2.1 API)

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

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable
```
public class Payload
extends java.lang.Object
implements java.io.Closeable
```
This class makes the archived payload of an ARC/WARC record accessible through a stream. The stream is fixed length so only the payload is available.

Author:

lbihanic, selghissassi, nicl

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`bClosed` Has record been closed before.
`protected boolean`	`bNoSuchAlgorithmException` Boolean indicating no such algorithm exception under initialization.
`protected byte[]`	`digest` Digest bytes.
`protected java.io.BufferedInputStream`	`in_buffered` Payload content.
`protected java.security.DigestInputStream`	`in_digest` Automatic digesting of payload input stream.
`protected FixedLengthInputStream`	`in_fl` Base stream used to limit payload access to only the payload and not any record data beyond that.
`protected ByteCountingPushBackInputStream`	`in_pb_exposed` Pushback input stream exposed to the outside, usable by payload processors.
`protected long`	`length` Payload length.
`protected java.security.MessageDigest`	`md` Message digest object.
`protected PayloadOnClosedHandler`	`onClosedHandler` Handler called when this payloads stream has been fully consumed.
`protected PayloadWithHeaderAbstract`	`payloadHeaderWrapped` Header wrapped payload, if present.
`protected int`	`pushback_size` Pushback size.

Constructor Summary

Constructors
Modifier Constructor and Description

protected Payload()
Non public constructor.

Constructors
Modifier	Constructor and Description
`protected`	`Payload()` Non public constructor.

Method Summary

All Methods Static Methods Instance 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 calculated digest.
`ByteCountingPushBackInputStream`	`getInputStream()` Get `InputStream` to read the payload directly from the source bypassing any existing `HttpResponse` object.
`java.io.InputStream`	`getInputStreamComplete()` Get `InputStream` to read the complete payload even though a http response header may have been read.
`PayloadWithHeaderAbstract`	`getPayloadHeaderWrapped()` Get the `PayloadHeaderWrapper` object associated with this payload.
`int`	`getPushbackSize()` Get pushback buffer size.
`long`	`getRemaining()` Get payload remaining length.
`long`	`getTotalLength()` Get payload total length.
`long`	`getUnavailable()` Get the number of unavailable bytes missing due to unexpected EOF.
`boolean`	`isClosed()` Check to see if the payload has been closed.
`static Payload`	`processPayload(java.io.InputStream in, long length, int pushback_size, java.lang.String digestAlgorithm)` Creates new `ArcPayload` instance.
`void`	`setOnClosedHandler(PayloadOnClosedHandler onClosedHandler)` Set optional handler to be called when payload is closed.
`void`	`setPayloadHeaderWrapped(PayloadWithHeaderAbstract payloadHeaderWrapped)` Set `PayloadHeaderWrapper` object in case of recognized payload content.

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.
  - length
```
protected long length
```
    Payload length.
  - in_fl
```
protected FixedLengthInputStream in_fl
```
    Base stream used to limit payload access to only the payload and not any record data beyond that. Also detects unexpected EOF.
  - 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_buffered
```
protected java.io.BufferedInputStream in_buffered
```
    Payload content.
  - in_pb_exposed
```
protected ByteCountingPushBackInputStream in_pb_exposed
```
    Pushback input stream exposed to the outside, usable by payload processors.
  - pushback_size
```
protected int pushback_size
```
    Pushback size.
  - payloadHeaderWrapped
```
protected PayloadWithHeaderAbstract payloadHeaderWrapped
```
    Header wrapped payload, if present.
  - onClosedHandler
```
protected PayloadOnClosedHandler onClosedHandler
```
    Handler called when this payloads stream has been fully consumed.
- Constructor Detail
  - Payload
```
protected Payload()
```
    Non public constructor.
- Method Detail
  - processPayload
```
public static Payload processPayload(java.io.InputStream in,
                                     long length,
                                     int pushback_size,
                                     java.lang.String digestAlgorithm)
                              throws java.io.IOException
```
    Creates new ArcPayload instance.
    
    Parameters:
    
    in - the input stream to parse.
    
    length - payload length.
    
    pushback_size - pushback size
    
    digestAlgorithm - digest algorithm to use on payload or null
    
    Returns:
    
    the payload
    
    Throws:
    
    java.io.IOException - if an I/O error occurs while initializing
  - setOnClosedHandler
```
public void setOnClosedHandler(PayloadOnClosedHandler onClosedHandler)
```
    Set optional handler to be called when payload is closed. This method should not be called by the payload consumer.
    
    Parameters:
    
    onClosedHandler - on closed handler implementation
  - getDigest
```
public byte[] getDigest()
```
    Returns the calculated digest.
    
    Returns:
    
    the calculated digest
  - getTotalLength
```
public long getTotalLength()
```
    Get payload total length.
    
    Returns:
    
    payload total length
  - 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 an I/O error occurs calling available method on stream
  - getPushbackSize
```
public int getPushbackSize()
```
    Get pushback buffer size.
    
    Returns:
    
    pushback buffer size
  - setPayloadHeaderWrapped
```
public void setPayloadHeaderWrapped(PayloadWithHeaderAbstract payloadHeaderWrapped)
```
    Set PayloadHeaderWrapper object in case of recognized payload content. This method should not be called by the payload consumer.
    
    Parameters:
    
    payloadHeaderWrapped - PayloadHeaderWrapper object
  - getPayloadHeaderWrapped
```
public PayloadWithHeaderAbstract getPayloadHeaderWrapped()
```
    Get the PayloadHeaderWrapper object associated with this payload.
    
    Returns:
    
    PayloadHeaderWrapper object or null
  - getInputStreamComplete
```
public java.io.InputStream getInputStreamComplete()
```
    Get InputStream to read the complete payload even though a http response header may have been read.
    
    Returns:
    
    InputStream to read payload data (in)directly.
  - getInputStream
```
public ByteCountingPushBackInputStream getInputStream()
```
    Get InputStream to read the payload directly from the source bypassing any existing HttpResponse object. A parsed http response header will not be accessible through this stream.
    
    Returns:
    
    InputStream to read payload data.
  - getRemaining
```
public long getRemaining()
                  throws java.io.IOException
```
    Get payload remaining length.
    
    Returns:
    
    payload remaining length
    
    Throws:
    
    java.io.IOException - if an I/O error occurs calling available method on stream
  - isClosed
```
public boolean isClosed()
```
    Check to see if the payload has been closed.
    
    Returns:
    
    boolean indicating whether this payload 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 - if an I/O error occurs in the closing process

Class Payload

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

bClosed

length

in_fl

md

digest

in_digest

bNoSuchAlgorithmException

in_buffered

in_pb_exposed

pushback_size

payloadHeaderWrapped

onClosedHandler

Constructor Detail

Payload

Method Detail

processPayload

setOnClosedHandler

getDigest

getTotalLength

getUnavailable

getPushbackSize

setPayloadHeaderWrapped

getPayloadHeaderWrapped

getInputStreamComplete

getInputStream

getRemaining

isClosed

close