Index (jwarc 0.28.3 API)

A B C D E F G H I J L M N O P R S T U V W

A

AbstractBuilder() - Constructor for class org.netpreserve.jwarc.HttpMessage.AbstractBuilder
AbstractBuilder(MessageVersion) - Constructor for class org.netpreserve.jwarc.Message.AbstractBuilder
AbstractBuilder(String) - Constructor for class org.netpreserve.jwarc.WarcCaptureRecord.AbstractBuilder
AbstractBuilder(String) - Constructor for class org.netpreserve.jwarc.WarcRecord.AbstractBuilder
addHeader(String, String) - Method in class org.netpreserve.jwarc.Message.AbstractBuilder: Adds a header field.
addHeaders(Map<String, List<String>>) - Method in class org.netpreserve.jwarc.Message.AbstractBuilder: Appends header fields.
algorithm() - Method in class org.netpreserve.jwarc.WarcDigest
all(String) - Method in class org.netpreserve.jwarc.MessageHeaders: Returns all the values of a header field.
appendTo(Appendable) - Method in class org.netpreserve.jwarc.MessageHeaders
ARC_1_1 - Static variable in class org.netpreserve.jwarc.MessageVersion

B

base() - Method in class org.netpreserve.jwarc.MediaType: The base type and subtype without any parameters.
base16() - Method in class org.netpreserve.jwarc.WarcDigest
base32() - Method in class org.netpreserve.jwarc.WarcDigest
base64() - Method in class org.netpreserve.jwarc.WarcDigest
blockDigest(String, String) - Method in class org.netpreserve.jwarc.WarcRecord.AbstractBuilder
blockDigest(WarcDigest) - Method in class org.netpreserve.jwarc.WarcRecord.AbstractBuilder
blockDigest() - Method in class org.netpreserve.jwarc.WarcRecord: Digest created from "WARC-Block-Digest" header containing digest values that were calculated by applying hash functions to this content body during creation of the WARC file.
body(MediaType, byte[]) - Method in class org.netpreserve.jwarc.Message.AbstractBuilder: Sets the message body.
body(MediaType, ReadableByteChannel, long) - Method in class org.netpreserve.jwarc.Message.AbstractBuilder: Sets the message body.
body() - Method in class org.netpreserve.jwarc.Message: The content body of this message.
body(MediaType, Message) - Method in class org.netpreserve.jwarc.WarcCaptureRecord.AbstractBuilder
body() - Method in class org.netpreserve.jwarc.WarcPayload
body(HttpRequest) - Method in class org.netpreserve.jwarc.WarcRequest.Builder
body(HttpResponse) - Method in class org.netpreserve.jwarc.WarcResponse.Builder
body(HttpResponse) - Method in class org.netpreserve.jwarc.WarcRevisit.Builder
bodyChannel - Variable in class org.netpreserve.jwarc.Message.AbstractBuilder
browse(URI) - Method in class org.netpreserve.jwarc.net.Browser
Browser - Class in org.netpreserve.jwarc.net
build() - Method in class org.netpreserve.jwarc.cdx.CdxFormat.Builder
build() - Method in class org.netpreserve.jwarc.HttpRequest.Builder
build() - Method in class org.netpreserve.jwarc.HttpResponse.Builder
build() - Method in class org.netpreserve.jwarc.Message.AbstractBuilder: Finishes building.
build() - Method in class org.netpreserve.jwarc.WarcContinuation.Builder
build() - Method in class org.netpreserve.jwarc.WarcConversion.Builder
build() - Method in class org.netpreserve.jwarc.Warcinfo.Builder
build() - Method in class org.netpreserve.jwarc.WarcMetadata.Builder
build(WarcRecord.Constructor<R>) - Method in class org.netpreserve.jwarc.WarcRecord.AbstractBuilder
build() - Method in class org.netpreserve.jwarc.WarcRequest.Builder
build() - Method in class org.netpreserve.jwarc.WarcResource.Builder
build() - Method in class org.netpreserve.jwarc.WarcResponse.Builder
build() - Method in class org.netpreserve.jwarc.WarcRevisit.Builder
Builder() - Constructor for class org.netpreserve.jwarc.cdx.CdxFormat.Builder
Builder(String, String) - Constructor for class org.netpreserve.jwarc.HttpRequest.Builder
Builder(String, URI) - Constructor for class org.netpreserve.jwarc.HttpRequest.Builder: Create a new HTTP request builder from a URI.
Builder(int, String) - Constructor for class org.netpreserve.jwarc.HttpResponse.Builder
Builder() - Constructor for class org.netpreserve.jwarc.WarcContinuation.Builder
Builder() - Constructor for class org.netpreserve.jwarc.WarcConversion.Builder
Builder() - Constructor for class org.netpreserve.jwarc.Warcinfo.Builder
Builder() - Constructor for class org.netpreserve.jwarc.WarcMetadata.Builder
Builder(URI) - Constructor for class org.netpreserve.jwarc.WarcRequest.Builder
Builder(String) - Constructor for class org.netpreserve.jwarc.WarcRequest.Builder
Builder(URI) - Constructor for class org.netpreserve.jwarc.WarcResource.Builder
Builder() - Constructor for class org.netpreserve.jwarc.WarcResource.Builder
Builder(URI) - Constructor for class org.netpreserve.jwarc.WarcResponse.Builder
Builder(String) - Constructor for class org.netpreserve.jwarc.WarcResponse.Builder
Builder(URI) - Constructor for class org.netpreserve.jwarc.WarcRevisit.Builder: Deprecated.
Builder(URI, URI) - Constructor for class org.netpreserve.jwarc.WarcRevisit.Builder
Builder(String, URI) - Constructor for class org.netpreserve.jwarc.WarcRevisit.Builder
Builder(String) - Constructor for class org.netpreserve.jwarc.WarcRevisit.Builder
Builder(String) - Constructor for class org.netpreserve.jwarc.WarcTargetRecord.Builder
bytes() - Method in class org.netpreserve.jwarc.WarcDigest

C

calculateBlockDigest() - Method in class org.netpreserve.jwarc.WarcReader: Enable calculation of block digests for all WARC records which include the header "WARC-Block-Digest" and using the same digest algorithm as mentioned in the header.
calculatedBlockDigest() - Method in class org.netpreserve.jwarc.WarcRecord: Digest created while reading the WARC record body if the WARC reader is configured to calculate digests and a "WARC-Block-Digest" header is present, see WarcReader.calculateBlockDigest().
CaptureIndex - Class in org.netpreserve.jwarc.net
CaptureIndex(List<Path>) - Constructor for class org.netpreserve.jwarc.net.CaptureIndex
CDX10 - Static variable in class org.netpreserve.jwarc.cdx.CdxFormat
CDX10_LEGEND - Static variable in class org.netpreserve.jwarc.cdx.CdxFormat
CDX11 - Static variable in class org.netpreserve.jwarc.cdx.CdxFormat
CDX11_LEGEND - Static variable in class org.netpreserve.jwarc.cdx.CdxFormat
CDX9 - Static variable in class org.netpreserve.jwarc.cdx.CdxFormat
CDX9_LEGEND - Static variable in class org.netpreserve.jwarc.cdx.CdxFormat
CdxFields - Class in org.netpreserve.jwarc.cdx
CdxFormat - Class in org.netpreserve.jwarc.cdx
CdxFormat(String) - Constructor for class org.netpreserve.jwarc.cdx.CdxFormat
CdxFormat.Builder - Class in org.netpreserve.jwarc.cdx
CdxReader - Class in org.netpreserve.jwarc.cdx
CdxReader(InputStream) - Constructor for class org.netpreserve.jwarc.cdx.CdxReader
CdxRecord - Class in org.netpreserve.jwarc.cdx
CdxRequestEncoder - Class in org.netpreserve.jwarc.cdx
CdxRequestEncoder() - Constructor for class org.netpreserve.jwarc.cdx.CdxRequestEncoder
CdxTool - Class in org.netpreserve.jwarc.tools
CdxTool() - Constructor for class org.netpreserve.jwarc.tools.CdxTool
CdxWriter - Class in org.netpreserve.jwarc.cdx: Writes CDX records.
CdxWriter(Writer) - Constructor for class org.netpreserve.jwarc.cdx.CdxWriter
certificate() - Method in class org.netpreserve.jwarc.net.CertificateAuthority
CertificateAuthority - Class in org.netpreserve.jwarc.net
CHECKSUM - Static variable in class org.netpreserve.jwarc.cdx.CdxFields
chrome(String, InetSocketAddress) - Static method in class org.netpreserve.jwarc.net.Browser
close() - Method in class org.netpreserve.jwarc.cdx.CdxReader
close() - Method in class org.netpreserve.jwarc.cdx.CdxWriter
close() - Method in class org.netpreserve.jwarc.InflateChannel
close() - Method in class org.netpreserve.jwarc.LengthedBody
close() - Method in class org.netpreserve.jwarc.net.WarcRenderer
close() - Method in class org.netpreserve.jwarc.WarcReader: Closes the underlying channel.
close() - Method in class org.netpreserve.jwarc.WarcWriter: Closes the channel.
compile(String) - Static method in class org.netpreserve.jwarc.WarcFilter: Compiles a filter expression from a string.
COMPRESSED_ARC_FILE_OFFSET - Static variable in class org.netpreserve.jwarc.cdx.CdxFields
COMPRESSED_RECORD_SIZE - Static variable in class org.netpreserve.jwarc.cdx.CdxFields
compression() - Method in class org.netpreserve.jwarc.WarcReader: The type of WARC compression that was detected.
concurrentTo(URI) - Method in class org.netpreserve.jwarc.WarcCaptureRecord.AbstractBuilder
concurrentTo() - Method in class org.netpreserve.jwarc.WarcCaptureRecord: The IDs of other records created during the same capture event as this one.
construct(MessageVersion, MessageHeaders, MessageBody) - Method in interface org.netpreserve.jwarc.WarcRecord.Constructor
consume() - Method in class org.netpreserve.jwarc.LengthedBody
consume() - Method in class org.netpreserve.jwarc.MessageBody
contains(String, String) - Method in class org.netpreserve.jwarc.MessageHeaders: Returns true when the given header value is present.
contentType() - Method in class org.netpreserve.jwarc.cdx.CdxRecord
contentType() - Method in class org.netpreserve.jwarc.GeminiResponse
contentType() - Method in class org.netpreserve.jwarc.Message: The media type of the body.
copy(InputStream, OutputStream) - Static method in class org.netpreserve.jwarc.IOUtils
copyTo(OutputStream) - Method in class org.netpreserve.jwarc.FetchOptions: If specified the response will also be copied to this OutputStream as well as the WARC file.
create(ReadableByteChannel, ByteBuffer, long) - Static method in class org.netpreserve.jwarc.LengthedBody

D

DATE - Static variable in class org.netpreserve.jwarc.cdx.CdxFields
date() - Method in class org.netpreserve.jwarc.cdx.CdxRecord
date(Instant) - Method in class org.netpreserve.jwarc.WarcRecord.AbstractBuilder: The instant that data capture for this record began.
date() - Method in class org.netpreserve.jwarc.WarcRecord: The instant that data capture for this record began.
DedupeTool - Class in org.netpreserve.jwarc.tools
DedupeTool() - Constructor for class org.netpreserve.jwarc.tools.DedupeTool
deduplicateWarcFile(Path, Path) - Method in class org.netpreserve.jwarc.tools.DedupeTool
digest() - Method in class org.netpreserve.jwarc.cdx.CdxRecord: A cryptographic digest of the response payload.
digest() - Method in class org.netpreserve.jwarc.WarcPayload
digestUnchanged() - Method in class org.netpreserve.jwarc.cdx.CdxFormat.Builder

E

emitWarning(String) - Method in class org.netpreserve.jwarc.MessageParser
empty() - Static method in class org.netpreserve.jwarc.MessageBody
encode(HttpRequest) - Static method in class org.netpreserve.jwarc.cdx.CdxRequestEncoder
equals(Object) - Method in class org.netpreserve.jwarc.MediaType: Two media types are considered equal if their type, subtype and parameter names are equal case-insensitively and if the parameter values are equal case-sensitively.
equals(Object) - Method in class org.netpreserve.jwarc.MessageVersion
equals(Object) - Method in class org.netpreserve.jwarc.WarcDigest
exception() - Method in class org.netpreserve.jwarc.FetchResult: If the fetch was interrupted by an exception but truncated records were still written this will return the caught exception.
ExtractTool - Class in org.netpreserve.jwarc.tools
ExtractTool() - Constructor for class org.netpreserve.jwarc.tools.ExtractTool

F

fetch(URI) - Method in class org.netpreserve.jwarc.WarcWriter: Downloads a remote resource recording the request and response as WARC records.
fetch(URI, FetchOptions) - Method in class org.netpreserve.jwarc.WarcWriter: Downloads a remote resource recording the request and response as WARC records.
fetch(URI, HttpRequest, OutputStream) - Method in class org.netpreserve.jwarc.WarcWriter: Downloads a remote resource recording the request and response as WARC records.
fetch(URI, HttpRequest, FetchOptions) - Method in class org.netpreserve.jwarc.WarcWriter: Downloads a remote resource recording the request and response as WARC records.
FetchOptions - Class in org.netpreserve.jwarc: Options for fetching a remote resource.
FetchOptions() - Constructor for class org.netpreserve.jwarc.FetchOptions
FetchResult - Class in org.netpreserve.jwarc: The result of a fetch operation.
FetchTool - Class in org.netpreserve.jwarc.tools
FetchTool() - Constructor for class org.netpreserve.jwarc.tools.FetchTool
fields(Map<String, List<String>>) - Method in class org.netpreserve.jwarc.Warcinfo.Builder
fields() - Method in class org.netpreserve.jwarc.Warcinfo: Parses the content body as application/warc-fields.
fields(Map<String, List<String>>) - Method in class org.netpreserve.jwarc.WarcMetadata.Builder
fields() - Method in class org.netpreserve.jwarc.WarcMetadata: Parses the body as application/warc-fields.
FILENAME - Static variable in class org.netpreserve.jwarc.cdx.CdxFields
filename() - Method in class org.netpreserve.jwarc.cdx.CdxRecord
filename(String) - Method in class org.netpreserve.jwarc.Warcinfo.Builder
filename() - Method in class org.netpreserve.jwarc.Warcinfo: The name of the file originally containing this warcinfo record.
FilterTool - Class in org.netpreserve.jwarc.tools
FilterTool() - Constructor for class org.netpreserve.jwarc.tools.FilterTool
first(String) - Method in class org.netpreserve.jwarc.MessageHeaders: Returns the first value of a header field.
format(byte, WarcCaptureRecord) - Static method in class org.netpreserve.jwarc.cdx.CdxFields
format(WarcCaptureRecord, String, long, long) - Method in class org.netpreserve.jwarc.cdx.CdxFormat
format(WarcCaptureRecord, String, long, long, String) - Method in class org.netpreserve.jwarc.cdx.CdxFormat

G

GEMINI - Static variable in class org.netpreserve.jwarc.MediaType
GEMINI - Static variable in class org.netpreserve.jwarc.MessageVersion
gemini() - Method in class org.netpreserve.jwarc.WarcResponse
GeminiParser - Class in org.netpreserve.jwarc
GeminiParser() - Constructor for class org.netpreserve.jwarc.GeminiParser
GeminiRequest - Class in org.netpreserve.jwarc
GeminiRequest(String) - Constructor for class org.netpreserve.jwarc.GeminiRequest
GeminiResponse - Class in org.netpreserve.jwarc
GeminiResponse(int, String, MessageBody) - Constructor for class org.netpreserve.jwarc.GeminiResponse
GEMTEXT - Static variable in class org.netpreserve.jwarc.MediaType
get(int) - Method in class org.netpreserve.jwarc.cdx.CdxRecord
getDigester(String) - Static method in class org.netpreserve.jwarc.WarcDigest: Get digester for algorithm names not matching the canonical Java names, e.g.
getDigester() - Method in class org.netpreserve.jwarc.WarcDigest
getErrorContext(String, int, int) - Static method in class org.netpreserve.jwarc.MessageParser
getErrorContext(ByteBuffer, int, int) - Static method in class org.netpreserve.jwarc.MessageParser
getMajor() - Method in class org.netpreserve.jwarc.MessageVersion
getMinor() - Method in class org.netpreserve.jwarc.MessageVersion
getProtocol() - Method in class org.netpreserve.jwarc.MessageVersion
gunzipChannel(ReadableByteChannel) - Static method in class org.netpreserve.jwarc.IOUtils

H

handle(HttpExchange) - Method in interface org.netpreserve.jwarc.net.HttpHandler
hashCode() - Method in class org.netpreserve.jwarc.MediaType
hashCode() - Method in class org.netpreserve.jwarc.MessageVersion
hashCode() - Method in class org.netpreserve.jwarc.WarcDigest
headerMap - Variable in class org.netpreserve.jwarc.Message.AbstractBuilder
headers() - Method in class org.netpreserve.jwarc.HttpParser
headers() - Method in class org.netpreserve.jwarc.Message: The named header fields of this message.
headers() - Method in class org.netpreserve.jwarc.WarcParser
hex() - Method in class org.netpreserve.jwarc.WarcDigest
HTML - Static variable in class org.netpreserve.jwarc.MediaType
HTML_UTF8 - Static variable in class org.netpreserve.jwarc.MediaType
HTTP - Static variable in class org.netpreserve.jwarc.MediaType
http() - Method in class org.netpreserve.jwarc.WarcRequest: Parses the content body of this record as HTTP request.
http() - Method in class org.netpreserve.jwarc.WarcResponse: Parses the HTTP response captured by this record.
http() - Method in class org.netpreserve.jwarc.WarcRevisit: Parses the HTTP response captured by this record.
HTTP_1_0 - Static variable in class org.netpreserve.jwarc.MessageVersion
HTTP_1_1 - Static variable in class org.netpreserve.jwarc.MessageVersion
HTTP_REQUEST - Static variable in class org.netpreserve.jwarc.MediaType
HTTP_RESPONSE - Static variable in class org.netpreserve.jwarc.MediaType
HttpHandler - Interface in org.netpreserve.jwarc.net
HttpMessage - Class in org.netpreserve.jwarc
HttpMessage.AbstractBuilder<R extends HttpMessage,B extends HttpMessage.AbstractBuilder<R,B>> - Class in org.netpreserve.jwarc
HttpParser - Class in org.netpreserve.jwarc
HttpParser() - Constructor for class org.netpreserve.jwarc.HttpParser
HttpRequest - Class in org.netpreserve.jwarc
HttpRequest.Builder - Class in org.netpreserve.jwarc
HttpResponse - Class in org.netpreserve.jwarc
HttpResponse.Builder - Class in org.netpreserve.jwarc

I

id() - Method in class org.netpreserve.jwarc.WarcRecord: The globally unique identifier for this record.
IDENTICAL_PAYLOAD_DIGEST_1_0 - Static variable in class org.netpreserve.jwarc.WarcRevisit: WARC 1.0 revisit profile for when the payload content was the same as determined by a strong digest function.
IDENTICAL_PAYLOAD_DIGEST_1_1 - Static variable in class org.netpreserve.jwarc.WarcRevisit: WARC 1.1 revisit profile for when the payload content was the same as determined by a strong digest function.
identifiedPayloadType(String) - Method in class org.netpreserve.jwarc.WarcTargetRecord.Builder
identifiedPayloadType() - Method in class org.netpreserve.jwarc.WarcTargetRecord: A content-type that was identified by an independent check (not just what the server said).
InflateChannel - Class in org.netpreserve.jwarc: A ReadableByteChannel inflating deflate-compressed content on read.
InflateChannel(ReadableByteChannel, ByteBuffer) - Constructor for class org.netpreserve.jwarc.InflateChannel
inflateChannel(ReadableByteChannel) - Static method in class org.netpreserve.jwarc.IOUtils
input() - Method in exception org.netpreserve.jwarc.WarcFilterException: Returns the expression containing the error.
IOUtils - Class in org.netpreserve.jwarc: This class is public only due to technical constraints.
IOUtils() - Constructor for class org.netpreserve.jwarc.IOUtils
ipAddress(InetAddress) - Method in class org.netpreserve.jwarc.WarcCaptureRecord.AbstractBuilder
ipAddress() - Method in class org.netpreserve.jwarc.WarcCaptureRecord: The IP address of the server involved in the capture event this record belongs to.
isError() - Method in class org.netpreserve.jwarc.GeminiParser
isError() - Method in class org.netpreserve.jwarc.HttpParser
isError() - Method in class org.netpreserve.jwarc.WarcParser
isFinished() - Method in class org.netpreserve.jwarc.GeminiParser
isFinished() - Method in class org.netpreserve.jwarc.HttpParser
isFinished() - Method in class org.netpreserve.jwarc.WarcParser
isOpen() - Method in class org.netpreserve.jwarc.InflateChannel
isOpen() - Method in class org.netpreserve.jwarc.LengthedBody
iterator() - Method in class org.netpreserve.jwarc.cdx.CdxReader
iterator() - Method in class org.netpreserve.jwarc.WarcReader: Returns an iterator over the records in the WARC file.

J

JSON - Static variable in class org.netpreserve.jwarc.MediaType

L

legend(String) - Method in class org.netpreserve.jwarc.cdx.CdxFormat.Builder
legend() - Method in class org.netpreserve.jwarc.cdx.CdxFormat
LengthedBody - Class in org.netpreserve.jwarc: A message body with a known length.
LengthedBody.LengthedReadableByteChannel - Interface in org.netpreserve.jwarc
lenientRequest() - Method in class org.netpreserve.jwarc.HttpParser: Configures the parser to read a HTTP request while allowing some deviations from the standard: The number of spaces in the request line may vary Any character except space and newline is allowed in the target Lines may end with LF instead of CRLF Any byte except LF is allowed in header field values Whitespace is allowed between the field name and colon
lenientResponse() - Method in class org.netpreserve.jwarc.HttpParser: Configures the parser to read a HTTP response while allowing some deviations from the standard: The number of spaces in the status line may vary Lines may end with LF instead of CRLF Any byte except LF is allowed in header field values Whitespace is allowed between the field name and colon
ListTool - Class in org.netpreserve.jwarc.tools
ListTool() - Constructor for class org.netpreserve.jwarc.tools.ListTool

M

main(String[]) - Static method in class org.netpreserve.jwarc.net.CertificateAuthority
main(String[]) - Static method in class org.netpreserve.jwarc.tools.CdxTool
main(String[]) - Static method in class org.netpreserve.jwarc.tools.DedupeTool
main(String[]) - Static method in class org.netpreserve.jwarc.tools.ExtractTool
main(String[]) - Static method in class org.netpreserve.jwarc.tools.FetchTool
main(String[]) - Static method in class org.netpreserve.jwarc.tools.FilterTool
main(String[]) - Static method in class org.netpreserve.jwarc.tools.ListTool
main(String[]) - Static method in class org.netpreserve.jwarc.tools.RecorderTool
main(String[]) - Static method in class org.netpreserve.jwarc.tools.RecordTool
main(String[]) - Static method in class org.netpreserve.jwarc.tools.SavebackTool
main(String[]) - Static method in class org.netpreserve.jwarc.tools.ScreenshotTool
main(String[]) - Static method in class org.netpreserve.jwarc.tools.ServeTool
main(String[]) - Static method in class org.netpreserve.jwarc.tools.StatsTool
main(String[]) - Static method in class org.netpreserve.jwarc.tools.ValidateTool
main(String[]) - Static method in class org.netpreserve.jwarc.tools.WarcTool
map() - Method in class org.netpreserve.jwarc.MessageHeaders: Returns a map of header fields to their values.
maxLength(long) - Method in class org.netpreserve.jwarc.FetchOptions: Stops the fetch after this many bytes are received (including any protocol headers).
maxTime(long) - Method in class org.netpreserve.jwarc.FetchOptions: Stops the fetch after this many milliseconds have elapsed.
MediaType - Class in org.netpreserve.jwarc
Message - Class in org.netpreserve.jwarc: A message consisting of headers and a content block (body).
Message.AbstractBuilder<R extends Message,B extends Message.AbstractBuilder<R,B>> - Class in org.netpreserve.jwarc
MessageBody - Class in org.netpreserve.jwarc
MessageHeaders - Class in org.netpreserve.jwarc
MessageParser - Class in org.netpreserve.jwarc
MessageParser() - Constructor for class org.netpreserve.jwarc.MessageParser
MessageVersion - Class in org.netpreserve.jwarc
MessageVersion(String) - Constructor for class org.netpreserve.jwarc.MessageVersion
MessageVersion(String, int, int) - Constructor for class org.netpreserve.jwarc.MessageVersion
meta() - Method in class org.netpreserve.jwarc.GeminiParser
meta() - Method in class org.netpreserve.jwarc.GeminiResponse
method() - Method in class org.netpreserve.jwarc.HttpParser
method() - Method in class org.netpreserve.jwarc.HttpRequest
MIME_TYPE - Static variable in class org.netpreserve.jwarc.cdx.CdxFields

N

newWarcFieldsParser() - Static method in class org.netpreserve.jwarc.WarcParser
next() - Method in class org.netpreserve.jwarc.cdx.CdxReader
next() - Method in class org.netpreserve.jwarc.WarcReader: Reads the next WARC record.
NORMALIZED_SURT - Static variable in class org.netpreserve.jwarc.cdx.CdxFields

O

OCTET_STREAM - Static variable in class org.netpreserve.jwarc.MediaType
onWarning(Consumer<String>) - Method in class org.netpreserve.jwarc.cdx.CdxWriter: Sets a handler for warnings emitted during processing.
onWarning(Consumer<String>) - Method in class org.netpreserve.jwarc.WarcReader: Registers a handler that will be called when the reader encounters an error it was able to recover from.
org.netpreserve.jwarc - package org.netpreserve.jwarc: Classes for parsing, serializing and manipulating WARC records.
org.netpreserve.jwarc.cdx - package org.netpreserve.jwarc.cdx
org.netpreserve.jwarc.net - package org.netpreserve.jwarc.net: Classes for constructing network services which operate on WARC files.
org.netpreserve.jwarc.tools - package org.netpreserve.jwarc.tools: Command-line tools for manipulating WARC files.
ORIGINAL_URL - Static variable in class org.netpreserve.jwarc.cdx.CdxFields

P

parameters() - Method in class org.netpreserve.jwarc.MediaType
parse(String) - Method in class org.netpreserve.jwarc.cdx.CdxFormat
parse(ByteBuffer) - Method in class org.netpreserve.jwarc.GeminiParser: Runs the parser on a buffer of data.
parse(ReadableByteChannel, ByteBuffer) - Method in class org.netpreserve.jwarc.GeminiParser
parse(ReadableByteChannel, ByteBuffer) - Static method in class org.netpreserve.jwarc.GeminiRequest
parse(ReadableByteChannel, ByteBuffer) - Static method in class org.netpreserve.jwarc.GeminiResponse
parse(ByteBuffer) - Method in class org.netpreserve.jwarc.HttpParser: Runs the parser on a buffer of data.
parse(ReadableByteChannel, ByteBuffer) - Method in class org.netpreserve.jwarc.HttpParser
parse(ReadableByteChannel) - Static method in class org.netpreserve.jwarc.HttpRequest: Parses a HTTP request while leniently allowing common deviations from the standard.
parse(ReadableByteChannel, ByteBuffer) - Static method in class org.netpreserve.jwarc.HttpRequest: Parses a HTTP request while leniently allowing common deviations from the standard.
parse(ReadableByteChannel) - Static method in class org.netpreserve.jwarc.HttpResponse: Parses a HTTP response while leniently allowing common deviations from the standard.
parse(String) - Static method in class org.netpreserve.jwarc.MediaType: Parses a media type string.
parse(ReadableByteChannel) - Static method in class org.netpreserve.jwarc.MessageHeaders: Parses application/warc-fields.
parse(ByteBuffer) - Method in class org.netpreserve.jwarc.WarcParser
parse(ReadableByteChannel, ByteBuffer) - Method in class org.netpreserve.jwarc.WarcParser
parseLeniently(String) - Static method in class org.netpreserve.jwarc.URIs
parseStrictly(ReadableByteChannel, ByteBuffer) - Static method in class org.netpreserve.jwarc.HttpRequest: Parses a HTTP request while strictly rejecting deviations from the standard.
parseStrictly(ReadableByteChannel) - Static method in class org.netpreserve.jwarc.HttpResponse: Parses a HTTP response while strictly rejecting deviations from the standard.
parseWithoutBody(ReadableByteChannel, WritableByteChannel) - Static method in class org.netpreserve.jwarc.HttpResponse
ParsingException - Exception in org.netpreserve.jwarc
ParsingException(String) - Constructor for exception org.netpreserve.jwarc.ParsingException
payload() - Method in class org.netpreserve.jwarc.WarcConversion
payload() - Method in class org.netpreserve.jwarc.WarcMetadata: Metadata records do not have a payload so this method always returns empty.
payload() - Method in class org.netpreserve.jwarc.WarcRequest
payload() - Method in class org.netpreserve.jwarc.WarcResponse
payload() - Method in class org.netpreserve.jwarc.WarcRevisit: Always returns Optional.empty().
payload() - Method in class org.netpreserve.jwarc.WarcTargetRecord: Returns the payload of this record if one is present.
payloadDigest(WarcDigest) - Method in class org.netpreserve.jwarc.WarcTargetRecord.Builder
payloadDigest(String, String) - Method in class org.netpreserve.jwarc.WarcTargetRecord.Builder
payloadDigest() - Method in class org.netpreserve.jwarc.WarcTargetRecord: Digest values that were calculated by applying hash functions to payload.
payloadType() - Method in class org.netpreserve.jwarc.WarcCaptureRecord: Content-Type of the payload.
payloadType() - Method in class org.netpreserve.jwarc.WarcRequest
payloadType() - Method in class org.netpreserve.jwarc.WarcResponse
percentEncodeIllegals(String) - Static method in class org.netpreserve.jwarc.URIs
percentPlusDecode(String) - Static method in class org.netpreserve.jwarc.URIs
percentPlusEncode(String) - Static method in class org.netpreserve.jwarc.cdx.CdxRequestEncoder
PLAIN_TEXT - Static variable in class org.netpreserve.jwarc.MediaType
position() - Method in class org.netpreserve.jwarc.cdx.CdxRecord: Position in bytes of the record in the WARC file.
position() - Method in interface org.netpreserve.jwarc.LengthedBody.LengthedReadableByteChannel
position() - Method in class org.netpreserve.jwarc.LengthedBody: The current position in bytes within the content body.
position() - Method in class org.netpreserve.jwarc.MessageBody
position() - Method in exception org.netpreserve.jwarc.WarcFilterException: Returns the character position of the error within the input.
position() - Method in class org.netpreserve.jwarc.WarcParser
position() - Method in class org.netpreserve.jwarc.WarcReader: Returns the byte position of the most recently read record.
position(long) - Method in class org.netpreserve.jwarc.WarcReader: Seeks to the record at the given position in the underlying channel.
position() - Method in class org.netpreserve.jwarc.WarcWriter: Returns the byte position the next record will be written to.
prefixedBase32() - Method in class org.netpreserve.jwarc.WarcDigest
prettyPrint() - Method in exception org.netpreserve.jwarc.WarcFilterException: Returns a user-friendly error message.
process(List<Path>, boolean) - Method in class org.netpreserve.jwarc.cdx.CdxWriter: Processes a list of WARC files writing CDX records for each response or resource record.
process(WarcReader, String) - Method in class org.netpreserve.jwarc.cdx.CdxWriter: Writes CDX records for each response or resource record in a WARC file.
profile() - Method in class org.netpreserve.jwarc.WarcRevisit: The revisit profile explaining why this capture was written as a revisit record.
PYWB_REVISIT_MIMETYPE - Static variable in class org.netpreserve.jwarc.cdx.CdxFormat

R

raw() - Method in class org.netpreserve.jwarc.MediaType: The original unparsed media type string.
raw() - Method in class org.netpreserve.jwarc.WarcDigest: Returns the original digest string without any canonicalization.
read(ByteBuffer) - Method in class org.netpreserve.jwarc.InflateChannel
read(ByteBuffer) - Method in class org.netpreserve.jwarc.LengthedBody
readNBytes(InputStream, int) - Static method in class org.netpreserve.jwarc.IOUtils
readTimeout(int) - Method in class org.netpreserve.jwarc.FetchOptions: Sets the read timeout in milliseconds on the socket.
reason() - Method in class org.netpreserve.jwarc.HttpParser
reason() - Method in class org.netpreserve.jwarc.HttpResponse: The resposne status reason phrase.
RecorderTool - Class in org.netpreserve.jwarc.tools
RecorderTool() - Constructor for class org.netpreserve.jwarc.tools.RecorderTool
recordId(UUID) - Method in class org.netpreserve.jwarc.WarcRecord.AbstractBuilder
recordId(URI) - Method in class org.netpreserve.jwarc.WarcRecord.AbstractBuilder
records() - Method in class org.netpreserve.jwarc.WarcReader: Returns a Stream over the records in the WARC file.
RecordTool - Class in org.netpreserve.jwarc.tools
RecordTool() - Constructor for class org.netpreserve.jwarc.tools.RecordTool
REDIRECT - Static variable in class org.netpreserve.jwarc.cdx.CdxFields
redirect() - Method in class org.netpreserve.jwarc.cdx.CdxRecord: The value of the Location HTTP header for redirect responses.
refersTo(URI) - Method in class org.netpreserve.jwarc.WarcConversion.Builder
refersTo() - Method in class org.netpreserve.jwarc.WarcConversion: The record id of the source of the conversion.
refersTo(URI) - Method in class org.netpreserve.jwarc.WarcRevisit.Builder
refersTo(UUID) - Method in class org.netpreserve.jwarc.WarcRevisit.Builder
refersTo(URI, URI, Instant) - Method in class org.netpreserve.jwarc.WarcRevisit.Builder
refersTo(UUID, URI, Instant) - Method in class org.netpreserve.jwarc.WarcRevisit.Builder
refersTo(URI, String, Instant) - Method in class org.netpreserve.jwarc.WarcRevisit.Builder
refersTo() - Method in class org.netpreserve.jwarc.WarcRevisit: The record id of the original response or resource that was revisited.
refersToDate() - Method in class org.netpreserve.jwarc.WarcRevisit: The date of the record this record is a revisit of.
refersToTargetURI() - Method in class org.netpreserve.jwarc.WarcRevisit: The target URI of the record this record is a revisit of.
registerType(String, WarcRecord.Constructor<WarcRecord>) - Method in class org.netpreserve.jwarc.WarcReader: Registers a new extension record type.
request() - Method in class org.netpreserve.jwarc.FetchResult: The WARC record containing the request that was sent.
reset() - Method in class org.netpreserve.jwarc.GeminiParser
reset() - Method in class org.netpreserve.jwarc.HttpParser
reset() - Method in class org.netpreserve.jwarc.WarcParser
response() - Method in class org.netpreserve.jwarc.FetchResult: The WARC record containing the request that was sent.
RESPONSE_CODE - Static variable in class org.netpreserve.jwarc.cdx.CdxFields

S

SavebackTool - Class in org.netpreserve.jwarc.tools
SavebackTool() - Constructor for class org.netpreserve.jwarc.tools.SavebackTool
screenshot(URI, Path) - Method in class org.netpreserve.jwarc.net.Browser
screenshot(URI) - Method in class org.netpreserve.jwarc.net.Browser
screenshot(URI, Instant, WarcWriter) - Method in class org.netpreserve.jwarc.net.WarcRenderer
ScreenshotTool - Class in org.netpreserve.jwarc.tools
ScreenshotTool() - Constructor for class org.netpreserve.jwarc.tools.ScreenshotTool
segmentNumber(long) - Method in class org.netpreserve.jwarc.WarcRecord.AbstractBuilder
segmentNumber() - Method in class org.netpreserve.jwarc.WarcRecord: The current record's relative ordering in a sequence of segmented records.
segmentOriginId(URI) - Method in class org.netpreserve.jwarc.WarcContinuation.Builder
segmentOriginId() - Method in class org.netpreserve.jwarc.WarcContinuation: The id of the first record in the series of segments this record is part of.
segmentTotalLength(long) - Method in class org.netpreserve.jwarc.WarcContinuation.Builder
segmentTotalLength() - Method in class org.netpreserve.jwarc.WarcContinuation: The total length of the content blocks of all segments added together.
serializeHeader() - Method in class org.netpreserve.jwarc.GeminiResponse
serializeHeader() - Method in class org.netpreserve.jwarc.Message: Serializes the message header.
SERVER_NOT_MODIFIED_1_0 - Static variable in class org.netpreserve.jwarc.WarcRevisit: WARC 1.0 revisit profile for when the server said the content had not changed.
SERVER_NOT_MODIFIED_1_1 - Static variable in class org.netpreserve.jwarc.WarcRevisit: WARC 1.1 revisit profile for when the server said the content had not changed.
ServeTool - Class in org.netpreserve.jwarc.tools
ServeTool() - Constructor for class org.netpreserve.jwarc.tools.ServeTool
setCdxServer(String) - Method in class org.netpreserve.jwarc.tools.DedupeTool
setFormat(CdxFormat) - Method in class org.netpreserve.jwarc.cdx.CdxWriter: Sets the CDX output format to use.
setHeader(String, String) - Method in class org.netpreserve.jwarc.Message.AbstractBuilder: Sets a header field.
setMinimumSize(long) - Method in class org.netpreserve.jwarc.tools.DedupeTool
setPostAppend(boolean) - Method in class org.netpreserve.jwarc.cdx.CdxWriter: Appends an encoded version of the request to the URL key for POST and PUT requests.
setRecordFilter(Predicate<WarcRecord>) - Method in class org.netpreserve.jwarc.cdx.CdxWriter: Records that don't match this filter will not be emitted.
size() - Method in class org.netpreserve.jwarc.cdx.CdxRecord: Length of the WARC record in bytes.
size() - Method in interface org.netpreserve.jwarc.LengthedBody.LengthedReadableByteChannel
size() - Method in class org.netpreserve.jwarc.LengthedBody: The length in bytes of the content body.
size() - Method in class org.netpreserve.jwarc.MessageBody: Returns the length of the body.
sole(String) - Method in class org.netpreserve.jwarc.MessageHeaders: Returns the value of a single-valued header field.
StatsTool - Class in org.netpreserve.jwarc.tools
StatsTool() - Constructor for class org.netpreserve.jwarc.tools.StatsTool
status() - Method in class org.netpreserve.jwarc.cdx.CdxRecord: HTTP response status code.
status() - Method in class org.netpreserve.jwarc.GeminiParser
status() - Method in class org.netpreserve.jwarc.GeminiResponse
status() - Method in class org.netpreserve.jwarc.HttpParser
status() - Method in class org.netpreserve.jwarc.HttpResponse: The 3 digit response status code.
statusHttpEquivalent() - Method in class org.netpreserve.jwarc.GeminiResponse: Returns the HTTP equivalent of the status code.
stream() - Method in class org.netpreserve.jwarc.LengthedBody: Returns an InputStream for reading this body.
stream() - Method in class org.netpreserve.jwarc.MessageBody
strictRequest() - Method in class org.netpreserve.jwarc.GeminiParser: Configures the parser to read a gemini request while rejecting deviations from the standard.
strictRequest() - Method in class org.netpreserve.jwarc.HttpParser: Configures the parser to read a HTTP request while rejecting deviations from the standard.
strictResponse() - Method in class org.netpreserve.jwarc.GeminiParser: Configures the parser to read a gemini response while rejecting deviations from the standard.
strictResponse() - Method in class org.netpreserve.jwarc.HttpParser: Configures the parser to read a HTTP response while rejecting deviations from the standard.
subtype() - Method in class org.netpreserve.jwarc.MediaType

T

target() - Method in class org.netpreserve.jwarc.cdx.CdxRecord
target() - Method in class org.netpreserve.jwarc.HttpParser
target() - Method in class org.netpreserve.jwarc.HttpRequest
target() - Method in class org.netpreserve.jwarc.WarcTargetRecord: The URI of the original target resource this record holds information about as an unparsed string.
targetURI() - Method in class org.netpreserve.jwarc.cdx.CdxRecord
targetURI(String) - Method in class org.netpreserve.jwarc.WarcMetadata.Builder
targetURI(URI) - Method in class org.netpreserve.jwarc.WarcMetadata.Builder
targetURI() - Method in class org.netpreserve.jwarc.WarcTargetRecord: The URI of the original target resource this record holds information about.
test(WarcRecord) - Method in class org.netpreserve.jwarc.WarcFilter
toNormalizedSurt(String) - Static method in class org.netpreserve.jwarc.URIs
toString() - Method in class org.netpreserve.jwarc.cdx.CdxFormat
toString() - Method in class org.netpreserve.jwarc.MediaType
toString() - Method in class org.netpreserve.jwarc.MessageHeaders
toString() - Method in class org.netpreserve.jwarc.MessageVersion
toString() - Method in class org.netpreserve.jwarc.WarcDigest
toString() - Method in class org.netpreserve.jwarc.WarcFilter
toString() - Method in class org.netpreserve.jwarc.WarcRecord
toString() - Method in class org.netpreserve.jwarc.WarcTargetRecord
truncated(WarcTruncationReason) - Method in class org.netpreserve.jwarc.WarcRecord.AbstractBuilder
truncated() - Method in class org.netpreserve.jwarc.WarcRecord: The reason why this record was truncated or WarcTruncationReason.NOT_TRUNCATED.
type() - Method in class org.netpreserve.jwarc.MediaType
type() - Method in class org.netpreserve.jwarc.WarcPayload
type() - Method in class org.netpreserve.jwarc.WarcRecord: The type of record.

U

URIs - Class in org.netpreserve.jwarc
URIs() - Constructor for class org.netpreserve.jwarc.URIs
url() - Method in class org.netpreserve.jwarc.GeminiParser
userAgent(String) - Method in class org.netpreserve.jwarc.FetchOptions: Sets the User-Agent request header.

V

ValidateTool - Class in org.netpreserve.jwarc.tools
ValidateTool(boolean) - Constructor for class org.netpreserve.jwarc.tools.ValidateTool
valueOf(String) - Static method in enum org.netpreserve.jwarc.WarcCompression: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.netpreserve.jwarc.WarcTruncationReason: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.netpreserve.jwarc.WarcCompression: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.netpreserve.jwarc.WarcTruncationReason: Returns an array containing the constants of this enum type, in the order they are declared.
version(MessageVersion) - Method in class org.netpreserve.jwarc.HttpMessage.AbstractBuilder
version() - Method in class org.netpreserve.jwarc.HttpParser
version - Variable in class org.netpreserve.jwarc.Message.AbstractBuilder
version(MessageVersion) - Method in class org.netpreserve.jwarc.Message.AbstractBuilder: Sets the protocol version of this message or record.
version() - Method in class org.netpreserve.jwarc.Message: The version of the network protocol or file format containing this message.
version() - Method in class org.netpreserve.jwarc.WarcParser
version(MessageVersion) - Method in class org.netpreserve.jwarc.WarcRecord.AbstractBuilder

W

WARC_1_0 - Static variable in class org.netpreserve.jwarc.MessageVersion
WARC_1_1 - Static variable in class org.netpreserve.jwarc.MessageVersion
WARC_FIELDS - Static variable in class org.netpreserve.jwarc.MediaType
WarcCaptureRecord - Class in org.netpreserve.jwarc: A type of WARC record created as part of a web capture event.
WarcCaptureRecord.AbstractBuilder<R extends WarcCaptureRecord,B extends WarcCaptureRecord.AbstractBuilder<R,B>> - Class in org.netpreserve.jwarc
WarcCompression - Enum in org.netpreserve.jwarc
WarcContinuation - Class in org.netpreserve.jwarc
WarcContinuation.Builder - Class in org.netpreserve.jwarc
WarcConversion - Class in org.netpreserve.jwarc
WarcConversion.Builder - Class in org.netpreserve.jwarc
WarcDigest - Class in org.netpreserve.jwarc
WarcDigest(String) - Constructor for class org.netpreserve.jwarc.WarcDigest
WarcDigest(String, String) - Constructor for class org.netpreserve.jwarc.WarcDigest
WarcDigest(String, byte[]) - Constructor for class org.netpreserve.jwarc.WarcDigest
WarcDigest(MessageDigest) - Constructor for class org.netpreserve.jwarc.WarcDigest
WarcFilter - Class in org.netpreserve.jwarc: Filter expressions for matching WARC records.
WarcFilterException - Exception in org.netpreserve.jwarc: Thrown when a syntax error is encountered when compiling a filter expression.
WarcFilterException(String, int, String) - Constructor for exception org.netpreserve.jwarc.WarcFilterException
Warcinfo - Class in org.netpreserve.jwarc: The warcinfo record contains information about the web crawl that generated the records following it.
Warcinfo.Builder - Class in org.netpreserve.jwarc
warcinfoId(URI) - Method in class org.netpreserve.jwarc.WarcTargetRecord.Builder
warcinfoID() - Method in class org.netpreserve.jwarc.WarcTargetRecord: The ID of a Warcinfo record associated with this record.
WarcMetadata - Class in org.netpreserve.jwarc
WarcMetadata.Builder - Class in org.netpreserve.jwarc
WarcParser - Class in org.netpreserve.jwarc: Low-level WARC record parser.
WarcParser() - Constructor for class org.netpreserve.jwarc.WarcParser
WarcPayload - Class in org.netpreserve.jwarc
WarcReader - Class in org.netpreserve.jwarc
WarcReader(ReadableByteChannel, ByteBuffer) - Constructor for class org.netpreserve.jwarc.WarcReader: Create WarcReader with user-provided buffer.
WarcReader(ReadableByteChannel) - Constructor for class org.netpreserve.jwarc.WarcReader
WarcReader(InputStream) - Constructor for class org.netpreserve.jwarc.WarcReader
WarcReader(Path) - Constructor for class org.netpreserve.jwarc.WarcReader
WarcRecord - Class in org.netpreserve.jwarc
WarcRecord.AbstractBuilder<R extends WarcRecord,B extends WarcRecord.AbstractBuilder<R,B>> - Class in org.netpreserve.jwarc
WarcRecord.Constructor<R extends WarcRecord> - Interface in org.netpreserve.jwarc
WarcRecorder - Class in org.netpreserve.jwarc.net: HTTP proxy which records requests and responses as WARC records.
WarcRecorder(ServerSocket, WarcWriter) - Constructor for class org.netpreserve.jwarc.net.WarcRecorder
WarcRenderer - Class in org.netpreserve.jwarc.net
WarcRenderer(CaptureIndex) - Constructor for class org.netpreserve.jwarc.net.WarcRenderer
WarcRenderer(CaptureIndex, String) - Constructor for class org.netpreserve.jwarc.net.WarcRenderer
WarcRequest - Class in org.netpreserve.jwarc
WarcRequest.Builder - Class in org.netpreserve.jwarc
WarcResource - Class in org.netpreserve.jwarc
WarcResource.Builder - Class in org.netpreserve.jwarc
WarcResponse - Class in org.netpreserve.jwarc
WarcResponse.Builder - Class in org.netpreserve.jwarc
WarcRevisit - Class in org.netpreserve.jwarc: A WARC record describing a subsequent visitation of content previously archived.
WarcRevisit.Builder - Class in org.netpreserve.jwarc
WarcServer - Class in org.netpreserve.jwarc.net: A primitive WARC replay server.
WarcServer(ServerSocket, List<Path>) - Constructor for class org.netpreserve.jwarc.net.WarcServer
WarcTargetRecord - Class in org.netpreserve.jwarc: A WARC record associated with some target URI.
WarcTargetRecord.Builder<R extends WarcTargetRecord,B extends WarcTargetRecord.Builder<R,B>> - Class in org.netpreserve.jwarc
WarcTool - Class in org.netpreserve.jwarc.tools
WarcTool() - Constructor for class org.netpreserve.jwarc.tools.WarcTool
WarcTruncationReason - Enum in org.netpreserve.jwarc
WarcWriter - Class in org.netpreserve.jwarc: Writes records to a WARC file.
WarcWriter(WritableByteChannel, WarcCompression) - Constructor for class org.netpreserve.jwarc.WarcWriter
WarcWriter(WritableByteChannel) - Constructor for class org.netpreserve.jwarc.WarcWriter
WarcWriter(OutputStream) - Constructor for class org.netpreserve.jwarc.WarcWriter
WarcWriter(Path) - Constructor for class org.netpreserve.jwarc.WarcWriter: Opens a WARC file for writing.
write(WarcCaptureRecord, String, long, long) - Method in class org.netpreserve.jwarc.cdx.CdxWriter: Writes a CDX record.
write(WarcCaptureRecord, String, long, long, String) - Method in class org.netpreserve.jwarc.cdx.CdxWriter: Writes a CDX record with an encoded request body appended to the urlkey field.
write(WarcRecord) - Method in class org.netpreserve.jwarc.WarcWriter
writeHeaderLine() - Method in class org.netpreserve.jwarc.cdx.CdxWriter: Writes a CDX header line.
WWW_FORM_URLENCODED - Static variable in class org.netpreserve.jwarc.MediaType

A B C D E F G H I J L M N O P R S T U V W