Interface ArchiveRecordHeader

All Known Implementing Classes:
ARCRecordMetaData
public interface ArchiveRecordHeader
Archive Record Header.
Version:
$Date$ $Version$
Author:
stack

  • Method Details

    • getDate

      String getDate()
      Get the time when the record was created.
      Returns:
      Date in 14 digit time format (UTC).
      See Also:

    • getLength

      long getLength()
      Returns:
      Return length of record.

    • getContentLength

      long getContentLength()
      Returns:
      Return Content-Length of the contents of the record

    • getUrl

      String getUrl()
      Returns:
      Record subject-url.

    • getMimetype

      String getMimetype()
      Returns:
      Record mimetype.

    • getVersion

      String getVersion()
      Returns:
      Record version.

    • getOffset

      long getOffset()
      Returns:
      Offset into Archive file at which this record begins.

    • getHeaderValue

      Object getHeaderValue(String key)
      Parameters:
      key - Key to use looking up field value.
      Returns:
      value for passed key of null if no such entry.

    • getHeaderFieldKeys

      Set<String> getHeaderFieldKeys()
      Returns:
      Header field name keys.

    • getHeaderFields

      Map<String,Object> getHeaderFields()
      Returns:
      Map of header fields.

    • getReaderIdentifier

      String getReaderIdentifier()
      Returns:
      Returns identifier for current Archive file. Be aware this may not be a file name or file path. It may just be an URL. Depends on how Archive file was made.

    • getRecordIdentifier

      String getRecordIdentifier()
      Returns:
      Identifier for the record. If ARC, the URL + date. If WARC, the GUID assigned.

    • getDigest

      String getDigest()
      Returns:
      Returns digest as String for this record. Only available after the record has been read in totality.

    • getContentBegin

      int getContentBegin()
      Offset at which the content begins. For ARCs, its used to delimit where http headers end and content begins. For WARCs, its end of Named Fields before payload starts.

    • toString

      String toString()
      Overrides:
      toString in class Object