org.archive.format.warc.WARCConstants Maven / Gradle / Ivy
/*
* This file is part of the Heritrix web crawler (crawler.archive.org).
*
* Licensed to the Internet Archive (IA) by one or more individual
* contributors.
*
* The IA licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.archive.format.warc;
import org.archive.format.ArchiveFileConstants;
/**
* WARC Constants used by WARC readers and writers.
*
* @contributor stack
*/
public interface WARCConstants extends ArchiveFileConstants {
/**
* Default maximum WARC file size.
* 1Gig.
*/
public static final int DEFAULT_MAX_WARC_FILE_SIZE = 1024 * 1024 * 1024;
/**
* WARC MAGIC
* WARC files and records begin with this sequence.
*/
public static final String WARC_MAGIC = "WARC/";
/**
* Hard-coded version for WARC files made with this code.
* conforms to ISO 28500:2009 as of May 2009
*/
public static final String WARC_VERSION = "1.0";
/**
* Assumed maximum size of a 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)
*
*/
public static final int MAX_WARC_HEADER_LINE_LENGTH = 1024 * 100;
public static final int MAX_LINE_LENGTH = MAX_WARC_HEADER_LINE_LENGTH;
/**
* WARC file extention.
*/
public static final String WARC_FILE_EXTENSION = "warc";
/**
* Dot WARC file extension.
*/
public static final String DOT_WARC_FILE_EXTENSION =
"." + WARC_FILE_EXTENSION;
/**
* Compressed WARC file extension.
*/
public static final String COMPRESSED_WARC_FILE_EXTENSION =
WARC_FILE_EXTENSION + DOT_COMPRESSED_FILE_EXTENSION;
/**
* Compressed dot WARC file extension.
*/
public static final String DOT_COMPRESSED_WARC_FILE_EXTENSION =
DOT_WARC_FILE_EXTENSION + DOT_COMPRESSED_FILE_EXTENSION;
/**
* 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.
*
* TODO: ARC uses ISO-8859-1. In general, we should use UTF-8 but we
* probably need a single byte encoding if we're out for preserving the
* binary data as received over the net (We probably don't want to transform
* the supra-ASCII characters to UTF-8 before storing in ARC). For now,
* till we figure it, DEFAULT_ENCODING is single-byte charset -- same as
* ARCs.
*/
public static final String DEFAULT_ENCODING = "UTF-8";
public static final String HEADER_LINE_ENCODING = DEFAULT_ENCODING;
// TODO: Revisit. 8859 isn't correct, especially if we settle on RFC822
// headers
public static final String WARC_HEADER_ENCODING = HEADER_LINE_ENCODING;
/**
* WARC Record Types. These names need to match the literal string values.
*/
enum WARCRecordType {
warcinfo,
response,
resource,
request,
metadata,
revisit,
conversion,
continuation
}
public static final String TYPE = "type";
/**
* WARC-ID
*/
public static final String WARC_ID = WARC_MAGIC + WARC_VERSION;
/**
* Header field seperator character.
*/
public static final char HEADER_FIELD_SEPARATOR = ' ';
/**
* WSP
* One of a space or horizontal tab character.
* TODO: WSP undefined. Fix.
*/
public static final Character [] WSP = {HEADER_FIELD_SEPARATOR, '\t'};
/**
* Placeholder for length in Header line.
* Placeholder is same size as the fixed field size allocated for length,
* 12 characters. 12 characters allows records of size almost 1TB.
*/
public static final String PLACEHOLDER_RECORD_LENGTH_STRING =
"000000000000";
public static final String NAMED_FIELD_IP_LABEL = "IP-Address";
public static final String NAMED_FIELD_CHECKSUM_LABEL = "Checksum";
public static final String NAMED_FIELD_RELATED_LABEL = "References";
public static final String NAMED_FIELD_WARCFILENAME = "Filename";
public static final String NAMED_FIELD_DESCRIPTION = "Description";
public static final String NAMED_FIELD_FILEDESC = "ARC-FileDesc";
public static final String NAMED_FIELD_TRUNCATED = "Truncated";
public static final String NAMED_FIELD_TRUNCATED_VALUE_TIME = "time";
public static final String NAMED_FIELD_TRUNCATED_VALUE_LENGTH = "length";
public static final String NAMED_FIELD_TRUNCATED_VALUE_HEAD =
"long-headers";
public static final String NAMED_FIELD_TRUNCATED_VALUE_UNSPECIFIED = null;
// Headers for version 0.17 of spec.
public static final String HEADER_KEY_URI = "WARC-Target-URI";
public static final String HEADER_KEY_DATE = "WARC-Date";
public static final String HEADER_KEY_TYPE = "WARC-Type";
public static final String HEADER_KEY_ID = "WARC-Record-ID";
public static final String HEADER_KEY_IP = "WARC-IP-Address";
public static final String HEADER_KEY_BLOCK_DIGEST = "WARC-Block-Digest";
public static final String HEADER_KEY_PAYLOAD_DIGEST = "WARC-Payload-Digest";
public static final String HEADER_KEY_CONCURRENT_TO =
"WARC-Concurrent-To";
public static final String HEADER_KEY_TRUNCATED = "WARC-Truncated";
public static final String HEADER_KEY_PROFILE = "WARC-Profile";
public static final String HEADER_KEY_FILENAME = "WARC-Filename";
public static final String HEADER_KEY_ETAG = "WARC-Etag";
public static final String HEADER_KEY_LAST_MODIFIED = "WARC-Last-Modified";
public static final String HEADER_KEY_REFERS_TO = "WARC-Refers-To";
/**
* These fields help a consumer of the warc to locate the warc record that
* {@value #HEADER_KEY_REFERS_TO} refers to.
*
* @see WARCWriterProcessor
*/
public static final String HEADER_KEY_REFERS_TO_TARGET_URI = "WARC-Refers-To-Target-URI";
public static final String HEADER_KEY_REFERS_TO_DATE = "WARC-Refers-To-Date";
public static final String HEADER_KEY_REFERS_TO_FILENAME = "WARC-Refers-To-Filename";
public static final String HEADER_KEY_REFERS_TO_FILE_OFFSET = "WARC-Refers-To-File-Offset";
public static final String PROFILE_REVISIT_IDENTICAL_DIGEST =
"http://netpreserve.org/warc/1.0/revisit/identical-payload-digest";
public static final String PROFILE_REVISIT_NOT_MODIFIED =
"http://netpreserve.org/warc/1.0/revisit/server-not-modified";
public static final String CONTENT_LENGTH = "Content-Length";
public static final String CONTENT_TYPE = "Content-Type";
public static final String CONTENT_DESCRIPTION = "Content-Description";
public static final String COLON_SPACE = ": ";
public static final String TRUNCATED_VALUE_UNSPECIFIED = "unspecified";
/**
* To be safe, lets use application type rather than message. Regards
* 'message/http', RFC says "...provided that it obeys the MIME restrictions
* for all 'message' types regarding line length and encodings." This
* usually means lines of 1000 octets max (unless a
* 'Content-Transfer-Encoding: binary' mime header is present).
* @see rfc2616 section 19.1
*/
public static final String HTTP_REQUEST_MIMETYPE =
"application/http; msgtype=request";
public static final String HTTP_RESPONSE_MIMETYPE =
"application/http; msgtype=response";
public static final String FTP_CONTROL_CONVERSATION_MIMETYPE =
"text/x-ftp-control-conversation";
public static final String WARC_FIELDS_TYPE = "application/warc-fields";
}