ARCConstants (webarchive-commons 1.1.5 API)

All Superinterfaces:

ArchiveFileConstants

All Known Subinterfaces:

ARCConstants

All Known Implementing Classes:

ARCMetaData, ARCMetaDataParser, ARCReader, ARCReaderFactory, ARCReaderFactory.CompressedARCReader, ARCReaderFactory.UncompressedARCReader, ARCRecord, ARCRecordMetaData, ARCResource, ARCUtils, ARCWriter, HTTPHeadersResource
```
public interface ARCConstants
extends ArchiveFileConstants
```
Constants used by ARC files and in ARC file processing.

Author:

stack

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class ARCConstants.ArcRecordErrors
set of known errors encountered reading ARCs

Nested Classes
Modifier and Type	Interface and Description
`static class`	`ARCConstants.ArcRecordErrors` set of known errors encountered reading ARCs

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACTUAL_LENGTH_KEY`
`static String`	`ALEXA_DAT_MIME`
`static String`	`ARC_FILE_EXTENSION` ARC file extention.
`static byte[]`	`ARC_GZIP_EXTRA_FIELD` The FLG.FEXTRA field that is added to ARC files.
`static String`	`ARC_MAGIC_NUMBER` ARC file MAGIC NUMBER.
`static Charset`	`ARC_META_CHARSET`
`static int`	`CARRIAGE_RETURN_ORD`
`static String`	`CHECKSUM_FIELD_KEY` Key for checksum field.
`static String`	`CHECKSUM_HEADER_FIELD_KEY` Key for the ARC Header Checksum field.
`static String`	`CODE_HEADER_FIELD_KEY` Key for the ARC Header Result Code field.
`static String`	`COMPRESSED_ARC_FILE_EXTENSION` Compressed arc file extension.
`static String`	`DATE_STRING_KEY`
`static String`	`DECLARED_LENGTH_KEY`
`static String`	`DEFAULT_ENCODING` Encoding to use getting bytes from strings.
`static int`	`DEFAULT_GZIP_HEADER_LENGTH` Length of minimual 'default GZIP header.
`static long`	`DEFAULT_MAX_ARC_FILE_SIZE` Default maximum ARC file size.
`static String`	`DEFAULT_MIME`
`static String`	`DELIMITER`
`static String`	`DNS_MIME`
`static String`	`DOT_ARC_FILE_EXTENSION` Dot ARC file extension.
`static String`	`DOT_COMPRESSED_ARC_FILE_EXTENSION` Compressed dot arc file extension.
`static String`	`DOT_COMPRESSED_FILE_EXTENSION`
`static int`	`FIELD_COUNT`
`static String`	`FILEDESC_SCHEME`
`static String`	`FILENAME_FIELD_KEY` Key for filename field.
`static String`	`FILENAME_HEADER_FIELD_KEY` Key for the ARC Header filename field.
`static byte[]`	`GZIP_HEADER_BEGIN` Start of a GZIP header that uses default deflater.
`static char`	`HEADER_FIELD_SEPARATOR` ARC header field seperator character.
`static String`	`HEADER_LENGTH`
`static String`	`IP_HEADER_FIELD_KEY` Key for the ARC Header IP field.
`static String`	`IP_KEY`
`static String`	`LEADING_NEWLINES_KEY`
`static char`	`LINE_SEPARATOR` ARC file line seperator character.
`static String`	`LOCATION_HEADER_FIELD_KEY` Key for the ARC Header Location field.
`static int`	`MAX_HEADER_LINE_LENGTH` Assumed maximum size of a record meta header line.
`static int`	`MAX_META_LENGTH`
`static int`	`MAX_METADATA_LINE_LENGTH` Maximum length for a metadata line.
`static String`	`MIME_KEY`
`static int`	`MINIMUM_RECORD_LENGTH` Minimum possible record length.
`static int`	`NEW_LINE_ORD`
`static String`	`OFFSET_FIELD_KEY` Key for offset field.
`static String`	`OFFSET_HEADER_FIELD_KEY` Key for the ARC Header Offset field.
`static List<String>`	`REQUIRED_VERSION_1_HEADER_FIELDS` Version 1 required metadata fields.
`static String`	`STATUSCODE_FIELD_KEY` Key for statuscode field.
`static String`	`TOKENIZED_PREFIX` Tokenized field prefix.
`static String`	`TRAILING_CRUFT_KEY`
`static String`	`TRAILING_NEWLINES_KEY`
`static String`	`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, READER_IDENTIFIER_FIELD_KEY, RECORD_IDENTIFIER_FIELD_KEY, SINGLE_SPACE, TYPE_FIELD_KEY, URL_FIELD_KEY, VERSION_FIELD_KEY

- Field Detail
  - MAX_META_LENGTH
```
static final int MAX_META_LENGTH
```
    See Also:
    Constant Field Values
  - ARC_META_CHARSET
```
static final Charset ARC_META_CHARSET
```
  - NEW_LINE_ORD
```
static final int NEW_LINE_ORD
```
    See Also:
    Constant Field Values
  - CARRIAGE_RETURN_ORD
```
static final int CARRIAGE_RETURN_ORD
```
    See Also:
    Constant Field Values
  - DELIMITER
```
static final String DELIMITER
```
    See Also:
    Constant Field Values
  - FIELD_COUNT
```
static final int FIELD_COUNT
```
    See Also:
    Constant Field Values
  - URL_KEY
```
static final String URL_KEY
```
    See Also:
    Constant Field Values
  - IP_KEY
```
static final String IP_KEY
```
    See Also:
    Constant Field Values
  - DATE_STRING_KEY
```
static final String DATE_STRING_KEY
```
    See Also:
    Constant Field Values
  - MIME_KEY
```
static final String MIME_KEY
```
    See Also:
    Constant Field Values
  - DECLARED_LENGTH_KEY
```
static final String DECLARED_LENGTH_KEY
```
    See Also:
    Constant Field Values
  - ACTUAL_LENGTH_KEY
```
static final String ACTUAL_LENGTH_KEY
```
    See Also:
    Constant Field Values
  - LEADING_NEWLINES_KEY
```
static final String LEADING_NEWLINES_KEY
```
    See Also:
    Constant Field Values
  - TRAILING_NEWLINES_KEY
```
static final String TRAILING_NEWLINES_KEY
```
    See Also:
    Constant Field Values
  - TRAILING_CRUFT_KEY
```
static final String TRAILING_CRUFT_KEY
```
    See Also:
    Constant Field Values
  - HEADER_LENGTH
```
static final String HEADER_LENGTH
```
    See Also:
    Constant Field Values
  - DEFAULT_MIME
```
static final String DEFAULT_MIME
```
    See Also:
    Constant Field Values
  - FILEDESC_SCHEME
```
static final String FILEDESC_SCHEME
```
    See Also:
    Constant Field Values
  - DNS_MIME
```
static final String DNS_MIME
```
    See Also:
    Constant Field Values
  - ALEXA_DAT_MIME
```
static final String ALEXA_DAT_MIME
```
    See Also:
    Constant Field Values
  - DEFAULT_MAX_ARC_FILE_SIZE
```
static final long DEFAULT_MAX_ARC_FILE_SIZE
```
    Default maximum ARC file size.
    
    See Also:
    Constant Field Values
  - MAX_METADATA_LINE_LENGTH
```
static final int MAX_METADATA_LINE_LENGTH
```
    Maximum length for a metadata line.
    
    See Also:
    Constant Field Values
  - ARC_FILE_EXTENSION
```
static final String ARC_FILE_EXTENSION
```
    ARC file extention.
    
    See Also:
    Constant Field Values
  - DOT_ARC_FILE_EXTENSION
```
static final String DOT_ARC_FILE_EXTENSION
```
    Dot ARC file extension.
    
    See Also:
    Constant Field Values
  - DOT_COMPRESSED_FILE_EXTENSION
```
static final String DOT_COMPRESSED_FILE_EXTENSION
```
    See Also:
    Constant Field Values
  - COMPRESSED_ARC_FILE_EXTENSION
```
static final String COMPRESSED_ARC_FILE_EXTENSION
```
    Compressed arc file extension.
    
    See Also:
    Constant Field Values
  - DOT_COMPRESSED_ARC_FILE_EXTENSION
```
static final String DOT_COMPRESSED_ARC_FILE_EXTENSION
```
    Compressed dot arc file extension.
    
    See Also:
    Constant Field Values
  - DEFAULT_ENCODING
```
static final String DEFAULT_ENCODING
```
    Encoding to use getting bytes from strings. Specify an encoding rather than leave it to chance: i.e whatever the JVMs encoding. Use an encoding that gets the stream as bytes, not chars.
    
    See Also:
    Constant Field Values
  - LINE_SEPARATOR
```
static final char LINE_SEPARATOR
```
    ARC file line seperator character. This is what the alexa c-code looks for delimiting lines.
    
    See Also:
    Constant Field Values
  - HEADER_FIELD_SEPARATOR
```
static final char HEADER_FIELD_SEPARATOR
```
    ARC header field seperator character.
    
    See Also:
    Constant Field Values
  - ARC_MAGIC_NUMBER
```
static final String ARC_MAGIC_NUMBER
```
    ARC file *MAGIC NUMBER*. Every ARC file must begin w/ this.
    
    See Also:
    Constant Field Values
  - ARC_GZIP_EXTRA_FIELD
```
static final byte[] ARC_GZIP_EXTRA_FIELD
```
    The FLG.FEXTRA field that is added to ARC files. (See RFC1952 to understand FLG.FEXTRA).
  - IP_HEADER_FIELD_KEY
```
static final String IP_HEADER_FIELD_KEY
```
    Key for the ARC Header IP field. Lowercased.
    
    See Also:
    Constant Field Values
  - CODE_HEADER_FIELD_KEY
```
static final String CODE_HEADER_FIELD_KEY
```
    Key for the ARC Header Result Code field. Lowercased.
    
    See Also:
    Constant Field Values
  - CHECKSUM_HEADER_FIELD_KEY
```
static final String CHECKSUM_HEADER_FIELD_KEY
```
    Key for the ARC Header Checksum field. Lowercased.
    
    See Also:
    Constant Field Values
  - LOCATION_HEADER_FIELD_KEY
```
static final String LOCATION_HEADER_FIELD_KEY
```
    Key for the ARC Header Location field. Lowercased.
    
    See Also:
    Constant Field Values
  - OFFSET_HEADER_FIELD_KEY
```
static final String OFFSET_HEADER_FIELD_KEY
```
    Key for the ARC Header Offset field. Lowercased.
    
    See Also:
    Constant Field Values
  - FILENAME_HEADER_FIELD_KEY
```
static final String FILENAME_HEADER_FIELD_KEY
```
    Key for the ARC Header filename field. Lowercased.
    
    See Also:
    Constant Field Values
  - STATUSCODE_FIELD_KEY
```
static final String STATUSCODE_FIELD_KEY
```
    Key for statuscode field.
    
    See Also:
    Constant Field Values
  - OFFSET_FIELD_KEY
```
static final String OFFSET_FIELD_KEY
```
    Key for offset field.
    
    See Also:
    Constant Field Values
  - FILENAME_FIELD_KEY
```
static final String FILENAME_FIELD_KEY
```
    Key for filename field.
    
    See Also:
    Constant Field Values
  - CHECKSUM_FIELD_KEY
```
static final String CHECKSUM_FIELD_KEY
```
    Key for checksum field.
    
    See Also:
    Constant Field Values
  - TOKENIZED_PREFIX
```
static final String TOKENIZED_PREFIX
```
    Tokenized field prefix. Use this prefix for tokenized fields when naming fields in an index.
    
    See Also:
    Constant Field Values
  - MAX_HEADER_LINE_LENGTH
```
static final int MAX_HEADER_LINE_LENGTH
```
    Assumed maximum size of a record meta header line. This 100k which seems massive but its the same as the LINE_LENGTH from alexa/include/a_arcio.h:
```
 #define LINE_LENGTH     (100*1024)
 
```
    See Also:
    Constant Field Values
  - REQUIRED_VERSION_1_HEADER_FIELDS
```
static final List<String> REQUIRED_VERSION_1_HEADER_FIELDS
```
    Version 1 required metadata fields.
  - MINIMUM_RECORD_LENGTH
```
static final int MINIMUM_RECORD_LENGTH
```
    Minimum possible record length. This is a rough calc. When the header is data it will occupy less space.
  - GZIP_HEADER_BEGIN
```
static final byte[] GZIP_HEADER_BEGIN
```
    Start of a GZIP header that uses default deflater.
  - DEFAULT_GZIP_HEADER_LENGTH
```
static final int DEFAULT_GZIP_HEADER_LENGTH
```
    Length of minimual 'default GZIP header. See RFC1952 for explaination of value of 10.
    
    See Also:
    Constant Field Values

Interface ARCConstants

Nested Class Summary

Field Summary

Fields inherited from interface org.archive.format.ArchiveFileConstants

Field Detail

MAX_META_LENGTH

ARC_META_CHARSET

NEW_LINE_ORD

CARRIAGE_RETURN_ORD

DELIMITER

FIELD_COUNT

URL_KEY

IP_KEY

DATE_STRING_KEY

MIME_KEY

DECLARED_LENGTH_KEY

ACTUAL_LENGTH_KEY

LEADING_NEWLINES_KEY

TRAILING_NEWLINES_KEY

TRAILING_CRUFT_KEY

HEADER_LENGTH

DEFAULT_MIME

FILEDESC_SCHEME

DNS_MIME

ALEXA_DAT_MIME

DEFAULT_MAX_ARC_FILE_SIZE

MAX_METADATA_LINE_LENGTH

ARC_FILE_EXTENSION

DOT_ARC_FILE_EXTENSION

DOT_COMPRESSED_FILE_EXTENSION

COMPRESSED_ARC_FILE_EXTENSION

DOT_COMPRESSED_ARC_FILE_EXTENSION

DEFAULT_ENCODING

LINE_SEPARATOR

HEADER_FIELD_SEPARATOR

ARC_MAGIC_NUMBER

ARC_GZIP_EXTRA_FIELD

IP_HEADER_FIELD_KEY

CODE_HEADER_FIELD_KEY

CHECKSUM_HEADER_FIELD_KEY

LOCATION_HEADER_FIELD_KEY

OFFSET_HEADER_FIELD_KEY

FILENAME_HEADER_FIELD_KEY

STATUSCODE_FIELD_KEY

OFFSET_FIELD_KEY

FILENAME_FIELD_KEY

CHECKSUM_FIELD_KEY

TOKENIZED_PREFIX

MAX_HEADER_LINE_LENGTH

REQUIRED_VERSION_1_HEADER_FIELDS

MINIMUM_RECORD_LENGTH

GZIP_HEADER_BEGIN

DEFAULT_GZIP_HEADER_LENGTH