Class ARCResource

java.lang.Object

org.archive.resource.AbstractResource

org.archive.resource.arc.ARCResource

All Implemented Interfaces:

ARCConstants, ArchiveFileConstants, Resource, ResourceConstants, EOFObserver

public class ARCResource
extends AbstractResource
implements ResourceConstants, ARCConstants, EOFObserver

Nested Class Summary

Nested classes/interfaces inherited from interface org.archive.format.arc.ARCConstants

ARCConstants.ArcRecordErrors

Field Summary

Fields inherited from class org.archive.resource.AbstractResource

container, metaData

Fields inherited from interface org.archive.format.arc.ARCConstants

ACTUAL_LENGTH_KEY, ALEXA_DAT_MIME, ARC_FILE_EXTENSION, ARC_GZIP_EXTRA_FIELD, ARC_MAGIC_NUMBER, ARC_META_CHARSET, CARRIAGE_RETURN_ORD, CHECKSUM_FIELD_KEY, CHECKSUM_HEADER_FIELD_KEY, CODE_HEADER_FIELD_KEY, COMPRESSED_ARC_FILE_EXTENSION, DATE_STRING_KEY, DECLARED_LENGTH_KEY, DEFAULT_ENCODING, DEFAULT_GZIP_HEADER_LENGTH, DEFAULT_MAX_ARC_FILE_SIZE, DEFAULT_MIME, DELIMITER, DNS_MIME, DOT_ARC_FILE_EXTENSION, DOT_COMPRESSED_ARC_FILE_EXTENSION, DOT_COMPRESSED_FILE_EXTENSION, FIELD_COUNT, FILEDESC_SCHEME, FILENAME_FIELD_KEY, FILENAME_HEADER_FIELD_KEY, GZIP_HEADER_BEGIN, HEADER_FIELD_SEPARATOR, HEADER_LENGTH, IP_HEADER_FIELD_KEY, IP_KEY, LEADING_NEWLINES_KEY, LINE_SEPARATOR, LOCATION_HEADER_FIELD_KEY, MAX_HEADER_LINE_LENGTH, MAX_META_LENGTH, MAX_METADATA_LINE_LENGTH, MIME_KEY, MINIMUM_RECORD_LENGTH, NEW_LINE_ORD, OFFSET_FIELD_KEY, OFFSET_HEADER_FIELD_KEY, REQUIRED_VERSION_1_HEADER_FIELDS, STATUSCODE_FIELD_KEY, TOKENIZED_PREFIX, TRAILING_CRUFT_KEY, TRAILING_NEWLINES_KEY, URL_KEY

Fields inherited from interface org.archive.format.ArchiveFileConstants

ABSOLUTE_OFFSET_KEY, CDX, CDX_FILE, CDX_LINE_BUFFER_SIZE, CRLF, DATE_FIELD_KEY, DEFAULT_DIGEST_METHOD, DUMP, GZIP_DUMP, HEADER, INVALID_SUFFIX, LENGTH_FIELD_KEY, MIMETYPE_FIELD_KEY, NOHEAD, OCCUPIED_SUFFIX, ORIGIN_FIELD_KEY, READER_IDENTIFIER_FIELD_KEY, RECORD_IDENTIFIER_FIELD_KEY, SINGLE_SPACE, TYPE_FIELD_KEY, URL_FIELD_KEY, VERSION_FIELD_KEY

Fields inherited from interface org.archive.resource.ResourceConstants

ARC_HEADER_LENGTH, ARC_HEADER_METADATA, CONTAINER, CONTAINER_COMPRESSED, CONTAINER_FILENAME, CONTAINER_OFFSET, CR_NL_CHARS, DAT_METADATA, DNS_DATE, DNS_ENTRIES, DNS_METADATA, DNS_NAME, DNS_NETCLASS, DNS_TTL, DNS_TYPE, DNS_VALUE, ENVELOPE, ENVELOPE_FORMAT, ENVELOPE_FORMAT_ARC, ENVELOPE_FORMAT_WARC, ENVELOPE_FORMAT_WARC_1_0, FILEDESC_DATA, FILEDESC_FORMAT, FILEDESC_MAJOR, FILEDESC_METADATA, FILEDESC_MINOR, FILEDESC_ORGANIZATION, GZIP, GZIP_COMMENT_LENGTH, GZIP_DEFLATE_LENGTH, GZIP_FEXTRA, GZIP_FEXTRA_NAME, GZIP_FEXTRA_VALUE, GZIP_FILENAME, GZIP_FOOTER_LENGTH, GZIP_HEADER_CRC, GZIP_HEADER_LENGTH, GZIP_INFLATED_CRC, GZIP_INFLATED_LENGTH, HTML_BASE, HTML_HEAD, HTML_LINK_TAGS, HTML_LINKS, HTML_META_TAGS, HTML_METADATA, HTML_SCRIPT_TAGS, HTML_TITLE, HTTP_ENTITY_DIGEST, HTTP_ENTITY_LENGTH, HTTP_ENTITY_TRAILING_SLOP, HTTP_HEADERS_CORRUPT, HTTP_HEADERS_LENGTH, HTTP_HEADERS_LIST, HTTP_MESSAGE_METHOD, HTTP_MESSAGE_PATH, HTTP_MESSAGE_REASON, HTTP_MESSAGE_STATUS, HTTP_MESSAGE_VERSION, HTTP_REQUEST_MESSAGE, HTTP_REQUEST_METADATA, HTTP_RESPONSE_MESSAGE, HTTP_RESPONSE_METADATA, METADATA_KV_NAME, METADATA_KV_VALUE, PAYLOAD_CONTENT_TYPE, PAYLOAD_DIGEST, PAYLOAD_LEADING_SLOP_BYTES, PAYLOAD_LENGTH, PAYLOAD_METADATA, PAYLOAD_SLOP_BYTES, PAYLOAD_TYPE_DAT, PAYLOAD_TYPE_DNS, PAYLOAD_TYPE_FILEDESC, PAYLOAD_TYPE_HTTP_REQUEST, PAYLOAD_TYPE_HTTP_RESPONSE, PAYLOAD_TYPE_WARC_META_FIELDS, PAYLOAD_TYPE_WARCINFO, WARC_HEADER_LENGTH, WARC_HEADER_METADATA, WARC_META_FIELDS_CORRUPT, WARC_META_FIELDS_LIST, WARC_META_FIELDS_METADATA, WARCINFO_METADATA

Constructor Summary

Constructors

Constructor	Description
ARCResource(MetaData metaData, ResourceContainer container, ARCMetaData arcMetaData, InputStream raw)

Method Summary

Modifier and Type	Method	Description
MetaData	getEnvelopeMetaData()
InputStream	getInputStream()
void	notifyEOF()

Methods inherited from class org.archive.resource.AbstractResource

dump, dumpShort, getContainer, getMetaData

Methods inherited from class java.lang.Object

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

Constructor Details

ARCResource

public ARCResource(MetaData metaData,
 ResourceContainer container,
 ARCMetaData arcMetaData,
 InputStream raw)

Method Details

getInputStream

public InputStream getInputStream()

Specified by:

getInputStream in interface Resource

Returns:

an InputStream for reading data from this Resource. Use only once, and assume it is unbuffered

notifyEOF

public void notifyEOF()
               throws IOException

Specified by:

notifyEOF in interface EOFObserver

Throws:

IOException

getEnvelopeMetaData

public MetaData getEnvelopeMetaData()