public class ArcHeader extends java.lang.Object
| Modifier and Type | Field and Description |
|---|---|
java.util.Date |
archiveDate
Archive date validated and converted to a
Date object. |
java.lang.String |
archiveDateStr
ARC record archive-date field string value.
|
java.lang.Long |
archiveLength
Archive-length validated and converted into a
Long object. |
java.lang.String |
archiveLengthStr
ARC record archive-length field string value.
|
java.lang.String |
checksumStr
ARC record checksum field string value.
|
ContentType |
contentType
Content-Type wrapper object with optional parameters.
|
java.lang.String |
contentTypeStr
ARC record content-type field string value.
|
protected Diagnostics<Diagnosis> |
diagnostics
Diagnostics used to report diagnoses.
|
protected ArcFieldParsers |
fieldParsers
ARC field parser used.
|
java.lang.String |
filenameStr
ARC record filename field string value.
|
protected boolean |
hasCompliantFields
Do the record fields comply in number with the one dictated by its
version.
|
byte[] |
headerBytes
Raw ARC header line byte array.
|
java.net.InetAddress |
inetAddress
IP-Address validated and converted to an
InetAddress object. |
java.lang.String |
ipAddressStr
ARC record IP-Address field string value.
|
java.lang.String |
locationStr
ARC record location field string value.
|
java.lang.Long |
offset
Offset validated and converted into a
Long object. |
java.lang.String |
offsetStr
ARC record offset field string value.
|
protected ArcReader |
reader
Associated WarcReader context.
|
int |
recordFieldVersion
Which version of the record fields was parsed, 1.x or 2.0.
|
java.lang.Integer |
resultCode
Result-code validated and converted into an
Integer object. |
java.lang.String |
resultCodeStr
ARC record result-code field string value.
|
protected long |
startOffset
ARC record starting offset relative to the source ARC file input
stream.
|
protected UriProfile |
uriProfile
URL URI profile.
|
java.lang.String |
urlScheme
URI Scheme (lowercase).
|
java.lang.String |
urlStr
ARC record URL field string value.
|
Uri |
urlUri
ARC record URL validated and converted to an
URI object. |
| Modifier | Constructor and Description |
|---|---|
protected |
ArcHeader()
Non public constructor to allow unit testing.
|
| Modifier and Type | Method and Description |
|---|---|
long |
getStartOffset()
Returns the starting offset of the record in the containing ARC.
|
static ArcHeader |
initHeader(ArcFieldParsers fieldParsers,
UriProfile uriProfile,
Diagnostics<Diagnosis> diagnostics)
Create a new
ArcHeader for recreating a header object. |
static ArcHeader |
initHeader(ArcReader reader,
long startOffset,
Diagnostics<Diagnosis> diagnostics)
Create and initialize a new
ArcHeader for reading. |
static ArcHeader |
initHeader(ArcWriter writer,
Diagnostics<Diagnosis> diagnostics)
Create and initialize a new
ArcHeader for writing. |
boolean |
parseHeader(ByteCountingPushBackInputStream in)
Tries to read lines from the input stream to determine if they could
be possible ARC record header lines.
|
void |
parseHeaders(java.lang.String[] fields)
Examines an array of strings to determine if it could be an ARC record
header.
|
java.lang.String |
toString() |
void |
toStringBuilder(java.lang.StringBuilder sb)
Add object information to
StringBuilder. |
protected ArcReader reader
protected Diagnostics<Diagnosis> diagnostics
protected UriProfile uriProfile
protected ArcFieldParsers fieldParsers
protected long startOffset
public int recordFieldVersion
protected boolean hasCompliantFields
public java.lang.String urlStr
public java.lang.String urlScheme
public java.lang.String ipAddressStr
public java.net.InetAddress inetAddress
InetAddress object.public java.lang.String archiveDateStr
public java.util.Date archiveDate
Date object.public java.lang.String contentTypeStr
public ContentType contentType
public java.lang.String resultCodeStr
public java.lang.Integer resultCode
Integer object.public java.lang.String checksumStr
public java.lang.String locationStr
public java.lang.String offsetStr
public java.lang.Long offset
Long object.public java.lang.String filenameStr
public java.lang.String archiveLengthStr
public java.lang.Long archiveLength
Long object.public byte[] headerBytes
protected ArcHeader()
public static ArcHeader initHeader(ArcFieldParsers fieldParsers, UriProfile uriProfile, Diagnostics<Diagnosis> diagnostics)
ArcHeader for recreating a header object.uriProfile - uri profile used to validate urlsfieldParsers - parsers used for the individual typesdiagnostics - diagnostics object used by parserArcHeader prepared for writingpublic static ArcHeader initHeader(ArcWriter writer, Diagnostics<Diagnosis> diagnostics)
ArcHeader for writing.writer - writer which shall be useddiagnostics - diagnostics object used by writerArcHeader prepared for writingpublic static ArcHeader initHeader(ArcReader reader, long startOffset, Diagnostics<Diagnosis> diagnostics)
ArcHeader for reading.reader - reader which shall be usedstartOffset - start offset of headerdiagnostics - diagnostics object used by readerArcHeader prepared for readingpublic boolean parseHeader(ByteCountingPushBackInputStream in) throws java.io.IOException
in - input stream supposedly containing ARC recordsjava.io.IOException - if an I/O exception occurs while trying to read an
ARC record headerpublic void parseHeaders(java.lang.String[] fields)
fields - array of possible ARC record header fieldspublic long getStartOffset()
public void toStringBuilder(java.lang.StringBuilder sb)
StringBuilder.sb - StringBuilder where to add informationpublic java.lang.String toString()
toString in class java.lang.ObjectCopyright © 2011–2022. All rights reserved.