| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>WARCRecord.Header (Apache HBase 3.0.0-alpha-2-SNAPSHOT Test API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="WARCRecord.Header (Apache HBase 3.0.0-alpha-2-SNAPSHOT Test API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/WARCRecord.Header.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../../org/apache/hadoop/hbase/test/util/warc/WARCRecord.html" title="class in org.apache.hadoop.hbase.test.util.warc"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/hadoop/hbase/test/util/warc/WARCWritable.html" title="class in org.apache.hadoop.hbase.test.util.warc"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/hadoop/hbase/test/util/warc/WARCRecord.Header.html" target="_top">Frames</a></li> |
| <li><a href="WARCRecord.Header.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.hadoop.hbase.test.util.warc</div> |
| <h2 title="Class WARCRecord.Header" class="title">Class WARCRecord.Header</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.hadoop.hbase.test.util.warc.WARCRecord.Header</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Enclosing class:</dt> |
| <dd><a href="../../../../../../../org/apache/hadoop/hbase/test/util/warc/WARCRecord.html" title="class in org.apache.hadoop.hbase.test.util.warc">WARCRecord</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public static final class <a href="../../../../../../../src-html/org/apache/hadoop/hbase/test/util/warc/WARCRecord.html#line.192">WARCRecord.Header</a> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> |
| <div class="block">Contains the parsed headers of a <a href="../../../../../../../org/apache/hadoop/hbase/test/util/warc/WARCRecord.html" title="class in org.apache.hadoop.hbase.test.util.warc"><code>WARCRecord</code></a>. Each record contains a number |
| of headers in key-value format, where some header keys are standardised, but |
| nonstandard ones can be added. |
| |
| The documentation of the methods in this class is excerpted from the |
| [WARC 1.0 specification](http://bibnum.bnf.fr/warc/WARC_ISO_28500_version1_latestdraft.pdf). |
| Please see the specification for more detail.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>private <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hbase/test/util/warc/WARCRecord.Header.html#fields">fields</a></span></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier</th> |
| <th class="colLast" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>private </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hbase/test/util/warc/WARCRecord.Header.html#Header-java.util.Map-">Header</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> fields)</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hbase/test/util/warc/WARCRecord.Header.html#getContentLength--">getContentLength</a></span>()</code> |
| <div class="block">The number of bytes in the body of the record, similar to RFC2616.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hbase/test/util/warc/WARCRecord.Header.html#getContentType--">getContentType</a></span>()</code> |
| <div class="block">The MIME type (RFC2045) of the information contained in the record's block.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hbase/test/util/warc/WARCRecord.Header.html#getDateString--">getDateString</a></span>()</code> |
| <div class="block">A 14-digit UTC timestamp formatted according to YYYY-MM-DDThh:mm:ssZ, described |
| in the W3C profile of ISO8601.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hbase/test/util/warc/WARCRecord.Header.html#getField-java.lang.String-">getField</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> field)</code> |
| <div class="block">Returns the value of a selected header field, or null if there is no header with |
| that field name.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hbase/test/util/warc/WARCRecord.Header.html#getRecordID--">getRecordID</a></span>()</code> |
| <div class="block">An identifier assigned to the current record that is globally unique for its |
| period of intended use.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hbase/test/util/warc/WARCRecord.Header.html#getRecordType--">getRecordType</a></span>()</code> |
| <div class="block">Returns the type of WARC record (the value of the `WARC-Type` header field).</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hbase/test/util/warc/WARCRecord.Header.html#getTargetURI--">getTargetURI</a></span>()</code> |
| <div class="block">The original URI whose capture gave rise to the information content in this record.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hbase/test/util/warc/WARCRecord.Header.html#toString--">toString</a></span>()</code> |
| <div class="block">Formats this header in WARC/1.0 format, consisting of a version line followed |
| by colon-delimited key-value pairs, and `\r\n` line endings.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hbase/test/util/warc/WARCRecord.Header.html#write-java.io.DataOutput-">write</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/DataOutput.html?is-external=true" title="class or interface in java.io">DataOutput</a> out)</code> |
| <div class="block">Appends this header to a <a href="https://docs.oracle.com/javase/8/docs/api/java/io/DataOutput.html?is-external=true" title="class or interface in java.io"><code>DataOutput</code></a> stream, in WARC/1.0 format.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="fields"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>fields</h4> |
| <pre>private final <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> <a href="../../../../../../../src-html/org/apache/hadoop/hbase/test/util/warc/WARCRecord.Header.html#line.193">fields</a></pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="Header-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>Header</h4> |
| <pre>private <a href="../../../../../../../src-html/org/apache/hadoop/hbase/test/util/warc/WARCRecord.Header.html#line.195">Header</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> fields)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getRecordType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRecordType</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../../src-html/org/apache/hadoop/hbase/test/util/warc/WARCRecord.Header.html#line.280">getRecordType</a>()</pre> |
| <div class="block">Returns the type of WARC record (the value of the `WARC-Type` header field). |
| WARC 1.0 defines the following record types: (for full definitions, see the |
| [spec](http://bibnum.bnf.fr/warc/WARC_ISO_28500_version1_latestdraft.pdf)) |
| |
| * `warcinfo`: Describes the records that follow it, up through end of file, |
| end of input, or until next `warcinfo` record. Typically, this appears once and |
| at the beginning of a WARC file. For a web archive, it often contains information |
| about the web crawl which generated the following records. |
| |
| The format of this descriptive record block may vary, though the use of the |
| `"application/warc-fields"` content-type is recommended. (...) |
| |
| * `response`: The record should contain a complete scheme-specific response, including |
| network protocol information where possible. For a target-URI of the `http` or |
| `https` schemes, a `response` record block should contain the full HTTP |
| response received over the network, including headers. That is, it contains the |
| 'Response' message defined by section 6 of HTTP/1.1 (RFC2616). |
| |
| The WARC record's Content-Type field should contain the value defined by HTTP/1.1, |
| `"application/http;msgtype=response"`. The payload of the record is defined as its |
| 'entity-body' (per RFC2616), with any transfer-encoding removed. |
| |
| * `resource`: The record contains a resource, without full protocol response |
| information. For example: a file directly retrieved from a locally accessible |
| repository or the result of a networked retrieval where the protocol information |
| has been discarded. For a target-URI of the `http` or `https` schemes, a `resource` |
| record block shall contain the returned 'entity-body' (per RFC2616, with any |
| transfer-encodings removed), possibly truncated. |
| |
| * `request`: The record holds the details of a complete scheme-specific request, |
| including network protocol information where possible. For a target-URI of the |
| `http` or `https` schemes, a `request` record block should contain the full HTTP |
| request sent over the network, including headers. That is, it contains the |
| 'Request' message defined by section 5 of HTTP/1.1 (RFC2616). |
| |
| The WARC record's Content-Type field should contain the value defined by HTTP/1.1, |
| `"application/http;msgtype=request"`. The payload of a `request` record with a |
| target-URI of scheme `http` or `https` is defined as its 'entity-body' (per |
| RFC2616), with any transfer-encoding removed. |
| |
| * `metadata`: The record contains content created in order to further describe, |
| explain, or accompany a harvested resource, in ways not covered by other record |
| types. A `metadata` record will almost always refer to another record of another |
| type, with that other record holding original harvested or transformed content. |
| |
| The format of the metadata record block may vary. The `"application/warc-fields"` |
| format may be used. |
| |
| * `revisit`: The record describes the revisitation of content already archived, |
| and might include only an abbreviated content body which has to be interpreted |
| relative to a previous record. Most typically, a `revisit` record is used |
| instead of a `response` or `resource` record to indicate that the content |
| visited was either a complete or substantial duplicate of material previously |
| archived. |
| |
| A `revisit` record shall contain a WARC-Profile field which determines the |
| interpretation of the record's fields and record block. Please see the |
| specification for details. |
| |
| * `conversion`: The record shall contain an alternative version of another |
| record's content that was created as the result of an archival process. |
| Typically, this is used to hold content transformations that maintain viability |
| of content after widely available rendering tools for the originally stored |
| format disappear. As needed, the original content may be migrated (transformed) |
| to a more viable format in order to keep the information usable with current |
| tools while minimizing loss of information. |
| |
| * `continuation`: Record blocks from `continuation` records must be appended to |
| corresponding prior record blocks (eg. from other WARC files) to create the |
| logically complete full-sized original record. That is, `continuation` |
| records are used when a record that would otherwise cause a WARC file size to |
| exceed a desired limit is broken into segments. A continuation record shall |
| contain the named fields `WARC-Segment-Origin-ID` and `WARC-Segment-Number`, |
| and the last `continuation` record of a series shall contain a |
| `WARC-Segment-Total-Length` field. Please see the specification for details. |
| |
| * Other record types may be added in future, so this list is not exclusive.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The record's `WARC-Type` header field, as a string.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDateString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDateString</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../../src-html/org/apache/hadoop/hbase/test/util/warc/WARCRecord.Header.html#line.293">getDateString</a>()</pre> |
| <div class="block">A 14-digit UTC timestamp formatted according to YYYY-MM-DDThh:mm:ssZ, described |
| in the W3C profile of ISO8601. The timestamp shall represent the instant that |
| data capture for record creation began. Multiple records written as part of a |
| single capture event shall use the same WARC-Date, even though the times of |
| their writing will not be exactly synchronized.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The record's `WARC-Date` header field, as a string.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRecordID--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRecordID</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../../src-html/org/apache/hadoop/hbase/test/util/warc/WARCRecord.Header.html#line.306">getRecordID</a>()</pre> |
| <div class="block">An identifier assigned to the current record that is globally unique for its |
| period of intended use. No identifier scheme is mandated by this specification, |
| but each record-id shall be a legal URI and clearly indicate a documented and |
| registered scheme to which it conforms (e.g., via a URI scheme prefix such as |
| `http:` or `urn:`).</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The record's `WARC-Record-ID` header field, as a string.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getContentType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContentType</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../../src-html/org/apache/hadoop/hbase/test/util/warc/WARCRecord.Header.html#line.323">getContentType</a>()</pre> |
| <div class="block">The MIME type (RFC2045) of the information contained in the record's block. For |
| example, in HTTP request and response records, this would be `application/http` |
| as per section 19.1 of RFC2616 (or `application/http; msgtype=request` and |
| `application/http; msgtype=response` respectively). |
| |
| In particular, the content-type is *not* the value of the HTTP Content-Type |
| header in an HTTP response, but a MIME type to describe the full archived HTTP |
| message (hence `application/http` if the block contains request or response |
| headers).</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The record's `Content-Type` header field, as a string.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTargetURI--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTargetURI</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../../src-html/org/apache/hadoop/hbase/test/util/warc/WARCRecord.Header.html#line.338">getTargetURI</a>()</pre> |
| <div class="block">The original URI whose capture gave rise to the information content in this record. |
| In the context of web harvesting, this is the URI that was the target of a |
| crawler's retrieval request. For a `revisit` record, it is the URI that was the |
| target of a retrieval request. Indirectly, such as for a `metadata`, or `conversion` |
| record, it is a copy of the `WARC-Target-URI` appearing in the original record to |
| which the newer record pertains. The URI in this value shall be properly escaped |
| according to RFC3986, and written with no internal whitespace.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The record's `WARC-Target-URI` header field, as a string.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getContentLength--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContentLength</h4> |
| <pre>public int <a href="../../../../../../../src-html/org/apache/hadoop/hbase/test/util/warc/WARCRecord.Header.html#line.347">getContentLength</a>()</pre> |
| <div class="block">The number of bytes in the body of the record, similar to RFC2616.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The record's `Content-Length` header field, parsed into an int.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getField-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getField</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../../src-html/org/apache/hadoop/hbase/test/util/warc/WARCRecord.Header.html#line.365">getField</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> field)</pre> |
| <div class="block">Returns the value of a selected header field, or null if there is no header with |
| that field name.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>field</code> - The name of the header to return (case-sensitive).</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The value associated with that field name, or null if not present.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="write-java.io.DataOutput-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>write</h4> |
| <pre>public void <a href="../../../../../../../src-html/org/apache/hadoop/hbase/test/util/warc/WARCRecord.Header.html#line.373">write</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/DataOutput.html?is-external=true" title="class or interface in java.io">DataOutput</a> out) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Appends this header to a <a href="https://docs.oracle.com/javase/8/docs/api/java/io/DataOutput.html?is-external=true" title="class or interface in java.io"><code>DataOutput</code></a> stream, in WARC/1.0 format.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>out</code> - The data output to which the header should be written.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../../src-html/org/apache/hadoop/hbase/test/util/warc/WARCRecord.Header.html#line.382">toString</a>()</pre> |
| <div class="block">Formats this header in WARC/1.0 format, consisting of a version line followed |
| by colon-delimited key-value pairs, and `\r\n` line endings.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/WARCRecord.Header.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../../org/apache/hadoop/hbase/test/util/warc/WARCRecord.html" title="class in org.apache.hadoop.hbase.test.util.warc"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/hadoop/hbase/test/util/warc/WARCWritable.html" title="class in org.apache.hadoop.hbase.test.util.warc"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/hadoop/hbase/test/util/warc/WARCRecord.Header.html" target="_top">Frames</a></li> |
| <li><a href="WARCRecord.Header.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2007–2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
