| <!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 (1.8.0_201) on Thu Apr 11 20:05:12 EDT 2019 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>AbstractInputFormat (Apache Accumulo Project 1.9.3 API)</title> |
| <meta name="date" content="2019-04-11"> |
| <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="AbstractInputFormat (Apache Accumulo Project 1.9.3 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":10,"i10":41,"i11":41,"i12":41,"i13":9,"i14":9,"i15":9,"i16":9,"i17":9,"i18":41,"i19":9,"i20":9,"i21":41,"i22":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/AbstractInputFormat.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>Prev Class</li> |
| <li><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/AbstractInputFormat.AbstractRecordReader.html" title="class in org.apache.accumulo.core.client.mapreduce"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/accumulo/core/client/mapreduce/AbstractInputFormat.html" target="_top">Frames</a></li> |
| <li><a href="AbstractInputFormat.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><a href="#nested.class.summary">Nested</a> | </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.accumulo.core.client.mapreduce</div> |
| <h2 title="Class AbstractInputFormat" class="title">Class AbstractInputFormat<K,V></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.mapreduce.InputFormat<K,V></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.accumulo.core.client.mapreduce.AbstractInputFormat<K,V></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/AccumuloMultiTableInputFormat.html" title="class in org.apache.accumulo.core.client.mapreduce">AccumuloMultiTableInputFormat</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputFormatBase.html" title="class in org.apache.accumulo.core.client.mapreduce">InputFormatBase</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">AbstractInputFormat<K,V></span> |
| extends org.apache.hadoop.mapreduce.InputFormat<K,V></pre> |
| <div class="block">An abstract input format to provide shared methods common to all other input format classes. At |
| the very least, any classes inheriting from this class will need to define their own |
| <code>RecordReader</code>.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/AbstractInputFormat.AbstractRecordReader.html" title="class in org.apache.accumulo.core.client.mapreduce">AbstractInputFormat.AbstractRecordReader</a><<a href="../../../../../../org/apache/accumulo/core/client/mapreduce/AbstractInputFormat.AbstractRecordReader.html" title="type parameter in AbstractInputFormat.AbstractRecordReader">K</a>,<a href="../../../../../../org/apache/accumulo/core/client/mapreduce/AbstractInputFormat.AbstractRecordReader.html" title="type parameter in AbstractInputFormat.AbstractRecordReader">V</a>></span></code> |
| <div class="block">An abstract base class to be used to create <code>RecordReader</code> |
| instances that convert from Accumulo |
| <a href="../../../../../../org/apache/accumulo/core/data/Key.html" title="class in org.apache.accumulo.core.data"><code>Key</code></a>/<a href="../../../../../../org/apache/accumulo/core/data/Value.html" title="class in org.apache.accumulo.core.data"><code>Value</code></a> pairs to |
| the user's K/V types.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- =========== 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>protected static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/AbstractInputFormat.html#CLASS">CLASS</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected static org.apache.log4j.Logger</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/AbstractInputFormat.html#log">log</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="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/AbstractInputFormat.html#AbstractInputFormat--">AbstractInputFormat</a></span>()</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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>protected static <a href="../../../../../../org/apache/accumulo/core/client/security/tokens/AuthenticationToken.html" title="interface in org.apache.accumulo.core.client.security.tokens">AuthenticationToken</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/AbstractInputFormat.html#getAuthenticationToken-org.apache.hadoop.mapreduce.JobContext-">getAuthenticationToken</a></span>(org.apache.hadoop.mapreduce.JobContext context)</code> |
| <div class="block">Gets the authenticated token from either the specified token file or directly from the |
| configuration, whichever was used when the job was configured.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <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/accumulo/core/client/mapreduce/AbstractInputFormat.html#getClassLoaderContext-org.apache.hadoop.mapreduce.JobContext-">getClassLoaderContext</a></span>(org.apache.hadoop.mapreduce.JobContext job)</code> |
| <div class="block">Returns the name of the current classloader context set on this scanner</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>protected static <a href="../../../../../../org/apache/accumulo/core/client/ClientConfiguration.html" title="class in org.apache.accumulo.core.client">ClientConfiguration</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/AbstractInputFormat.html#getClientConfiguration-org.apache.hadoop.mapreduce.JobContext-">getClientConfiguration</a></span>(org.apache.hadoop.mapreduce.JobContext context)</code> |
| <div class="block">Construct the <a href="../../../../../../org/apache/accumulo/core/client/ClientConfiguration.html" title="class in org.apache.accumulo.core.client"><code>ClientConfiguration</code></a> given the provided context.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>protected static <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html" title="class in org.apache.accumulo.core.client.mapreduce">InputTableConfig</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/AbstractInputFormat.html#getInputTableConfig-org.apache.hadoop.mapreduce.JobContext-java.lang.String-">getInputTableConfig</a></span>(org.apache.hadoop.mapreduce.JobContext context, |
| <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> tableName)</code> |
| <div class="block">Fetches a <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html" title="class in org.apache.accumulo.core.client.mapreduce"><code>InputTableConfig</code></a> that has been set on the configuration for a specific table.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>protected static <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="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html" title="class in org.apache.accumulo.core.client.mapreduce">InputTableConfig</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/AbstractInputFormat.html#getInputTableConfigs-org.apache.hadoop.mapreduce.JobContext-">getInputTableConfigs</a></span>(org.apache.hadoop.mapreduce.JobContext context)</code> |
| <div class="block">Fetches all <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html" title="class in org.apache.accumulo.core.client.mapreduce"><code>InputTableConfig</code></a>s that have been set on the given job.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>protected static <a href="../../../../../../org/apache/accumulo/core/client/Instance.html" title="interface in org.apache.accumulo.core.client">Instance</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/AbstractInputFormat.html#getInstance-org.apache.hadoop.mapreduce.JobContext-">getInstance</a></span>(org.apache.hadoop.mapreduce.JobContext context)</code> |
| <div class="block">Initializes an Accumulo <a href="../../../../../../org/apache/accumulo/core/client/Instance.html" title="interface in org.apache.accumulo.core.client"><code>Instance</code></a> based on the |
| configuration.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>protected static org.apache.log4j.Level</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/AbstractInputFormat.html#getLogLevel-org.apache.hadoop.mapreduce.JobContext-">getLogLevel</a></span>(org.apache.hadoop.mapreduce.JobContext context)</code> |
| <div class="block">Gets the log level from this configuration.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>protected static <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/accumulo/core/client/mapreduce/AbstractInputFormat.html#getPrincipal-org.apache.hadoop.mapreduce.JobContext-">getPrincipal</a></span>(org.apache.hadoop.mapreduce.JobContext context)</code> |
| <div class="block">Gets the user name from the configuration.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>protected static <a href="../../../../../../org/apache/accumulo/core/security/Authorizations.html" title="class in org.apache.accumulo.core.security">Authorizations</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/AbstractInputFormat.html#getScanAuthorizations-org.apache.hadoop.mapreduce.JobContext-">getScanAuthorizations</a></span>(org.apache.hadoop.mapreduce.JobContext context)</code> |
| <div class="block">Gets the authorizations to set for the scans from the configuration.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><org.apache.hadoop.mapreduce.InputSplit></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/AbstractInputFormat.html#getSplits-org.apache.hadoop.mapreduce.JobContext-">getSplits</a></span>(org.apache.hadoop.mapreduce.JobContext context)</code> |
| <div class="block">Gets the splits of the tables that have been set on the job by reading the metadata table for |
| the specified ranges.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>protected static org.apache.accumulo.core.client.impl.TabletLocator</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/AbstractInputFormat.html#getTabletLocator-org.apache.hadoop.mapreduce.JobContext-java.lang.String-">getTabletLocator</a></span>(org.apache.hadoop.mapreduce.JobContext context, |
| <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> table)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">since 1.7.0 This method returns a type that is not part of the public API and is |
| not guaranteed to be stable. The method was deprecated to discourage its use.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>protected static byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/AbstractInputFormat.html#getToken-org.apache.hadoop.mapreduce.JobContext-">getToken</a></span>(org.apache.hadoop.mapreduce.JobContext context)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">since 1.6.0; Use <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/AbstractInputFormat.html#getAuthenticationToken-org.apache.hadoop.mapreduce.JobContext-"><code>getAuthenticationToken(JobContext)</code></a> instead.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>protected static <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/accumulo/core/client/mapreduce/AbstractInputFormat.html#getTokenClass-org.apache.hadoop.mapreduce.JobContext-">getTokenClass</a></span>(org.apache.hadoop.mapreduce.JobContext context)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">since 1.6.0; Use <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/AbstractInputFormat.html#getAuthenticationToken-org.apache.hadoop.mapreduce.JobContext-"><code>getAuthenticationToken(JobContext)</code></a> instead.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>protected static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/AbstractInputFormat.html#isConnectorInfoSet-org.apache.hadoop.mapreduce.JobContext-">isConnectorInfoSet</a></span>(org.apache.hadoop.mapreduce.JobContext context)</code> |
| <div class="block">Determines if the connector has been configured.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/AbstractInputFormat.html#setClassLoaderContext-org.apache.hadoop.mapreduce.Job-java.lang.String-">setClassLoaderContext</a></span>(org.apache.hadoop.mapreduce.Job job, |
| <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> context)</code> |
| <div class="block">Sets the name of the classloader context on this scanner</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/AbstractInputFormat.html#setConnectorInfo-org.apache.hadoop.mapreduce.Job-java.lang.String-org.apache.accumulo.core.client.security.tokens.AuthenticationToken-">setConnectorInfo</a></span>(org.apache.hadoop.mapreduce.Job job, |
| <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> principal, |
| <a href="../../../../../../org/apache/accumulo/core/client/security/tokens/AuthenticationToken.html" title="interface in org.apache.accumulo.core.client.security.tokens">AuthenticationToken</a> token)</code> |
| <div class="block">Sets the connector information needed to communicate with Accumulo in this job.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/AbstractInputFormat.html#setConnectorInfo-org.apache.hadoop.mapreduce.Job-java.lang.String-java.lang.String-">setConnectorInfo</a></span>(org.apache.hadoop.mapreduce.Job job, |
| <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> principal, |
| <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> tokenFile)</code> |
| <div class="block">Sets the connector information needed to communicate with Accumulo in this job.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/AbstractInputFormat.html#setLogLevel-org.apache.hadoop.mapreduce.Job-org.apache.log4j.Level-">setLogLevel</a></span>(org.apache.hadoop.mapreduce.Job job, |
| org.apache.log4j.Level level)</code> |
| <div class="block">Sets the log level for this job.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/AbstractInputFormat.html#setMockInstance-org.apache.hadoop.mapreduce.Job-java.lang.String-">setMockInstance</a></span>(org.apache.hadoop.mapreduce.Job job, |
| <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> instanceName)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">since 1.8.0; use MiniAccumuloCluster or a standard mock framework</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/AbstractInputFormat.html#setScanAuthorizations-org.apache.hadoop.mapreduce.Job-org.apache.accumulo.core.security.Authorizations-">setScanAuthorizations</a></span>(org.apache.hadoop.mapreduce.Job job, |
| <a href="../../../../../../org/apache/accumulo/core/security/Authorizations.html" title="class in org.apache.accumulo.core.security">Authorizations</a> auths)</code> |
| <div class="block">Sets the <a href="../../../../../../org/apache/accumulo/core/security/Authorizations.html" title="class in org.apache.accumulo.core.security"><code>Authorizations</code></a> used to scan.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/AbstractInputFormat.html#setZooKeeperInstance-org.apache.hadoop.mapreduce.Job-org.apache.accumulo.core.client.ClientConfiguration-">setZooKeeperInstance</a></span>(org.apache.hadoop.mapreduce.Job job, |
| <a href="../../../../../../org/apache/accumulo/core/client/ClientConfiguration.html" title="class in org.apache.accumulo.core.client">ClientConfiguration</a> clientConfig)</code> |
| <div class="block">Configures a <a href="../../../../../../org/apache/accumulo/core/client/ZooKeeperInstance.html" title="class in org.apache.accumulo.core.client"><code>ZooKeeperInstance</code></a> for this job.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/AbstractInputFormat.html#setZooKeeperInstance-org.apache.hadoop.mapreduce.Job-java.lang.String-java.lang.String-">setZooKeeperInstance</a></span>(org.apache.hadoop.mapreduce.Job job, |
| <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> instanceName, |
| <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> zooKeepers)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">since 1.6.0; Use <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/AbstractInputFormat.html#setZooKeeperInstance-org.apache.hadoop.mapreduce.Job-org.apache.accumulo.core.client.ClientConfiguration-"><code>setZooKeeperInstance(Job, ClientConfiguration)</code></a> instead.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>protected static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/AbstractInputFormat.html#validateOptions-org.apache.hadoop.mapreduce.JobContext-">validateOptions</a></span>(org.apache.hadoop.mapreduce.JobContext context)</code> |
| <div class="block">Check whether a configuration is fully configured to be used with an Accumulo |
| <code>InputFormat</code>.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.mapreduce.InputFormat"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.hadoop.mapreduce.InputFormat</h3> |
| <code>createRecordReader</code></li> |
| </ul> |
| <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#toString--" title="class or interface in java.lang">toString</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="CLASS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CLASS</h4> |
| <pre>protected static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> CLASS</pre> |
| </li> |
| </ul> |
| <a name="log"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>log</h4> |
| <pre>protected static final org.apache.log4j.Logger log</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="AbstractInputFormat--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>AbstractInputFormat</h4> |
| <pre>public AbstractInputFormat()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="setClassLoaderContext-org.apache.hadoop.mapreduce.Job-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setClassLoaderContext</h4> |
| <pre>public static void setClassLoaderContext(org.apache.hadoop.mapreduce.Job job, |
| <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> context)</pre> |
| <div class="block">Sets the name of the classloader context on this scanner</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>job</code> - the Hadoop job instance to be configured</dd> |
| <dd><code>context</code> - name of the classloader context</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.8.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getClassLoaderContext-org.apache.hadoop.mapreduce.JobContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClassLoaderContext</h4> |
| <pre>public static <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> getClassLoaderContext(org.apache.hadoop.mapreduce.JobContext job)</pre> |
| <div class="block">Returns the name of the current classloader context set on this scanner</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>job</code> - the Hadoop job instance to be configured</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>name of the current context</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.8.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setConnectorInfo-org.apache.hadoop.mapreduce.Job-java.lang.String-org.apache.accumulo.core.client.security.tokens.AuthenticationToken-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setConnectorInfo</h4> |
| <pre>public static void setConnectorInfo(org.apache.hadoop.mapreduce.Job job, |
| <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> principal, |
| <a href="../../../../../../org/apache/accumulo/core/client/security/tokens/AuthenticationToken.html" title="interface in org.apache.accumulo.core.client.security.tokens">AuthenticationToken</a> token) |
| throws <a href="../../../../../../org/apache/accumulo/core/client/AccumuloSecurityException.html" title="class in org.apache.accumulo.core.client">AccumuloSecurityException</a></pre> |
| <div class="block">Sets the connector information needed to communicate with Accumulo in this job. |
| |
| <p> |
| <b>WARNING:</b> Some tokens, when serialized, divulge sensitive information in the |
| configuration as a means to pass the token to MapReduce tasks. This information is BASE64 |
| encoded to provide a charset safe conversion to a string, but this conversion is not intended |
| to be secure. <a href="../../../../../../org/apache/accumulo/core/client/security/tokens/PasswordToken.html" title="class in org.apache.accumulo.core.client.security.tokens"><code>PasswordToken</code></a> is one example that is insecure in this way; however |
| <a href="../../../../../../org/apache/accumulo/core/client/security/tokens/DelegationToken.html" title="interface in org.apache.accumulo.core.client.security.tokens"><code>DelegationToken</code></a>s, acquired using |
| <a href="../../../../../../org/apache/accumulo/core/client/admin/SecurityOperations.html#getDelegationToken-org.apache.accumulo.core.client.admin.DelegationTokenConfig-"><code>SecurityOperations.getDelegationToken(DelegationTokenConfig)</code></a>, is not subject to this |
| concern.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>job</code> - the Hadoop job instance to be configured</dd> |
| <dd><code>principal</code> - a valid Accumulo user name (user must have Table.CREATE permission)</dd> |
| <dd><code>token</code> - the user's password</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/accumulo/core/client/AccumuloSecurityException.html" title="class in org.apache.accumulo.core.client">AccumuloSecurityException</a></code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.5.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setConnectorInfo-org.apache.hadoop.mapreduce.Job-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setConnectorInfo</h4> |
| <pre>public static void setConnectorInfo(org.apache.hadoop.mapreduce.Job job, |
| <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> principal, |
| <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> tokenFile) |
| throws <a href="../../../../../../org/apache/accumulo/core/client/AccumuloSecurityException.html" title="class in org.apache.accumulo.core.client">AccumuloSecurityException</a></pre> |
| <div class="block">Sets the connector information needed to communicate with Accumulo in this job. |
| |
| <p> |
| Stores the password in a file in HDFS and pulls that into the Distributed Cache in an attempt |
| to be more secure than storing it in the Configuration.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>job</code> - the Hadoop job instance to be configured</dd> |
| <dd><code>principal</code> - a valid Accumulo user name (user must have Table.CREATE permission)</dd> |
| <dd><code>tokenFile</code> - the path to the token file</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/accumulo/core/client/AccumuloSecurityException.html" title="class in org.apache.accumulo.core.client">AccumuloSecurityException</a></code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isConnectorInfoSet-org.apache.hadoop.mapreduce.JobContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isConnectorInfoSet</h4> |
| <pre>protected static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> isConnectorInfoSet(org.apache.hadoop.mapreduce.JobContext context)</pre> |
| <div class="block">Determines if the connector has been configured.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - the Hadoop context for the configured job</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the connector has been configured, false otherwise</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.5.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/AbstractInputFormat.html#setConnectorInfo-org.apache.hadoop.mapreduce.Job-java.lang.String-org.apache.accumulo.core.client.security.tokens.AuthenticationToken-"><code>setConnectorInfo(Job, String, AuthenticationToken)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPrincipal-org.apache.hadoop.mapreduce.JobContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPrincipal</h4> |
| <pre>protected static <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> getPrincipal(org.apache.hadoop.mapreduce.JobContext context)</pre> |
| <div class="block">Gets the user name from the configuration.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - the Hadoop context for the configured job</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the user name</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.5.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/AbstractInputFormat.html#setConnectorInfo-org.apache.hadoop.mapreduce.Job-java.lang.String-org.apache.accumulo.core.client.security.tokens.AuthenticationToken-"><code>setConnectorInfo(Job, String, AuthenticationToken)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTokenClass-org.apache.hadoop.mapreduce.JobContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTokenClass</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| protected static <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> getTokenClass(org.apache.hadoop.mapreduce.JobContext context)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">since 1.6.0; Use <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/AbstractInputFormat.html#getAuthenticationToken-org.apache.hadoop.mapreduce.JobContext-"><code>getAuthenticationToken(JobContext)</code></a> instead.</span></div> |
| <div class="block">Gets the serialized token class from either the configuration or the token file.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.5.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getToken-org.apache.hadoop.mapreduce.JobContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getToken</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| protected static byte[] getToken(org.apache.hadoop.mapreduce.JobContext context)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">since 1.6.0; Use <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/AbstractInputFormat.html#getAuthenticationToken-org.apache.hadoop.mapreduce.JobContext-"><code>getAuthenticationToken(JobContext)</code></a> instead.</span></div> |
| <div class="block">Gets the serialized token from either the configuration or the token file.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.5.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAuthenticationToken-org.apache.hadoop.mapreduce.JobContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAuthenticationToken</h4> |
| <pre>protected static <a href="../../../../../../org/apache/accumulo/core/client/security/tokens/AuthenticationToken.html" title="interface in org.apache.accumulo.core.client.security.tokens">AuthenticationToken</a> getAuthenticationToken(org.apache.hadoop.mapreduce.JobContext context)</pre> |
| <div class="block">Gets the authenticated token from either the specified token file or directly from the |
| configuration, whichever was used when the job was configured.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - the Hadoop context for the configured job</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the principal's authentication token</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/AbstractInputFormat.html#setConnectorInfo-org.apache.hadoop.mapreduce.Job-java.lang.String-org.apache.accumulo.core.client.security.tokens.AuthenticationToken-"><code>setConnectorInfo(Job, String, AuthenticationToken)</code></a>, |
| <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/AbstractInputFormat.html#setConnectorInfo-org.apache.hadoop.mapreduce.Job-java.lang.String-java.lang.String-"><code>setConnectorInfo(Job, String, String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setZooKeeperInstance-org.apache.hadoop.mapreduce.Job-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setZooKeeperInstance</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| public static void setZooKeeperInstance(org.apache.hadoop.mapreduce.Job job, |
| <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> instanceName, |
| <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> zooKeepers)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">since 1.6.0; Use <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/AbstractInputFormat.html#setZooKeeperInstance-org.apache.hadoop.mapreduce.Job-org.apache.accumulo.core.client.ClientConfiguration-"><code>setZooKeeperInstance(Job, ClientConfiguration)</code></a> instead.</span></div> |
| <div class="block">Configures a <a href="../../../../../../org/apache/accumulo/core/client/ZooKeeperInstance.html" title="class in org.apache.accumulo.core.client"><code>ZooKeeperInstance</code></a> for this job.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>job</code> - the Hadoop job instance to be configured</dd> |
| <dd><code>instanceName</code> - the Accumulo instance name</dd> |
| <dd><code>zooKeepers</code> - a comma-separated list of zookeeper servers</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.5.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setZooKeeperInstance-org.apache.hadoop.mapreduce.Job-org.apache.accumulo.core.client.ClientConfiguration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setZooKeeperInstance</h4> |
| <pre>public static void setZooKeeperInstance(org.apache.hadoop.mapreduce.Job job, |
| <a href="../../../../../../org/apache/accumulo/core/client/ClientConfiguration.html" title="class in org.apache.accumulo.core.client">ClientConfiguration</a> clientConfig)</pre> |
| <div class="block">Configures a <a href="../../../../../../org/apache/accumulo/core/client/ZooKeeperInstance.html" title="class in org.apache.accumulo.core.client"><code>ZooKeeperInstance</code></a> for this job.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>job</code> - the Hadoop job instance to be configured</dd> |
| <dd><code>clientConfig</code> - client configuration containing connection options</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMockInstance-org.apache.hadoop.mapreduce.Job-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMockInstance</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| public static void setMockInstance(org.apache.hadoop.mapreduce.Job job, |
| <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> instanceName)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">since 1.8.0; use MiniAccumuloCluster or a standard mock framework</span></div> |
| <div class="block">Configures a <a href="../../../../../../org/apache/accumulo/core/client/mock/MockInstance.html" title="class in org.apache.accumulo.core.client.mock"><code>MockInstance</code></a> for this job.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>job</code> - the Hadoop job instance to be configured</dd> |
| <dd><code>instanceName</code> - the Accumulo instance name</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.5.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getInstance-org.apache.hadoop.mapreduce.JobContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInstance</h4> |
| <pre>protected static <a href="../../../../../../org/apache/accumulo/core/client/Instance.html" title="interface in org.apache.accumulo.core.client">Instance</a> getInstance(org.apache.hadoop.mapreduce.JobContext context)</pre> |
| <div class="block">Initializes an Accumulo <a href="../../../../../../org/apache/accumulo/core/client/Instance.html" title="interface in org.apache.accumulo.core.client"><code>Instance</code></a> based on the |
| configuration.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - the Hadoop context for the configured job</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an Accumulo instance</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.5.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/AbstractInputFormat.html#setZooKeeperInstance-org.apache.hadoop.mapreduce.Job-org.apache.accumulo.core.client.ClientConfiguration-"><code>setZooKeeperInstance(Job, ClientConfiguration)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setLogLevel-org.apache.hadoop.mapreduce.Job-org.apache.log4j.Level-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLogLevel</h4> |
| <pre>public static void setLogLevel(org.apache.hadoop.mapreduce.Job job, |
| org.apache.log4j.Level level)</pre> |
| <div class="block">Sets the log level for this job.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>job</code> - the Hadoop job instance to be configured</dd> |
| <dd><code>level</code> - the logging level</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.5.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLogLevel-org.apache.hadoop.mapreduce.JobContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLogLevel</h4> |
| <pre>protected static org.apache.log4j.Level getLogLevel(org.apache.hadoop.mapreduce.JobContext context)</pre> |
| <div class="block">Gets the log level from this configuration.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - the Hadoop context for the configured job</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the log level</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.5.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/AbstractInputFormat.html#setLogLevel-org.apache.hadoop.mapreduce.Job-org.apache.log4j.Level-"><code>setLogLevel(Job, Level)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setScanAuthorizations-org.apache.hadoop.mapreduce.Job-org.apache.accumulo.core.security.Authorizations-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setScanAuthorizations</h4> |
| <pre>public static void setScanAuthorizations(org.apache.hadoop.mapreduce.Job job, |
| <a href="../../../../../../org/apache/accumulo/core/security/Authorizations.html" title="class in org.apache.accumulo.core.security">Authorizations</a> auths)</pre> |
| <div class="block">Sets the <a href="../../../../../../org/apache/accumulo/core/security/Authorizations.html" title="class in org.apache.accumulo.core.security"><code>Authorizations</code></a> used to scan. Must be a |
| subset of the user's authorization. Defaults to the empty set.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>job</code> - the Hadoop job instance to be configured</dd> |
| <dd><code>auths</code> - the user's authorizations</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getScanAuthorizations-org.apache.hadoop.mapreduce.JobContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getScanAuthorizations</h4> |
| <pre>protected static <a href="../../../../../../org/apache/accumulo/core/security/Authorizations.html" title="class in org.apache.accumulo.core.security">Authorizations</a> getScanAuthorizations(org.apache.hadoop.mapreduce.JobContext context)</pre> |
| <div class="block">Gets the authorizations to set for the scans from the configuration.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - the Hadoop context for the configured job</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the Accumulo scan authorizations</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.5.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/AbstractInputFormat.html#setScanAuthorizations-org.apache.hadoop.mapreduce.Job-org.apache.accumulo.core.security.Authorizations-"><code>setScanAuthorizations(Job, Authorizations)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getInputTableConfigs-org.apache.hadoop.mapreduce.JobContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInputTableConfigs</h4> |
| <pre>protected static <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="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html" title="class in org.apache.accumulo.core.client.mapreduce">InputTableConfig</a>> getInputTableConfigs(org.apache.hadoop.mapreduce.JobContext context)</pre> |
| <div class="block">Fetches all <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html" title="class in org.apache.accumulo.core.client.mapreduce"><code>InputTableConfig</code></a>s that have been set on the given job.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - the Hadoop job instance to be configured</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html" title="class in org.apache.accumulo.core.client.mapreduce"><code>InputTableConfig</code></a> objects for the job</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getInputTableConfig-org.apache.hadoop.mapreduce.JobContext-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInputTableConfig</h4> |
| <pre>protected static <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html" title="class in org.apache.accumulo.core.client.mapreduce">InputTableConfig</a> getInputTableConfig(org.apache.hadoop.mapreduce.JobContext context, |
| <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> tableName)</pre> |
| <div class="block">Fetches a <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html" title="class in org.apache.accumulo.core.client.mapreduce"><code>InputTableConfig</code></a> that has been set on the configuration for a specific table. |
| |
| <p> |
| null is returned in the event that the table doesn't exist.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - the Hadoop job instance to be configured</dd> |
| <dd><code>tableName</code> - the table name for which to grab the config object</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html" title="class in org.apache.accumulo.core.client.mapreduce"><code>InputTableConfig</code></a> for the given table</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTabletLocator-org.apache.hadoop.mapreduce.JobContext-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTabletLocator</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| protected static org.apache.accumulo.core.client.impl.TabletLocator getTabletLocator(org.apache.hadoop.mapreduce.JobContext context, |
| <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> table) |
| throws <a href="../../../../../../org/apache/accumulo/core/client/TableNotFoundException.html" title="class in org.apache.accumulo.core.client">TableNotFoundException</a></pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">since 1.7.0 This method returns a type that is not part of the public API and is |
| not guaranteed to be stable. The method was deprecated to discourage its use.</span></div> |
| <div class="block">Initializes an Accumulo <code>TabletLocator</code> based on the |
| configuration.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - the Hadoop context for the configured job</dd> |
| <dd><code>table</code> - the table for which to initialize the locator</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an Accumulo tablet locator</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/accumulo/core/client/TableNotFoundException.html" title="class in org.apache.accumulo.core.client">TableNotFoundException</a></code> - if the table name set on the configuration doesn't exist</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="validateOptions-org.apache.hadoop.mapreduce.JobContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validateOptions</h4> |
| <pre>protected static void validateOptions(org.apache.hadoop.mapreduce.JobContext context) |
| 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">Check whether a configuration is fully configured to be used with an Accumulo |
| <code>InputFormat</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - the Hadoop context for the configured job</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> - if the context is improperly configured</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.5.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getClientConfiguration-org.apache.hadoop.mapreduce.JobContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClientConfiguration</h4> |
| <pre>protected static <a href="../../../../../../org/apache/accumulo/core/client/ClientConfiguration.html" title="class in org.apache.accumulo.core.client">ClientConfiguration</a> getClientConfiguration(org.apache.hadoop.mapreduce.JobContext context)</pre> |
| <div class="block">Construct the <a href="../../../../../../org/apache/accumulo/core/client/ClientConfiguration.html" title="class in org.apache.accumulo.core.client"><code>ClientConfiguration</code></a> given the provided context.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - The Job</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The ClientConfiguration</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.7.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSplits-org.apache.hadoop.mapreduce.JobContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getSplits</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><org.apache.hadoop.mapreduce.InputSplit> getSplits(org.apache.hadoop.mapreduce.JobContext context) |
| 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">Gets the splits of the tables that have been set on the job by reading the metadata table for |
| the specified ranges.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>getSplits</code> in class <code>org.apache.hadoop.mapreduce.InputFormat<<a href="../../../../../../org/apache/accumulo/core/client/mapreduce/AbstractInputFormat.html" title="type parameter in AbstractInputFormat">K</a>,<a href="../../../../../../org/apache/accumulo/core/client/mapreduce/AbstractInputFormat.html" title="type parameter in AbstractInputFormat">V</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the splits from the tables based on the ranges.</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> - if a table set on the job doesn't exist or an error occurs initializing the tablet |
| locator</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/AbstractInputFormat.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>Prev Class</li> |
| <li><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/AbstractInputFormat.AbstractRecordReader.html" title="class in org.apache.accumulo.core.client.mapreduce"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/accumulo/core/client/mapreduce/AbstractInputFormat.html" target="_top">Frames</a></li> |
| <li><a href="AbstractInputFormat.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><a href="#nested.class.summary">Nested</a> | </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 © 2011–2019 <a href="https://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |