Google Git
Sign in
apache / hadoop / refs/heads/YARN-5734 / . / hadoop-common-project / hadoop-common / dev-support / jdiff / Apache_Hadoop_Common_2.6.0.xml
blob: b1052537f4668fa32fea578525e98b9a531c6e3c [file] [log] [blame]
<?xml version="1.0" encoding="iso-8859-1" standalone="no"?>
<!-- Generated by the JDiff Javadoc doclet -->
<!-- (http://www.jdiff.org) -->
<!-- on Mon Mar 30 15:27:52 PDT 2015 -->
<api
xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
xsi:noNamespaceSchemaLocation='api.xsd'
name="hadoop-core 2.6.0"
jdversion="1.0.9">
<!-- Command line arguments = -doclet org.apache.hadoop.classification.tools.ExcludePrivateAnnotationsJDiffDoclet -docletpath /Users/llu/hadoop-common/hadoop-common-project/hadoop-common/target/hadoop-annotations.jar:/Users/llu/hadoop-common/hadoop-common-project/hadoop-common/target/jdiff.jar -verbose -classpath /Users/llu/hadoop-common/hadoop-common-project/hadoop-common/target/classes:/Users/llu/hadoop-common/hadoop-common-project/hadoop-annotations/target/hadoop-annotations-2.6.0.jar:/Library/Java/JavaVirtualMachines/jdk1.7.0_67.jdk/Contents/Home/lib/tools.jar:/Users/llu/.m2/repository/com/google/guava/guava/11.0.2/guava-11.0.2.jar:/Users/llu/.m2/repository/commons-cli/commons-cli/1.2/commons-cli-1.2.jar:/Users/llu/.m2/repository/org/apache/commons/commons-math3/3.1.1/commons-math3-3.1.1.jar:/Users/llu/.m2/repository/xmlenc/xmlenc/0.52/xmlenc-0.52.jar:/Users/llu/.m2/repository/commons-httpclient/commons-httpclient/3.1/commons-httpclient-3.1.jar:/Users/llu/.m2/repository/commons-codec/commons-codec/1.4/commons-codec-1.4.jar:/Users/llu/.m2/repository/commons-io/commons-io/2.4/commons-io-2.4.jar:/Users/llu/.m2/repository/commons-net/commons-net/3.1/commons-net-3.1.jar:/Users/llu/.m2/repository/commons-collections/commons-collections/3.2.1/commons-collections-3.2.1.jar:/Users/llu/.m2/repository/javax/servlet/servlet-api/2.5/servlet-api-2.5.jar:/Users/llu/.m2/repository/org/mortbay/jetty/jetty/6.1.26/jetty-6.1.26.jar:/Users/llu/.m2/repository/org/mortbay/jetty/jetty-util/6.1.26/jetty-util-6.1.26.jar:/Users/llu/.m2/repository/com/sun/jersey/jersey-core/1.9/jersey-core-1.9.jar:/Users/llu/.m2/repository/com/sun/jersey/jersey-json/1.9/jersey-json-1.9.jar:/Users/llu/.m2/repository/org/codehaus/jettison/jettison/1.1/jettison-1.1.jar:/Users/llu/.m2/repository/com/sun/xml/bind/jaxb-impl/2.2.3-1/jaxb-impl-2.2.3-1.jar:/Users/llu/.m2/repository/javax/xml/bind/jaxb-api/2.2.2/jaxb-api-2.2.2.jar:/Users/llu/.m2/repository/javax/xml/stream/stax-api/1.0-2/stax-api-1.0-2.jar:/Users/llu/.m2/repository/javax/activation/activation/1.1/activation-1.1.jar:/Users/llu/.m2/repository/org/codehaus/jackson/jackson-jaxrs/1.9.13/jackson-jaxrs-1.9.13.jar:/Users/llu/.m2/repository/org/codehaus/jackson/jackson-xc/1.9.13/jackson-xc-1.9.13.jar:/Users/llu/.m2/repository/com/sun/jersey/jersey-server/1.9/jersey-server-1.9.jar:/Users/llu/.m2/repository/asm/asm/3.2/asm-3.2.jar:/Users/llu/.m2/repository/commons-logging/commons-logging/1.1.3/commons-logging-1.1.3.jar:/Users/llu/.m2/repository/log4j/log4j/1.2.17/log4j-1.2.17.jar:/Users/llu/.m2/repository/net/java/dev/jets3t/jets3t/0.9.0/jets3t-0.9.0.jar:/Users/llu/.m2/repository/org/apache/httpcomponents/httpclient/4.2.5/httpclient-4.2.5.jar:/Users/llu/.m2/repository/org/apache/httpcomponents/httpcore/4.2.5/httpcore-4.2.5.jar:/Users/llu/.m2/repository/com/jamesmurty/utils/java-xmlbuilder/0.4/java-xmlbuilder-0.4.jar:/Users/llu/.m2/repository/commons-lang/commons-lang/2.6/commons-lang-2.6.jar:/Users/llu/.m2/repository/commons-configuration/commons-configuration/1.6/commons-configuration-1.6.jar:/Users/llu/.m2/repository/commons-digester/commons-digester/1.8/commons-digester-1.8.jar:/Users/llu/.m2/repository/commons-beanutils/commons-beanutils/1.7.0/commons-beanutils-1.7.0.jar:/Users/llu/.m2/repository/commons-beanutils/commons-beanutils-core/1.8.0/commons-beanutils-core-1.8.0.jar:/Users/llu/.m2/repository/org/slf4j/slf4j-api/1.7.5/slf4j-api-1.7.5.jar:/Users/llu/.m2/repository/org/codehaus/jackson/jackson-core-asl/1.9.13/jackson-core-asl-1.9.13.jar:/Users/llu/.m2/repository/org/codehaus/jackson/jackson-mapper-asl/1.9.13/jackson-mapper-asl-1.9.13.jar:/Users/llu/.m2/repository/org/apache/avro/avro/1.7.4/avro-1.7.4.jar:/Users/llu/.m2/repository/com/thoughtworks/paranamer/paranamer/2.3/paranamer-2.3.jar:/Users/llu/.m2/repository/org/xerial/snappy/snappy-java/1.0.4.1/snappy-java-1.0.4.1.jar:/Users/llu/.m2/repository/org/apache/ant/ant/1.8.1/ant-1.8.1.jar:/Users/llu/.m2/repository/org/apache/ant/ant-launcher/1.8.1/ant-launcher-1.8.1.jar:/Users/llu/.m2/repository/com/google/protobuf/protobuf-java/2.5.0/protobuf-java-2.5.0.jar:/Users/llu/.m2/repository/com/google/code/gson/gson/2.2.4/gson-2.2.4.jar:/Users/llu/hadoop-common/hadoop-common-project/hadoop-auth/target/hadoop-auth-2.6.0.jar:/Users/llu/.m2/repository/org/apache/directory/server/apacheds-kerberos-codec/2.0.0-M15/apacheds-kerberos-codec-2.0.0-M15.jar:/Users/llu/.m2/repository/org/apache/directory/server/apacheds-i18n/2.0.0-M15/apacheds-i18n-2.0.0-M15.jar:/Users/llu/.m2/repository/org/apache/directory/api/api-asn1-api/1.0.0-M20/api-asn1-api-1.0.0-M20.jar:/Users/llu/.m2/repository/org/apache/directory/api/api-util/1.0.0-M20/api-util-1.0.0-M20.jar:/Users/llu/.m2/repository/org/apache/curator/curator-framework/2.6.0/curator-framework-2.6.0.jar:/Users/llu/.m2/repository/com/jcraft/jsch/0.1.42/jsch-0.1.42.jar:/Users/llu/.m2/repository/org/apache/curator/curator-client/2.6.0/curator-client-2.6.0.jar:/Users/llu/.m2/repository/org/apache/curator/curator-recipes/2.6.0/curator-recipes-2.6.0.jar:/Users/llu/.m2/repository/com/google/code/findbugs/jsr305/1.3.9/jsr305-1.3.9.jar:/Users/llu/.m2/repository/org/htrace/htrace-core/3.0.4/htrace-core-3.0.4.jar:/Users/llu/.m2/repository/org/apache/zookeeper/zookeeper/3.4.6/zookeeper-3.4.6.jar:/Users/llu/.m2/repository/io/netty/netty/3.6.2.Final/netty-3.6.2.Final.jar:/Users/llu/.m2/repository/org/apache/commons/commons-compress/1.4.1/commons-compress-1.4.1.jar:/Users/llu/.m2/repository/org/tukaani/xz/1.0/xz-1.0.jar -sourcepath /Users/llu/hadoop-common/hadoop-common-project/hadoop-common/src/main/java -apidir /Users/llu/hadoop-common/hadoop-common-project/hadoop-common/target/site/jdiff/xml -apiname hadoop-core 2.6.0 -->
<package name="org.apache.hadoop">
<!-- start class org.apache.hadoop.HadoopIllegalArgumentException -->
<class name="HadoopIllegalArgumentException" extends="java.lang.IllegalArgumentException"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="HadoopIllegalArgumentException" type="java.lang.String"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Constructs exception with the specified detail message.
@param message detailed message.]]>
</doc>
</constructor>
<doc>
<![CDATA[Indicates that a method has been passed illegal or invalid argument. This
exception is thrown instead of IllegalArgumentException to differentiate the
exception thrown in Hadoop implementation from the one thrown in JDK.]]>
</doc>
</class>
<!-- end class org.apache.hadoop.HadoopIllegalArgumentException -->
</package>
<package name="org.apache.hadoop.conf">
<!-- start interface org.apache.hadoop.conf.Configurable -->
<interface name="Configurable" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<method name="setConf"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
<doc>
<![CDATA[Set the configuration to be used by this object.]]>
</doc>
</method>
<method name="getConf" return="org.apache.hadoop.conf.Configuration"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Return the configuration used by this object.]]>
</doc>
</method>
<doc>
<![CDATA[Something that may be configured with a {@link Configuration}.]]>
</doc>
</interface>
<!-- end interface org.apache.hadoop.conf.Configurable -->
<!-- start class org.apache.hadoop.conf.Configuration -->
<class name="Configuration" extends="java.lang.Object"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="java.lang.Iterable"/>
<implements name="org.apache.hadoop.io.Writable"/>
<constructor name="Configuration"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[A new configuration.]]>
</doc>
</constructor>
<constructor name="Configuration" type="boolean"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[A new configuration where the behavior of reading from the default
resources can be turned off.
If the parameter {@code loadDefaults} is false, the new instance
will not load resources from the default files.
@param loadDefaults specifies whether to load from the default files]]>
</doc>
</constructor>
<constructor name="Configuration" type="org.apache.hadoop.conf.Configuration"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[A new configuration with the same settings cloned from another.
@param other the configuration from which to clone settings.]]>
</doc>
</constructor>
<method name="addDeprecations"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="deltas" type="org.apache.hadoop.conf.Configuration.DeprecationDelta[]"/>
<doc>
<![CDATA[Adds a set of deprecated keys to the global deprecations.
This method is lockless. It works by means of creating a new
DeprecationContext based on the old one, and then atomically swapping in
the new context. If someone else updated the context in between us reading
the old context and swapping in the new one, we try again until we win the
race.
@param deltas The deprecations to add.]]>
</doc>
</method>
<method name="addDeprecation"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="use {@link #addDeprecation(String key, String newKey,
String customMessage)} instead">
<param name="key" type="java.lang.String"/>
<param name="newKeys" type="java.lang.String[]"/>
<param name="customMessage" type="java.lang.String"/>
<doc>
<![CDATA[Adds the deprecated key to the global deprecation map.
It does not override any existing entries in the deprecation map.
This is to be used only by the developers in order to add deprecation of
keys, and attempts to call this method after loading resources once,
would lead to <tt>UnsupportedOperationException</tt>
If a key is deprecated in favor of multiple keys, they are all treated as
aliases of each other, and setting any one of them resets all the others
to the new value.
If you have multiple deprecation entries to add, it is more efficient to
use #addDeprecations(DeprecationDelta[] deltas) instead.
@param key
@param newKeys
@param customMessage
@deprecated use {@link #addDeprecation(String key, String newKey,
String customMessage)} instead]]>
</doc>
</method>
<method name="addDeprecation"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="key" type="java.lang.String"/>
<param name="newKey" type="java.lang.String"/>
<param name="customMessage" type="java.lang.String"/>
<doc>
<![CDATA[Adds the deprecated key to the global deprecation map.
It does not override any existing entries in the deprecation map.
This is to be used only by the developers in order to add deprecation of
keys, and attempts to call this method after loading resources once,
would lead to <tt>UnsupportedOperationException</tt>
If you have multiple deprecation entries to add, it is more efficient to
use #addDeprecations(DeprecationDelta[] deltas) instead.
@param key
@param newKey
@param customMessage]]>
</doc>
</method>
<method name="addDeprecation"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="use {@link #addDeprecation(String key, String newKey)} instead">
<param name="key" type="java.lang.String"/>
<param name="newKeys" type="java.lang.String[]"/>
<doc>
<![CDATA[Adds the deprecated key to the global deprecation map when no custom
message is provided.
It does not override any existing entries in the deprecation map.
This is to be used only by the developers in order to add deprecation of
keys, and attempts to call this method after loading resources once,
would lead to <tt>UnsupportedOperationException</tt>
If a key is deprecated in favor of multiple keys, they are all treated as
aliases of each other, and setting any one of them resets all the others
to the new value.
If you have multiple deprecation entries to add, it is more efficient to
use #addDeprecations(DeprecationDelta[] deltas) instead.
@param key Key that is to be deprecated
@param newKeys list of keys that take up the values of deprecated key
@deprecated use {@link #addDeprecation(String key, String newKey)} instead]]>
</doc>
</method>
<method name="addDeprecation"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="key" type="java.lang.String"/>
<param name="newKey" type="java.lang.String"/>
<doc>
<![CDATA[Adds the deprecated key to the global deprecation map when no custom
message is provided.
It does not override any existing entries in the deprecation map.
This is to be used only by the developers in order to add deprecation of
keys, and attempts to call this method after loading resources once,
would lead to <tt>UnsupportedOperationException</tt>
If you have multiple deprecation entries to add, it is more efficient to
use #addDeprecations(DeprecationDelta[] deltas) instead.
@param key Key that is to be deprecated
@param newKey key that takes up the value of deprecated key]]>
</doc>
</method>
<method name="isDeprecated" return="boolean"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="key" type="java.lang.String"/>
<doc>
<![CDATA[checks whether the given <code>key</code> is deprecated.
@param key the parameter which is to be checked for deprecation
@return <code>true</code> if the key is deprecated and
<code>false</code> otherwise.]]>
</doc>
</method>
<method name="setDeprecatedProperties"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Sets all deprecated properties that are not currently set but have a
corresponding new property that is set. Useful for iterating the
properties when all deprecated properties for currently set properties
need to be present.]]>
</doc>
</method>
<method name="addDefaultResource"
abstract="false" native="false" synchronized="true"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<doc>
<![CDATA[Add a default resource. Resources are loaded in the order of the resources
added.
@param name file name. File should be present in the classpath.]]>
</doc>
</method>
<method name="addResource"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<doc>
<![CDATA[Add a configuration resource.
The properties of this resource will override properties of previously
added resources, unless they were marked <a href="#Final">final</a>.
@param name resource to be added, the classpath is examined for a file
with that name.]]>
</doc>
</method>
<method name="addResource"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="url" type="java.net.URL"/>
<doc>
<![CDATA[Add a configuration resource.
The properties of this resource will override properties of previously
added resources, unless they were marked <a href="#Final">final</a>.
@param url url of the resource to be added, the local filesystem is
examined directly to find the resource, without referring to
the classpath.]]>
</doc>
</method>
<method name="addResource"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="file" type="org.apache.hadoop.fs.Path"/>
<doc>
<![CDATA[Add a configuration resource.
The properties of this resource will override properties of previously
added resources, unless they were marked <a href="#Final">final</a>.
@param file file-path of resource to be added, the local filesystem is
examined directly to find the resource, without referring to
the classpath.]]>
</doc>
</method>
<method name="addResource"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="in" type="java.io.InputStream"/>
<doc>
<![CDATA[Add a configuration resource.
The properties of this resource will override properties of previously
added resources, unless they were marked <a href="#Final">final</a>.
WARNING: The contents of the InputStream will be cached, by this method.
So use this sparingly because it does increase the memory consumption.
@param in InputStream to deserialize the object from. In will be read from
when a get or set is called next. After it is read the stream will be
closed.]]>
</doc>
</method>
<method name="addResource"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="in" type="java.io.InputStream"/>
<param name="name" type="java.lang.String"/>
<doc>
<![CDATA[Add a configuration resource.
The properties of this resource will override properties of previously
added resources, unless they were marked <a href="#Final">final</a>.
@param in InputStream to deserialize the object from.
@param name the name of the resource because InputStream.toString is not
very descriptive some times.]]>
</doc>
</method>
<method name="addResource"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
<doc>
<![CDATA[Add a configuration resource.
The properties of this resource will override properties of previously
added resources, unless they were marked <a href="#Final">final</a>.
@param conf Configuration object from which to load properties]]>
</doc>
</method>
<method name="reloadConfiguration"
abstract="false" native="false" synchronized="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Reload configuration from previously added resources.
This method will clear all the configuration read from the added
resources, and final parameters. This will make the resources to
be read again before accessing the values. Values that are added
via set methods will overlay values read from the resources.]]>
</doc>
</method>
<method name="get" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<doc>
<![CDATA[Get the value of the <code>name</code> property, <code>null</code> if
no such property exists. If the key is deprecated, it returns the value of
the first key which replaces the deprecated key and is not null.
Values are processed for <a href="#VariableExpansion">variable expansion</a>
before being returned.
@param name the property name, will be trimmed before get value.
@return the value of the <code>name</code> or its replacing property,
or null if no such property exists.]]>
</doc>
</method>
<method name="getTrimmed" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<doc>
<![CDATA[Get the value of the <code>name</code> property as a trimmed <code>String</code>,
<code>null</code> if no such property exists.
If the key is deprecated, it returns the value of
the first key which replaces the deprecated key and is not null
Values are processed for <a href="#VariableExpansion">variable expansion</a>
before being returned.
@param name the property name.
@return the value of the <code>name</code> or its replacing property,
or null if no such property exists.]]>
</doc>
</method>
<method name="getTrimmed" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="defaultValue" type="java.lang.String"/>
<doc>
<![CDATA[Get the value of the <code>name</code> property as a trimmed <code>String</code>,
<code>defaultValue</code> if no such property exists.
See @{Configuration#getTrimmed} for more details.
@param name the property name.
@param defaultValue the property default value.
@return the value of the <code>name</code> or defaultValue
if it is not set.]]>
</doc>
</method>
<method name="getRaw" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<doc>
<![CDATA[Get the value of the <code>name</code> property, without doing
<a href="#VariableExpansion">variable expansion</a>.If the key is
deprecated, it returns the value of the first key which replaces
the deprecated key and is not null.
@param name the property name.
@return the value of the <code>name</code> property or
its replacing property and null if no such property exists.]]>
</doc>
</method>
<method name="set"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="value" type="java.lang.String"/>
<doc>
<![CDATA[Set the <code>value</code> of the <code>name</code> property. If
<code>name</code> is deprecated or there is a deprecated name associated to it,
it sets the value to both names. Name will be trimmed before put into
configuration.
@param name property name.
@param value property value.]]>
</doc>
</method>
<method name="set"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="value" type="java.lang.String"/>
<param name="source" type="java.lang.String"/>
<doc>
<![CDATA[Set the <code>value</code> of the <code>name</code> property. If
<code>name</code> is deprecated, it also sets the <code>value</code> to
the keys that replace the deprecated key. Name will be trimmed before put
into configuration.
@param name property name.
@param value property value.
@param source the place that this configuration value came from
(For debugging).
@throws IllegalArgumentException when the value or name is null.]]>
</doc>
</method>
<method name="unset"
abstract="false" native="false" synchronized="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<doc>
<![CDATA[Unset a previously set property.]]>
</doc>
</method>
<method name="setIfUnset"
abstract="false" native="false" synchronized="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="value" type="java.lang.String"/>
<doc>
<![CDATA[Sets a property if it is currently unset.
@param name the property name
@param value the new value]]>
</doc>
</method>
<method name="get" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="defaultValue" type="java.lang.String"/>
<doc>
<![CDATA[Get the value of the <code>name</code>. If the key is deprecated,
it returns the value of the first key which replaces the deprecated key
and is not null.
If no such property exists,
then <code>defaultValue</code> is returned.
@param name property name, will be trimmed before get value.
@param defaultValue default value.
@return property value, or <code>defaultValue</code> if the property
doesn't exist.]]>
</doc>
</method>
<method name="getInt" return="int"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="defaultValue" type="int"/>
<doc>
<![CDATA[Get the value of the <code>name</code> property as an <code>int</code>.
If no such property exists, the provided default value is returned,
or if the specified value is not a valid <code>int</code>,
then an error is thrown.
@param name property name.
@param defaultValue default value.
@throws NumberFormatException when the value is invalid
@return property value as an <code>int</code>,
or <code>defaultValue</code>.]]>
</doc>
</method>
<method name="getInts" return="int[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<doc>
<![CDATA[Get the value of the <code>name</code> property as a set of comma-delimited
<code>int</code> values.
If no such property exists, an empty array is returned.
@param name property name
@return property value interpreted as an array of comma-delimited
<code>int</code> values]]>
</doc>
</method>
<method name="setInt"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="value" type="int"/>
<doc>
<![CDATA[Set the value of the <code>name</code> property to an <code>int</code>.
@param name property name.
@param value <code>int</code> value of the property.]]>
</doc>
</method>
<method name="getLong" return="long"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="defaultValue" type="long"/>
<doc>
<![CDATA[Get the value of the <code>name</code> property as a <code>long</code>.
If no such property exists, the provided default value is returned,
or if the specified value is not a valid <code>long</code>,
then an error is thrown.
@param name property name.
@param defaultValue default value.
@throws NumberFormatException when the value is invalid
@return property value as a <code>long</code>,
or <code>defaultValue</code>.]]>
</doc>
</method>
<method name="getLongBytes" return="long"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="defaultValue" type="long"/>
<doc>
<![CDATA[Get the value of the <code>name</code> property as a <code>long</code> or
human readable format. If no such property exists, the provided default
value is returned, or if the specified value is not a valid
<code>long</code> or human readable format, then an error is thrown. You
can use the following suffix (case insensitive): k(kilo), m(mega), g(giga),
t(tera), p(peta), e(exa)
@param name property name.
@param defaultValue default value.
@throws NumberFormatException when the value is invalid
@return property value as a <code>long</code>,
or <code>defaultValue</code>.]]>
</doc>
</method>
<method name="setLong"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="value" type="long"/>
<doc>
<![CDATA[Set the value of the <code>name</code> property to a <code>long</code>.
@param name property name.
@param value <code>long</code> value of the property.]]>
</doc>
</method>
<method name="getFloat" return="float"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="defaultValue" type="float"/>
<doc>
<![CDATA[Get the value of the <code>name</code> property as a <code>float</code>.
If no such property exists, the provided default value is returned,
or if the specified value is not a valid <code>float</code>,
then an error is thrown.
@param name property name.
@param defaultValue default value.
@throws NumberFormatException when the value is invalid
@return property value as a <code>float</code>,
or <code>defaultValue</code>.]]>
</doc>
</method>
<method name="setFloat"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="value" type="float"/>
<doc>
<![CDATA[Set the value of the <code>name</code> property to a <code>float</code>.
@param name property name.
@param value property value.]]>
</doc>
</method>
<method name="getDouble" return="double"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="defaultValue" type="double"/>
<doc>
<![CDATA[Get the value of the <code>name</code> property as a <code>double</code>.
If no such property exists, the provided default value is returned,
or if the specified value is not a valid <code>double</code>,
then an error is thrown.
@param name property name.
@param defaultValue default value.
@throws NumberFormatException when the value is invalid
@return property value as a <code>double</code>,
or <code>defaultValue</code>.]]>
</doc>
</method>
<method name="setDouble"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="value" type="double"/>
<doc>
<![CDATA[Set the value of the <code>name</code> property to a <code>double</code>.
@param name property name.
@param value property value.]]>
</doc>
</method>
<method name="getBoolean" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="defaultValue" type="boolean"/>
<doc>
<![CDATA[Get the value of the <code>name</code> property as a <code>boolean</code>.
If no such property is specified, or if the specified value is not a valid
<code>boolean</code>, then <code>defaultValue</code> is returned.
@param name property name.
@param defaultValue default value.
@return property value as a <code>boolean</code>,
or <code>defaultValue</code>.]]>
</doc>
</method>
<method name="setBoolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="value" type="boolean"/>
<doc>
<![CDATA[Set the value of the <code>name</code> property to a <code>boolean</code>.
@param name property name.
@param value <code>boolean</code> value of the property.]]>
</doc>
</method>
<method name="setBooleanIfUnset"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="value" type="boolean"/>
<doc>
<![CDATA[Set the given property, if it is currently unset.
@param name property name
@param value new value]]>
</doc>
</method>
<method name="setEnum"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="value" type="T"/>
<doc>
<![CDATA[Set the value of the <code>name</code> property to the given type. This
is equivalent to <code>set(&lt;name&gt;, value.toString())</code>.
@param name property name
@param value new value]]>
</doc>
</method>
<method name="getEnum" return="T"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="defaultValue" type="T"/>
<doc>
<![CDATA[Return value matching this enumerated type.
@param name Property name
@param defaultValue Value returned if no mapping exists
@throws IllegalArgumentException If mapping is illegal for the type
provided]]>
</doc>
</method>
<method name="setTimeDuration"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="value" type="long"/>
<param name="unit" type="java.util.concurrent.TimeUnit"/>
<doc>
<![CDATA[Set the value of <code>name</code> to the given time duration. This
is equivalent to <code>set(&lt;name&gt;, value + &lt;time suffix&gt;)</code>.
@param name Property name
@param value Time duration
@param unit Unit of time]]>
</doc>
</method>
<method name="getTimeDuration" return="long"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="defaultValue" type="long"/>
<param name="unit" type="java.util.concurrent.TimeUnit"/>
<doc>
<![CDATA[Return time duration in the given time unit. Valid units are encoded in
properties as suffixes: nanoseconds (ns), microseconds (us), milliseconds
(ms), seconds (s), minutes (m), hours (h), and days (d).
@param name Property name
@param defaultValue Value returned if no mapping exists.
@param unit Unit to convert the stored property, if it exists.
@throws NumberFormatException If the property stripped of its unit is not
a number]]>
</doc>
</method>
<method name="getPattern" return="java.util.regex.Pattern"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="defaultValue" type="java.util.regex.Pattern"/>
<doc>
<![CDATA[Get the value of the <code>name</code> property as a <code>Pattern</code>.
If no such property is specified, or if the specified value is not a valid
<code>Pattern</code>, then <code>DefaultValue</code> is returned.
@param name property name
@param defaultValue default value
@return property value as a compiled Pattern, or defaultValue]]>
</doc>
</method>
<method name="setPattern"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="pattern" type="java.util.regex.Pattern"/>
<doc>
<![CDATA[Set the given property to <code>Pattern</code>.
If the pattern is passed as null, sets the empty pattern which results in
further calls to getPattern(...) returning the default value.
@param name property name
@param pattern new value]]>
</doc>
</method>
<method name="getPropertySources" return="java.lang.String[]"
abstract="false" native="false" synchronized="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<doc>
<![CDATA[Gets information about why a property was set. Typically this is the
path to the resource objects (file, URL, etc.) the property came from, but
it can also indicate that it was set programatically, or because of the
command line.
@param name - The property name to get the source of.
@return null - If the property or its source wasn't found. Otherwise,
returns a list of the sources of the resource. The older sources are
the first ones in the list. So for example if a configuration is set from
the command line, and then written out to a file that is read back in the
first entry would indicate that it was set from the command line, while
the second one would indicate the file that the new configuration was read
in from.]]>
</doc>
</method>
<method name="getRange" return="org.apache.hadoop.conf.Configuration.IntegerRanges"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="defaultValue" type="java.lang.String"/>
<doc>
<![CDATA[Parse the given attribute as a set of integer ranges
@param name the attribute name
@param defaultValue the default value if it is not set
@return a new set of ranges from the configured value]]>
</doc>
</method>
<method name="getStringCollection" return="java.util.Collection"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<doc>
<![CDATA[Get the comma delimited values of the <code>name</code> property as
a collection of <code>String</code>s.
If no such property is specified then empty collection is returned.
<p>
This is an optimized version of {@link #getStrings(String)}
@param name property name.
@return property value as a collection of <code>String</code>s.]]>
</doc>
</method>
<method name="getStrings" return="java.lang.String[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<doc>
<![CDATA[Get the comma delimited values of the <code>name</code> property as
an array of <code>String</code>s.
If no such property is specified then <code>null</code> is returned.
@param name property name.
@return property value as an array of <code>String</code>s,
or <code>null</code>.]]>
</doc>
</method>
<method name="getStrings" return="java.lang.String[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="defaultValue" type="java.lang.String[]"/>
<doc>
<![CDATA[Get the comma delimited values of the <code>name</code> property as
an array of <code>String</code>s.
If no such property is specified then default value is returned.
@param name property name.
@param defaultValue The default value
@return property value as an array of <code>String</code>s,
or default value.]]>
</doc>
</method>
<method name="getTrimmedStringCollection" return="java.util.Collection"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<doc>
<![CDATA[Get the comma delimited values of the <code>name</code> property as
a collection of <code>String</code>s, trimmed of the leading and trailing whitespace.
If no such property is specified then empty <code>Collection</code> is returned.
@param name property name.
@return property value as a collection of <code>String</code>s, or empty <code>Collection</code>]]>
</doc>
</method>
<method name="getTrimmedStrings" return="java.lang.String[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<doc>
<![CDATA[Get the comma delimited values of the <code>name</code> property as
an array of <code>String</code>s, trimmed of the leading and trailing whitespace.
If no such property is specified then an empty array is returned.
@param name property name.
@return property value as an array of trimmed <code>String</code>s,
or empty array.]]>
</doc>
</method>
<method name="getTrimmedStrings" return="java.lang.String[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="defaultValue" type="java.lang.String[]"/>
<doc>
<![CDATA[Get the comma delimited values of the <code>name</code> property as
an array of <code>String</code>s, trimmed of the leading and trailing whitespace.
If no such property is specified then default value is returned.
@param name property name.
@param defaultValue The default value
@return property value as an array of trimmed <code>String</code>s,
or default value.]]>
</doc>
</method>
<method name="setStrings"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="values" type="java.lang.String[]"/>
<doc>
<![CDATA[Set the array of string values for the <code>name</code> property as
as comma delimited values.
@param name property name.
@param values The values]]>
</doc>
</method>
<method name="getPassword" return="char[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Get the value for a known password configuration element.
In order to enable the elimination of clear text passwords in config,
this method attempts to resolve the property name as an alias through
the CredentialProvider API and conditionally fallsback to config.
@param name property name
@return password]]>
</doc>
</method>
<method name="getPasswordFromCredentialProviders" return="char[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Try and resolve the provided element name as a credential provider
alias.
@param name alias of the provisioned credential
@return password or null if not found
@throws IOException]]>
</doc>
</method>
<method name="getPasswordFromConfig" return="char[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<doc>
<![CDATA[Fallback to clear text passwords in configuration.
@param name
@return clear text password or null]]>
</doc>
</method>
<method name="getSocketAddr" return="java.net.InetSocketAddress"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="hostProperty" type="java.lang.String"/>
<param name="addressProperty" type="java.lang.String"/>
<param name="defaultAddressValue" type="java.lang.String"/>
<param name="defaultPort" type="int"/>
<doc>
<![CDATA[Get the socket address for <code>hostProperty</code> as a
<code>InetSocketAddress</code>. If <code>hostProperty</code> is
<code>null</code>, <code>addressProperty</code> will be used. This
is useful for cases where we want to differentiate between host
bind address and address clients should use to establish connection.
@param hostProperty bind host property name.
@param addressProperty address property name.
@param defaultAddressValue the default value
@param defaultPort the default port
@return InetSocketAddress]]>
</doc>
</method>
<method name="getSocketAddr" return="java.net.InetSocketAddress"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="defaultAddress" type="java.lang.String"/>
<param name="defaultPort" type="int"/>
<doc>
<![CDATA[Get the socket address for <code>name</code> property as a
<code>InetSocketAddress</code>.
@param name property name.
@param defaultAddress the default value
@param defaultPort the default port
@return InetSocketAddress]]>
</doc>
</method>
<method name="setSocketAddr"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="addr" type="java.net.InetSocketAddress"/>
<doc>
<![CDATA[Set the socket address for the <code>name</code> property as
a <code>host:port</code>.]]>
</doc>
</method>
<method name="updateConnectAddr" return="java.net.InetSocketAddress"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="hostProperty" type="java.lang.String"/>
<param name="addressProperty" type="java.lang.String"/>
<param name="defaultAddressValue" type="java.lang.String"/>
<param name="addr" type="java.net.InetSocketAddress"/>
<doc>
<![CDATA[Set the socket address a client can use to connect for the
<code>name</code> property as a <code>host:port</code>. The wildcard
address is replaced with the local host's address. If the host and address
properties are configured the host component of the address will be combined
with the port component of the addr to generate the address. This is to allow
optional control over which host name is used in multi-home bind-host
cases where a host can have multiple names
@param hostProperty the bind-host configuration name
@param addressProperty the service address configuration name
@param defaultAddressValue the service default address configuration value
@param addr InetSocketAddress of the service listener
@return InetSocketAddress for clients to connect]]>
</doc>
</method>
<method name="updateConnectAddr" return="java.net.InetSocketAddress"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="addr" type="java.net.InetSocketAddress"/>
<doc>
<![CDATA[Set the socket address a client can use to connect for the
<code>name</code> property as a <code>host:port</code>. The wildcard
address is replaced with the local host's address.
@param name property name.
@param addr InetSocketAddress of a listener to store in the given property
@return InetSocketAddress for clients to connect]]>
</doc>
</method>
<method name="getClassByName" return="java.lang.Class"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<exception name="ClassNotFoundException" type="java.lang.ClassNotFoundException"/>
<doc>
<![CDATA[Load a class by name.
@param name the class name.
@return the class object.
@throws ClassNotFoundException if the class is not found.]]>
</doc>
</method>
<method name="getClassByNameOrNull" return="java.lang.Class"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<doc>
<![CDATA[Load a class by name, returning null rather than throwing an exception
if it couldn't be loaded. This is to avoid the overhead of creating
an exception.
@param name the class name
@return the class object, or null if it could not be found.]]>
</doc>
</method>
<method name="getClasses" return="java.lang.Class[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="defaultValue" type="java.lang.Class[]"/>
<doc>
<![CDATA[Get the value of the <code>name</code> property
as an array of <code>Class</code>.
The value of the property specifies a list of comma separated class names.
If no such property is specified, then <code>defaultValue</code> is
returned.
@param name the property name.
@param defaultValue default value.
@return property value as a <code>Class[]</code>,
or <code>defaultValue</code>.]]>
</doc>
</method>
<method name="getClass" return="java.lang.Class"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="defaultValue" type="java.lang.Class"/>
<doc>
<![CDATA[Get the value of the <code>name</code> property as a <code>Class</code>.
If no such property is specified, then <code>defaultValue</code> is
returned.
@param name the class name.
@param defaultValue default value.
@return property value as a <code>Class</code>,
or <code>defaultValue</code>.]]>
</doc>
</method>
<method name="getClass" return="java.lang.Class"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="defaultValue" type="java.lang.Class"/>
<param name="xface" type="java.lang.Class"/>
<doc>
<![CDATA[Get the value of the <code>name</code> property as a <code>Class</code>
implementing the interface specified by <code>xface</code>.
If no such property is specified, then <code>defaultValue</code> is
returned.
An exception is thrown if the returned class does not implement the named
interface.
@param name the class name.
@param defaultValue default value.
@param xface the interface implemented by the named class.
@return property value as a <code>Class</code>,
or <code>defaultValue</code>.]]>
</doc>
</method>
<method name="getInstances" return="java.util.List"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="xface" type="java.lang.Class"/>
<doc>
<![CDATA[Get the value of the <code>name</code> property as a <code>List</code>
of objects implementing the interface specified by <code>xface</code>.
An exception is thrown if any of the classes does not exist, or if it does
not implement the named interface.
@param name the property name.
@param xface the interface implemented by the classes named by
<code>name</code>.
@return a <code>List</code> of objects implementing <code>xface</code>.]]>
</doc>
</method>
<method name="setClass"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="theClass" type="java.lang.Class"/>
<param name="xface" type="java.lang.Class"/>
<doc>
<![CDATA[Set the value of the <code>name</code> property to the name of a
<code>theClass</code> implementing the given interface <code>xface</code>.
An exception is thrown if <code>theClass</code> does not implement the
interface <code>xface</code>.
@param name property name.
@param theClass property value.
@param xface the interface implemented by the named class.]]>
</doc>
</method>
<method name="getLocalPath" return="org.apache.hadoop.fs.Path"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="dirsProp" type="java.lang.String"/>
<param name="path" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Get a local file under a directory named by <i>dirsProp</i> with
the given <i>path</i>. If <i>dirsProp</i> contains multiple directories,
then one is chosen based on <i>path</i>'s hash code. If the selected
directory does not exist, an attempt is made to create it.
@param dirsProp directory in which to locate the file.
@param path file-path.
@return local file under the directory with the given path.]]>
</doc>
</method>
<method name="getFile" return="java.io.File"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="dirsProp" type="java.lang.String"/>
<param name="path" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Get a local file name under a directory named in <i>dirsProp</i> with
the given <i>path</i>. If <i>dirsProp</i> contains multiple directories,
then one is chosen based on <i>path</i>'s hash code. If the selected
directory does not exist, an attempt is made to create it.
@param dirsProp directory in which to locate the file.
@param path file-path.
@return local file under the directory with the given path.]]>
</doc>
</method>
<method name="getResource" return="java.net.URL"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<doc>
<![CDATA[Get the {@link URL} for the named resource.
@param name resource name.
@return the url for the named resource.]]>
</doc>
</method>
<method name="getConfResourceAsInputStream" return="java.io.InputStream"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<doc>
<![CDATA[Get an input stream attached to the configuration resource with the
given <code>name</code>.
@param name configuration resource name.
@return an input stream attached to the resource.]]>
</doc>
</method>
<method name="getConfResourceAsReader" return="java.io.Reader"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<doc>
<![CDATA[Get a {@link Reader} attached to the configuration resource with the
given <code>name</code>.
@param name configuration resource name.
@return a reader attached to the resource.]]>
</doc>
</method>
<method name="getFinalParameters" return="java.util.Set"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the set of parameters marked final.
@return final parameter set.]]>
</doc>
</method>
<method name="getProps" return="java.util.Properties"
abstract="false" native="false" synchronized="true"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
</method>
<method name="size" return="int"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Return the number of keys in the configuration.
@return number of keys in the configuration.]]>
</doc>
</method>
<method name="clear"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Clears all keys from the configuration.]]>
</doc>
</method>
<method name="iterator" return="java.util.Iterator"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get an {@link Iterator} to go through the list of <code>String</code>
key-value pairs in the configuration.
@return an iterator over the entries.]]>
</doc>
</method>
<method name="writeXml"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="out" type="java.io.OutputStream"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Write out the non-default properties in this configuration to the given
{@link OutputStream} using UTF-8 encoding.
@param out the output stream to write to.]]>
</doc>
</method>
<method name="writeXml"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="out" type="java.io.Writer"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Write out the non-default properties in this configuration to the given
{@link Writer}.
@param out the writer to write to.]]>
</doc>
</method>
<method name="dumpConfiguration"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="config" type="org.apache.hadoop.conf.Configuration"/>
<param name="out" type="java.io.Writer"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Writes out all the parameters and their properties (final and resource) to
the given {@link Writer}
The format of the output would be
{ "properties" : [ {key1,value1,key1.isFinal,key1.resource}, {key2,value2,
key2.isFinal,key2.resource}... ] }
It does not output the parameters of the configuration object which is
loaded from an input stream.
@param out the Writer to write to
@throws IOException]]>
</doc>
</method>
<method name="getClassLoader" return="java.lang.ClassLoader"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the {@link ClassLoader} for this job.
@return the correct class loader.]]>
</doc>
</method>
<method name="setClassLoader"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="classLoader" type="java.lang.ClassLoader"/>
<doc>
<![CDATA[Set the class loader that will be used to load the various objects.
@param classLoader the new class loader.]]>
</doc>
</method>
<method name="toString" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="setQuietMode"
abstract="false" native="false" synchronized="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="quietmode" type="boolean"/>
<doc>
<![CDATA[Set the quietness-mode.
In the quiet-mode, error and informational messages might not be logged.
@param quietmode <code>true</code> to set quiet-mode on, <code>false</code>
to turn it off.]]>
</doc>
</method>
<method name="main"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="args" type="java.lang.String[]"/>
<exception name="Exception" type="java.lang.Exception"/>
<doc>
<![CDATA[For debugging. List non-default properties to the terminal and exit.]]>
</doc>
</method>
<method name="readFields"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="in" type="java.io.DataInput"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="write"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="out" type="java.io.DataOutput"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="getValByRegex" return="java.util.Map"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="regex" type="java.lang.String"/>
<doc>
<![CDATA[get keys matching the the regex
@param regex
@return Map<String,String> with matching keys]]>
</doc>
</method>
<method name="dumpDeprecatedKeys"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="hasWarnedDeprecation" return="boolean"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<doc>
<![CDATA[Returns whether or not a deprecated name has been warned. If the name is not
deprecated then always return false]]>
</doc>
</method>
<doc>
<![CDATA[Provides access to configuration parameters.
<h4 id="Resources">Resources</h4>
<p>Configurations are specified by resources. A resource contains a set of
name/value pairs as XML data. Each resource is named by either a
<code>String</code> or by a {@link Path}. If named by a <code>String</code>,
then the classpath is examined for a file with that name. If named by a
<code>Path</code>, then the local filesystem is examined directly, without
referring to the classpath.
<p>Unless explicitly turned off, Hadoop by default specifies two
resources, loaded in-order from the classpath: <ol>
<li><tt>
<a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
core-default.xml</a></tt>: Read-only defaults for hadoop.</li>
<li><tt>core-site.xml</tt>: Site-specific configuration for a given hadoop
installation.</li>
</ol>
Applications may add additional resources, which are loaded
subsequent to these resources in the order they are added.
<h4 id="FinalParams">Final Parameters</h4>
<p>Configuration parameters may be declared <i>final</i>.
Once a resource declares a value final, no subsequently-loaded
resource can alter that value.
For example, one might define a final parameter with:
<tt><pre>
&lt;property&gt;
&lt;name&gt;dfs.hosts.include&lt;/name&gt;
&lt;value&gt;/etc/hadoop/conf/hosts.include&lt;/value&gt;
<b>&lt;final&gt;true&lt;/final&gt;</b>
&lt;/property&gt;</pre></tt>
Administrators typically define parameters as final in
<tt>core-site.xml</tt> for values that user applications may not alter.
<h4 id="VariableExpansion">Variable Expansion</h4>
<p>Value strings are first processed for <i>variable expansion</i>. The
available properties are:<ol>
<li>Other properties defined in this Configuration; and, if a name is
undefined here,</li>
<li>Properties in {@link System#getProperties()}.</li>
</ol>
<p>For example, if a configuration resource contains the following property
definitions:
<tt><pre>
&lt;property&gt;
&lt;name&gt;basedir&lt;/name&gt;
&lt;value&gt;/user/${<i>user.name</i>}&lt;/value&gt;
&lt;/property&gt;
&lt;property&gt;
&lt;name&gt;tempdir&lt;/name&gt;
&lt;value&gt;${<i>basedir</i>}/tmp&lt;/value&gt;
&lt;/property&gt;</pre></tt>
When <tt>conf.get("tempdir")</tt> is called, then <tt>${<i>basedir</i>}</tt>
will be resolved to another property in this Configuration, while
<tt>${<i>user.name</i>}</tt> would then ordinarily be resolved to the value
of the System property with that name.
By default, warnings will be given to any deprecated configuration
parameters and these are suppressible by configuring
<tt>log4j.logger.org.apache.hadoop.conf.Configuration.deprecation</tt> in
log4j.properties file.]]>
</doc>
</class>
<!-- end class org.apache.hadoop.conf.Configuration -->
<!-- start class org.apache.hadoop.conf.Configuration.DeprecationDelta -->
<class name="Configuration.DeprecationDelta" extends="java.lang.Object"
abstract="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="Configuration.DeprecationDelta" type="java.lang.String, java.lang.String, java.lang.String"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<constructor name="Configuration.DeprecationDelta" type="java.lang.String, java.lang.String"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="getKey" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getNewKeys" return="java.lang.String[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getCustomMessage" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<doc>
<![CDATA[A pending addition to the global set of deprecated keys.]]>
</doc>
</class>
<!-- end class org.apache.hadoop.conf.Configuration.DeprecationDelta -->
<!-- start class org.apache.hadoop.conf.Configuration.IntegerRanges -->
<class name="Configuration.IntegerRanges" extends="java.lang.Object"
abstract="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<implements name="java.lang.Iterable"/>
<constructor name="Configuration.IntegerRanges"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<constructor name="Configuration.IntegerRanges" type="java.lang.String"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="isIncluded" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="value" type="int"/>
<doc>
<![CDATA[Is the given value in the set of ranges
@param value the value to check
@return is the value in the ranges?]]>
</doc>
</method>
<method name="isEmpty" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[@return true if there are no values in this range, else false.]]>
</doc>
</method>
<method name="toString" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="iterator" return="java.util.Iterator"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<doc>
<![CDATA[A class that represents a set of positive integer ranges. It parses
strings of the form: "2-3,5,7-" where ranges are separated by comma and
the lower/upper bounds are separated by dash. Either the lower or upper
bound may be omitted meaning all values up to or over. So the string
above means 2, 3, 5, and 7, 8, 9, ...]]>
</doc>
</class>
<!-- end class org.apache.hadoop.conf.Configuration.IntegerRanges -->
<!-- start class org.apache.hadoop.conf.Configured -->
<class name="Configured" extends="java.lang.Object"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="org.apache.hadoop.conf.Configurable"/>
<constructor name="Configured"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Construct a Configured.]]>
</doc>
</constructor>
<constructor name="Configured" type="org.apache.hadoop.conf.Configuration"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Construct a Configured.]]>
</doc>
</constructor>
<method name="setConf"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
</method>
<method name="getConf" return="org.apache.hadoop.conf.Configuration"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<doc>
<![CDATA[Base class for things that may be configured with a {@link Configuration}.]]>
</doc>
</class>
<!-- end class org.apache.hadoop.conf.Configured -->
<!-- start class org.apache.hadoop.conf.ConfServlet.BadFormatException -->
<class name="ConfServlet.BadFormatException" extends="java.lang.Exception"
abstract="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="ConfServlet.BadFormatException" type="java.lang.String"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
</class>
<!-- end class org.apache.hadoop.conf.ConfServlet.BadFormatException -->
<!-- start interface org.apache.hadoop.conf.Reconfigurable -->
<interface name="Reconfigurable" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="org.apache.hadoop.conf.Configurable"/>
<method name="reconfigureProperty" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="property" type="java.lang.String"/>
<param name="newVal" type="java.lang.String"/>
<exception name="ReconfigurationException" type="org.apache.hadoop.conf.ReconfigurationException"/>
<doc>
<![CDATA[Change a configuration property on this object to the value specified.
Change a configuration property on this object to the value specified
and return the previous value that the configuration property was set to
(or null if it was not previously set). If newVal is null, set the property
to its default value;
If the property cannot be changed, throw a
{@link ReconfigurationException}.]]>
</doc>
</method>
<method name="isPropertyReconfigurable" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="property" type="java.lang.String"/>
<doc>
<![CDATA[Return whether a given property is changeable at run time.
If isPropertyReconfigurable returns true for a property,
then changeConf should not throw an exception when changing
this property.]]>
</doc>
</method>
<method name="getReconfigurableProperties" return="java.util.Collection"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Return all the properties that can be changed at run time.]]>
</doc>
</method>
<doc>
<![CDATA[Something whose {@link Configuration} can be changed at run time.]]>
</doc>
</interface>
<!-- end interface org.apache.hadoop.conf.Reconfigurable -->
<!-- start class org.apache.hadoop.conf.ReconfigurableBase -->
<class name="ReconfigurableBase" extends="org.apache.hadoop.conf.Configured"
abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="org.apache.hadoop.conf.Reconfigurable"/>
<constructor name="ReconfigurableBase"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Construct a ReconfigurableBase.]]>
</doc>
</constructor>
<constructor name="ReconfigurableBase" type="org.apache.hadoop.conf.Configuration"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Construct a ReconfigurableBase with the {@link Configuration}
conf.]]>
</doc>
</constructor>
<method name="setReconfigurationUtil"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="ru" type="org.apache.hadoop.conf.ReconfigurationUtil"/>
</method>
<method name="getChangedProperties" return="java.util.Collection"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="newConf" type="org.apache.hadoop.conf.Configuration"/>
<param name="oldConf" type="org.apache.hadoop.conf.Configuration"/>
</method>
<method name="startReconfigurationTask"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Start a reconfiguration task to reload configuration in background.]]>
</doc>
</method>
<method name="getReconfigurationTaskStatus" return="org.apache.hadoop.conf.ReconfigurationTaskStatus"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="shutdownReconfigurationTask"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="reconfigureProperty" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="true" visibility="public"
deprecated="not deprecated">
<param name="property" type="java.lang.String"/>
<param name="newVal" type="java.lang.String"/>
<exception name="ReconfigurationException" type="org.apache.hadoop.conf.ReconfigurationException"/>
<doc>
<![CDATA[{@inheritDoc}
This method makes the change to this objects {@link Configuration}
and calls reconfigurePropertyImpl to update internal data structures.
This method cannot be overridden, subclasses should instead override
reconfigureProperty.]]>
</doc>
</method>
<method name="getReconfigurableProperties" return="java.util.Collection"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[{@inheritDoc}
Subclasses must override this.]]>
</doc>
</method>
<method name="isPropertyReconfigurable" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="property" type="java.lang.String"/>
<doc>
<![CDATA[{@inheritDoc}
Subclasses may wish to override this with a more efficient implementation.]]>
</doc>
</method>
<method name="reconfigurePropertyImpl"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="property" type="java.lang.String"/>
<param name="newVal" type="java.lang.String"/>
<exception name="ReconfigurationException" type="org.apache.hadoop.conf.ReconfigurationException"/>
<doc>
<![CDATA[Change a configuration property.
Subclasses must override this. This method applies the change to
all internal data structures derived from the configuration property
that is being changed. If this object owns other Reconfigurable objects
reconfigureProperty should be called recursively to make sure that
to make sure that the configuration of these objects is updated.]]>
</doc>
</method>
<doc>
<![CDATA[Utility base class for implementing the Reconfigurable interface.
Subclasses should override reconfigurePropertyImpl to change individual
properties and getReconfigurableProperties to get all properties that
can be changed at run time.]]>
</doc>
</class>
<!-- end class org.apache.hadoop.conf.ReconfigurableBase -->
<!-- start class org.apache.hadoop.conf.ReconfigurationException -->
<class name="ReconfigurationException" extends="java.lang.Exception"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="ReconfigurationException"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Create a new instance of {@link ReconfigurationException}.]]>
</doc>
</constructor>
<constructor name="ReconfigurationException" type="java.lang.String, java.lang.String, java.lang.String, java.lang.Throwable"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Create a new instance of {@link ReconfigurationException}.]]>
</doc>
</constructor>
<constructor name="ReconfigurationException" type="java.lang.String, java.lang.String, java.lang.String"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Create a new instance of {@link ReconfigurationException}.]]>
</doc>
</constructor>
<method name="getProperty" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get property that cannot be changed.]]>
</doc>
</method>
<method name="getNewValue" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get value to which property was supposed to be changed.]]>
</doc>
</method>
<method name="getOldValue" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get old value of property that cannot be changed.]]>
</doc>
</method>
<doc>
<![CDATA[Exception indicating that configuration property cannot be changed
at run time.]]>
</doc>
</class>
<!-- end class org.apache.hadoop.conf.ReconfigurationException -->
<!-- start class org.apache.hadoop.conf.ReconfigurationServlet -->
<class name="ReconfigurationServlet" extends="javax.servlet.http.HttpServlet"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="ReconfigurationServlet"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="init"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<exception name="ServletException" type="javax.servlet.ServletException"/>
</method>
<method name="doGet"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="req" type="javax.servlet.http.HttpServletRequest"/>
<param name="resp" type="javax.servlet.http.HttpServletResponse"/>
<exception name="ServletException" type="javax.servlet.ServletException"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="doPost"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="req" type="javax.servlet.http.HttpServletRequest"/>
<param name="resp" type="javax.servlet.http.HttpServletResponse"/>
<exception name="ServletException" type="javax.servlet.ServletException"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<field name="CONF_SERVLET_RECONFIGURABLE_PREFIX" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
</field>
<doc>
<![CDATA[A servlet for changing a node's configuration.
Reloads the configuration file, verifies whether changes are
possible and asks the admin to approve the change.]]>
</doc>
</class>
<!-- end class org.apache.hadoop.conf.ReconfigurationServlet -->
<!-- start class org.apache.hadoop.conf.ReconfigurationTaskStatus -->
<class name="ReconfigurationTaskStatus" extends="java.lang.Object"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="ReconfigurationTaskStatus" type="long, long, java.util.Map"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="hasTask" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Return true if
- A reconfiguration task has finished or
- an active reconfiguration task is running]]>
</doc>
</method>
<method name="stopped" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Return true if the latest reconfiguration task has finished and there is
no another active task running.]]>
</doc>
</method>
<method name="getStartTime" return="long"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getEndTime" return="long"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getStatus" return="java.util.Map"
abstract="false" native="false" synchronized="false"
static="false" final="true" visibility="public"
deprecated="not deprecated">
</method>
</class>
<!-- end class org.apache.hadoop.conf.ReconfigurationTaskStatus -->
<!-- start class org.apache.hadoop.conf.ReconfigurationUtil -->
<class name="ReconfigurationUtil" extends="java.lang.Object"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="ReconfigurationUtil"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="getChangedProperties" return="java.util.Collection"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="newConf" type="org.apache.hadoop.conf.Configuration"/>
<param name="oldConf" type="org.apache.hadoop.conf.Configuration"/>
</method>
<method name="parseChangedProperties" return="java.util.Collection"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="newConf" type="org.apache.hadoop.conf.Configuration"/>
<param name="oldConf" type="org.apache.hadoop.conf.Configuration"/>
</method>
</class>
<!-- end class org.apache.hadoop.conf.ReconfigurationUtil -->
<!-- start class org.apache.hadoop.conf.ReconfigurationUtil.PropertyChange -->
<class name="ReconfigurationUtil.PropertyChange" extends="java.lang.Object"
abstract="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="ReconfigurationUtil.PropertyChange" type="java.lang.String, java.lang.String, java.lang.String"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<field name="prop" type="java.lang.String"
transient="false" volatile="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</field>
<field name="oldVal" type="java.lang.String"
transient="false" volatile="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</field>
<field name="newVal" type="java.lang.String"
transient="false" volatile="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</field>
</class>
<!-- end class org.apache.hadoop.conf.ReconfigurationUtil.PropertyChange -->
<doc>
<![CDATA[Configuration of system parameters.]]>
</doc>
</package>
<package name="org.apache.hadoop.crypto">
</package>
<package name="org.apache.hadoop.crypto.key">
<!-- start class org.apache.hadoop.crypto.key.CachingKeyProvider -->
<class name="CachingKeyProvider" extends="org.apache.hadoop.crypto.key.KeyProviderExtension"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="CachingKeyProvider" type="org.apache.hadoop.crypto.key.KeyProvider, long, long"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="getCurrentKey" return="org.apache.hadoop.crypto.key.KeyProvider.KeyVersion"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="getKeyVersion" return="org.apache.hadoop.crypto.key.KeyProvider.KeyVersion"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="versionName" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="deleteKey"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="rollNewVersion" return="org.apache.hadoop.crypto.key.KeyProvider.KeyVersion"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="material" type="byte[]"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="rollNewVersion" return="org.apache.hadoop.crypto.key.KeyProvider.KeyVersion"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<exception name="NoSuchAlgorithmException" type="java.security.NoSuchAlgorithmException"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="getMetadata" return="org.apache.hadoop.crypto.key.KeyProvider.Metadata"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<doc>
<![CDATA[A <code>KeyProviderExtension</code> implementation providing a short lived
cache for <code>KeyVersions</code> and <code>Metadata</code>to avoid burst
of requests to hit the underlying <code>KeyProvider</code>.]]>
</doc>
</class>
<!-- end class org.apache.hadoop.crypto.key.CachingKeyProvider -->
<!-- start class org.apache.hadoop.crypto.key.JavaKeyStoreProvider.Factory -->
<class name="JavaKeyStoreProvider.Factory" extends="org.apache.hadoop.crypto.key.KeyProviderFactory"
abstract="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="JavaKeyStoreProvider.Factory"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="createProvider" return="org.apache.hadoop.crypto.key.KeyProvider"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="providerName" type="java.net.URI"/>
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<doc>
<![CDATA[The factory to create JksProviders, which is used by the ServiceLoader.]]>
</doc>
</class>
<!-- end class org.apache.hadoop.crypto.key.JavaKeyStoreProvider.Factory -->
<!-- start class org.apache.hadoop.crypto.key.JavaKeyStoreProvider.KeyMetadata -->
<class name="JavaKeyStoreProvider.KeyMetadata" extends="java.lang.Object"
abstract="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<implements name="java.security.Key"/>
<implements name="java.io.Serializable"/>
<method name="getAlgorithm" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getFormat" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getEncoded" return="byte[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<doc>
<![CDATA[An adapter between a KeyStore Key and our Metadata. This is used to store
the metadata in a KeyStore even though isn't really a key.]]>
</doc>
</class>
<!-- end class org.apache.hadoop.crypto.key.JavaKeyStoreProvider.KeyMetadata -->
<!-- start class org.apache.hadoop.crypto.key.KeyProvider -->
<class name="KeyProvider" extends="java.lang.Object"
abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="KeyProvider" type="org.apache.hadoop.conf.Configuration"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Constructor.
@param conf configuration for the provider]]>
</doc>
</constructor>
<method name="getConf" return="org.apache.hadoop.conf.Configuration"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Return the provider configuration.
@return the provider configuration]]>
</doc>
</method>
<method name="options" return="org.apache.hadoop.crypto.key.KeyProvider.Options"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
<doc>
<![CDATA[A helper function to create an options object.
@param conf the configuration to use
@return a new options object]]>
</doc>
</method>
<method name="isTransient" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Indicates whether this provider represents a store
that is intended for transient use - such as the UserProvider
is. These providers are generally used to provide access to
keying material rather than for long term storage.
@return true if transient, false otherwise]]>
</doc>
</method>
<method name="getKeyVersion" return="org.apache.hadoop.crypto.key.KeyProvider.KeyVersion"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="versionName" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Get the key material for a specific version of the key. This method is used
when decrypting data.
@param versionName the name of a specific version of the key
@return the key material
@throws IOException]]>
</doc>
</method>
<method name="getKeys" return="java.util.List"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Get the key names for all keys.
@return the list of key names
@throws IOException]]>
</doc>
</method>
<method name="getKeysMetadata" return="org.apache.hadoop.crypto.key.KeyProvider.Metadata[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="names" type="java.lang.String[]"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Get key metadata in bulk.
@param names the names of the keys to get
@throws IOException]]>
</doc>
</method>
<method name="getKeyVersions" return="java.util.List"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Get the key material for all versions of a specific key name.
@return the list of key material
@throws IOException]]>
</doc>
</method>
<method name="getCurrentKey" return="org.apache.hadoop.crypto.key.KeyProvider.KeyVersion"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Get the current version of the key, which should be used for encrypting new
data.
@param name the base name of the key
@return the version name of the current version of the key or null if the
key version doesn't exist
@throws IOException]]>
</doc>
</method>
<method name="getMetadata" return="org.apache.hadoop.crypto.key.KeyProvider.Metadata"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Get metadata about the key.
@param name the basename of the key
@return the key's metadata or null if the key doesn't exist
@throws IOException]]>
</doc>
</method>
<method name="createKey" return="org.apache.hadoop.crypto.key.KeyProvider.KeyVersion"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="material" type="byte[]"/>
<param name="options" type="org.apache.hadoop.crypto.key.KeyProvider.Options"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Create a new key. The given key must not already exist.
@param name the base name of the key
@param material the key material for the first version of the key.
@param options the options for the new key.
@return the version name of the first version of the key.
@throws IOException]]>
</doc>
</method>
<method name="generateKey" return="byte[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="size" type="int"/>
<param name="algorithm" type="java.lang.String"/>
<exception name="NoSuchAlgorithmException" type="java.security.NoSuchAlgorithmException"/>
<doc>
<![CDATA[Generates a key material.
@param size length of the key.
@param algorithm algorithm to use for generating the key.
@return the generated key.
@throws NoSuchAlgorithmException]]>
</doc>
</method>
<method name="createKey" return="org.apache.hadoop.crypto.key.KeyProvider.KeyVersion"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="options" type="org.apache.hadoop.crypto.key.KeyProvider.Options"/>
<exception name="NoSuchAlgorithmException" type="java.security.NoSuchAlgorithmException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Create a new key generating the material for it.
The given key must not already exist.
<p/>
This implementation generates the key material and calls the
{@link #createKey(String, byte[], Options)} method.
@param name the base name of the key
@param options the options for the new key.
@return the version name of the first version of the key.
@throws IOException
@throws NoSuchAlgorithmException]]>
</doc>
</method>
<method name="deleteKey"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Delete the given key.
@param name the name of the key to delete
@throws IOException]]>
</doc>
</method>
<method name="rollNewVersion" return="org.apache.hadoop.crypto.key.KeyProvider.KeyVersion"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="material" type="byte[]"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Roll a new version of the given key.
@param name the basename of the key
@param material the new key material
@return the name of the new version of the key
@throws IOException]]>
</doc>
</method>
<method name="close"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Can be used by implementing classes to close any resources
that require closing]]>
</doc>
</method>
<method name="rollNewVersion" return="org.apache.hadoop.crypto.key.KeyProvider.KeyVersion"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<exception name="NoSuchAlgorithmException" type="java.security.NoSuchAlgorithmException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Roll a new version of the given key generating the material for it.
<p/>
This implementation generates the key material and calls the
{@link #rollNewVersion(String, byte[])} method.
@param name the basename of the key
@return the name of the new version of the key
@throws IOException]]>
</doc>
</method>
<method name="flush"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Ensures that any changes to the keys are written to persistent store.
@throws IOException]]>
</doc>
</method>
<method name="getBaseName" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="versionName" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Split the versionName in to a base name. Converts "/aaa/bbb/3" to
"/aaa/bbb".
@param versionName the version name to split
@return the base name of the key
@throws IOException]]>
</doc>
</method>
<method name="buildVersionName" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="protected"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="version" type="int"/>
<doc>
<![CDATA[Build a version string from a basename and version number. Converts
"/aaa/bbb" and 3 to "/aaa/bbb@3".
@param name the basename of the key
@param version the version of the key
@return the versionName of the key.]]>
</doc>
</method>
<method name="findProvider" return="org.apache.hadoop.crypto.key.KeyProvider"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="providerList" type="java.util.List"/>
<param name="keyName" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Find the provider with the given key.
@param providerList the list of providers
@param keyName the key name we are looking for
@return the KeyProvider that has the key]]>
</doc>
</method>
<field name="DEFAULT_CIPHER_NAME" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
</field>
<field name="DEFAULT_CIPHER" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
</field>
<field name="DEFAULT_BITLENGTH_NAME" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
</field>
<field name="DEFAULT_BITLENGTH" type="int"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
</field>
<doc>
<![CDATA[A provider of secret key material for Hadoop applications. Provides an
abstraction to separate key storage from users of encryption. It
is intended to support getting or storing keys in a variety of ways,
including third party bindings.
<P/>
<code>KeyProvider</code> implementations must be thread safe.]]>
</doc>
</class>
<!-- end class org.apache.hadoop.crypto.key.KeyProvider -->
<!-- start class org.apache.hadoop.crypto.key.KeyProvider.KeyVersion -->
<class name="KeyProvider.KeyVersion" extends="java.lang.Object"
abstract="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="KeyProvider.KeyVersion" type="java.lang.String, java.lang.String, byte[]"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
</constructor>
<method name="getName" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getVersionName" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getMaterial" return="byte[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="toString" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<doc>
<![CDATA[The combination of both the key version name and the key material.]]>
</doc>
</class>
<!-- end class org.apache.hadoop.crypto.key.KeyProvider.KeyVersion -->
<!-- start class org.apache.hadoop.crypto.key.KeyProvider.Metadata -->
<class name="KeyProvider.Metadata" extends="java.lang.Object"
abstract="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="KeyProvider.Metadata" type="java.lang.String, int, java.lang.String, java.util.Map, java.util.Date, int"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
</constructor>
<constructor name="KeyProvider.Metadata" type="byte[]"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Deserialize a new metadata object from a set of bytes.
@param bytes the serialized metadata
@throws IOException]]>
</doc>
</constructor>
<method name="toString" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getDescription" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getCreated" return="java.util.Date"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getCipher" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getAttributes" return="java.util.Map"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getAlgorithm" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the algorithm from the cipher.
@return the algorithm name]]>
</doc>
</method>
<method name="getBitLength" return="int"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getVersions" return="int"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="addVersion" return="int"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
</method>
<method name="serialize" return="byte[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Serialize the metadata to a set of bytes.
@return the serialized bytes
@throws IOException]]>
</doc>
</method>
<doc>
<![CDATA[Key metadata that is associated with the key.]]>
</doc>
</class>
<!-- end class org.apache.hadoop.crypto.key.KeyProvider.Metadata -->
<!-- start class org.apache.hadoop.crypto.key.KeyProvider.Options -->
<class name="KeyProvider.Options" extends="java.lang.Object"
abstract="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="KeyProvider.Options" type="org.apache.hadoop.conf.Configuration"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="setCipher" return="org.apache.hadoop.crypto.key.KeyProvider.Options"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="cipher" type="java.lang.String"/>
</method>
<method name="setBitLength" return="org.apache.hadoop.crypto.key.KeyProvider.Options"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="bitLength" type="int"/>
</method>
<method name="setDescription" return="org.apache.hadoop.crypto.key.KeyProvider.Options"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="description" type="java.lang.String"/>
</method>
<method name="setAttributes" return="org.apache.hadoop.crypto.key.KeyProvider.Options"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="attributes" type="java.util.Map"/>
</method>
<method name="getCipher" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getBitLength" return="int"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getDescription" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getAttributes" return="java.util.Map"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="toString" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<doc>
<![CDATA[Options when creating key objects.]]>
</doc>
</class>
<!-- end class org.apache.hadoop.crypto.key.KeyProvider.Options -->
<!-- start interface org.apache.hadoop.crypto.key.KeyProviderCryptoExtension.CryptoExtension -->
<interface name="KeyProviderCryptoExtension.CryptoExtension" abstract="true"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<implements name="org.apache.hadoop.crypto.key.KeyProviderExtension.Extension"/>
<method name="warmUpEncryptedKeys"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="keyNames" type="java.lang.String[]"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Calls to this method allows the underlying KeyProvider to warm-up any
implementation specific caches used to store the Encrypted Keys.
@param keyNames Array of Key Names]]>
</doc>
</method>
<method name="drain"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="keyName" type="java.lang.String"/>
<doc>
<![CDATA[Drains the Queue for the provided key.
@param keyName the key to drain the Queue for]]>
</doc>
</method>
<method name="generateEncryptedKey" return="org.apache.hadoop.crypto.key.KeyProviderCryptoExtension.EncryptedKeyVersion"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="encryptionKeyName" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
<exception name="GeneralSecurityException" type="java.security.GeneralSecurityException"/>
<doc>
<![CDATA[Generates a key material and encrypts it using the given key version name
and initialization vector. The generated key material is of the same
length as the <code>KeyVersion</code> material of the latest key version
of the key and is encrypted using the same cipher.
<p/>
NOTE: The generated key is not stored by the <code>KeyProvider</code>
@param encryptionKeyName
The latest KeyVersion of this key's material will be encrypted.
@return EncryptedKeyVersion with the generated key material, the version
name is 'EEK' (for Encrypted Encryption Key)
@throws IOException
thrown if the key material could not be generated
@throws GeneralSecurityException
thrown if the key material could not be encrypted because of a
cryptographic issue.]]>
</doc>
</method>
<method name="decryptEncryptedKey" return="org.apache.hadoop.crypto.key.KeyProvider.KeyVersion"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="encryptedKeyVersion" type="org.apache.hadoop.crypto.key.KeyProviderCryptoExtension.EncryptedKeyVersion"/>
<exception name="IOException" type="java.io.IOException"/>
<exception name="GeneralSecurityException" type="java.security.GeneralSecurityException"/>
<doc>
<![CDATA[Decrypts an encrypted byte[] key material using the given a key version
name and initialization vector.
@param encryptedKeyVersion
contains keyVersionName and IV to decrypt the encrypted key
material
@return a KeyVersion with the decrypted key material, the version name is
'EK' (For Encryption Key)
@throws IOException
thrown if the key material could not be decrypted
@throws GeneralSecurityException
thrown if the key material could not be decrypted because of a
cryptographic issue.]]>
</doc>
</method>
<doc>
<![CDATA[CryptoExtension is a type of Extension that exposes methods to generate
EncryptedKeys and to decrypt the same.]]>
</doc>
</interface>
<!-- end interface org.apache.hadoop.crypto.key.KeyProviderCryptoExtension.CryptoExtension -->
<!-- start class org.apache.hadoop.crypto.key.KeyProviderCryptoExtension.EncryptedKeyVersion -->
<class name="KeyProviderCryptoExtension.EncryptedKeyVersion" extends="java.lang.Object"
abstract="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="KeyProviderCryptoExtension.EncryptedKeyVersion" type="java.lang.String, java.lang.String, byte[], org.apache.hadoop.crypto.key.KeyProvider.KeyVersion"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<doc>
<![CDATA[Create a new EncryptedKeyVersion.
@param keyName Name of the encryption key used to
encrypt the encrypted key.
@param encryptionKeyVersionName Version name of the encryption key used
to encrypt the encrypted key.
@param encryptedKeyIv Initialization vector of the encrypted
key. The IV of the encryption key used to
encrypt the encrypted key is derived from
this IV.
@param encryptedKeyVersion The encrypted encryption key version.]]>
</doc>
</constructor>
<method name="createForDecryption" return="org.apache.hadoop.crypto.key.KeyProviderCryptoExtension.EncryptedKeyVersion"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="keyName" type="java.lang.String"/>
<param name="encryptionKeyVersionName" type="java.lang.String"/>
<param name="encryptedKeyIv" type="byte[]"/>
<param name="encryptedKeyMaterial" type="byte[]"/>
<doc>
<![CDATA[Factory method to create a new EncryptedKeyVersion that can then be
passed into {@link #decryptEncryptedKey}. Note that the fields of the
returned EncryptedKeyVersion will only partially be populated; it is not
necessarily suitable for operations besides decryption.
@param keyName Key name of the encryption key use to encrypt the
encrypted key.
@param encryptionKeyVersionName Version name of the encryption key used
to encrypt the encrypted key.
@param encryptedKeyIv Initialization vector of the encrypted
key. The IV of the encryption key used to
encrypt the encrypted key is derived from
this IV.
@param encryptedKeyMaterial Key material of the encrypted key.
@return EncryptedKeyVersion suitable for decryption.]]>
</doc>
</method>
<method name="getEncryptionKeyName" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[@return Name of the encryption key used to encrypt the encrypted key.]]>
</doc>
</method>
<method name="getEncryptionKeyVersionName" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[@return Version name of the encryption key used to encrypt the encrypted
key.]]>
</doc>
</method>
<method name="getEncryptedKeyIv" return="byte[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[@return Initialization vector of the encrypted key. The IV of the
encryption key used to encrypt the encrypted key is derived from this
IV.]]>
</doc>
</method>
<method name="getEncryptedKeyVersion" return="org.apache.hadoop.crypto.key.KeyProvider.KeyVersion"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[@return The encrypted encryption key version.]]>
</doc>
</method>
<method name="deriveIV" return="byte[]"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="protected"
deprecated="not deprecated">
<param name="encryptedKeyIV" type="byte[]"/>
<doc>
<![CDATA[Derive the initialization vector (IV) for the encryption key from the IV
of the encrypted key. This derived IV is used with the encryption key to
decrypt the encrypted key.
<p/>
The alternative to this is using the same IV for both the encryption key
and the encrypted key. Even a simple symmetric transformation like this
improves security by avoiding IV re-use. IVs will also be fairly unique
among different EEKs.
@param encryptedKeyIV of the encrypted key (i.e. {@link
#getEncryptedKeyIv()})
@return IV for the encryption key]]>
</doc>
</method>
<doc>
<![CDATA[An encrypted encryption key (EEK) and related information. An EEK must be
decrypted using the key's encryption key before it can be used.]]>
</doc>
</class>
<!-- end class org.apache.hadoop.crypto.key.KeyProviderCryptoExtension.EncryptedKeyVersion -->
<!-- start class org.apache.hadoop.crypto.key.KeyProviderDelegationTokenExtension -->
<class name="KeyProviderDelegationTokenExtension" extends="org.apache.hadoop.crypto.key.KeyProviderExtension"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<method name="addDelegationTokens" return="org.apache.hadoop.security.token.Token[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="renewer" type="java.lang.String"/>
<param name="credentials" type="org.apache.hadoop.security.Credentials"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Passes the renewer and Credentials object to the underlying
{@link DelegationTokenExtension}
@param renewer the user allowed to renew the delegation tokens
@param credentials cache in which to add new delegation tokens
@return list of new delegation tokens
@throws IOException thrown if IOException if an IO error occurs.]]>
</doc>
</method>
<method name="createKeyProviderDelegationTokenExtension" return="org.apache.hadoop.crypto.key.KeyProviderDelegationTokenExtension"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="keyProvider" type="org.apache.hadoop.crypto.key.KeyProvider"/>
<doc>
<![CDATA[Creates a <code>KeyProviderDelegationTokenExtension</code> using a given
{@link KeyProvider}.
<p/>
If the given <code>KeyProvider</code> implements the
{@link DelegationTokenExtension} interface the <code>KeyProvider</code>
itself will provide the extension functionality, otherwise a default
extension implementation will be used.
@param keyProvider <code>KeyProvider</code> to use to create the
<code>KeyProviderDelegationTokenExtension</code> extension.
@return a <code>KeyProviderDelegationTokenExtension</code> instance
using the given <code>KeyProvider</code>.]]>
</doc>
</method>
<doc>
<![CDATA[A KeyProvider extension with the ability to add a renewer's Delegation
Tokens to the provided Credentials.]]>
</doc>
</class>
<!-- end class org.apache.hadoop.crypto.key.KeyProviderDelegationTokenExtension -->
<!-- start interface org.apache.hadoop.crypto.key.KeyProviderDelegationTokenExtension.DelegationTokenExtension -->
<interface name="KeyProviderDelegationTokenExtension.DelegationTokenExtension" abstract="true"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<implements name="org.apache.hadoop.crypto.key.KeyProviderExtension.Extension"/>
<method name="addDelegationTokens" return="org.apache.hadoop.security.token.Token[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="renewer" type="java.lang.String"/>
<param name="credentials" type="org.apache.hadoop.security.Credentials"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The implementer of this class will take a renewer and add all
delegation tokens associated with the renewer to the
<code>Credentials</code> object if it is not already present,
@param renewer the user allowed to renew the delegation tokens
@param credentials cache in which to add new delegation tokens
@return list of new delegation tokens
@throws IOException thrown if IOException if an IO error occurs.]]>
</doc>
</method>
<doc>
<![CDATA[DelegationTokenExtension is a type of Extension that exposes methods to
needed to work with Delegation Tokens.]]>
</doc>
</interface>
<!-- end interface org.apache.hadoop.crypto.key.KeyProviderDelegationTokenExtension.DelegationTokenExtension -->
<!-- start class org.apache.hadoop.crypto.key.KeyProviderExtension -->
<class name="KeyProviderExtension" extends="org.apache.hadoop.crypto.key.KeyProvider"
abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="KeyProviderExtension" type="org.apache.hadoop.crypto.key.KeyProvider, E"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="getExtension" return="E"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
</method>
<method name="getKeyProvider" return="org.apache.hadoop.crypto.key.KeyProvider"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
</method>
<method name="isTransient" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getKeysMetadata" return="org.apache.hadoop.crypto.key.KeyProvider.Metadata[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="names" type="java.lang.String[]"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="getCurrentKey" return="org.apache.hadoop.crypto.key.KeyProvider.KeyVersion"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="createKey" return="org.apache.hadoop.crypto.key.KeyProvider.KeyVersion"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="options" type="org.apache.hadoop.crypto.key.KeyProvider.Options"/>
<exception name="NoSuchAlgorithmException" type="java.security.NoSuchAlgorithmException"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="rollNewVersion" return="org.apache.hadoop.crypto.key.KeyProvider.KeyVersion"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<exception name="NoSuchAlgorithmException" type="java.security.NoSuchAlgorithmException"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="getKeyVersion" return="org.apache.hadoop.crypto.key.KeyProvider.KeyVersion"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="versionName" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="getKeys" return="java.util.List"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="getKeyVersions" return="java.util.List"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="getMetadata" return="org.apache.hadoop.crypto.key.KeyProvider.Metadata"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="createKey" return="org.apache.hadoop.crypto.key.KeyProvider.KeyVersion"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="material" type="byte[]"/>
<param name="options" type="org.apache.hadoop.crypto.key.KeyProvider.Options"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="deleteKey"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="rollNewVersion" return="org.apache.hadoop.crypto.key.KeyProvider.KeyVersion"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="material" type="byte[]"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="flush"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="toString" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<doc>
<![CDATA[This is a utility class used to extend the functionality of KeyProvider, that
takes a KeyProvider and an Extension. It implements all the required methods
of the KeyProvider by delegating it to the provided KeyProvider.]]>
</doc>
</class>
<!-- end class org.apache.hadoop.crypto.key.KeyProviderExtension -->
<!-- start interface org.apache.hadoop.crypto.key.KeyProviderExtension.Extension -->
<interface name="KeyProviderExtension.Extension" abstract="true"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[A marker interface for the KeyProviderExtension subclass implement.]]>
</doc>
</interface>
<!-- end interface org.apache.hadoop.crypto.key.KeyProviderExtension.Extension -->
<!-- start class org.apache.hadoop.crypto.key.KeyProviderFactory -->
<class name="KeyProviderFactory" extends="java.lang.Object"
abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="KeyProviderFactory"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="createProvider" return="org.apache.hadoop.crypto.key.KeyProvider"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="providerName" type="java.net.URI"/>
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="getProviders" return="java.util.List"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="get" return="org.apache.hadoop.crypto.key.KeyProvider"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="uri" type="java.net.URI"/>
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Create a KeyProvider based on a provided URI.
@param uri key provider URI
@param conf configuration to initialize the key provider
@return the key provider for the specified URI, or <code>NULL</code> if
a provider for the specified URI scheme could not be found.
@throws IOException thrown if the provider failed to initialize.]]>
</doc>
</method>
<field name="KEY_PROVIDER_PATH" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
</field>
<doc>
<![CDATA[A factory to create a list of KeyProvider based on the path given in a
Configuration. It uses a service loader interface to find the available
KeyProviders and create them based on the list of URIs.]]>
</doc>
</class>
<!-- end class org.apache.hadoop.crypto.key.KeyProviderFactory -->
<!-- start class org.apache.hadoop.crypto.key.KeyShell -->
<class name="KeyShell" extends="org.apache.hadoop.conf.Configured"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="org.apache.hadoop.util.Tool"/>
<constructor name="KeyShell"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="run" return="int"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="args" type="java.lang.String[]"/>
<exception name="Exception" type="java.lang.Exception"/>
<doc>
<![CDATA[Primary entry point for the KeyShell; called via main().
@param args Command line arguments.
@return 0 on success and 1 on failure. This value is passed back to
the unix shell, so we must follow shell return code conventions:
the return code is an unsigned character, and 0 means success, and
small positive integers mean failure.
@throws Exception]]>
</doc>
</method>
<method name="main"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="args" type="java.lang.String[]"/>
<exception name="Exception" type="java.lang.Exception"/>
<doc>
<![CDATA[main() entry point for the KeyShell. While strictly speaking the
return is void, it will System.exit() with a return code: 0 is for
success and 1 for failure.
@param args Command line arguments.
@throws Exception]]>
</doc>
</method>
<field name="out" type="java.io.PrintStream"
transient="false" volatile="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[allows stdout to be captured if necessary]]>
</doc>
</field>
<field name="err" type="java.io.PrintStream"
transient="false" volatile="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[allows stderr to be captured if necessary]]>
</doc>
</field>
<doc>
<![CDATA[This program is the CLI utility for the KeyProvider facilities in Hadoop.]]>
</doc>
</class>
<!-- end class org.apache.hadoop.crypto.key.KeyShell -->
<!-- start class org.apache.hadoop.crypto.key.UserProvider.Factory -->
<class name="UserProvider.Factory" extends="org.apache.hadoop.crypto.key.KeyProviderFactory"
abstract="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="UserProvider.Factory"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="createProvider" return="org.apache.hadoop.crypto.key.KeyProvider"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="providerName" type="java.net.URI"/>
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
</class>
<!-- end class org.apache.hadoop.crypto.key.UserProvider.Factory -->
</package>
<package name="org.apache.hadoop.crypto.key.kms">
<!-- start class org.apache.hadoop.crypto.key.kms.KMSClientProvider.Factory -->
<class name="KMSClientProvider.Factory" extends="org.apache.hadoop.crypto.key.KeyProviderFactory"
abstract="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="KMSClientProvider.Factory"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="createProvider" return="org.apache.hadoop.crypto.key.KeyProvider"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="providerName" type="java.net.URI"/>
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<doc>
<![CDATA[The factory to create KMSClientProvider, which is used by the
ServiceLoader.]]>
</doc>
</class>
<!-- end class org.apache.hadoop.crypto.key.kms.KMSClientProvider.Factory -->
<!-- start class org.apache.hadoop.crypto.key.kms.KMSClientProvider.KMSEncryptedKeyVersion -->
<class name="KMSClientProvider.KMSEncryptedKeyVersion" extends="org.apache.hadoop.crypto.key.KeyProviderCryptoExtension.EncryptedKeyVersion"
abstract="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="KMSClientProvider.KMSEncryptedKeyVersion" type="java.lang.String, java.lang.String, byte[], java.lang.String, byte[]"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
</class>
<!-- end class org.apache.hadoop.crypto.key.kms.KMSClientProvider.KMSEncryptedKeyVersion -->
<!-- start class org.apache.hadoop.crypto.key.kms.KMSClientProvider.KMSKeyVersion -->
<class name="KMSClientProvider.KMSKeyVersion" extends="org.apache.hadoop.crypto.key.KeyProvider.KeyVersion"
abstract="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="KMSClientProvider.KMSKeyVersion" type="java.lang.String, java.lang.String, byte[]"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
</class>
<!-- end class org.apache.hadoop.crypto.key.kms.KMSClientProvider.KMSKeyVersion -->
<!-- start class org.apache.hadoop.crypto.key.kms.KMSClientProvider.KMSMetadata -->
<class name="KMSClientProvider.KMSMetadata" extends="org.apache.hadoop.crypto.key.KeyProvider.Metadata"
abstract="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="KMSClientProvider.KMSMetadata" type="java.lang.String, int, java.lang.String, java.util.Map, java.util.Date, int"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
</class>
<!-- end class org.apache.hadoop.crypto.key.kms.KMSClientProvider.KMSMetadata -->
<!-- start interface org.apache.hadoop.crypto.key.kms.ValueQueue.QueueRefiller -->
<interface name="ValueQueue.QueueRefiller" abstract="true"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<method name="fillQueueForKey"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="keyName" type="java.lang.String"/>
<param name="keyQueue" type="java.util.Queue"/>
<param name="numValues" type="int"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Method that has to be implemented by implementing classes to fill the
Queue.
@param keyName Key name
@param keyQueue Queue that needs to be filled
@param numValues number of Values to be added to the queue.
@throws IOException]]>
</doc>
</method>
<doc>
<![CDATA[QueueRefiller interface a client must implement to use this class]]>
</doc>
</interface>
<!-- end interface org.apache.hadoop.crypto.key.kms.ValueQueue.QueueRefiller -->
<!-- start class org.apache.hadoop.crypto.key.kms.ValueQueue.SyncGenerationPolicy -->
<class name="ValueQueue.SyncGenerationPolicy" extends="java.lang.Enum"
abstract="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<method name="values" return="org.apache.hadoop.crypto.key.kms.ValueQueue.SyncGenerationPolicy[]"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="valueOf" return="org.apache.hadoop.crypto.key.kms.ValueQueue.SyncGenerationPolicy"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
</method>
<doc>
<![CDATA[Policy to decide how many values to return to client when client asks for
"n" values and Queue is empty.
This decides how many values to return when client calls "getAtMost"]]>
</doc>
</class>
<!-- end class org.apache.hadoop.crypto.key.kms.ValueQueue.SyncGenerationPolicy -->
</package>
<package name="org.apache.hadoop.crypto.random">
</package>
<package name="org.apache.hadoop.fs">
<!-- start class org.apache.hadoop.fs.AbstractFileSystem -->
<class name="AbstractFileSystem" extends="java.lang.Object"
abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="AbstractFileSystem" type="java.net.URI, java.lang.String, boolean, int"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<exception name="URISyntaxException" type="java.net.URISyntaxException"/>
<doc>
<![CDATA[Constructor to be called by subclasses.
@param uri for this file system.
@param supportedScheme the scheme supported by the implementor
@param authorityNeeded if true then theURI must have authority, if false
then the URI must have null authority.
@throws URISyntaxException <code>uri</code> has syntax error]]>
</doc>
</constructor>
<method name="getStatistics" return="org.apache.hadoop.fs.FileSystem.Statistics"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="isValidName" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="src" type="java.lang.String"/>
<doc>
<![CDATA[Returns true if the specified string is considered valid in the path part
of a URI by this file system. The default implementation enforces the rules
of HDFS, but subclasses may override this method to implement specific
validation rules for specific file systems.
@param src String source filename to check, path part of the URI
@return boolean true if the specified string is considered valid]]>
</doc>
</method>
<method name="createFileSystem" return="org.apache.hadoop.fs.AbstractFileSystem"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="uri" type="java.net.URI"/>
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
<doc>
<![CDATA[Create a file system instance for the specified uri using the conf. The
conf is used to find the class name that implements the file system. The
conf is also passed to the file system for its configuration.
@param uri URI of the file system
@param conf Configuration for the file system
@return Returns the file system for the given URI
@throws UnsupportedFileSystemException file system for <code>uri</code> is
not found]]>
</doc>
</method>
<method name="getStatistics" return="org.apache.hadoop.fs.FileSystem.Statistics"
abstract="false" native="false" synchronized="true"
static="true" final="false" visibility="protected"
deprecated="not deprecated">
<param name="uri" type="java.net.URI"/>
<doc>
<![CDATA[Get the statistics for a particular file system.
@param uri
used as key to lookup STATISTICS_TABLE. Only scheme and authority
part of the uri are used.
@return a statistics object]]>
</doc>
</method>
<method name="clearStatistics"
abstract="false" native="false" synchronized="true"
static="true" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="printStatistics"
abstract="false" native="false" synchronized="true"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Prints statistics for all file systems.]]>
</doc>
</method>
<method name="getAllStatistics" return="java.util.Map"
abstract="false" native="false" synchronized="true"
static="true" final="false" visibility="protected"
deprecated="not deprecated">
</method>
<method name="get" return="org.apache.hadoop.fs.AbstractFileSystem"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="uri" type="java.net.URI"/>
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
<doc>
<![CDATA[The main factory method for creating a file system. Get a file system for
the URI's scheme and authority. The scheme of the <code>uri</code>
determines a configuration property name,
<tt>fs.AbstractFileSystem.<i>scheme</i>.impl</tt> whose value names the
AbstractFileSystem class.
The entire URI and conf is passed to the AbstractFileSystem factory method.
@param uri for the file system to be created.
@param conf which is passed to the file system impl.
@return file system for the given URI.
@throws UnsupportedFileSystemException if the file system for
<code>uri</code> is not supported.]]>
</doc>
</method>
<method name="checkScheme"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="uri" type="java.net.URI"/>
<param name="supportedScheme" type="java.lang.String"/>
<doc>
<![CDATA[Check that the Uri's scheme matches
@param uri
@param supportedScheme]]>
</doc>
</method>
<method name="getUriDefaultPort" return="int"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[The default port of this file system.
@return default port of this file system's Uri scheme
A uri with a port of -1 => default port;]]>
</doc>
</method>
<method name="getUri" return="java.net.URI"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns a URI whose scheme and authority identify this FileSystem.
@return the uri of this file system.]]>
</doc>
</method>
<method name="checkPath"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<doc>
<![CDATA[Check that a Path belongs to this FileSystem.
If the path is fully qualified URI, then its scheme and authority
matches that of this file system. Otherwise the path must be
slash-relative name.
@throws InvalidPathException if the path is invalid]]>
</doc>
</method>
<method name="getUriPath" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="p" type="org.apache.hadoop.fs.Path"/>
<doc>
<![CDATA[Get the path-part of a pathname. Checks that URI matches this file system
and that the path-part is a valid name.
@param p path
@return path-part of the Path p]]>
</doc>
</method>
<method name="makeQualified" return="org.apache.hadoop.fs.Path"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<doc>
<![CDATA[Make the path fully qualified to this file system
@param path
@return the qualified path]]>
</doc>
</method>
<method name="getInitialWorkingDirectory" return="org.apache.hadoop.fs.Path"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Some file systems like LocalFileSystem have an initial workingDir
that is used as the starting workingDir. For other file systems
like HDFS there is no built in notion of an initial workingDir.
@return the initial workingDir if the file system has such a notion
otherwise return a null.]]>
</doc>
</method>
<method name="getHomeDirectory" return="org.apache.hadoop.fs.Path"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Return the current user's home directory in this file system.
The default implementation returns "/user/$USER/".
@return current user's home directory.]]>
</doc>
</method>
<method name="getServerDefaults" return="org.apache.hadoop.fs.FsServerDefaults"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Return a set of server default configuration values.
@return server default configuration values
@throws IOException an I/O error occurred]]>
</doc>
</method>
<method name="resolvePath" return="org.apache.hadoop.fs.Path"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="p" type="org.apache.hadoop.fs.Path"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Return the fully-qualified path of path f resolving the path
through any internal symlinks or mount point
@param p path to be resolved
@return fully qualified path
@throws FileNotFoundException, AccessControlException, IOException
UnresolvedLinkException if symbolic link on path cannot be resolved
internally]]>
</doc>
</method>
<method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
abstract="false" native="false" synchronized="false"
static="false" final="true" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="createFlag" type="java.util.EnumSet"/>
<param name="opts" type="org.apache.hadoop.fs.Options.CreateOpts[]"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileAlreadyExistsException" type="org.apache.hadoop.fs.FileAlreadyExistsException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="ParentNotDirectoryException" type="org.apache.hadoop.fs.ParentNotDirectoryException"/>
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The specification of this method matches that of
{@link FileContext#create(Path, EnumSet, Options.CreateOpts...)} except
that the Path f must be fully qualified and the permission is absolute
(i.e. umask has been applied).]]>
</doc>
</method>
<method name="createInternal" return="org.apache.hadoop.fs.FSDataOutputStream"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="flag" type="java.util.EnumSet"/>
<param name="absolutePermission" type="org.apache.hadoop.fs.permission.FsPermission"/>
<param name="bufferSize" type="int"/>
<param name="replication" type="short"/>
<param name="blockSize" type="long"/>
<param name="progress" type="org.apache.hadoop.util.Progressable"/>
<param name="checksumOpt" type="org.apache.hadoop.fs.Options.ChecksumOpt"/>
<param name="createParent" type="boolean"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileAlreadyExistsException" type="org.apache.hadoop.fs.FileAlreadyExistsException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="ParentNotDirectoryException" type="org.apache.hadoop.fs.ParentNotDirectoryException"/>
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The specification of this method matches that of
{@link #create(Path, EnumSet, Options.CreateOpts...)} except that the opts
have been declared explicitly.]]>
</doc>
</method>
<method name="mkdir"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="dir" type="org.apache.hadoop.fs.Path"/>
<param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
<param name="createParent" type="boolean"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileAlreadyExistsException" type="org.apache.hadoop.fs.FileAlreadyExistsException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The specification of this method matches that of
{@link FileContext#mkdir(Path, FsPermission, boolean)} except that the Path
f must be fully qualified and the permission is absolute (i.e.
umask has been applied).]]>
</doc>
</method>
<method name="delete" return="boolean"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="recursive" type="boolean"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The specification of this method matches that of
{@link FileContext#delete(Path, boolean)} except that Path f must be for
this file system.]]>
</doc>
</method>
<method name="open" return="org.apache.hadoop.fs.FSDataInputStream"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The specification of this method matches that of
{@link FileContext#open(Path)} except that Path f must be for this
file system.]]>
</doc>
</method>
<method name="open" return="org.apache.hadoop.fs.FSDataInputStream"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="bufferSize" type="int"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The specification of this method matches that of
{@link FileContext#open(Path, int)} except that Path f must be for this
file system.]]>
</doc>
</method>
<method name="setReplication" return="boolean"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="replication" type="short"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The specification of this method matches that of
{@link FileContext#setReplication(Path, short)} except that Path f must be
for this file system.]]>
</doc>
</method>
<method name="rename"
abstract="false" native="false" synchronized="false"
static="false" final="true" visibility="public"
deprecated="not deprecated">
<param name="src" type="org.apache.hadoop.fs.Path"/>
<param name="dst" type="org.apache.hadoop.fs.Path"/>
<param name="options" type="org.apache.hadoop.fs.Options.Rename[]"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileAlreadyExistsException" type="org.apache.hadoop.fs.FileAlreadyExistsException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="ParentNotDirectoryException" type="org.apache.hadoop.fs.ParentNotDirectoryException"/>
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The specification of this method matches that of
{@link FileContext#rename(Path, Path, Options.Rename...)} except that Path
f must be for this file system.]]>
</doc>
</method>
<method name="renameInternal"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="src" type="org.apache.hadoop.fs.Path"/>
<param name="dst" type="org.apache.hadoop.fs.Path"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileAlreadyExistsException" type="org.apache.hadoop.fs.FileAlreadyExistsException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="ParentNotDirectoryException" type="org.apache.hadoop.fs.ParentNotDirectoryException"/>
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The specification of this method matches that of
{@link FileContext#rename(Path, Path, Options.Rename...)} except that Path
f must be for this file system and NO OVERWRITE is performed.
File systems that do not have a built in overwrite need implement only this
method and can take advantage of the default impl of the other
{@link #renameInternal(Path, Path, boolean)}]]>
</doc>
</method>
<method name="renameInternal"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="src" type="org.apache.hadoop.fs.Path"/>
<param name="dst" type="org.apache.hadoop.fs.Path"/>
<param name="overwrite" type="boolean"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileAlreadyExistsException" type="org.apache.hadoop.fs.FileAlreadyExistsException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="ParentNotDirectoryException" type="org.apache.hadoop.fs.ParentNotDirectoryException"/>
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The specification of this method matches that of
{@link FileContext#rename(Path, Path, Options.Rename...)} except that Path
f must be for this file system.]]>
</doc>
</method>
<method name="supportsSymlinks" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns true if the file system supports symlinks, false otherwise.
@return true if filesystem supports symlinks]]>
</doc>
</method>
<method name="createSymlink"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="target" type="org.apache.hadoop.fs.Path"/>
<param name="link" type="org.apache.hadoop.fs.Path"/>
<param name="createParent" type="boolean"/>
<exception name="IOException" type="java.io.IOException"/>
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
<doc>
<![CDATA[The specification of this method matches that of
{@link FileContext#createSymlink(Path, Path, boolean)};]]>
</doc>
</method>
<method name="getLinkTarget" return="org.apache.hadoop.fs.Path"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Partially resolves the path. This is used during symlink resolution in
{@link FSLinkResolver}, and differs from the similarly named method
{@link FileContext#getLinkTarget(Path)}.
@throws IOException subclass implementations may throw IOException]]>
</doc>
</method>
<method name="setPermission"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The specification of this method matches that of
{@link FileContext#setPermission(Path, FsPermission)} except that Path f
must be for this file system.]]>
</doc>
</method>
<method name="setOwner"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="username" type="java.lang.String"/>
<param name="groupname" type="java.lang.String"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The specification of this method matches that of
{@link FileContext#setOwner(Path, String, String)} except that Path f must
be for this file system.]]>
</doc>
</method>
<method name="setTimes"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="mtime" type="long"/>
<param name="atime" type="long"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The specification of this method matches that of
{@link FileContext#setTimes(Path, long, long)} except that Path f must be
for this file system.]]>
</doc>
</method>
<method name="getFileChecksum" return="org.apache.hadoop.fs.FileChecksum"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The specification of this method matches that of
{@link FileContext#getFileChecksum(Path)} except that Path f must be for
this file system.]]>
</doc>
</method>
<method name="getFileStatus" return="org.apache.hadoop.fs.FileStatus"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The specification of this method matches that of
{@link FileContext#getFileStatus(Path)}
except that an UnresolvedLinkException may be thrown if a symlink is
encountered in the path.]]>
</doc>
</method>
<method name="access"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<param name="mode" type="org.apache.hadoop.fs.permission.FsAction"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The specification of this method matches that of
{@link FileContext#access(Path, FsAction)}
except that an UnresolvedLinkException may be thrown if a symlink is
encountered in the path.]]>
</doc>
</method>
<method name="getFileLinkStatus" return="org.apache.hadoop.fs.FileStatus"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The specification of this method matches that of
{@link FileContext#getFileLinkStatus(Path)}
except that an UnresolvedLinkException may be thrown if a symlink is
encountered in the path leading up to the final path component.
If the file system does not support symlinks then the behavior is
equivalent to {@link AbstractFileSystem#getFileStatus(Path)}.]]>
</doc>
</method>
<method name="getFileBlockLocations" return="org.apache.hadoop.fs.BlockLocation[]"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="start" type="long"/>
<param name="len" type="long"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The specification of this method matches that of
{@link FileContext#getFileBlockLocations(Path, long, long)} except that
Path f must be for this file system.]]>
</doc>
</method>
<method name="getFsStatus" return="org.apache.hadoop.fs.FsStatus"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The specification of this method matches that of
{@link FileContext#getFsStatus(Path)} except that Path f must be for this
file system.]]>
</doc>
</method>
<method name="getFsStatus" return="org.apache.hadoop.fs.FsStatus"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The specification of this method matches that of
{@link FileContext#getFsStatus(Path)}.]]>
</doc>
</method>
<method name="listStatusIterator" return="org.apache.hadoop.fs.RemoteIterator"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The specification of this method matches that of
{@link FileContext#listStatus(Path)} except that Path f must be for this
file system.]]>
</doc>
</method>
<method name="listLocatedStatus" return="org.apache.hadoop.fs.RemoteIterator"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The specification of this method matches that of
{@link FileContext#listLocatedStatus(Path)} except that Path f
must be for this file system.]]>
</doc>
</method>
<method name="listStatus" return="org.apache.hadoop.fs.FileStatus[]"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The specification of this method matches that of
{@link FileContext.Util#listStatus(Path)} except that Path f must be
for this file system.]]>
</doc>
</method>
<method name="listCorruptFileBlocks" return="org.apache.hadoop.fs.RemoteIterator"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[@return an iterator over the corrupt files under the given path
(may contain duplicates if a file has more than one corrupt block)
@throws IOException]]>
</doc>
</method>
<method name="setVerifyChecksum"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="verifyChecksum" type="boolean"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The specification of this method matches that of
{@link FileContext#setVerifyChecksum(boolean, Path)} except that Path f
must be for this file system.]]>
</doc>
</method>
<method name="getCanonicalServiceName" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get a canonical name for this file system.
@return a URI string that uniquely identifies this file system]]>
</doc>
</method>
<method name="getDelegationTokens" return="java.util.List"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="renewer" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Get one or more delegation tokens associated with the filesystem. Normally
a file system returns a single delegation token. A file system that manages
multiple file systems underneath, could return set of delegation tokens for
all the file systems it manages
@param renewer the account name that is allowed to renew the token.
@return List of delegation tokens.
If delegation tokens not supported then return a list of size zero.
@throws IOException]]>
</doc>
</method>
<method name="modifyAclEntries"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<param name="aclSpec" type="java.util.List"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Modifies ACL entries of files and directories. This method can add new ACL
entries or modify the permissions on existing ACL entries. All existing
ACL entries that are not specified in this call are retained without
changes. (Modifications are merged into the current ACL.)
@param path Path to modify
@param aclSpec List<AclEntry> describing modifications
@throws IOException if an ACL could not be modified]]>
</doc>
</method>
<method name="removeAclEntries"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<param name="aclSpec" type="java.util.List"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Removes ACL entries from files and directories. Other ACL entries are
retained.
@param path Path to modify
@param aclSpec List<AclEntry> describing entries to remove
@throws IOException if an ACL could not be modified]]>
</doc>
</method>
<method name="removeDefaultAcl"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Removes all default ACL entries from files and directories.
@param path Path to modify
@throws IOException if an ACL could not be modified]]>
</doc>
</method>
<method name="removeAcl"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Removes all but the base ACL entries of files and directories. The entries
for user, group, and others are retained for compatibility with permission
bits.
@param path Path to modify
@throws IOException if an ACL could not be removed]]>
</doc>
</method>
<method name="setAcl"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<param name="aclSpec" type="java.util.List"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Fully replaces ACL of files and directories, discarding all existing
entries.
@param path Path to modify
@param aclSpec List<AclEntry> describing modifications, must include entries
for user, group, and others for compatibility with permission bits.
@throws IOException if an ACL could not be modified]]>
</doc>
</method>
<method name="getAclStatus" return="org.apache.hadoop.fs.permission.AclStatus"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Gets the ACLs of files and directories.
@param path Path to get
@return RemoteIterator<AclStatus> which returns each AclStatus
@throws IOException if an ACL could not be read]]>
</doc>
</method>
<method name="setXAttr"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<param name="name" type="java.lang.String"/>
<param name="value" type="byte[]"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Set an xattr of a file or directory.
The name must be prefixed with the namespace followed by ".". For example,
"user.attr".
<p/>
Refer to the HDFS extended attributes user documentation for details.
@param path Path to modify
@param name xattr name.
@param value xattr value.
@throws IOException]]>
</doc>
</method>
<method name="setXAttr"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<param name="name" type="java.lang.String"/>
<param name="value" type="byte[]"/>
<param name="flag" type="java.util.EnumSet"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Set an xattr of a file or directory.
The name must be prefixed with the namespace followed by ".". For example,
"user.attr".
<p/>
Refer to the HDFS extended attributes user documentation for details.
@param path Path to modify
@param name xattr name.
@param value xattr value.
@param flag xattr set flag
@throws IOException]]>
</doc>
</method>
<method name="getXAttr" return="byte[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<param name="name" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Get an xattr for a file or directory.
The name must be prefixed with the namespace followed by ".". For example,
"user.attr".
<p/>
Refer to the HDFS extended attributes user documentation for details.
@param path Path to get extended attribute
@param name xattr name.
@return byte[] xattr value.
@throws IOException]]>
</doc>
</method>
<method name="getXAttrs" return="java.util.Map"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Get all of the xattrs for a file or directory.
Only those xattrs for which the logged-in user has permissions to view
are returned.
<p/>
Refer to the HDFS extended attributes user documentation for details.
@param path Path to get extended attributes
@return Map<String, byte[]> describing the XAttrs of the file or directory
@throws IOException]]>
</doc>
</method>
<method name="getXAttrs" return="java.util.Map"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<param name="names" type="java.util.List"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Get all of the xattrs for a file or directory.
Only those xattrs for which the logged-in user has permissions to view
are returned.
<p/>
Refer to the HDFS extended attributes user documentation for details.
@param path Path to get extended attributes
@param names XAttr names.
@return Map<String, byte[]> describing the XAttrs of the file or directory
@throws IOException]]>
</doc>
</method>
<method name="listXAttrs" return="java.util.List"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Get all of the xattr names for a file or directory.
Only the xattr names for which the logged-in user has permissions to view
are returned.
<p/>
Refer to the HDFS extended attributes user documentation for details.
@param path Path to get extended attributes
@return Map<String, byte[]> describing the XAttrs of the file or directory
@throws IOException]]>
</doc>
</method>
<method name="removeXAttr"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<param name="name" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Remove an xattr of a file or directory.
The name must be prefixed with the namespace followed by ".". For example,
"user.attr".
<p/>
Refer to the HDFS extended attributes user documentation for details.
@param path Path to remove extended attribute
@param name xattr name
@throws IOException]]>
</doc>
</method>
<method name="hashCode" return="int"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="equals" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="other" type="java.lang.Object"/>
</method>
<field name="statistics" type="org.apache.hadoop.fs.FileSystem.Statistics"
transient="false" volatile="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<doc>
<![CDATA[The statistics for this file system.]]>
</doc>
</field>
<doc>
<![CDATA[This class provides an interface for implementors of a Hadoop file system
(analogous to the VFS of Unix). Applications do not access this class;
instead they access files across all file systems using {@link FileContext}.
Pathnames passed to AbstractFileSystem can be fully qualified URI that
matches the "this" file system (ie same scheme and authority)
or a Slash-relative name that is assumed to be relative
to the root of the "this" file system .]]>
</doc>
</class>
<!-- end class org.apache.hadoop.fs.AbstractFileSystem -->
<!-- start class org.apache.hadoop.fs.AvroFSInput -->
<class name="AvroFSInput" extends="java.lang.Object"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="java.io.Closeable"/>
<implements name="org.apache.avro.file.SeekableInput"/>
<constructor name="AvroFSInput" type="org.apache.hadoop.fs.FSDataInputStream, long"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Construct given an {@link FSDataInputStream} and its length.]]>
</doc>
</constructor>
<constructor name="AvroFSInput" type="org.apache.hadoop.fs.FileContext, org.apache.hadoop.fs.Path"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Construct given a {@link FileContext} and a {@link Path}.]]>
</doc>
</constructor>
<method name="length" return="long"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="read" return="int"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="b" type="byte[]"/>
<param name="off" type="int"/>
<param name="len" type="int"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="seek"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="p" type="long"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="tell" return="long"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="close"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<exception name="IOException" type="java.io.IOException"/>
</method>
<doc>
<![CDATA[Adapts an {@link FSDataInputStream} to Avro's SeekableInput interface.]]>
</doc>
</class>
<!-- end class org.apache.hadoop.fs.AvroFSInput -->
<!-- start class org.apache.hadoop.fs.BatchedRemoteIterator -->
<class name="BatchedRemoteIterator" extends="java.lang.Object"
abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="org.apache.hadoop.fs.RemoteIterator"/>
<constructor name="BatchedRemoteIterator" type="K"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="makeRequest" return="org.apache.hadoop.fs.BatchedRemoteIterator.BatchedEntries"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="prevKey" type="K"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Perform the actual remote request.
@param prevKey The key to send.
@return A list of replies.]]>
</doc>
</method>
<method name="hasNext" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="elementToPrevKey" return="K"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="element" type="E"/>
<doc>
<![CDATA[Return the next list key associated with an element.]]>
</doc>
</method>
<method name="next" return="E"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<exception name="IOException" type="java.io.IOException"/>
</method>
<doc>
<![CDATA[A RemoteIterator that fetches elements in batches.]]>
</doc>
</class>
<!-- end class org.apache.hadoop.fs.BatchedRemoteIterator -->
<!-- start interface org.apache.hadoop.fs.BatchedRemoteIterator.BatchedEntries -->
<interface name="BatchedRemoteIterator.BatchedEntries" abstract="true"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<method name="get" return="E"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="i" type="int"/>
</method>
<method name="size" return="int"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="hasMore" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
</interface>
<!-- end interface org.apache.hadoop.fs.BatchedRemoteIterator.BatchedEntries -->
<!-- start class org.apache.hadoop.fs.BatchedRemoteIterator.BatchedListEntries -->
<class name="BatchedRemoteIterator.BatchedListEntries" extends="java.lang.Object"
abstract="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<implements name="org.apache.hadoop.fs.BatchedRemoteIterator.BatchedEntries"/>
<constructor name="BatchedRemoteIterator.BatchedListEntries" type="java.util.List, boolean"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="get" return="E"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="i" type="int"/>
</method>
<method name="size" return="int"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="hasMore" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
</class>
<!-- end class org.apache.hadoop.fs.BatchedRemoteIterator.BatchedListEntries -->
<!-- start class org.apache.hadoop.fs.BlockLocation -->
<class name="BlockLocation" extends="java.lang.Object"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="BlockLocation"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Default Constructor]]>
</doc>
</constructor>
<constructor name="BlockLocation" type="org.apache.hadoop.fs.BlockLocation"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Copy constructor]]>
</doc>
</constructor>
<constructor name="BlockLocation" type="java.lang.String[], java.lang.String[], long, long"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Constructor with host, name, offset and length]]>
</doc>
</constructor>
<constructor name="BlockLocation" type="java.lang.String[], java.lang.String[], long, long, boolean"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Constructor with host, name, offset, length and corrupt flag]]>
</doc>
</constructor>
<constructor name="BlockLocation" type="java.lang.String[], java.lang.String[], java.lang.String[], long, long"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Constructor with host, name, network topology, offset and length]]>
</doc>
</constructor>
<constructor name="BlockLocation" type="java.lang.String[], java.lang.String[], java.lang.String[], long, long, boolean"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Constructor with host, name, network topology, offset, length
and corrupt flag]]>
</doc>
</constructor>
<constructor name="BlockLocation" type="java.lang.String[], java.lang.String[], java.lang.String[], java.lang.String[], long, long, boolean"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="getHosts" return="java.lang.String[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Get the list of hosts (hostname) hosting this block]]>
</doc>
</method>
<method name="getCachedHosts" return="java.lang.String[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the list of hosts (hostname) hosting a cached replica of the block]]>
</doc>
</method>
<method name="getNames" return="java.lang.String[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Get the list of names (IP:xferPort) hosting this block]]>
</doc>
</method>
<method name="getTopologyPaths" return="java.lang.String[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Get the list of network topology paths for each of the hosts.
The last component of the path is the "name" (IP:xferPort).]]>
</doc>
</method>
<method name="getOffset" return="long"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the start offset of file associated with this block]]>
</doc>
</method>
<method name="getLength" return="long"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the length of the block]]>
</doc>
</method>
<method name="isCorrupt" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the corrupt flag.]]>
</doc>
</method>
<method name="setOffset"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="offset" type="long"/>
<doc>
<![CDATA[Set the start offset of file associated with this block]]>
</doc>
</method>
<method name="setLength"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="length" type="long"/>
<doc>
<![CDATA[Set the length of block]]>
</doc>
</method>
<method name="setCorrupt"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="corrupt" type="boolean"/>
<doc>
<![CDATA[Set the corrupt flag.]]>
</doc>
</method>
<method name="setHosts"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="hosts" type="java.lang.String[]"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Set the hosts hosting this block]]>
</doc>
</method>
<method name="setCachedHosts"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="cachedHosts" type="java.lang.String[]"/>
<doc>
<![CDATA[Set the hosts hosting a cached replica of this block]]>
</doc>
</method>
<method name="setNames"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="names" type="java.lang.String[]"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Set the names (host:port) hosting this block]]>
</doc>
</method>
<method name="setTopologyPaths"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="topologyPaths" type="java.lang.String[]"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Set the network topology paths of the hosts]]>
</doc>
</method>
<method name="toString" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<doc>
<![CDATA[Represents the network location of a block, information about the hosts
that contain block replicas, and other block metadata (E.g. the file
offset associated with the block, length, whether it is corrupt, etc).]]>
</doc>
</class>
<!-- end class org.apache.hadoop.fs.BlockLocation -->
<!-- start interface org.apache.hadoop.fs.ByteBufferReadable -->
<interface name="ByteBufferReadable" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<method name="read" return="int"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="buf" type="java.nio.ByteBuffer"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Reads up to buf.remaining() bytes into buf. Callers should use
buf.limit(..) to control the size of the desired read.
<p/>
After a successful call, buf.position() and buf.limit() should be
unchanged, and therefore any data can be immediately read from buf.
buf.mark() may be cleared or updated.
<p/>
In the case of an exception, the values of buf.position() and buf.limit()
are undefined, and callers should be prepared to recover from this
eventuality.
<p/>
Many implementations will throw {@link UnsupportedOperationException}, so
callers that are not confident in support for this method from the
underlying filesystem should be prepared to handle that exception.
<p/>
Implementations should treat 0-length requests as legitimate, and must not
signal an error upon their receipt.
@param buf
the ByteBuffer to receive the results of the read operation. Up to
buf.limit() - buf.position() bytes may be read.
@return the number of bytes available to read from buf
@throws IOException
if there is some error performing the read]]>
</doc>
</method>
<doc>
<![CDATA[Implementers of this interface provide a read API that writes to a
ByteBuffer, not a byte[].]]>
</doc>
</interface>
<!-- end interface org.apache.hadoop.fs.ByteBufferReadable -->
<!-- start interface org.apache.hadoop.fs.CanSetDropBehind -->
<interface name="CanSetDropBehind" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<method name="setDropBehind"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="dropCache" type="java.lang.Boolean"/>
<exception name="IOException" type="java.io.IOException"/>
<exception name="UnsupportedOperationException" type="java.lang.UnsupportedOperationException"/>
<doc>
<![CDATA[Configure whether the stream should drop the cache.
@param dropCache Whether to drop the cache. null means to use the
default value.
@throws IOException If there was an error changing the dropBehind
setting.
UnsupportedOperationException If this stream doesn't support
setting the drop-behind.]]>
</doc>
</method>
</interface>
<!-- end interface org.apache.hadoop.fs.CanSetDropBehind -->
<!-- start interface org.apache.hadoop.fs.CanSetReadahead -->
<interface name="CanSetReadahead" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<method name="setReadahead"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="readahead" type="java.lang.Long"/>
<exception name="IOException" type="java.io.IOException"/>
<exception name="UnsupportedOperationException" type="java.lang.UnsupportedOperationException"/>
<doc>
<![CDATA[Set the readahead on this stream.
@param readahead The readahead to use. null means to use the default.
@throws IOException If there was an error changing the dropBehind
setting.
UnsupportedOperationException If this stream doesn't support
setting readahead.]]>
</doc>
</method>
</interface>
<!-- end interface org.apache.hadoop.fs.CanSetReadahead -->
<!-- start class org.apache.hadoop.fs.ChecksumException -->
<class name="ChecksumException" extends="java.io.IOException"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="ChecksumException" type="java.lang.String, long"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="getPos" return="long"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<doc>
<![CDATA[Thrown for checksum errors.]]>
</doc>
</class>
<!-- end class org.apache.hadoop.fs.ChecksumException -->
<!-- start class org.apache.hadoop.fs.ChecksumFileSystem -->
<class name="ChecksumFileSystem" extends="org.apache.hadoop.fs.FilterFileSystem"
abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="ChecksumFileSystem" type="org.apache.hadoop.fs.FileSystem"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="getApproxChkSumLength" return="double"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="size" type="long"/>
</method>
<method name="setConf"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
</method>
<method name="setVerifyChecksum"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="verifyChecksum" type="boolean"/>
<doc>
<![CDATA[Set whether to verify checksum.]]>
</doc>
</method>
<method name="setWriteChecksum"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="writeChecksum" type="boolean"/>
</method>
<method name="getRawFileSystem" return="org.apache.hadoop.fs.FileSystem"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[get the raw file system]]>
</doc>
</method>
<method name="getChecksumFile" return="org.apache.hadoop.fs.Path"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="file" type="org.apache.hadoop.fs.Path"/>
<doc>
<![CDATA[Return the name of the checksum file associated with a file.]]>
</doc>
</method>
<method name="isChecksumFile" return="boolean"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="file" type="org.apache.hadoop.fs.Path"/>
<doc>
<![CDATA[Return true iff file is a checksum file name.]]>
</doc>
</method>
<method name="getChecksumFileLength" return="long"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="file" type="org.apache.hadoop.fs.Path"/>
<param name="fileSize" type="long"/>
<doc>
<![CDATA[Return the length of the checksum file given the size of the
actual file.]]>
</doc>
</method>
<method name="getBytesPerSum" return="int"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Return the bytes Per Checksum]]>
</doc>
</method>
<method name="open" return="org.apache.hadoop.fs.FSDataInputStream"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="bufferSize" type="int"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Opens an FSDataInputStream at the indicated Path.
@param f the file name to open
@param bufferSize the size of the buffer to be used.]]>
</doc>
</method>
<method name="append" return="org.apache.hadoop.fs.FSDataOutputStream"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="bufferSize" type="int"/>
<param name="progress" type="org.apache.hadoop.util.Progressable"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="getChecksumLength" return="long"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="size" type="long"/>
<param name="bytesPerSum" type="int"/>
<doc>
<![CDATA[Calculated the length of the checksum file in bytes.
@param size the length of the data file in bytes
@param bytesPerSum the number of bytes in a checksum block
@return the number of bytes in the checksum file]]>
</doc>
</method>
<method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
<param name="overwrite" type="boolean"/>
<param name="bufferSize" type="int"/>
<param name="replication" type="short"/>
<param name="blockSize" type="long"/>
<param name="progress" type="org.apache.hadoop.util.Progressable"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="createNonRecursive" return="org.apache.hadoop.fs.FSDataOutputStream"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
<param name="overwrite" type="boolean"/>
<param name="bufferSize" type="int"/>
<param name="replication" type="short"/>
<param name="blockSize" type="long"/>
<param name="progress" type="org.apache.hadoop.util.Progressable"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="setReplication" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="src" type="org.apache.hadoop.fs.Path"/>
<param name="replication" type="short"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Set replication for an existing file.
Implement the abstract <tt>setReplication</tt> of <tt>FileSystem</tt>
@param src file name
@param replication new replication
@throws IOException
@return true if successful;
false if file does not exist or is a directory]]>
</doc>
</method>
<method name="rename" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="src" type="org.apache.hadoop.fs.Path"/>
<param name="dst" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Rename files/dirs]]>
</doc>
</method>
<method name="delete" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="recursive" type="boolean"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Implement the delete(Path, boolean) in checksum
file system.]]>
</doc>
</method>
<method name="listStatus" return="org.apache.hadoop.fs.FileStatus[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[List the statuses of the files/directories in the given path if the path is
a directory.
@param f
given path
@return the statuses of the files/directories in the given path
@throws IOException]]>
</doc>
</method>
<method name="listLocatedStatus" return="org.apache.hadoop.fs.RemoteIterator"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[List the statuses of the files/directories in the given path if the path is
a directory.
@param f
given path
@return the statuses of the files/directories in the given patch
@throws IOException]]>
</doc>
</method>
<method name="mkdirs" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="copyFromLocalFile"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="delSrc" type="boolean"/>
<param name="src" type="org.apache.hadoop.fs.Path"/>
<param name="dst" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="copyToLocalFile"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="delSrc" type="boolean"/>
<param name="src" type="org.apache.hadoop.fs.Path"/>
<param name="dst" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The src file is under FS, and the dst is on the local disk.
Copy it from FS control to the local dst name.]]>
</doc>
</method>
<method name="copyToLocalFile"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="src" type="org.apache.hadoop.fs.Path"/>
<param name="dst" type="org.apache.hadoop.fs.Path"/>
<param name="copyCrc" type="boolean"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The src file is under FS, and the dst is on the local disk.
Copy it from FS control to the local dst name.
If src and dst are directories, the copyCrc parameter
determines whether to copy CRC files.]]>
</doc>
</method>
<method name="startLocalOutput" return="org.apache.hadoop.fs.Path"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="fsOutputFile" type="org.apache.hadoop.fs.Path"/>
<param name="tmpLocalFile" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="completeLocalOutput"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="fsOutputFile" type="org.apache.hadoop.fs.Path"/>
<param name="tmpLocalFile" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="reportChecksumFailure" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="in" type="org.apache.hadoop.fs.FSDataInputStream"/>
<param name="inPos" type="long"/>
<param name="sums" type="org.apache.hadoop.fs.FSDataInputStream"/>
<param name="sumsPos" type="long"/>
<doc>
<![CDATA[Report a checksum error to the file system.
@param f the file name containing the error
@param in the stream open on the file
@param inPos the position of the beginning of the bad data in the file
@param sums the stream open on the checksum file
@param sumsPos the position of the beginning of the bad data in the checksum file
@return if retry is neccessary]]>
</doc>
</method>
<doc>
<![CDATA[Abstract Checksumed FileSystem.
It provide a basic implementation of a Checksumed FileSystem,
which creates a checksum file for each raw file.
It generates & verifies checksums at the client side.]]>
</doc>
</class>
<!-- end class org.apache.hadoop.fs.ChecksumFileSystem -->
<!-- start class org.apache.hadoop.fs.CommonConfigurationKeysPublic -->
<class name="CommonConfigurationKeysPublic" extends="java.lang.Object"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="CommonConfigurationKeysPublic"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<field name="IO_NATIVE_LIB_AVAILABLE_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="IO_NATIVE_LIB_AVAILABLE_DEFAULT" type="boolean"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Default value for IO_NATIVE_LIB_AVAILABLE_KEY]]>
</doc>
</field>
<field name="NET_TOPOLOGY_SCRIPT_NUMBER_ARGS_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="NET_TOPOLOGY_SCRIPT_NUMBER_ARGS_DEFAULT" type="int"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Default value for NET_TOPOLOGY_SCRIPT_NUMBER_ARGS_KEY]]>
</doc>
</field>
<field name="FS_DEFAULT_NAME_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="FS_DEFAULT_NAME_DEFAULT" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Default value for FS_DEFAULT_NAME_KEY]]>
</doc>
</field>
<field name="FS_DF_INTERVAL_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="FS_DF_INTERVAL_DEFAULT" type="long"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Default value for FS_DF_INTERVAL_KEY]]>
</doc>
</field>
<field name="FS_DU_INTERVAL_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="FS_DU_INTERVAL_DEFAULT" type="long"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Default value for FS_DU_INTERVAL_KEY]]>
</doc>
</field>
<field name="FS_CLIENT_RESOLVE_REMOTE_SYMLINKS_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="FS_CLIENT_RESOLVE_REMOTE_SYMLINKS_DEFAULT" type="boolean"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Default value for FS_CLIENT_RESOLVE_REMOTE_SYMLINKS_KEY]]>
</doc>
</field>
<field name="NET_TOPOLOGY_SCRIPT_FILE_NAME_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="NET_TOPOLOGY_NODE_SWITCH_MAPPING_IMPL_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="NET_TOPOLOGY_IMPL_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="NET_TOPOLOGY_TABLE_MAPPING_FILE_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="NET_DEPENDENCY_SCRIPT_FILE_NAME_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
</field>
<field name="FS_TRASH_CHECKPOINT_INTERVAL_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="FS_TRASH_CHECKPOINT_INTERVAL_DEFAULT" type="long"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Default value for FS_TRASH_CHECKPOINT_INTERVAL_KEY]]>
</doc>
</field>
<field name="FS_LOCAL_BLOCK_SIZE_DEFAULT" type="long"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Not used anywhere, looks like default value for FS_LOCAL_BLOCK_SIZE]]>
</doc>
</field>
<field name="FS_AUTOMATIC_CLOSE_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="FS_AUTOMATIC_CLOSE_DEFAULT" type="boolean"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Default value for FS_AUTOMATIC_CLOSE_KEY]]>
</doc>
</field>
<field name="FS_FILE_IMPL_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="FS_FTP_HOST_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="FS_FTP_HOST_PORT_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="FS_TRASH_INTERVAL_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="FS_TRASH_INTERVAL_DEFAULT" type="long"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Default value for FS_TRASH_INTERVAL_KEY]]>
</doc>
</field>
<field name="IO_MAPFILE_BLOOM_SIZE_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="IO_MAPFILE_BLOOM_SIZE_DEFAULT" type="int"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Default value for IO_MAPFILE_BLOOM_SIZE_KEY]]>
</doc>
</field>
<field name="IO_MAPFILE_BLOOM_ERROR_RATE_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="IO_MAPFILE_BLOOM_ERROR_RATE_DEFAULT" type="float"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Default value for IO_MAPFILE_BLOOM_ERROR_RATE_KEY]]>
</doc>
</field>
<field name="IO_COMPRESSION_CODEC_LZO_CLASS_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Codec class that implements Lzo compression algorithm]]>
</doc>
</field>
<field name="IO_MAP_INDEX_INTERVAL_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="IO_MAP_INDEX_INTERVAL_DEFAULT" type="int"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Default value for IO_MAP_INDEX_INTERVAL_DEFAULT]]>
</doc>
</field>
<field name="IO_MAP_INDEX_SKIP_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="IO_MAP_INDEX_SKIP_DEFAULT" type="int"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Default value for IO_MAP_INDEX_SKIP_KEY]]>
</doc>
</field>
<field name="IO_SEQFILE_COMPRESS_BLOCKSIZE_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="IO_SEQFILE_COMPRESS_BLOCKSIZE_DEFAULT" type="int"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Default value for IO_SEQFILE_COMPRESS_BLOCKSIZE_KEY]]>
</doc>
</field>
<field name="IO_FILE_BUFFER_SIZE_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="IO_FILE_BUFFER_SIZE_DEFAULT" type="int"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Default value for IO_FILE_BUFFER_SIZE_KEY]]>
</doc>
</field>
<field name="IO_SKIP_CHECKSUM_ERRORS_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="IO_SKIP_CHECKSUM_ERRORS_DEFAULT" type="boolean"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Default value for IO_SKIP_CHECKSUM_ERRORS_KEY]]>
</doc>
</field>
<field name="IO_SORT_MB_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="Moved to mapreduce, see mapreduce.task.io.sort.mb
in mapred-default.xml
See https://issues.apache.org/jira/browse/HADOOP-6801">
<doc>
<![CDATA[@deprecated Moved to mapreduce, see mapreduce.task.io.sort.mb
in mapred-default.xml
See https://issues.apache.org/jira/browse/HADOOP-6801]]>
</doc>
</field>
<field name="IO_SORT_MB_DEFAULT" type="int"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Default value for IO_SORT_MB_DEFAULT]]>
</doc>
</field>
<field name="IO_SORT_FACTOR_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="Moved to mapreduce, see mapreduce.task.io.sort.factor
in mapred-default.xml
See https://issues.apache.org/jira/browse/HADOOP-6801">
<doc>
<![CDATA[@deprecated Moved to mapreduce, see mapreduce.task.io.sort.factor
in mapred-default.xml
See https://issues.apache.org/jira/browse/HADOOP-6801]]>
</doc>
</field>
<field name="IO_SORT_FACTOR_DEFAULT" type="int"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Default value for IO_SORT_FACTOR_DEFAULT]]>
</doc>
</field>
<field name="IO_SERIALIZATIONS_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="TFILE_IO_CHUNK_SIZE_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="TFILE_IO_CHUNK_SIZE_DEFAULT" type="int"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Default value for TFILE_IO_CHUNK_SIZE_DEFAULT]]>
</doc>
</field>
<field name="TFILE_FS_INPUT_BUFFER_SIZE_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="TFILE_FS_INPUT_BUFFER_SIZE_DEFAULT" type="int"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Default value for TFILE_FS_INPUT_BUFFER_SIZE_KEY]]>
</doc>
</field>
<field name="TFILE_FS_OUTPUT_BUFFER_SIZE_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="TFILE_FS_OUTPUT_BUFFER_SIZE_DEFAULT" type="int"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Default value for TFILE_FS_OUTPUT_BUFFER_SIZE_KEY]]>
</doc>
</field>
<field name="IPC_CLIENT_CONNECTION_MAXIDLETIME_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="IPC_CLIENT_CONNECTION_MAXIDLETIME_DEFAULT" type="int"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Default value for IPC_CLIENT_CONNECTION_MAXIDLETIME_KEY]]>
</doc>
</field>
<field name="IPC_CLIENT_CONNECT_TIMEOUT_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="IPC_CLIENT_CONNECT_TIMEOUT_DEFAULT" type="int"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Default value for IPC_CLIENT_CONNECT_TIMEOUT_KEY]]>
</doc>
</field>
<field name="IPC_CLIENT_CONNECT_MAX_RETRIES_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="IPC_CLIENT_CONNECT_MAX_RETRIES_DEFAULT" type="int"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Default value for IPC_CLIENT_CONNECT_MAX_RETRIES_KEY]]>
</doc>
</field>
<field name="IPC_CLIENT_CONNECT_RETRY_INTERVAL_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="IPC_CLIENT_CONNECT_RETRY_INTERVAL_DEFAULT" type="int"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Default value for IPC_CLIENT_CONNECT_RETRY_INTERVAL_KEY]]>
</doc>
</field>
<field name="IPC_CLIENT_CONNECT_MAX_RETRIES_ON_SOCKET_TIMEOUTS_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="IPC_CLIENT_CONNECT_MAX_RETRIES_ON_SOCKET_TIMEOUTS_DEFAULT" type="int"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Default value for IPC_CLIENT_CONNECT_MAX_RETRIES_ON_SOCKET_TIMEOUTS_KEY]]>
</doc>
</field>
<field name="IPC_CLIENT_TCPNODELAY_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="IPC_CLIENT_TCPNODELAY_DEFAULT" type="boolean"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Defalt value for IPC_CLIENT_TCPNODELAY_KEY]]>
</doc>
</field>
<field name="IPC_SERVER_LISTEN_QUEUE_SIZE_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="IPC_SERVER_LISTEN_QUEUE_SIZE_DEFAULT" type="int"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Default value for IPC_SERVER_LISTEN_QUEUE_SIZE_KEY]]>
</doc>
</field>
<field name="IPC_CLIENT_KILL_MAX_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="IPC_CLIENT_KILL_MAX_DEFAULT" type="int"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Default value for IPC_CLIENT_KILL_MAX_KEY]]>
</doc>
</field>
<field name="IPC_CLIENT_IDLETHRESHOLD_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="IPC_CLIENT_IDLETHRESHOLD_DEFAULT" type="int"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Default value for IPC_CLIENT_IDLETHRESHOLD_DEFAULT]]>
</doc>
</field>
<field name="IPC_SERVER_TCPNODELAY_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="IPC_SERVER_TCPNODELAY_DEFAULT" type="boolean"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Default value for IPC_SERVER_TCPNODELAY_KEY]]>
</doc>
</field>
<field name="HADOOP_RPC_SOCKET_FACTORY_CLASS_DEFAULT_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="HADOOP_RPC_SOCKET_FACTORY_CLASS_DEFAULT_DEFAULT" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
</field>
<field name="HADOOP_SOCKS_SERVER_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="HADOOP_UTIL_HASH_TYPE_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="HADOOP_UTIL_HASH_TYPE_DEFAULT" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Default value for HADOOP_UTIL_HASH_TYPE_KEY]]>
</doc>
</field>
<field name="HADOOP_SECURITY_GROUP_MAPPING" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="HADOOP_SECURITY_GROUPS_CACHE_SECS" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="HADOOP_SECURITY_GROUPS_CACHE_SECS_DEFAULT" type="long"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="HADOOP_SECURITY_GROUPS_NEGATIVE_CACHE_SECS" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="HADOOP_SECURITY_GROUPS_NEGATIVE_CACHE_SECS_DEFAULT" type="long"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="HADOOP_SECURITY_GROUPS_CACHE_WARN_AFTER_MS" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="HADOOP_SECURITY_GROUPS_CACHE_WARN_AFTER_MS_DEFAULT" type="long"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
</field>
<field name="HADOOP_SECURITY_AUTHENTICATION" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="HADOOP_SECURITY_AUTHORIZATION" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="HADOOP_SECURITY_INSTRUMENTATION_REQUIRES_ADMIN" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="HADOOP_SECURITY_SERVICE_USER_NAME_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="HADOOP_SECURITY_AUTH_TO_LOCAL" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="HADOOP_SSL_ENABLED_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
</field>
<field name="HADOOP_SSL_ENABLED_DEFAULT" type="boolean"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
</field>
<field name="HTTP_POLICY_HTTP_ONLY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
</field>
<field name="HTTP_POLICY_HTTPS_ONLY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
</field>
<field name="HADOOP_RPC_PROTECTION" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="HADOOP_SECURITY_SASL_PROPS_RESOLVER_CLASS" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Class to override Sasl Properties for a connection]]>
</doc>
</field>
<field name="HADOOP_SECURITY_CRYPTO_CODEC_CLASSES_KEY_PREFIX" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
</field>
<field name="HADOOP_SECURITY_CRYPTO_CIPHER_SUITE_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="HADOOP_SECURITY_CRYPTO_CIPHER_SUITE_DEFAULT" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
</field>
<field name="HADOOP_SECURITY_CRYPTO_JCE_PROVIDER_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="HADOOP_SECURITY_CRYPTO_BUFFER_SIZE_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="HADOOP_SECURITY_CRYPTO_BUFFER_SIZE_DEFAULT" type="int"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Defalt value for HADOOP_SECURITY_CRYPTO_BUFFER_SIZE_KEY]]>
</doc>
</field>
<field name="HADOOP_SECURITY_IMPERSONATION_PROVIDER_CLASS" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Class to override Impersonation provider]]>
</doc>
</field>
<field name="KMS_CLIENT_ENC_KEY_CACHE_SIZE" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="KMS_CLIENT_ENC_KEY_CACHE_SIZE_DEFAULT" type="int"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Default value for KMS_CLIENT_ENC_KEY_CACHE_SIZE]]>
</doc>
</field>
<field name="KMS_CLIENT_ENC_KEY_CACHE_LOW_WATERMARK" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="KMS_CLIENT_ENC_KEY_CACHE_LOW_WATERMARK_DEFAULT" type="float"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Default value for KMS_CLIENT_ENC_KEY_CACHE_LOW_WATERMARK]]>
</doc>
</field>
<field name="KMS_CLIENT_ENC_KEY_CACHE_NUM_REFILL_THREADS" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="KMS_CLIENT_ENC_KEY_CACHE_NUM_REFILL_THREADS_DEFAULT" type="int"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Default value for KMS_CLIENT_ENC_KEY_NUM_REFILL_THREADS]]>
</doc>
</field>
<field name="KMS_CLIENT_ENC_KEY_CACHE_EXPIRY_MS" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="KMS_CLIENT_ENC_KEY_CACHE_EXPIRY_DEFAULT" type="int"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Default value for KMS_CLIENT_ENC_KEY_CACHE_EXPIRY (12 hrs)]]>
</doc>
</field>
<field name="HADOOP_SECURITY_JAVA_SECURE_RANDOM_ALGORITHM_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="HADOOP_SECURITY_JAVA_SECURE_RANDOM_ALGORITHM_DEFAULT" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Defalt value for HADOOP_SECURITY_JAVA_SECURE_RANDOM_ALGORITHM_KEY]]>
</doc>
</field>
<field name="HADOOP_SECURITY_SECURE_RANDOM_IMPL_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="HADOOP_SECURITY_SECURE_RANDOM_DEVICE_FILE_PATH_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]>
</doc>
</field>
<field name="HADOOP_SECURITY_SECURE_RANDOM_DEVICE_FILE_PATH_DEFAULT" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
</field>
<doc>
<![CDATA[This class contains constants for configuration keys used
in the common code.
It includes all publicly documented configuration keys. In general
this class should not be used directly (use CommonConfigurationKeys
instead)]]>
</doc>
</class>
<!-- end class org.apache.hadoop.fs.CommonConfigurationKeysPublic -->
<!-- start class org.apache.hadoop.fs.ContentSummary -->
<class name="ContentSummary" extends="java.lang.Object"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="org.apache.hadoop.io.Writable"/>
<constructor name="ContentSummary"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Constructor]]>
</doc>
</constructor>
<constructor name="ContentSummary" type="long, long, long"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Constructor]]>
</doc>
</constructor>
<constructor name="ContentSummary" type="long, long, long, long, long, long"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Constructor]]>
</doc>
</constructor>
<method name="getLength" return="long"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[@return the length]]>
</doc>
</method>
<method name="getDirectoryCount" return="long"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[@return the directory count]]>
</doc>
</method>
<method name="getFileCount" return="long"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[@return the file count]]>
</doc>
</method>
<method name="getQuota" return="long"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Return the directory quota]]>
</doc>
</method>
<method name="getSpaceConsumed" return="long"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Retuns (disk) space consumed]]>
</doc>
</method>
<method name="getSpaceQuota" return="long"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns (disk) space quota]]>
</doc>
</method>
<method name="write"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="out" type="java.io.DataOutput"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="readFields"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="in" type="java.io.DataInput"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="getHeader" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="qOption" type="boolean"/>
<doc>
<![CDATA[Return the header of the output.
if qOption is false, output directory count, file count, and content size;
if qOption is true, output quota and remaining quota as well.
@param qOption a flag indicating if quota needs to be printed or not
@return the header of the output]]>
</doc>
</method>
<method name="toString" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="toString" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="qOption" type="boolean"/>
<doc>
<![CDATA[Return the string representation of the object in the output format.
if qOption is false, output directory count, file count, and content size;
if qOption is true, output quota and remaining quota as well.
@param qOption a flag indicating if quota needs to be printed or not
@return the string representation of the object]]>
</doc>
</method>
<method name="toString" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="qOption" type="boolean"/>
<param name="hOption" type="boolean"/>
<doc>
<![CDATA[Return the string representation of the object in the output format.
if qOption is false, output directory count, file count, and content size;
if qOption is true, output quota and remaining quota as well.
if hOption is false file sizes are returned in bytes
if hOption is true file sizes are returned in human readable
@param qOption a flag indicating if quota needs to be printed or not
@param hOption a flag indicating if human readable output if to be used
@return the string representation of the object]]>
</doc>
</method>
<doc>
<![CDATA[Store the summary of a content (a directory or a file).]]>
</doc>
</class>
<!-- end class org.apache.hadoop.fs.ContentSummary -->
<!-- start class org.apache.hadoop.fs.CreateFlag -->
<class name="CreateFlag" extends="java.lang.Enum"
abstract="false"
static="false" final="true" visibility="public"
deprecated="not deprecated">
<method name="values" return="org.apache.hadoop.fs.CreateFlag[]"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="valueOf" return="org.apache.hadoop.fs.CreateFlag"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
</method>
<method name="validate"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="flag" type="java.util.EnumSet"/>
<doc>
<![CDATA[Validate the CreateFlag and throw exception if it is invalid
@param flag set of CreateFlag
@throws HadoopIllegalArgumentException if the CreateFlag is invalid]]>
</doc>
</method>
<method name="validate"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="java.lang.Object"/>
<param name="pathExists" type="boolean"/>
<param name="flag" type="java.util.EnumSet"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Validate the CreateFlag for create operation
@param path Object representing the path; usually String or {@link Path}
@param pathExists pass true if the path exists in the file system
@param flag set of CreateFlag
@throws IOException on error
@throws HadoopIllegalArgumentException if the CreateFlag is invalid]]>
</doc>
</method>
<doc>
<![CDATA[CreateFlag specifies the file create semantic. Users can combine flags like: <br>
<code>
EnumSet.of(CreateFlag.CREATE, CreateFlag.APPEND)
<code>
<p>
Use the CreateFlag as follows:
<ol>
<li> CREATE - to create a file if it does not exist,
else throw FileAlreadyExists.</li>
<li> APPEND - to append to a file if it exists,
else throw FileNotFoundException.</li>
<li> OVERWRITE - to truncate a file if it exists,
else throw FileNotFoundException.</li>
<li> CREATE|APPEND - to create a file if it does not exist,
else append to an existing file.</li>
<li> CREATE|OVERWRITE - to create a file if it does not exist,
else overwrite an existing file.</li>
<li> SYNC_BLOCK - to force closed blocks to the disk device.
In addition {@link Syncable#hsync()} should be called after each write,
if true synchronous behavior is required.</li>
</ol>
Following combination is not valid and will result in
{@link HadoopIllegalArgumentException}:
<ol>
<li> APPEND|OVERWRITE</li>
<li> CREATE|APPEND|OVERWRITE</li>
</ol>]]>
</doc>
</class>
<!-- end class org.apache.hadoop.fs.CreateFlag -->
<!-- start interface org.apache.hadoop.fs.DelegationTokenRenewer.Renewable -->
<interface name="DelegationTokenRenewer.Renewable" abstract="true"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<method name="getRenewToken" return="org.apache.hadoop.security.token.Token"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[@return the renew token.]]>
</doc>
</method>
<method name="setDelegationToken"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="token" type="org.apache.hadoop.security.token.Token"/>
<doc>
<![CDATA[Set delegation token.]]>
</doc>
</method>
<doc>
<![CDATA[The renewable interface used by the renewer.]]>
</doc>
</interface>
<!-- end interface org.apache.hadoop.fs.DelegationTokenRenewer.Renewable -->
<!-- start class org.apache.hadoop.fs.DelegationTokenRenewer.RenewAction -->
<class name="DelegationTokenRenewer.RenewAction" extends="java.lang.Object"
abstract="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<implements name="java.util.concurrent.Delayed"/>
<method name="isValid" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getDelay" return="long"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="unit" type="java.util.concurrent.TimeUnit"/>
<doc>
<![CDATA[Get the delay until this event should happen.]]>
</doc>
</method>
<method name="compareTo" return="int"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="delayed" type="java.util.concurrent.Delayed"/>
</method>
<method name="hashCode" return="int"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="equals" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="that" type="java.lang.Object"/>
</method>
<method name="toString" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<doc>
<![CDATA[An action that will renew and replace the file system's delegation
tokens automatically.]]>
</doc>
</class>
<!-- end class org.apache.hadoop.fs.DelegationTokenRenewer.RenewAction -->
<!-- start class org.apache.hadoop.fs.DUHelper -->
<class name="DUHelper" extends="java.lang.Object"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<method name="getFolderUsage" return="long"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="folder" type="java.lang.String"/>
</method>
<method name="check" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="folder" type="java.lang.String"/>
</method>
<method name="getFileCount" return="long"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getUsage" return="double"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="main"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="args" type="java.lang.String[]"/>
</method>
</class>
<!-- end class org.apache.hadoop.fs.DUHelper -->
<!-- start class org.apache.hadoop.fs.FileAlreadyExistsException -->
<class name="FileAlreadyExistsException" extends="java.io.IOException"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="FileAlreadyExistsException"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<constructor name="FileAlreadyExistsException" type="java.lang.String"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<doc>
<![CDATA[Used when target file already exists for any operation and
is not configured to be overwritten.]]>
</doc>
</class>
<!-- end class org.apache.hadoop.fs.FileAlreadyExistsException -->
<!-- start class org.apache.hadoop.fs.FileChecksum -->
<class name="FileChecksum" extends="java.lang.Object"
abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="org.apache.hadoop.io.Writable"/>
<constructor name="FileChecksum"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="getAlgorithmName" return="java.lang.String"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[The checksum algorithm name]]>
</doc>
</method>
<method name="getLength" return="int"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[The length of the checksum in bytes]]>
</doc>
</method>
<method name="getBytes" return="byte[]"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[The value of the checksum in bytes]]>
</doc>
</method>
<method name="getChecksumOpt" return="org.apache.hadoop.fs.Options.ChecksumOpt"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="equals" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="other" type="java.lang.Object"/>
<doc>
<![CDATA[Return true if both the algorithms and the values are the same.]]>
</doc>
</method>
<method name="hashCode" return="int"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<doc>
<![CDATA[An abstract class representing file checksums for files.]]>
</doc>
</class>
<!-- end class org.apache.hadoop.fs.FileChecksum -->
<!-- start class org.apache.hadoop.fs.FileContext -->
<class name="FileContext" extends="java.lang.Object"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<method name="getFSofPath" return="org.apache.hadoop.fs.AbstractFileSystem"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="absOrFqPath" type="org.apache.hadoop.fs.Path"/>
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Get the file system of supplied path.
@param absOrFqPath - absolute or fully qualified path
@return the file system of the path
@throws UnsupportedFileSystemException If the file system for
<code>absOrFqPath</code> is not supported.
@throws IOExcepton If the file system for <code>absOrFqPath</code> could
not be instantiated.]]>
</doc>
</method>
<method name="getFileContext" return="org.apache.hadoop.fs.FileContext"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="defFS" type="org.apache.hadoop.fs.AbstractFileSystem"/>
<param name="aConf" type="org.apache.hadoop.conf.Configuration"/>
<doc>
<![CDATA[Create a FileContext with specified FS as default using the specified
config.
@param defFS
@param aConf
@return new FileContext with specifed FS as default.]]>
</doc>
</method>
<method name="getFileContext" return="org.apache.hadoop.fs.FileContext"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="protected"
deprecated="not deprecated">
<param name="defaultFS" type="org.apache.hadoop.fs.AbstractFileSystem"/>
<doc>
<![CDATA[Create a FileContext for specified file system using the default config.
@param defaultFS
@return a FileContext with the specified AbstractFileSystem
as the default FS.]]>
</doc>
</method>
<method name="getFileContext" return="org.apache.hadoop.fs.FileContext"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
<doc>
<![CDATA[Create a FileContext using the default config read from the
$HADOOP_CONFIG/core.xml, Unspecified key-values for config are defaulted
from core-defaults.xml in the release jar.
@throws UnsupportedFileSystemException If the file system from the default
configuration is not supported]]>
</doc>
</method>
<method name="getLocalFSFileContext" return="org.apache.hadoop.fs.FileContext"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
<doc>
<![CDATA[@return a FileContext for the local file system using the default config.
@throws UnsupportedFileSystemException If the file system for
{@link FsConstants#LOCAL_FS_URI} is not supported.]]>
</doc>
</method>
<method name="getFileContext" return="org.apache.hadoop.fs.FileContext"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="defaultFsUri" type="java.net.URI"/>
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
<doc>
<![CDATA[Create a FileContext for specified URI using the default config.
@param defaultFsUri
@return a FileContext with the specified URI as the default FS.
@throws UnsupportedFileSystemException If the file system for
<code>defaultFsUri</code> is not supported]]>
</doc>
</method>
<method name="getFileContext" return="org.apache.hadoop.fs.FileContext"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="defaultFsUri" type="java.net.URI"/>
<param name="aConf" type="org.apache.hadoop.conf.Configuration"/>
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
<doc>
<![CDATA[Create a FileContext for specified default URI using the specified config.
@param defaultFsUri
@param aConf
@return new FileContext for specified uri
@throws UnsupportedFileSystemException If the file system with specified is
not supported
@throws RuntimeException If the file system specified is supported but
could not be instantiated, or if login fails.]]>
</doc>
</method>
<method name="getFileContext" return="org.apache.hadoop.fs.FileContext"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="aConf" type="org.apache.hadoop.conf.Configuration"/>
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
<doc>
<![CDATA[Create a FileContext using the passed config. Generally it is better to use
{@link #getFileContext(URI, Configuration)} instead of this one.
@param aConf
@return new FileContext
@throws UnsupportedFileSystemException If file system in the config
is not supported]]>
</doc>
</method>
<method name="getLocalFSFileContext" return="org.apache.hadoop.fs.FileContext"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="aConf" type="org.apache.hadoop.conf.Configuration"/>
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
<doc>
<![CDATA[@param aConf - from which the FileContext is configured
@return a FileContext for the local file system using the specified config.
@throws UnsupportedFileSystemException If default file system in the config
is not supported]]>
</doc>
</method>
<method name="getDefaultFileSystem" return="org.apache.hadoop.fs.AbstractFileSystem"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="setWorkingDirectory"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="newWDir" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Set the working directory for wd-relative names (such a "foo/bar"). Working
directory feature is provided by simply prefixing relative names with the
working dir. Note this is different from Unix where the wd is actually set
to the inode. Hence setWorkingDir does not follow symlinks etc. This works
better in a distributed environment that has multiple independent roots.
{@link #getWorkingDirectory()} should return what setWorkingDir() set.
@param newWDir new working directory
@throws IOException
<br>
NewWdir can be one of:
<ul>
<li>relative path: "foo/bar";</li>
<li>absolute without scheme: "/foo/bar"</li>
<li>fully qualified with scheme: "xx://auth/foo/bar"</li>
</ul>
<br>
Illegal WDs:
<ul>
<li>relative with scheme: "xx:foo/bar"</li>
<li>non existent directory</li>
</ul>]]>
</doc>
</method>
<method name="getWorkingDirectory" return="org.apache.hadoop.fs.Path"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Gets the working directory for wd-relative names (such a "foo/bar").]]>
</doc>
</method>
<method name="getUgi" return="org.apache.hadoop.security.UserGroupInformation"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Gets the ugi in the file-context
@return UserGroupInformation]]>
</doc>
</method>
<method name="getHomeDirectory" return="org.apache.hadoop.fs.Path"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Return the current user's home directory in this file system.
The default implementation returns "/user/$USER/".
@return the home directory]]>
</doc>
</method>
<method name="getUMask" return="org.apache.hadoop.fs.permission.FsPermission"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[@return the umask of this FileContext]]>
</doc>
</method>
<method name="setUMask"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="newUmask" type="org.apache.hadoop.fs.permission.FsPermission"/>
<doc>
<![CDATA[Set umask to the supplied parameter.
@param newUmask the new umask]]>
</doc>
</method>
<method name="resolvePath" return="org.apache.hadoop.fs.Path"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Resolve the path following any symlinks or mount points
@param f to be resolved
@return fully qualified resolved path
@throws FileNotFoundException If <code>f</code> does not exist
@throws AccessControlException if access denied
@throws IOException If an IO Error occurred
Exceptions applicable to file systems accessed over RPC:
@throws RpcClientException If an exception occurred in the RPC client
@throws RpcServerException If an exception occurred in the RPC server
@throws UnexpectedServerException If server implementation throws
undeclared exception to RPC server
RuntimeExceptions:
@throws InvalidPathException If path <code>f</code> is not valid]]>
</doc>
</method>
<method name="makeQualified" return="org.apache.hadoop.fs.Path"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<doc>
<![CDATA[Make the path fully qualified if it is isn't.
A Fully-qualified path has scheme and authority specified and an absolute
path.
Use the default file system and working dir in this FileContext to qualify.
@param path
@return qualified path]]>
</doc>
</method>
<method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="createFlag" type="java.util.EnumSet"/>
<param name="opts" type="org.apache.hadoop.fs.Options.CreateOpts[]"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileAlreadyExistsException" type="org.apache.hadoop.fs.FileAlreadyExistsException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="ParentNotDirectoryException" type="org.apache.hadoop.fs.ParentNotDirectoryException"/>
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Create or overwrite file on indicated path and returns an output stream for
writing into the file.
@param f the file name to open
@param createFlag gives the semantics of create; see {@link CreateFlag}
@param opts file creation options; see {@link Options.CreateOpts}.
<ul>
<li>Progress - to report progress on the operation - default null
<li>Permission - umask is applied against permisssion: default is
FsPermissions:getDefault()
<li>CreateParent - create missing parent path; default is to not
to create parents
<li>The defaults for the following are SS defaults of the file
server implementing the target path. Not all parameters make sense
for all kinds of file system - eg. localFS ignores Blocksize,
replication, checksum
<ul>
<li>BufferSize - buffersize used in FSDataOutputStream
<li>Blocksize - block size for file blocks
<li>ReplicationFactor - replication for blocks
<li>ChecksumParam - Checksum parameters. server default is used
if not specified.
</ul>
</ul>
@return {@link FSDataOutputStream} for created file
@throws AccessControlException If access is denied
@throws FileAlreadyExistsException If file <code>f</code> already exists
@throws FileNotFoundException If parent of <code>f</code> does not exist
and <code>createParent</code> is false
@throws ParentNotDirectoryException If parent of <code>f</code> is not a
directory.
@throws UnsupportedFileSystemException If file system for <code>f</code> is
not supported
@throws IOException If an I/O error occurred
Exceptions applicable to file systems accessed over RPC:
@throws RpcClientException If an exception occurred in the RPC client
@throws RpcServerException If an exception occurred in the RPC server
@throws UnexpectedServerException If server implementation throws
undeclared exception to RPC server
RuntimeExceptions:
@throws InvalidPathException If path <code>f</code> is not valid]]>
</doc>
</method>
<method name="mkdir"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="dir" type="org.apache.hadoop.fs.Path"/>
<param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
<param name="createParent" type="boolean"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileAlreadyExistsException" type="org.apache.hadoop.fs.FileAlreadyExistsException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="ParentNotDirectoryException" type="org.apache.hadoop.fs.ParentNotDirectoryException"/>
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Make(create) a directory and all the non-existent parents.
@param dir - the dir to make
@param permission - permissions is set permission&~umask
@param createParent - if true then missing parent dirs are created if false
then parent must exist
@throws AccessControlException If access is denied
@throws FileAlreadyExistsException If directory <code>dir</code> already
exists
@throws FileNotFoundException If parent of <code>dir</code> does not exist
and <code>createParent</code> is false
@throws ParentNotDirectoryException If parent of <code>dir</code> is not a
directory
@throws UnsupportedFileSystemException If file system for <code>dir</code>
is not supported
@throws IOException If an I/O error occurred
Exceptions applicable to file systems accessed over RPC:
@throws RpcClientException If an exception occurred in the RPC client
@throws UnexpectedServerException If server implementation throws
undeclared exception to RPC server
RuntimeExceptions:
@throws InvalidPathException If path <code>dir</code> is not valid]]>
</doc>
</method>
<method name="delete" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="recursive" type="boolean"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Delete a file.
@param f the path to delete.
@param recursive if path is a directory and set to
true, the directory is deleted else throws an exception. In
case of a file the recursive can be set to either true or false.
@throws AccessControlException If access is denied
@throws FileNotFoundException If <code>f</code> does not exist
@throws UnsupportedFileSystemException If file system for <code>f</code> is
not supported
@throws IOException If an I/O error occurred
Exceptions applicable to file systems accessed over RPC:
@throws RpcClientException If an exception occurred in the RPC client
@throws RpcServerException If an exception occurred in the RPC server
@throws UnexpectedServerException If server implementation throws
undeclared exception to RPC server
RuntimeExceptions:
@throws InvalidPathException If path <code>f</code> is invalid]]>
</doc>
</method>
<method name="open" return="org.apache.hadoop.fs.FSDataInputStream"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Opens an FSDataInputStream at the indicated Path using
default buffersize.
@param f the file name to open
@throws AccessControlException If access is denied
@throws FileNotFoundException If file <code>f</code> does not exist
@throws UnsupportedFileSystemException If file system for <code>f</code>
is not supported
@throws IOException If an I/O error occurred
Exceptions applicable to file systems accessed over RPC:
@throws RpcClientException If an exception occurred in the RPC client
@throws RpcServerException If an exception occurred in the RPC server
@throws UnexpectedServerException If server implementation throws
undeclared exception to RPC server]]>
</doc>
</method>
<method name="open" return="org.apache.hadoop.fs.FSDataInputStream"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="bufferSize" type="int"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Opens an FSDataInputStream at the indicated Path.
@param f the file name to open
@param bufferSize the size of the buffer to be used.
@throws AccessControlException If access is denied
@throws FileNotFoundException If file <code>f</code> does not exist
@throws UnsupportedFileSystemException If file system for <code>f</code> is
not supported
@throws IOException If an I/O error occurred
Exceptions applicable to file systems accessed over RPC:
@throws RpcClientException If an exception occurred in the RPC client
@throws RpcServerException If an exception occurred in the RPC server
@throws UnexpectedServerException If server implementation throws
undeclared exception to RPC server]]>
</doc>
</method>
<method name="setReplication" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="replication" type="short"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Set replication for an existing file.
@param f file name
@param replication new replication
@return true if successful
@throws AccessControlException If access is denied
@throws FileNotFoundException If file <code>f</code> does not exist
@throws IOException If an I/O error occurred
Exceptions applicable to file systems accessed over RPC:
@throws RpcClientException If an exception occurred in the RPC client
@throws RpcServerException If an exception occurred in the RPC server
@throws UnexpectedServerException If server implementation throws
undeclared exception to RPC server]]>
</doc>
</method>
<method name="rename"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="src" type="org.apache.hadoop.fs.Path"/>
<param name="dst" type="org.apache.hadoop.fs.Path"/>
<param name="options" type="org.apache.hadoop.fs.Options.Rename[]"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileAlreadyExistsException" type="org.apache.hadoop.fs.FileAlreadyExistsException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="ParentNotDirectoryException" type="org.apache.hadoop.fs.ParentNotDirectoryException"/>
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Renames Path src to Path dst
<ul>
<li
<li>Fails if src is a file and dst is a directory.
<li>Fails if src is a directory and dst is a file.
<li>Fails if the parent of dst does not exist or is a file.
</ul>
<p>
If OVERWRITE option is not passed as an argument, rename fails if the dst
already exists.
<p>
If OVERWRITE option is passed as an argument, rename overwrites the dst if
it is a file or an empty directory. Rename fails if dst is a non-empty
directory.
<p>
Note that atomicity of rename is dependent on the file system
implementation. Please refer to the file system documentation for details
<p>
@param src path to be renamed
@param dst new path after rename
@throws AccessControlException If access is denied
@throws FileAlreadyExistsException If <code>dst</code> already exists and
<code>options</options> has {@link Options.Rename#OVERWRITE}
option false.
@throws FileNotFoundException If <code>src</code> does not exist
@throws ParentNotDirectoryException If parent of <code>dst</code> is not a
directory
@throws UnsupportedFileSystemException If file system for <code>src</code>
and <code>dst</code> is not supported
@throws IOException If an I/O error occurred
Exceptions applicable to file systems accessed over RPC:
@throws RpcClientException If an exception occurred in the RPC client
@throws RpcServerException If an exception occurred in the RPC server
@throws UnexpectedServerException If server implementation throws
undeclared exception to RPC server]]>
</doc>
</method>
<method name="setPermission"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Set permission of a path.
@param f
@param permission - the new absolute permission (umask is not applied)
@throws AccessControlException If access is denied
@throws FileNotFoundException If <code>f</code> does not exist
@throws UnsupportedFileSystemException If file system for <code>f</code>
is not supported
@throws IOException If an I/O error occurred
Exceptions applicable to file systems accessed over RPC:
@throws RpcClientException If an exception occurred in the RPC client
@throws RpcServerException If an exception occurred in the RPC server
@throws UnexpectedServerException If server implementation throws
undeclared exception to RPC server]]>
</doc>
</method>
<method name="setOwner"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="username" type="java.lang.String"/>
<param name="groupname" type="java.lang.String"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Set owner of a path (i.e. a file or a directory). The parameters username
and groupname cannot both be null.
@param f The path
@param username If it is null, the original username remains unchanged.
@param groupname If it is null, the original groupname remains unchanged.
@throws AccessControlException If access is denied
@throws FileNotFoundException If <code>f</code> does not exist
@throws UnsupportedFileSystemException If file system for <code>f</code> is
not supported
@throws IOException If an I/O error occurred
Exceptions applicable to file systems accessed over RPC:
@throws RpcClientException If an exception occurred in the RPC client
@throws RpcServerException If an exception occurred in the RPC server
@throws UnexpectedServerException If server implementation throws
undeclared exception to RPC server
RuntimeExceptions:
@throws HadoopIllegalArgumentException If <code>username</code> or
<code>groupname</code> is invalid.]]>
</doc>
</method>
<method name="setTimes"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="mtime" type="long"/>
<param name="atime" type="long"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Set access time of a file.
@param f The path
@param mtime Set the modification time of this file.
The number of milliseconds since epoch (Jan 1, 1970).
A value of -1 means that this call should not set modification time.
@param atime Set the access time of this file.
The number of milliseconds since Jan 1, 1970.
A value of -1 means that this call should not set access time.
@throws AccessControlException If access is denied
@throws FileNotFoundException If <code>f</code> does not exist
@throws UnsupportedFileSystemException If file system for <code>f</code> is
not supported
@throws IOException If an I/O error occurred
Exceptions applicable to file systems accessed over RPC:
@throws RpcClientException If an exception occurred in the RPC client
@throws RpcServerException If an exception occurred in the RPC server
@throws UnexpectedServerException If server implementation throws
undeclared exception to RPC server]]>
</doc>
</method>
<method name="getFileChecksum" return="org.apache.hadoop.fs.FileChecksum"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Get the checksum of a file.
@param f file path
@return The file checksum. The default return value is null,
which indicates that no checksum algorithm is implemented
in the corresponding FileSystem.
@throws AccessControlException If access is denied
@throws FileNotFoundException If <code>f</code> does not exist
@throws IOException If an I/O error occurred
Exceptions applicable to file systems accessed over RPC:
@throws RpcClientException If an exception occurred in the RPC client
@throws RpcServerException If an exception occurred in the RPC server
@throws UnexpectedServerException If server implementation throws
undeclared exception to RPC server]]>
</doc>
</method>
<method name="setVerifyChecksum"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="verifyChecksum" type="boolean"/>
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Set the verify checksum flag for the file system denoted by the path.
This is only applicable if the
corresponding FileSystem supports checksum. By default doesn't do anything.
@param verifyChecksum
@param f set the verifyChecksum for the Filesystem containing this path
@throws AccessControlException If access is denied
@throws FileNotFoundException If <code>f</code> does not exist
@throws UnsupportedFileSystemException If file system for <code>f</code> is
not supported
@throws IOException If an I/O error occurred
Exceptions applicable to file systems accessed over RPC:
@throws RpcClientException If an exception occurred in the RPC client
@throws RpcServerException If an exception occurred in the RPC server
@throws UnexpectedServerException If server implementation throws
undeclared exception to RPC server]]>
</doc>
</method>
<method name="getFileStatus" return="org.apache.hadoop.fs.FileStatus"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Return a file status object that represents the path.
@param f The path we want information from
@return a FileStatus object
@throws AccessControlException If access is denied
@throws FileNotFoundException If <code>f</code> does not exist
@throws UnsupportedFileSystemException If file system for <code>f</code> is
not supported
@throws IOException If an I/O error occurred
Exceptions applicable to file systems accessed over RPC:
@throws RpcClientException If an exception occurred in the RPC client
@throws RpcServerException If an exception occurred in the RPC server
@throws UnexpectedServerException If server implementation throws
undeclared exception to RPC server]]>
</doc>
</method>
<method name="access"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<param name="mode" type="org.apache.hadoop.fs.permission.FsAction"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Checks if the user can access a path. The mode specifies which access
checks to perform. If the requested permissions are granted, then the
method returns normally. If access is denied, then the method throws an
{@link AccessControlException}.
<p/>
The default implementation of this method calls {@link #getFileStatus(Path)}
and checks the returned permissions against the requested permissions.
Note that the getFileStatus call will be subject to authorization checks.
Typically, this requires search (execute) permissions on each directory in
the path's prefix, but this is implementation-defined. Any file system
that provides a richer authorization model (such as ACLs) may override the
default implementation so that it checks against that model instead.
<p>
In general, applications should avoid using this method, due to the risk of
time-of-check/time-of-use race conditions. The permissions on a file may
change immediately after the access call returns. Most applications should
prefer running specific file system actions as the desired user represented
by a {@link UserGroupInformation}.
@param path Path to check
@param mode type of access to check
@throws AccessControlException if access is denied
@throws FileNotFoundException if the path does not exist
@throws UnsupportedFileSystemException if file system for <code>path</code>
is not supported
@throws IOException see specific implementation
Exceptions applicable to file systems accessed over RPC:
@throws RpcClientException If an exception occurred in the RPC client
@throws RpcServerException If an exception occurred in the RPC server
@throws UnexpectedServerException If server implementation throws
undeclared exception to RPC server]]>
</doc>
</method>
<method name="getFileLinkStatus" return="org.apache.hadoop.fs.FileStatus"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Return a file status object that represents the path. If the path
refers to a symlink then the FileStatus of the symlink is returned.
The behavior is equivalent to #getFileStatus() if the underlying
file system does not support symbolic links.
@param f The path we want information from.
@return A FileStatus object
@throws AccessControlException If access is denied
@throws FileNotFoundException If <code>f</code> does not exist
@throws UnsupportedFileSystemException If file system for <code>f</code> is
not supported
@throws IOException If an I/O error occurred]]>
</doc>
</method>
<method name="getLinkTarget" return="org.apache.hadoop.fs.Path"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Returns the target of the given symbolic link as it was specified
when the link was created. Links in the path leading up to the
final path component are resolved transparently.
@param f the path to return the target of
@return The un-interpreted target of the symbolic link.
@throws AccessControlException If access is denied
@throws FileNotFoundException If path <code>f</code> does not exist
@throws UnsupportedFileSystemException If file system for <code>f</code> is
not supported
@throws IOException If the given path does not refer to a symlink
or an I/O error occurred]]>
</doc>
</method>
<method name="getFileBlockLocations" return="org.apache.hadoop.fs.BlockLocation[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="start" type="long"/>
<param name="len" type="long"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Return blockLocation of the given file for the given offset and len.
For a nonexistent file or regions, null will be returned.
This call is most helpful with DFS, where it returns
hostnames of machines that contain the given file.
@param f - get blocklocations of this file
@param start position (byte offset)
@param len (in bytes)
@return block locations for given file at specified offset of len
@throws AccessControlException If access is denied
@throws FileNotFoundException If <code>f</code> does not exist
@throws UnsupportedFileSystemException If file system for <code>f</code> is
not supported
@throws IOException If an I/O error occurred
Exceptions applicable to file systems accessed over RPC:
@throws RpcClientException If an exception occurred in the RPC client
@throws RpcServerException If an exception occurred in the RPC server
@throws UnexpectedServerException If server implementation throws
undeclared exception to RPC server
RuntimeExceptions:
@throws InvalidPathException If path <code>f</code> is invalid]]>
</doc>
</method>
<method name="getFsStatus" return="org.apache.hadoop.fs.FsStatus"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Returns a status object describing the use and capacity of the
file system denoted by the Parh argument p.
If the file system has multiple partitions, the
use and capacity of the partition pointed to by the specified
path is reflected.
@param f Path for which status should be obtained. null means the
root partition of the default file system.
@return a FsStatus object
@throws AccessControlException If access is denied
@throws FileNotFoundException If <code>f</code> does not exist
@throws UnsupportedFileSystemException If file system for <code>f</code> is
not supported
@throws IOException If an I/O error occurred
Exceptions applicable to file systems accessed over RPC:
@throws RpcClientException If an exception occurred in the RPC client
@throws RpcServerException If an exception occurred in the RPC server
@throws UnexpectedServerException If server implementation throws
undeclared exception to RPC server]]>
</doc>
</method>
<method name="createSymlink"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="target" type="org.apache.hadoop.fs.Path"/>
<param name="link" type="org.apache.hadoop.fs.Path"/>
<param name="createParent" type="boolean"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileAlreadyExistsException" type="org.apache.hadoop.fs.FileAlreadyExistsException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="ParentNotDirectoryException" type="org.apache.hadoop.fs.ParentNotDirectoryException"/>
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Creates a symbolic link to an existing file. An exception is thrown if
the symlink exits, the user does not have permission to create symlink,
or the underlying file system does not support symlinks.
Symlink permissions are ignored, access to a symlink is determined by
the permissions of the symlink target.
Symlinks in paths leading up to the final path component are resolved
transparently. If the final path component refers to a symlink some
functions operate on the symlink itself, these are:
- delete(f) and deleteOnExit(f) - Deletes the symlink.
- rename(src, dst) - If src refers to a symlink, the symlink is
renamed. If dst refers to a symlink, the symlink is over-written.
- getLinkTarget(f) - Returns the target of the symlink.
- getFileLinkStatus(f) - Returns a FileStatus object describing
the symlink.
Some functions, create() and mkdir(), expect the final path component
does not exist. If they are given a path that refers to a symlink that
does exist they behave as if the path referred to an existing file or
directory. All other functions fully resolve, ie follow, the symlink.
These are: open, setReplication, setOwner, setTimes, setWorkingDirectory,
setPermission, getFileChecksum, setVerifyChecksum, getFileBlockLocations,
getFsStatus, getFileStatus, exists, and listStatus.
Symlink targets are stored as given to createSymlink, assuming the
underlying file system is capable of storing a fully qualified URI.
Dangling symlinks are permitted. FileContext supports four types of
symlink targets, and resolves them as follows
<pre>
Given a path referring to a symlink of form:
<---X--->
fs://host/A/B/link
<-----Y----->
In this path X is the scheme and authority that identify the file system,
and Y is the path leading up to the final path component "link". If Y is
a symlink itself then let Y' be the target of Y and X' be the scheme and
authority of Y'. Symlink targets may:
1. Fully qualified URIs
fs://hostX/A/B/file Resolved according to the target file system.
2. Partially qualified URIs (eg scheme but no host)
fs:///A/B/file Resolved according to the target file system. Eg resolving
a symlink to hdfs:///A results in an exception because
HDFS URIs must be fully qualified, while a symlink to
file:///A will not since Hadoop's local file systems
require partially qualified URIs.
3. Relative paths
path Resolves to [Y'][path]. Eg if Y resolves to hdfs://host/A and path
is "../B/file" then [Y'][path] is hdfs://host/B/file
4. Absolute paths
path Resolves to [X'][path]. Eg if Y resolves hdfs://host/A/B and path
is "/file" then [X][path] is hdfs://host/file
</pre>
@param target the target of the symbolic link
@param link the path to be created that points to target
@param createParent if true then missing parent dirs are created if
false then parent must exist
@throws AccessControlException If access is denied
@throws FileAlreadyExistsException If file <code>linkcode> already exists
@throws FileNotFoundException If <code>target</code> does not exist
@throws ParentNotDirectoryException If parent of <code>link</code> is not a
directory.
@throws UnsupportedFileSystemException If file system for
<code>target</code> or <code>link</code> is not supported
@throws IOException If an I/O error occurred]]>
</doc>
</method>
<method name="listStatus" return="org.apache.hadoop.fs.RemoteIterator"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[List the statuses of the files/directories in the given path if the path is
a directory.
@param f is the path
@return an iterator that traverses statuses of the files/directories
in the given path
@throws AccessControlException If access is denied
@throws FileNotFoundException If <code>f</code> does not exist
@throws UnsupportedFileSystemException If file system for <code>f</code> is
not supported
@throws IOException If an I/O error occurred
Exceptions applicable to file systems accessed over RPC:
@throws RpcClientException If an exception occurred in the RPC client
@throws RpcServerException If an exception occurred in the RPC server
@throws UnexpectedServerException If server implementation throws
undeclared exception to RPC server]]>
</doc>
</method>
<method name="listCorruptFileBlocks" return="org.apache.hadoop.fs.RemoteIterator"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[@return an iterator over the corrupt files under the given path
(may contain duplicates if a file has more than one corrupt block)
@throws IOException]]>
</doc>
</method>
<method name="listLocatedStatus" return="org.apache.hadoop.fs.RemoteIterator"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[List the statuses of the files/directories in the given path if the path is
a directory.
Return the file's status and block locations If the path is a file.
If a returned status is a file, it contains the file's block locations.
@param f is the path
@return an iterator that traverses statuses of the files/directories
in the given path
If any IO exception (for example the input directory gets deleted while
listing is being executed), next() or hasNext() of the returned iterator
may throw a RuntimeException with the io exception as the cause.
@throws AccessControlException If access is denied
@throws FileNotFoundException If <code>f</code> does not exist
@throws UnsupportedFileSystemException If file system for <code>f</code> is
not supported
@throws IOException If an I/O error occurred
Exceptions applicable to file systems accessed over RPC:
@throws RpcClientException If an exception occurred in the RPC client
@throws RpcServerException If an exception occurred in the RPC server
@throws UnexpectedServerException If server implementation throws
undeclared exception to RPC server]]>
</doc>
</method>
<method name="deleteOnExit" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Mark a path to be deleted on JVM shutdown.
@param f the existing path to delete.
@return true if deleteOnExit is successful, otherwise false.
@throws AccessControlException If access is denied
@throws UnsupportedFileSystemException If file system for <code>f</code> is
not supported
@throws IOException If an I/O error occurred
Exceptions applicable to file systems accessed over RPC:
@throws RpcClientException If an exception occurred in the RPC client
@throws RpcServerException If an exception occurred in the RPC server
@throws UnexpectedServerException If server implementation throws
undeclared exception to RPC server]]>
</doc>
</method>
<method name="util" return="org.apache.hadoop.fs.FileContext.Util"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="resolve" return="org.apache.hadoop.fs.Path"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Resolves all symbolic links in the specified path.
Returns the new path object.]]>
</doc>
</method>
<method name="resolveIntermediate" return="org.apache.hadoop.fs.Path"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Resolves all symbolic links in the specified path leading up
to, but not including the final path component.
@param f path to resolve
@return the new path object.]]>
</doc>
</method>
<method name="getStatistics" return="org.apache.hadoop.fs.FileSystem.Statistics"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="uri" type="java.net.URI"/>
<doc>
<![CDATA[Get the statistics for a particular file system
@param uri
the uri to lookup the statistics. Only scheme and authority part
of the uri are used as the key to store and lookup.
@return a statistics object]]>
</doc>
</method>
<method name="clearStatistics"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Clears all the statistics stored in AbstractFileSystem, for all the file
systems.]]>
</doc>
</method>
<method name="printStatistics"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Prints the statistics to standard output. File System is identified by the
scheme and authority.]]>
</doc>
</method>
<method name="getAllStatistics" return="java.util.Map"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[@return Map of uri and statistics for each filesystem instantiated. The uri
consists of scheme and authority for the filesystem.]]>
</doc>
</method>
<method name="getDelegationTokens" return="java.util.List"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="p" type="org.apache.hadoop.fs.Path"/>
<param name="renewer" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Get delegation tokens for the file systems accessed for a given
path.
@param p Path for which delegations tokens are requested.
@param renewer the account name that is allowed to renew the token.
@return List of delegation tokens.
@throws IOException]]>
</doc>
</method>
<method name="modifyAclEntries"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<param name="aclSpec" type="java.util.List"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Modifies ACL entries of files and directories. This method can add new ACL
entries or modify the permissions on existing ACL entries. All existing
ACL entries that are not specified in this call are retained without
changes. (Modifications are merged into the current ACL.)
@param path Path to modify
@param aclSpec List<AclEntry> describing modifications
@throws IOException if an ACL could not be modified]]>
</doc>
</method>
<method name="removeAclEntries"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<param name="aclSpec" type="java.util.List"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Removes ACL entries from files and directories. Other ACL entries are
retained.
@param path Path to modify
@param aclSpec List<AclEntry> describing entries to remove
@throws IOException if an ACL could not be modified]]>
</doc>
</method>
<method name="removeDefaultAcl"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Removes all default ACL entries from files and directories.
@param path Path to modify
@throws IOException if an ACL could not be modified]]>
</doc>
</method>
<method name="removeAcl"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Removes all but the base ACL entries of files and directories. The entries
for user, group, and others are retained for compatibility with permission
bits.
@param path Path to modify
@throws IOException if an ACL could not be removed]]>
</doc>
</method>
<method name="setAcl"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<param name="aclSpec" type="java.util.List"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Fully replaces ACL of files and directories, discarding all existing
entries.
@param path Path to modify
@param aclSpec List<AclEntry> describing modifications, must include entries
for user, group, and others for compatibility with permission bits.
@throws IOException if an ACL could not be modified]]>
</doc>
</method>
<method name="getAclStatus" return="org.apache.hadoop.fs.permission.AclStatus"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Gets the ACLs of files and directories.
@param path Path to get
@return RemoteIterator<AclStatus> which returns each AclStatus
@throws IOException if an ACL could not be read]]>
</doc>
</method>
<method name="setXAttr"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<param name="name" type="java.lang.String"/>
<param name="value" type="byte[]"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Set an xattr of a file or directory.
The name must be prefixed with the namespace followed by ".". For example,
"user.attr".
<p/>
Refer to the HDFS extended attributes user documentation for details.
@param path Path to modify
@param name xattr name.
@param value xattr value.
@throws IOException]]>
</doc>
</method>
<method name="setXAttr"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<param name="name" type="java.lang.String"/>
<param name="value" type="byte[]"/>
<param name="flag" type="java.util.EnumSet"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Set an xattr of a file or directory.
The name must be prefixed with the namespace followed by ".". For example,
"user.attr".
<p/>
Refer to the HDFS extended attributes user documentation for details.
@param path Path to modify
@param name xattr name.
@param value xattr value.
@param flag xattr set flag
@throws IOException]]>
</doc>
</method>
<method name="getXAttr" return="byte[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<param name="name" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Get an xattr for a file or directory.
The name must be prefixed with the namespace followed by ".". For example,
"user.attr".
<p/>
Refer to the HDFS extended attributes user documentation for details.
@param path Path to get extended attribute
@param name xattr name.
@return byte[] xattr value.
@throws IOException]]>
</doc>
</method>
<method name="getXAttrs" return="java.util.Map"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Get all of the xattrs for a file or directory.
Only those xattrs for which the logged-in user has permissions to view
are returned.
<p/>
Refer to the HDFS extended attributes user documentation for details.
@param path Path to get extended attributes
@return Map<String, byte[]> describing the XAttrs of the file or directory
@throws IOException]]>
</doc>
</method>
<method name="getXAttrs" return="java.util.Map"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<param name="names" type="java.util.List"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Get all of the xattrs for a file or directory.
Only those xattrs for which the logged-in user has permissions to view
are returned.
<p/>
Refer to the HDFS extended attributes user documentation for details.
@param path Path to get extended attributes
@param names XAttr names.
@return Map<String, byte[]> describing the XAttrs of the file or directory
@throws IOException]]>
</doc>
</method>
<method name="removeXAttr"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<param name="name" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Remove an xattr of a file or directory.
The name must be prefixed with the namespace followed by ".". For example,
"user.attr".
<p/>
Refer to the HDFS extended attributes user documentation for details.
@param path Path to remove extended attribute
@param name xattr name
@throws IOException]]>
</doc>
</method>
<method name="listXAttrs" return="java.util.List"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Get all of the xattr names for a file or directory.
Only those xattr names which the logged-in user has permissions to view
are returned.
<p/>
Refer to the HDFS extended attributes user documentation for details.
@param path Path to get extended attributes
@return List<String> of the XAttr names of the file or directory
@throws IOException]]>
</doc>
</method>
<field name="LOG" type="org.apache.commons.logging.Log"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
</field>
<field name="DEFAULT_PERM" type="org.apache.hadoop.fs.permission.FsPermission"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Default permission for directory and symlink
In previous versions, this default permission was also used to
create files, so files created end up with ugo+x permission.
See HADOOP-9155 for detail.
Two new constants are added to solve this, please use
{@link FileContext#DIR_DEFAULT_PERM} for directory, and use
{@link FileContext#FILE_DEFAULT_PERM} for file.
This constant is kept for compatibility.]]>
</doc>
</field>
<field name="DIR_DEFAULT_PERM" type="org.apache.hadoop.fs.permission.FsPermission"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Default permission for directory]]>
</doc>
</field>
<field name="FILE_DEFAULT_PERM" type="org.apache.hadoop.fs.permission.FsPermission"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Default permission for file]]>
</doc>
</field>
<field name="SHUTDOWN_HOOK_PRIORITY" type="int"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Priority of the FileContext shutdown hook.]]>
</doc>
</field>
<doc>
<![CDATA[The FileContext class provides an interface to the application writer for
using the Hadoop file system.
It provides a set of methods for the usual operation: create, open,
list, etc
<p>
<b> *** Path Names *** </b>
<p>
The Hadoop file system supports a URI name space and URI names.
It offers a forest of file systems that can be referenced using fully
qualified URIs.
Two common Hadoop file systems implementations are
<ul>
<li> the local file system: file:///path
<li> the hdfs file system hdfs://nnAddress:nnPort/path
</ul>
While URI names are very flexible, it requires knowing the name or address
of the server. For convenience one often wants to access the default system
in one's environment without knowing its name/address. This has an
additional benefit that it allows one to change one's default fs
(e.g. admin moves application from cluster1 to cluster2).
<p>
To facilitate this, Hadoop supports a notion of a default file system.
The user can set his default file system, although this is
typically set up for you in your environment via your default config.
A default file system implies a default scheme and authority; slash-relative
names (such as /for/bar) are resolved relative to that default FS.
Similarly a user can also have working-directory-relative names (i.e. names
not starting with a slash). While the working directory is generally in the
same default FS, the wd can be in a different FS.
<p>
Hence Hadoop path names can be one of:
<ul>
<li> fully qualified URI: scheme://authority/path
<li> slash relative names: /path relative to the default file system
<li> wd-relative names: path relative to the working dir
</ul>
Relative paths with scheme (scheme:foo/bar) are illegal.
<p>
<b>****The Role of the FileContext and configuration defaults****</b>
<p>
The FileContext provides file namespace context for resolving file names;
it also contains the umask for permissions, In that sense it is like the
per-process file-related state in Unix system.
These two properties
<ul>
<li> default file system i.e your slash)
<li> umask
</ul>
in general, are obtained from the default configuration file
in your environment, (@see {@link Configuration}).
No other configuration parameters are obtained from the default config as
far as the file context layer is concerned. All file system instances
(i.e. deployments of file systems) have default properties; we call these
server side (SS) defaults. Operation like create allow one to select many
properties: either pass them in as explicit parameters or use
the SS properties.
<p>
The file system related SS defaults are
<ul>
<li> the home directory (default is "/user/userName")
<li> the initial wd (only for local fs)
<li> replication factor
<li> block size
<li> buffer size
<li> encryptDataTransfer
<li> checksum option. (checksumType and bytesPerChecksum)
</ul>
<p>
<b> *** Usage Model for the FileContext class *** </b>
<p>
Example 1: use the default config read from the $HADOOP_CONFIG/core.xml.
Unspecified values come from core-defaults.xml in the release jar.
<ul>
<li> myFContext = FileContext.getFileContext(); // uses the default config
// which has your default FS
<li> myFContext.create(path, ...);
<li> myFContext.setWorkingDir(path)
<li> myFContext.open (path, ...);
</ul>
Example 2: Get a FileContext with a specific URI as the default FS
<ul>
<li> myFContext = FileContext.getFileContext(URI)
<li> myFContext.create(path, ...);
...
</ul>
Example 3: FileContext with local file system as the default
<ul>
<li> myFContext = FileContext.getLocalFSFileContext()
<li> myFContext.create(path, ...);
<li> ...
</ul>
Example 4: Use a specific config, ignoring $HADOOP_CONFIG
Generally you should not need use a config unless you are doing
<ul>
<li> configX = someConfigSomeOnePassedToYou.
<li> myFContext = getFileContext(configX); // configX is not changed,
// is passed down
<li> myFContext.create(path, ...);
<li>...
</ul>]]>
</doc>
</class>
<!-- end class org.apache.hadoop.fs.FileContext -->
<!-- start class org.apache.hadoop.fs.FileContext.Util -->
<class name="FileContext.Util" extends="java.lang.Object"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="FileContext.Util"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="exists" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Does the file exist?
Note: Avoid using this method if you already have FileStatus in hand.
Instead reuse the FileStatus
@param f the file or dir to be checked
@throws AccessControlException If access is denied
@throws IOException If an I/O error occurred
@throws UnsupportedFileSystemException If file system for <code>f</code> is
not supported
Exceptions applicable to file systems accessed over RPC:
@throws RpcClientException If an exception occurred in the RPC client
@throws RpcServerException If an exception occurred in the RPC server
@throws UnexpectedServerException If server implementation throws
undeclared exception to RPC server]]>
</doc>
</method>
<method name="getContentSummary" return="org.apache.hadoop.fs.ContentSummary"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Return the {@link ContentSummary} of path f.
@param f path
@return the {@link ContentSummary} of path f.
@throws AccessControlException If access is denied
@throws FileNotFoundException If <code>f</code> does not exist
@throws UnsupportedFileSystemException If file system for
<code>f</code> is not supported
@throws IOException If an I/O error occurred
Exceptions applicable to file systems accessed over RPC:
@throws RpcClientException If an exception occurred in the RPC client
@throws RpcServerException If an exception occurred in the RPC server
@throws UnexpectedServerException If server implementation throws
undeclared exception to RPC server]]>
</doc>
</method>
<method name="listStatus" return="org.apache.hadoop.fs.FileStatus[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="files" type="org.apache.hadoop.fs.Path[]"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[See {@link #listStatus(Path[], PathFilter)}]]>
</doc>
</method>
<method name="listStatus" return="org.apache.hadoop.fs.FileStatus[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="filter" type="org.apache.hadoop.fs.PathFilter"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Filter files/directories in the given path using the user-supplied path
filter.
@param f is the path name
@param filter is the user-supplied path filter
@return an array of FileStatus objects for the files under the given path
after applying the filter
@throws AccessControlException If access is denied
@throws FileNotFoundException If <code>f</code> does not exist
@throws UnsupportedFileSystemException If file system for
<code>pathPattern</code> is not supported
@throws IOException If an I/O error occurred
Exceptions applicable to file systems accessed over RPC:
@throws RpcClientException If an exception occurred in the RPC client
@throws RpcServerException If an exception occurred in the RPC server
@throws UnexpectedServerException If server implementation throws
undeclared exception to RPC server]]>
</doc>
</method>
<method name="listStatus" return="org.apache.hadoop.fs.FileStatus[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="files" type="org.apache.hadoop.fs.Path[]"/>
<param name="filter" type="org.apache.hadoop.fs.PathFilter"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Filter files/directories in the given list of paths using user-supplied
path filter.
@param files is a list of paths
@param filter is the filter
@return a list of statuses for the files under the given paths after
applying the filter
@throws AccessControlException If access is denied
@throws FileNotFoundException If a file in <code>files</code> does not
exist
@throws IOException If an I/O error occurred
Exceptions applicable to file systems accessed over RPC:
@throws RpcClientException If an exception occurred in the RPC client
@throws RpcServerException If an exception occurred in the RPC server
@throws UnexpectedServerException If server implementation throws
undeclared exception to RPC server]]>
</doc>
</method>
<method name="listStatus" return="org.apache.hadoop.fs.FileStatus[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[List the statuses of the files/directories in the given path
if the path is a directory.
@param f is the path
@return an array that contains statuses of the files/directories
in the given path
@throws AccessControlException If access is denied
@throws FileNotFoundException If <code>f</code> does not exist
@throws UnsupportedFileSystemException If file system for <code>f</code> is
not supported
@throws IOException If an I/O error occurred
Exceptions applicable to file systems accessed over RPC:
@throws RpcClientException If an exception occurred in the RPC client
@throws RpcServerException If an exception occurred in the RPC server
@throws UnexpectedServerException If server implementation throws
undeclared exception to RPC server]]>
</doc>
</method>
<method name="listFiles" return="org.apache.hadoop.fs.RemoteIterator"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="recursive" type="boolean"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[List the statuses and block locations of the files in the given path.
If the path is a directory,
if recursive is false, returns files in the directory;
if recursive is true, return files in the subtree rooted at the path.
The subtree is traversed in the depth-first order.
If the path is a file, return the file's status and block locations.
Files across symbolic links are also returned.
@param f is the path
@param recursive if the subdirectories need to be traversed recursively
@return an iterator that traverses statuses of the files
If any IO exception (for example a sub-directory gets deleted while
listing is being executed), next() or hasNext() of the returned iterator
may throw a RuntimeException with the IO exception as the cause.
@throws AccessControlException If access is denied
@throws FileNotFoundException If <code>f</code> does not exist
@throws UnsupportedFileSystemException If file system for <code>f</code>
is not supported
@throws IOException If an I/O error occurred
Exceptions applicable to file systems accessed over RPC:
@throws RpcClientException If an exception occurred in the RPC client
@throws RpcServerException If an exception occurred in the RPC server
@throws UnexpectedServerException If server implementation throws
undeclared exception to RPC server]]>
</doc>
</method>
<method name="globStatus" return="org.apache.hadoop.fs.FileStatus[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="pathPattern" type="org.apache.hadoop.fs.Path"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[<p>Return all the files that match filePattern and are not checksum
files. Results are sorted by their names.
<p>
A filename pattern is composed of <i>regular</i> characters and
<i>special pattern matching</i> characters, which are:
<dl>
<dd>
<dl>
<p>
<dt> <tt> ? </tt>
<dd> Matches any single character.
<p>
<dt> <tt> * </tt>
<dd> Matches zero or more characters.
<p>
<dt> <tt> [<i>abc</i>] </tt>
<dd> Matches a single character from character set
<tt>{<i>a,b,c</i>}</tt>.
<p>
<dt> <tt> [<i>a</i>-<i>b</i>] </tt>
<dd> Matches a single character from the character range
<tt>{<i>a...b</i>}</tt>. Note: character <tt><i>a</i></tt> must be
lexicographically less than or equal to character <tt><i>b</i></tt>.
<p>
<dt> <tt> [^<i>a</i>] </tt>
<dd> Matches a single char that is not from character set or range
<tt>{<i>a</i>}</tt>. Note that the <tt>^</tt> character must occur
immediately to the right of the opening bracket.
<p>
<dt> <tt> \<i>c</i> </tt>
<dd> Removes (escapes) any special meaning of character <i>c</i>.
<p>
<dt> <tt> {ab,cd} </tt>
<dd> Matches a string from the string set <tt>{<i>ab, cd</i>} </tt>
<p>
<dt> <tt> {ab,c{de,fh}} </tt>
<dd> Matches a string from string set <tt>{<i>ab, cde, cfh</i>}</tt>
</dl>
</dd>
</dl>
@param pathPattern a regular expression specifying a pth pattern
@return an array of paths that match the path pattern
@throws AccessControlException If access is denied
@throws UnsupportedFileSystemException If file system for
<code>pathPattern</code> is not supported
@throws IOException If an I/O error occurred
Exceptions applicable to file systems accessed over RPC:
@throws RpcClientException If an exception occurred in the RPC client
@throws RpcServerException If an exception occurred in the RPC server
@throws UnexpectedServerException If server implementation throws
undeclared exception to RPC server]]>
</doc>
</method>
<method name="globStatus" return="org.apache.hadoop.fs.FileStatus[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="pathPattern" type="org.apache.hadoop.fs.Path"/>
<param name="filter" type="org.apache.hadoop.fs.PathFilter"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Return an array of FileStatus objects whose path names match pathPattern
and is accepted by the user-supplied path filter. Results are sorted by
their path names.
Return null if pathPattern has no glob and the path does not exist.
Return an empty array if pathPattern has a glob and no path matches it.
@param pathPattern regular expression specifying the path pattern
@param filter user-supplied path filter
@return an array of FileStatus objects
@throws AccessControlException If access is denied
@throws UnsupportedFileSystemException If file system for
<code>pathPattern</code> is not supported
@throws IOException If an I/O error occurred
Exceptions applicable to file systems accessed over RPC:
@throws RpcClientException If an exception occurred in the RPC client
@throws RpcServerException If an exception occurred in the RPC server
@throws UnexpectedServerException If server implementation throws
undeclared exception to RPC server]]>
</doc>
</method>
<method name="copy" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="src" type="org.apache.hadoop.fs.Path"/>
<param name="dst" type="org.apache.hadoop.fs.Path"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileAlreadyExistsException" type="org.apache.hadoop.fs.FileAlreadyExistsException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="ParentNotDirectoryException" type="org.apache.hadoop.fs.ParentNotDirectoryException"/>
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Copy file from src to dest. See
{@link #copy(Path, Path, boolean, boolean)}]]>
</doc>
</method>
<method name="copy" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="src" type="org.apache.hadoop.fs.Path"/>
<param name="dst" type="org.apache.hadoop.fs.Path"/>
<param name="deleteSource" type="boolean"/>
<param name="overwrite" type="boolean"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileAlreadyExistsException" type="org.apache.hadoop.fs.FileAlreadyExistsException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="ParentNotDirectoryException" type="org.apache.hadoop.fs.ParentNotDirectoryException"/>
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Copy from src to dst, optionally deleting src and overwriting dst.
@param src
@param dst
@param deleteSource - delete src if true
@param overwrite overwrite dst if true; throw IOException if dst exists
and overwrite is false.
@return true if copy is successful
@throws AccessControlException If access is denied
@throws FileAlreadyExistsException If <code>dst</code> already exists
@throws FileNotFoundException If <code>src</code> does not exist
@throws ParentNotDirectoryException If parent of <code>dst</code> is not
a directory
@throws UnsupportedFileSystemException If file system for
<code>src</code> or <code>dst</code> is not supported
@throws IOException If an I/O error occurred
Exceptions applicable to file systems accessed over RPC:
@throws RpcClientException If an exception occurred in the RPC client
@throws RpcServerException If an exception occurred in the RPC server
@throws UnexpectedServerException If server implementation throws
undeclared exception to RPC server
RuntimeExceptions:
@throws InvalidPathException If path <code>dst</code> is invalid]]>
</doc>
</method>
<doc>
<![CDATA[Utility/library methods built over the basic FileContext methods.
Since this are library functions, the oprtation are not atomic
and some of them may partially complete if other threads are making
changes to the same part of the name space.]]>
</doc>
</class>
<!-- end class org.apache.hadoop.fs.FileContext.Util -->
<!-- start class org.apache.hadoop.fs.FileStatus -->
<class name="FileStatus" extends="java.lang.Object"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="org.apache.hadoop.io.Writable"/>
<implements name="java.lang.Comparable"/>
<constructor name="FileStatus"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<constructor name="FileStatus" type="long, boolean, int, long, long, org.apache.hadoop.fs.Path"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<constructor name="FileStatus" type="long, boolean, int, long, long, long, org.apache.hadoop.fs.permission.FsPermission, java.lang.String, java.lang.String, org.apache.hadoop.fs.Path"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Constructor for file systems on which symbolic links are not supported]]>
</doc>
</constructor>
<constructor name="FileStatus" type="long, boolean, int, long, long, long, org.apache.hadoop.fs.permission.FsPermission, java.lang.String, java.lang.String, org.apache.hadoop.fs.Path, org.apache.hadoop.fs.Path"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<constructor name="FileStatus" type="org.apache.hadoop.fs.FileStatus"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Copy constructor.
@param other FileStatus to copy]]>
</doc>
</constructor>
<method name="getLen" return="long"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the length of this file, in bytes.
@return the length of this file, in bytes.]]>
</doc>
</method>
<method name="isFile" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Is this a file?
@return true if this is a file]]>
</doc>
</method>
<method name="isDirectory" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Is this a directory?
@return true if this is a directory]]>
</doc>
</method>
<method name="isDir" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="Use {@link FileStatus#isFile()},
{@link FileStatus#isDirectory()}, and {@link FileStatus#isSymlink()}
instead.">
<doc>
<![CDATA[Old interface, instead use the explicit {@link FileStatus#isFile()},
{@link FileStatus#isDirectory()}, and {@link FileStatus#isSymlink()}
@return true if this is a directory.
@deprecated Use {@link FileStatus#isFile()},
{@link FileStatus#isDirectory()}, and {@link FileStatus#isSymlink()}
instead.]]>
</doc>
</method>
<method name="isSymlink" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Is this a symbolic link?
@return true if this is a symbolic link]]>
</doc>
</method>
<method name="getBlockSize" return="long"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the block size of the file.
@return the number of bytes]]>
</doc>
</method>
<method name="getReplication" return="short"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the replication factor of a file.
@return the replication factor of a file.]]>
</doc>
</method>
<method name="getModificationTime" return="long"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the modification time of the file.
@return the modification time of file in milliseconds since January 1, 1970 UTC.]]>
</doc>
</method>
<method name="getAccessTime" return="long"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the access time of the file.
@return the access time of file in milliseconds since January 1, 1970 UTC.]]>
</doc>
</method>
<method name="getPermission" return="org.apache.hadoop.fs.permission.FsPermission"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get FsPermission associated with the file.
@return permssion. If a filesystem does not have a notion of permissions
or if permissions could not be determined, then default
permissions equivalent of "rwxrwxrwx" is returned.]]>
</doc>
</method>
<method name="isEncrypted" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Tell whether the underlying file or directory is encrypted or not.
@return true if the underlying file is encrypted.]]>
</doc>
</method>
<method name="getOwner" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the owner of the file.
@return owner of the file. The string could be empty if there is no
notion of owner of a file in a filesystem or if it could not
be determined (rare).]]>
</doc>
</method>
<method name="getGroup" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the group associated with the file.
@return group for the file. The string could be empty if there is no
notion of group of a file in a filesystem or if it could not
be determined (rare).]]>
</doc>
</method>
<method name="getPath" return="org.apache.hadoop.fs.Path"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="setPath"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="p" type="org.apache.hadoop.fs.Path"/>
</method>
<method name="setPermission"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
<doc>
<![CDATA[Sets permission.
@param permission if permission is null, default value is set]]>
</doc>
</method>
<method name="setOwner"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="owner" type="java.lang.String"/>
<doc>
<![CDATA[Sets owner.
@param owner if it is null, default value is set]]>
</doc>
</method>
<method name="setGroup"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="group" type="java.lang.String"/>
<doc>
<![CDATA[Sets group.
@param group if it is null, default value is set]]>
</doc>
</method>
<method name="getSymlink" return="org.apache.hadoop.fs.Path"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[@return The contents of the symbolic link.]]>
</doc>
</method>
<method name="setSymlink"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="p" type="org.apache.hadoop.fs.Path"/>
</method>
<method name="write"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="out" type="java.io.DataOutput"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="readFields"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="in" type="java.io.DataInput"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="compareTo" return="int"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="o" type="java.lang.Object"/>
<doc>
<![CDATA[Compare this object to another object
@param o the object to be compared.
@return a negative integer, zero, or a positive integer as this object
is less than, equal to, or greater than the specified object.
@throws ClassCastException if the specified object's is not of
type FileStatus]]>
</doc>
</method>
<method name="equals" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="o" type="java.lang.Object"/>
<doc>
<![CDATA[Compare if this object is equal to another object
@param o the object to be compared.
@return true if two file status has the same path name; false if not.]]>
</doc>
</method>
<method name="hashCode" return="int"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns a hash code value for the object, which is defined as
the hash code of the path name.
@return a hash code value for the path name.]]>
</doc>
</method>
<method name="toString" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<doc>
<![CDATA[Interface that represents the client side information for a file.]]>
</doc>
</class>
<!-- end class org.apache.hadoop.fs.FileStatus -->
<!-- start class org.apache.hadoop.fs.FileSystem -->
<class name="FileSystem" extends="org.apache.hadoop.conf.Configured"
abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="java.io.Closeable"/>
<constructor name="FileSystem"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
</constructor>
<method name="get" return="org.apache.hadoop.fs.FileSystem"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="uri" type="java.net.URI"/>
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
<param name="user" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
<exception name="InterruptedException" type="java.lang.InterruptedException"/>
<doc>
<![CDATA[Get a filesystem instance based on the uri, the passed
configuration and the user
@param uri of the filesystem
@param conf the configuration to use
@param user to perform the get as
@return the filesystem instance
@throws IOException
@throws InterruptedException]]>
</doc>
</method>
<method name="get" return="org.apache.hadoop.fs.FileSystem"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Returns the configured filesystem implementation.
@param conf the configuration to use]]>
</doc>
</method>
<method name="getDefaultUri" return="java.net.URI"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
<doc>
<![CDATA[Get the default filesystem URI from a configuration.
@param conf the configuration to use
@return the uri of the default filesystem]]>
</doc>
</method>
<method name="setDefaultUri"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
<param name="uri" type="java.net.URI"/>
<doc>
<![CDATA[Set the default filesystem URI in a configuration.
@param conf the configuration to alter
@param uri the new default filesystem uri]]>
</doc>
</method>
<method name="setDefaultUri"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
<param name="uri" type="java.lang.String"/>
<doc>
<![CDATA[Set the default filesystem URI in a configuration.
@param conf the configuration to alter
@param uri the new default filesystem uri]]>
</doc>
</method>
<method name="initialize"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.net.URI"/>
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Called after a new FileSystem instance is constructed.
@param name a uri whose authority section names the host, port, etc.
for this FileSystem
@param conf the configuration]]>
</doc>
</method>
<method name="getScheme" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Return the protocol scheme for the FileSystem.
<p/>
This implementation throws an <code>UnsupportedOperationException</code>.
@return the protocol scheme for the FileSystem.]]>
</doc>
</method>
<method name="getUri" return="java.net.URI"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns a URI whose scheme and authority identify this FileSystem.]]>
</doc>
</method>
<method name="getCanonicalUri" return="java.net.URI"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<doc>
<![CDATA[Return a canonicalized form of this FileSystem's URI.
The default implementation simply calls {@link #canonicalizeUri(URI)}
on the filesystem's own URI, so subclasses typically only need to
implement that method.
@see #canonicalizeUri(URI)]]>
</doc>
</method>
<method name="canonicalizeUri" return="java.net.URI"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="uri" type="java.net.URI"/>
<doc>
<![CDATA[Canonicalize the given URI.
This is filesystem-dependent, but may for example consist of
canonicalizing the hostname using DNS and adding the default
port if not specified.
The default implementation simply fills in the default port if
not specified and if the filesystem has a default port.
@return URI
@see NetUtils#getCanonicalUri(URI, int)]]>
</doc>
</method>
<method name="getDefaultPort" return="int"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<doc>
<![CDATA[Get the default port for this file system.
@return the default port or 0 if there isn't one]]>
</doc>
</method>
<method name="getFSofPath" return="org.apache.hadoop.fs.FileSystem"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="protected"
deprecated="not deprecated">
<param name="absOrFqPath" type="org.apache.hadoop.fs.Path"/>
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="getCanonicalServiceName" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get a canonical service name for this file system. The token cache is
the only user of the canonical service name, and uses it to lookup this
filesystem's service tokens.
If file system provides a token of its own then it must have a canonical
name, otherwise canonical name can be null.
Default Impl: If the file system has child file systems
(such as an embedded file system) then it is assumed that the fs has no
tokens of its own and hence returns a null name; otherwise a service
name is built using Uri and port.
@return a service string that uniquely identifies this file system, null
if the filesystem does not implement tokens
@see SecurityUtil#buildDTServiceName(URI, int)]]>
</doc>
</method>
<method name="getName" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="call #getUri() instead.">
<doc>
<![CDATA[@deprecated call #getUri() instead.]]>
</doc>
</method>
<method name="getNamed" return="org.apache.hadoop.fs.FileSystem"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="call #get(URI,Configuration) instead.">
<param name="name" type="java.lang.String"/>
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[@deprecated call #get(URI,Configuration) instead.]]>
</doc>
</method>
<method name="getLocal" return="org.apache.hadoop.fs.LocalFileSystem"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Get the local file system.
@param conf the configuration to configure the file system with
@return a LocalFileSystem]]>
</doc>
</method>
<method name="get" return="org.apache.hadoop.fs.FileSystem"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="uri" type="java.net.URI"/>
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Returns the FileSystem for this URI's scheme and authority. The scheme
of the URI determines a configuration property name,
<tt>fs.<i>scheme</i>.class</tt> whose value names the FileSystem class.
The entire URI is passed to the FileSystem instance's initialize method.]]>
</doc>
</method>
<method name="newInstance" return="org.apache.hadoop.fs.FileSystem"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="uri" type="java.net.URI"/>
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
<param name="user" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
<exception name="InterruptedException" type="java.lang.InterruptedException"/>
<doc>
<![CDATA[Returns the FileSystem for this URI's scheme and authority and the
passed user. Internally invokes {@link #newInstance(URI, Configuration)}
@param uri of the filesystem
@param conf the configuration to use
@param user to perform the get as
@return filesystem instance
@throws IOException
@throws InterruptedException]]>
</doc>
</method>
<method name="newInstance" return="org.apache.hadoop.fs.FileSystem"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="uri" type="java.net.URI"/>
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Returns the FileSystem for this URI's scheme and authority. The scheme
of the URI determines a configuration property name,
<tt>fs.<i>scheme</i>.class</tt> whose value names the FileSystem class.
The entire URI is passed to the FileSystem instance's initialize method.
This always returns a new FileSystem object.]]>
</doc>
</method>
<method name="newInstance" return="org.apache.hadoop.fs.FileSystem"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Returns a unique configured filesystem implementation.
This always returns a new FileSystem object.
@param conf the configuration to use]]>
</doc>
</method>
<method name="newInstanceLocal" return="org.apache.hadoop.fs.LocalFileSystem"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Get a unique local file system object
@param conf the configuration to configure the file system with
@return a LocalFileSystem
This always returns a new FileSystem object.]]>
</doc>
</method>
<method name="closeAll"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Close all cached filesystems. Be sure those filesystems are not
used anymore.
@throws IOException]]>
</doc>
</method>
<method name="closeAllForUGI"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="ugi" type="org.apache.hadoop.security.UserGroupInformation"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Close all cached filesystems for a given UGI. Be sure those filesystems
are not used anymore.
@param ugi user group info to close
@throws IOException]]>
</doc>
</method>
<method name="makeQualified" return="org.apache.hadoop.fs.Path"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<doc>
<![CDATA[Make sure that a path specifies a FileSystem.
@param path to use]]>
</doc>
</method>
<method name="getDelegationToken" return="org.apache.hadoop.security.token.Token"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="renewer" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Get a new delegation token for this file system.
This is an internal method that should have been declared protected
but wasn't historically.
Callers should use {@link #addDelegationTokens(String, Credentials)}
@param renewer the account name that is allowed to renew the token.
@return a new delegation token
@throws IOException]]>
</doc>
</method>
<method name="addDelegationTokens" return="org.apache.hadoop.security.token.Token[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="renewer" type="java.lang.String"/>
<param name="credentials" type="org.apache.hadoop.security.Credentials"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Obtain all delegation tokens used by this FileSystem that are not
already present in the given Credentials. Existing tokens will neither
be verified as valid nor having the given renewer. Missing tokens will
be acquired and added to the given Credentials.
Default Impl: works for simple fs with its own token
and also for an embedded fs whose tokens are those of its
children file system (i.e. the embedded fs has not tokens of its
own).
@param renewer the user allowed to renew the delegation tokens
@param credentials cache in which to add new delegation tokens
@return list of new delegation tokens
@throws IOException]]>
</doc>
</method>
<method name="getChildFileSystems" return="org.apache.hadoop.fs.FileSystem[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get all the immediate child FileSystems embedded in this FileSystem.
It does not recurse and get grand children. If a FileSystem
has multiple child FileSystems, then it should return a unique list
of those FileSystems. Default is to return null to signify no children.
@return FileSystems used by this FileSystem]]>
</doc>
</method>
<method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
<param name="file" type="org.apache.hadoop.fs.Path"/>
<param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[create a file with the provided permission
The permission of the file is set to be the provided permission as in
setPermission, not permission&~umask
It is implemented using two RPCs. It is understood that it is inefficient,
but the implementation is thread-safe. The other option is to change the
value of umask in configuration to be 0, but it is not thread-safe.
@param fs file system handle
@param file the name of the file to be created
@param permission the permission of the file
@return an output stream
@throws IOException]]>
</doc>
</method>
<method name="mkdirs" return="boolean"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
<param name="dir" type="org.apache.hadoop.fs.Path"/>
<param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[create a directory with the provided permission
The permission of the directory is set to be the provided permission as in
setPermission, not permission&~umask
@see #create(FileSystem, Path, FsPermission)
@param fs file system handle
@param dir the name of the directory to be created
@param permission the permission of the directory
@return true if the directory creation succeeds; false otherwise
@throws IOException]]>
</doc>
</method>
<method name="checkPath"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<doc>
<![CDATA[Check that a Path belongs to this FileSystem.
@param path to check]]>
</doc>
</method>
<method name="getFileBlockLocations" return="org.apache.hadoop.fs.BlockLocation[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="file" type="org.apache.hadoop.fs.FileStatus"/>
<param name="start" type="long"/>
<param name="len" type="long"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Return an array containing hostnames, offset and size of
portions of the given file. For a nonexistent
file or regions, null will be returned.
This call is most helpful with DFS, where it returns
hostnames of machines that contain the given file.
The FileSystem will simply return an elt containing 'localhost'.
@param file FilesStatus to get data from
@param start offset into the given file
@param len length for which to get locations for]]>
</doc>
</method>
<method name="getFileBlockLocations" return="org.apache.hadoop.fs.BlockLocation[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="p" type="org.apache.hadoop.fs.Path"/>
<param name="start" type="long"/>
<param name="len" type="long"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Return an array containing hostnames, offset and size of
portions of the given file. For a nonexistent
file or regions, null will be returned.
This call is most helpful with DFS, where it returns
hostnames of machines that contain the given file.
The FileSystem will simply return an elt containing 'localhost'.
@param p path is used to identify an FS since an FS could have
another FS that it could be delegating the call to
@param start offset into the given file
@param len length for which to get locations for]]>
</doc>
</method>
<method name="getServerDefaults" return="org.apache.hadoop.fs.FsServerDefaults"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="use {@link #getServerDefaults(Path)} instead">
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Return a set of server default configuration values
@return server default configuration values
@throws IOException
@deprecated use {@link #getServerDefaults(Path)} instead]]>
</doc>
</method>
<method name="getServerDefaults" return="org.apache.hadoop.fs.FsServerDefaults"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="p" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Return a set of server default configuration values
@param p path is used to identify an FS since an FS could have
another FS that it could be delegating the call to
@return server default configuration values
@throws IOException]]>
</doc>
</method>
<method name="resolvePath" return="org.apache.hadoop.fs.Path"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="p" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Return the fully-qualified path of path f resolving the path
through any symlinks or mount point
@param p path to be resolved
@return fully qualified path
@throws FileNotFoundException]]>
</doc>
</method>
<method name="open" return="org.apache.hadoop.fs.FSDataInputStream"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="bufferSize" type="int"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Opens an FSDataInputStream at the indicated Path.
@param f the file name to open
@param bufferSize the size of the buffer to be used.]]>
</doc>
</method>
<method name="open" return="org.apache.hadoop.fs.FSDataInputStream"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Opens an FSDataInputStream at the indicated Path.
@param f the file to open]]>
</doc>
</method>
<method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Create an FSDataOutputStream at the indicated Path.
Files are overwritten by default.
@param f the file to create]]>
</doc>
</method>
<method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="overwrite" type="boolean"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Create an FSDataOutputStream at the indicated Path.
@param f the file to create
@param overwrite if a file with this name already exists, then if true,
the file will be overwritten, and if false an exception will be thrown.]]>
</doc>
</method>
<method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="progress" type="org.apache.hadoop.util.Progressable"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Create an FSDataOutputStream at the indicated Path with write-progress
reporting.
Files are overwritten by default.
@param f the file to create
@param progress to report progress]]>
</doc>
</method>
<method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="replication" type="short"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Create an FSDataOutputStream at the indicated Path.
Files are overwritten by default.
@param f the file to create
@param replication the replication factor]]>
</doc>
</method>
<method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="replication" type="short"/>
<param name="progress" type="org.apache.hadoop.util.Progressable"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Create an FSDataOutputStream at the indicated Path with write-progress
reporting.
Files are overwritten by default.
@param f the file to create
@param replication the replication factor
@param progress to report progress]]>
</doc>
</method>
<method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="overwrite" type="boolean"/>
<param name="bufferSize" type="int"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Create an FSDataOutputStream at the indicated Path.
@param f the file name to create
@param overwrite if a file with this name already exists, then if true,
the file will be overwritten, and if false an error will be thrown.
@param bufferSize the size of the buffer to be used.]]>
</doc>
</method>
<method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="overwrite" type="boolean"/>
<param name="bufferSize" type="int"/>
<param name="progress" type="org.apache.hadoop.util.Progressable"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Create an FSDataOutputStream at the indicated Path with write-progress
reporting.
@param f the path of the file to open
@param overwrite if a file with this name already exists, then if true,
the file will be overwritten, and if false an error will be thrown.
@param bufferSize the size of the buffer to be used.]]>
</doc>
</method>
<method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="overwrite" type="boolean"/>
<param name="bufferSize" type="int"/>
<param name="replication" type="short"/>
<param name="blockSize" type="long"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Create an FSDataOutputStream at the indicated Path.
@param f the file name to open
@param overwrite if a file with this name already exists, then if true,
the file will be overwritten, and if false an error will be thrown.
@param bufferSize the size of the buffer to be used.
@param replication required block replication for the file.]]>
</doc>
</method>
<method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="overwrite" type="boolean"/>
<param name="bufferSize" type="int"/>
<param name="replication" type="short"/>
<param name="blockSize" type="long"/>
<param name="progress" type="org.apache.hadoop.util.Progressable"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Create an FSDataOutputStream at the indicated Path with write-progress
reporting.
@param f the file name to open
@param overwrite if a file with this name already exists, then if true,
the file will be overwritten, and if false an error will be thrown.
@param bufferSize the size of the buffer to be used.
@param replication required block replication for the file.]]>
</doc>
</method>
<method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
<param name="overwrite" type="boolean"/>
<param name="bufferSize" type="int"/>
<param name="replication" type="short"/>
<param name="blockSize" type="long"/>
<param name="progress" type="org.apache.hadoop.util.Progressable"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Create an FSDataOutputStream at the indicated Path with write-progress
reporting.
@param f the file name to open
@param permission
@param overwrite if a file with this name already exists, then if true,
the file will be overwritten, and if false an error will be thrown.
@param bufferSize the size of the buffer to be used.
@param replication required block replication for the file.
@param blockSize
@param progress
@throws IOException
@see #setPermission(Path, FsPermission)]]>
</doc>
</method>
<method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
<param name="flags" type="java.util.EnumSet"/>
<param name="bufferSize" type="int"/>
<param name="replication" type="short"/>
<param name="blockSize" type="long"/>
<param name="progress" type="org.apache.hadoop.util.Progressable"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Create an FSDataOutputStream at the indicated Path with write-progress
reporting.
@param f the file name to open
@param permission
@param flags {@link CreateFlag}s to use for this stream.
@param bufferSize the size of the buffer to be used.
@param replication required block replication for the file.
@param blockSize
@param progress
@throws IOException
@see #setPermission(Path, FsPermission)]]>
</doc>
</method>
<method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
<param name="flags" type="java.util.EnumSet"/>
<param name="bufferSize" type="int"/>
<param name="replication" type="short"/>
<param name="blockSize" type="long"/>
<param name="progress" type="org.apache.hadoop.util.Progressable"/>
<param name="checksumOpt" type="org.apache.hadoop.fs.Options.ChecksumOpt"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Create an FSDataOutputStream at the indicated Path with a custom
checksum option
@param f the file name to open
@param permission
@param flags {@link CreateFlag}s to use for this stream.
@param bufferSize the size of the buffer to be used.
@param replication required block replication for the file.
@param blockSize
@param progress
@param checksumOpt checksum parameter. If null, the values
found in conf will be used.
@throws IOException
@see #setPermission(Path, FsPermission)]]>
</doc>
</method>
<method name="primitiveCreate" return="org.apache.hadoop.fs.FSDataOutputStream"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="absolutePermission" type="org.apache.hadoop.fs.permission.FsPermission"/>
<param name="flag" type="java.util.EnumSet"/>
<param name="bufferSize" type="int"/>
<param name="replication" type="short"/>
<param name="blockSize" type="long"/>
<param name="progress" type="org.apache.hadoop.util.Progressable"/>
<param name="checksumOpt" type="org.apache.hadoop.fs.Options.ChecksumOpt"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="primitiveMkdir" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="absolutePermission" type="org.apache.hadoop.fs.permission.FsPermission"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[This version of the mkdirs method assumes that the permission is absolute.
It has been added to support the FileContext that processes the permission
with umask before calling this method.
This a temporary method added to support the transition from FileSystem
to FileContext for user applications.]]>
</doc>
</method>
<method name="primitiveMkdir"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="absolutePermission" type="org.apache.hadoop.fs.permission.FsPermission"/>
<param name="createParent" type="boolean"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[This version of the mkdirs method assumes that the permission is absolute.
It has been added to support the FileContext that processes the permission
with umask before calling this method.
This a temporary method added to support the transition from FileSystem
to FileContext for user applications.]]>
</doc>
</method>
<method name="createNonRecursive" return="org.apache.hadoop.fs.FSDataOutputStream"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="API only for 0.20-append">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="overwrite" type="boolean"/>
<param name="bufferSize" type="int"/>
<param name="replication" type="short"/>
<param name="blockSize" type="long"/>
<param name="progress" type="org.apache.hadoop.util.Progressable"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Opens an FSDataOutputStream at the indicated Path with write-progress
reporting. Same as create(), except fails if parent directory doesn't
already exist.
@param f the file name to open
@param overwrite if a file with this name already exists, then if true,
the file will be overwritten, and if false an error will be thrown.
@param bufferSize the size of the buffer to be used.
@param replication required block replication for the file.
@param blockSize
@param progress
@throws IOException
@see #setPermission(Path, FsPermission)
@deprecated API only for 0.20-append]]>
</doc>
</method>
<method name="createNonRecursive" return="org.apache.hadoop.fs.FSDataOutputStream"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="API only for 0.20-append">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
<param name="overwrite" type="boolean"/>
<param name="bufferSize" type="int"/>
<param name="replication" type="short"/>
<param name="blockSize" type="long"/>
<param name="progress" type="org.apache.hadoop.util.Progressable"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Opens an FSDataOutputStream at the indicated Path with write-progress
reporting. Same as create(), except fails if parent directory doesn't
already exist.
@param f the file name to open
@param permission
@param overwrite if a file with this name already exists, then if true,
the file will be overwritten, and if false an error will be thrown.
@param bufferSize the size of the buffer to be used.
@param replication required block replication for the file.
@param blockSize
@param progress
@throws IOException
@see #setPermission(Path, FsPermission)
@deprecated API only for 0.20-append]]>
</doc>
</method>
<method name="createNonRecursive" return="org.apache.hadoop.fs.FSDataOutputStream"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="API only for 0.20-append">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
<param name="flags" type="java.util.EnumSet"/>
<param name="bufferSize" type="int"/>
<param name="replication" type="short"/>
<param name="blockSize" type="long"/>
<param name="progress" type="org.apache.hadoop.util.Progressable"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Opens an FSDataOutputStream at the indicated Path with write-progress
reporting. Same as create(), except fails if parent directory doesn't
already exist.
@param f the file name to open
@param permission
@param flags {@link CreateFlag}s to use for this stream.
@param bufferSize the size of the buffer to be used.
@param replication required block replication for the file.
@param blockSize
@param progress
@throws IOException
@see #setPermission(Path, FsPermission)
@deprecated API only for 0.20-append]]>
</doc>
</method>
<method name="createNewFile" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Creates the given Path as a brand-new zero-length file. If
create fails, or if it already existed, return false.
@param f path to use for create]]>
</doc>
</method>
<method name="append" return="org.apache.hadoop.fs.FSDataOutputStream"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Append to an existing file (optional operation).
Same as append(f, getConf().getInt("io.file.buffer.size", 4096), null)
@param f the existing file to be appended.
@throws IOException]]>
</doc>
</method>
<method name="append" return="org.apache.hadoop.fs.FSDataOutputStream"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="bufferSize" type="int"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Append to an existing file (optional operation).
Same as append(f, bufferSize, null).
@param f the existing file to be appended.
@param bufferSize the size of the buffer to be used.
@throws IOException]]>
</doc>
</method>
<method name="append" return="org.apache.hadoop.fs.FSDataOutputStream"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="bufferSize" type="int"/>
<param name="progress" type="org.apache.hadoop.util.Progressable"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Append to an existing file (optional operation).
@param f the existing file to be appended.
@param bufferSize the size of the buffer to be used.
@param progress for reporting progress if it is not null.
@throws IOException]]>
</doc>
</method>
<method name="concat"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="trg" type="org.apache.hadoop.fs.Path"/>
<param name="psrcs" type="org.apache.hadoop.fs.Path[]"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Concat existing files together.
@param trg the path to the target destination.
@param psrcs the paths to the sources to use for the concatenation.
@throws IOException]]>
</doc>
</method>
<method name="getReplication" return="short"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="Use getFileStatus() instead">
<param name="src" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Get replication.
@deprecated Use getFileStatus() instead
@param src file name
@return file replication
@throws IOException]]>
</doc>
</method>
<method name="setReplication" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="src" type="org.apache.hadoop.fs.Path"/>
<param name="replication" type="short"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Set replication for an existing file.
@param src file name
@param replication new replication
@throws IOException
@return true if successful;
false if file does not exist or is a directory]]>
</doc>
</method>
<method name="rename" return="boolean"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="src" type="org.apache.hadoop.fs.Path"/>
<param name="dst" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Renames Path src to Path dst. Can take place on local fs
or remote DFS.
@param src path to be renamed
@param dst new path after rename
@throws IOException on failure
@return true if rename is successful]]>
</doc>
</method>
<method name="rename"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="src" type="org.apache.hadoop.fs.Path"/>
<param name="dst" type="org.apache.hadoop.fs.Path"/>
<param name="options" type="org.apache.hadoop.fs.Options.Rename[]"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Renames Path src to Path dst
<ul>
<li
<li>Fails if src is a file and dst is a directory.
<li>Fails if src is a directory and dst is a file.
<li>Fails if the parent of dst does not exist or is a file.
</ul>
<p>
If OVERWRITE option is not passed as an argument, rename fails
if the dst already exists.
<p>
If OVERWRITE option is passed as an argument, rename overwrites
the dst if it is a file or an empty directory. Rename fails if dst is
a non-empty directory.
<p>
Note that atomicity of rename is dependent on the file system
implementation. Please refer to the file system documentation for
details. This default implementation is non atomic.
<p>
This method is deprecated since it is a temporary method added to
support the transition from FileSystem to FileContext for user
applications.
@param src path to be renamed
@param dst new path after rename
@throws IOException on failure]]>
</doc>
</method>
<method name="delete" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="Use {@link #delete(Path, boolean)} instead.">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Delete a file
@deprecated Use {@link #delete(Path, boolean)} instead.]]>
</doc>
</method>
<method name="delete" return="boolean"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="recursive" type="boolean"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Delete a file.
@param f the path to delete.
@param recursive if path is a directory and set to
true, the directory is deleted else throws an exception. In
case of a file the recursive can be set to either true or false.
@return true if delete is successful else false.
@throws IOException]]>
</doc>
</method>
<method name="deleteOnExit" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Mark a path to be deleted when FileSystem is closed.
When the JVM shuts down,
all FileSystem objects will be closed automatically.
Then,
the marked path will be deleted as a result of closing the FileSystem.
The path has to exist in the file system.
@param f the path to delete.
@return true if deleteOnExit is successful, otherwise false.
@throws IOException]]>
</doc>
</method>
<method name="cancelDeleteOnExit" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<doc>
<![CDATA[Cancel the deletion of the path when the FileSystem is closed
@param f the path to cancel deletion]]>
</doc>
</method>
<method name="processDeleteOnExit"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<doc>
<![CDATA[Delete all files that were marked as delete-on-exit. This recursively
deletes all files in the specified paths.]]>
</doc>
</method>
<method name="exists" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Check if exists.
@param f source file]]>
</doc>
</method>
<method name="isDirectory" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[True iff the named path is a directory.
Note: Avoid using this method. Instead reuse the FileStatus
returned by getFileStatus() or listStatus() methods.
@param f path to check]]>
</doc>
</method>
<method name="isFile" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[True iff the named path is a regular file.
Note: Avoid using this method. Instead reuse the FileStatus
returned by getFileStatus() or listStatus() methods.
@param f path to check]]>
</doc>
</method>
<method name="getLength" return="long"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="Use getFileStatus() instead">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[@deprecated Use getFileStatus() instead]]>
</doc>
</method>
<method name="getContentSummary" return="org.apache.hadoop.fs.ContentSummary"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Return the {@link ContentSummary} of a given {@link Path}.
@param f path to use]]>
</doc>
</method>
<method name="listStatus" return="org.apache.hadoop.fs.FileStatus[]"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[List the statuses of the files/directories in the given path if the path is
a directory.
@param f given path
@return the statuses of the files/directories in the given patch
@throws FileNotFoundException when the path does not exist;
IOException see specific implementation]]>
</doc>
</method>
<method name="listCorruptFileBlocks" return="org.apache.hadoop.fs.RemoteIterator"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[@return an iterator over the corrupt files under the given path
(may contain duplicates if a file has more than one corrupt block)
@throws IOException]]>
</doc>
</method>
<method name="listStatus" return="org.apache.hadoop.fs.FileStatus[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="filter" type="org.apache.hadoop.fs.PathFilter"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Filter files/directories in the given path using the user-supplied path
filter.
@param f
a path name
@param filter
the user-supplied path filter
@return an array of FileStatus objects for the files under the given path
after applying the filter
@throws FileNotFoundException when the path does not exist;
IOException see specific implementation]]>
</doc>
</method>
<method name="listStatus" return="org.apache.hadoop.fs.FileStatus[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="files" type="org.apache.hadoop.fs.Path[]"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Filter files/directories in the given list of paths using default
path filter.
@param files
a list of paths
@return a list of statuses for the files under the given paths after
applying the filter default Path filter
@throws FileNotFoundException when the path does not exist;
IOException see specific implementation]]>
</doc>
</method>
<method name="listStatus" return="org.apache.hadoop.fs.FileStatus[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="files" type="org.apache.hadoop.fs.Path[]"/>
<param name="filter" type="org.apache.hadoop.fs.PathFilter"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Filter files/directories in the given list of paths using user-supplied
path filter.
@param files
a list of paths
@param filter
the user-supplied path filter
@return a list of statuses for the files under the given paths after
applying the filter
@throws FileNotFoundException when the path does not exist;
IOException see specific implementation]]>
</doc>
</method>
<method name="globStatus" return="org.apache.hadoop.fs.FileStatus[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="pathPattern" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[<p>Return all the files that match filePattern and are not checksum
files. Results are sorted by their names.
<p>
A filename pattern is composed of <i>regular</i> characters and
<i>special pattern matching</i> characters, which are:
<dl>
<dd>
<dl>
<p>
<dt> <tt> ? </tt>
<dd> Matches any single character.
<p>
<dt> <tt> * </tt>
<dd> Matches zero or more characters.
<p>
<dt> <tt> [<i>abc</i>] </tt>
<dd> Matches a single character from character set
<tt>{<i>a,b,c</i>}</tt>.
<p>
<dt> <tt> [<i>a</i>-<i>b</i>] </tt>
<dd> Matches a single character from the character range
<tt>{<i>a...b</i>}</tt>. Note that character <tt><i>a</i></tt> must be
lexicographically less than or equal to character <tt><i>b</i></tt>.
<p>
<dt> <tt> [^<i>a</i>] </tt>
<dd> Matches a single character that is not from character set or range
<tt>{<i>a</i>}</tt>. Note that the <tt>^</tt> character must occur
immediately to the right of the opening bracket.
<p>
<dt> <tt> \<i>c</i> </tt>
<dd> Removes (escapes) any special meaning of character <i>c</i>.
<p>
<dt> <tt> {ab,cd} </tt>
<dd> Matches a string from the string set <tt>{<i>ab, cd</i>} </tt>
<p>
<dt> <tt> {ab,c{de,fh}} </tt>
<dd> Matches a string from the string set <tt>{<i>ab, cde, cfh</i>}</tt>
</dl>
</dd>
</dl>
@param pathPattern a regular expression specifying a pth pattern
@return an array of paths that match the path pattern
@throws IOException]]>
</doc>
</method>
<method name="globStatus" return="org.apache.hadoop.fs.FileStatus[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="pathPattern" type="org.apache.hadoop.fs.Path"/>
<param name="filter" type="org.apache.hadoop.fs.PathFilter"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Return an array of FileStatus objects whose path names match pathPattern
and is accepted by the user-supplied path filter. Results are sorted by
their path names.
Return null if pathPattern has no glob and the path does not exist.
Return an empty array if pathPattern has a glob and no path matches it.
@param pathPattern
a regular expression specifying the path pattern
@param filter
a user-supplied path filter
@return an array of FileStatus objects
@throws IOException if any I/O error occurs when fetching file status]]>
</doc>
</method>
<method name="listLocatedStatus" return="org.apache.hadoop.fs.RemoteIterator"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[List the statuses of the files/directories in the given path if the path is
a directory.
Return the file's status and block locations If the path is a file.
If a returned status is a file, it contains the file's block locations.
@param f is the path
@return an iterator that traverses statuses of the files/directories
in the given path
@throws FileNotFoundException If <code>f</code> does not exist
@throws IOException If an I/O error occurred]]>
</doc>
</method>
<method name="listLocatedStatus" return="org.apache.hadoop.fs.RemoteIterator"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="filter" type="org.apache.hadoop.fs.PathFilter"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Listing a directory
The returned results include its block location if it is a file
The results are filtered by the given path filter
@param f a path
@param filter a path filter
@return an iterator that traverses statuses of the files/directories
in the given path
@throws FileNotFoundException if <code>f</code> does not exist
@throws IOException if any I/O error occurred]]>
</doc>
</method>
<method name="listFiles" return="org.apache.hadoop.fs.RemoteIterator"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="recursive" type="boolean"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[List the statuses and block locations of the files in the given path.
If the path is a directory,
if recursive is false, returns files in the directory;
if recursive is true, return files in the subtree rooted at the path.
If the path is a file, return the file's status and block locations.
@param f is the path
@param recursive if the subdirectories need to be traversed recursively
@return an iterator that traverses statuses of the files
@throws FileNotFoundException when the path does not exist;
IOException see specific implementation]]>
</doc>
</method>
<method name="getHomeDirectory" return="org.apache.hadoop.fs.Path"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Return the current user's home directory in this filesystem.
The default implementation returns "/user/$USER/".]]>
</doc>
</method>
<method name="setWorkingDirectory"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="new_dir" type="org.apache.hadoop.fs.Path"/>
<doc>
<![CDATA[Set the current working directory for the given file system. All relative
paths will be resolved relative to it.
@param new_dir]]>
</doc>
</method>
<method name="getWorkingDirectory" return="org.apache.hadoop.fs.Path"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the current working directory for the given file system
@return the directory pathname]]>
</doc>
</method>
<method name="getInitialWorkingDirectory" return="org.apache.hadoop.fs.Path"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<doc>
<![CDATA[Note: with the new FilesContext class, getWorkingDirectory()
will be removed.
The working directory is implemented in FilesContext.
Some file systems like LocalFileSystem have an initial workingDir
that we use as the starting workingDir. For other file systems
like HDFS there is no built in notion of an initial workingDir.
@return if there is built in notion of workingDir then it
is returned; else a null is returned.]]>
</doc>
</method>
<method name="mkdirs" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Call {@link #mkdirs(Path, FsPermission)} with default permission.]]>
</doc>
</method>
<method name="mkdirs" return="boolean"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Make the given file and all non-existent parents into
directories. Has the semantics of Unix 'mkdir -p'.
Existence of the directory hierarchy is not an error.
@param f path to create
@param permission to apply to f]]>
</doc>
</method>
<method name="copyFromLocalFile"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="src" type="org.apache.hadoop.fs.Path"/>
<param name="dst" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The src file is on the local disk. Add it to FS at
the given dst name and the source is kept intact afterwards
@param src path
@param dst path]]>
</doc>
</method>
<method name="moveFromLocalFile"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="srcs" type="org.apache.hadoop.fs.Path[]"/>
<param name="dst" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The src files is on the local disk. Add it to FS at
the given dst name, removing the source afterwards.
@param srcs path
@param dst path]]>
</doc>
</method>
<method name="moveFromLocalFile"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="src" type="org.apache.hadoop.fs.Path"/>
<param name="dst" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The src file is on the local disk. Add it to FS at
the given dst name, removing the source afterwards.
@param src path
@param dst path]]>
</doc>
</method>
<method name="copyFromLocalFile"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="delSrc" type="boolean"/>
<param name="src" type="org.apache.hadoop.fs.Path"/>
<param name="dst" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The src file is on the local disk. Add it to FS at
the given dst name.
delSrc indicates if the source should be removed
@param delSrc whether to delete the src
@param src path
@param dst path]]>
</doc>
</method>
<method name="copyFromLocalFile"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="delSrc" type="boolean"/>
<param name="overwrite" type="boolean"/>
<param name="srcs" type="org.apache.hadoop.fs.Path[]"/>
<param name="dst" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The src files are on the local disk. Add it to FS at
the given dst name.
delSrc indicates if the source should be removed
@param delSrc whether to delete the src
@param overwrite whether to overwrite an existing file
@param srcs array of paths which are source
@param dst path]]>
</doc>
</method>
<method name="copyFromLocalFile"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="delSrc" type="boolean"/>
<param name="overwrite" type="boolean"/>
<param name="src" type="org.apache.hadoop.fs.Path"/>
<param name="dst" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The src file is on the local disk. Add it to FS at
the given dst name.
delSrc indicates if the source should be removed
@param delSrc whether to delete the src
@param overwrite whether to overwrite an existing file
@param src path
@param dst path]]>
</doc>
</method>
<method name="copyToLocalFile"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="src" type="org.apache.hadoop.fs.Path"/>
<param name="dst" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The src file is under FS, and the dst is on the local disk.
Copy it from FS control to the local dst name.
@param src path
@param dst path]]>
</doc>
</method>
<method name="moveToLocalFile"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="src" type="org.apache.hadoop.fs.Path"/>
<param name="dst" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The src file is under FS, and the dst is on the local disk.
Copy it from FS control to the local dst name.
Remove the source afterwards
@param src path
@param dst path]]>
</doc>
</method>
<method name="copyToLocalFile"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="delSrc" type="boolean"/>
<param name="src" type="org.apache.hadoop.fs.Path"/>
<param name="dst" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The src file is under FS, and the dst is on the local disk.
Copy it from FS control to the local dst name.
delSrc indicates if the src will be removed or not.
@param delSrc whether to delete the src
@param src path
@param dst path]]>
</doc>
</method>
<method name="copyToLocalFile"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="delSrc" type="boolean"/>
<param name="src" type="org.apache.hadoop.fs.Path"/>
<param name="dst" type="org.apache.hadoop.fs.Path"/>
<param name="useRawLocalFileSystem" type="boolean"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The src file is under FS, and the dst is on the local disk. Copy it from FS
control to the local dst name. delSrc indicates if the src will be removed
or not. useRawLocalFileSystem indicates whether to use RawLocalFileSystem
as local file system or not. RawLocalFileSystem is non crc file system.So,
It will not create any crc files at local.
@param delSrc
whether to delete the src
@param src
path
@param dst
path
@param useRawLocalFileSystem
whether to use RawLocalFileSystem as local file system or not.
@throws IOException
- if any IO error]]>
</doc>
</method>
<method name="startLocalOutput" return="org.apache.hadoop.fs.Path"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="fsOutputFile" type="org.apache.hadoop.fs.Path"/>
<param name="tmpLocalFile" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Returns a local File that the user can write output to. The caller
provides both the eventual FS target name and the local working
file. If the FS is local, we write directly into the target. If
the FS is remote, we write into the tmp local area.
@param fsOutputFile path of output file
@param tmpLocalFile path of local tmp file]]>
</doc>
</method>
<method name="completeLocalOutput"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="fsOutputFile" type="org.apache.hadoop.fs.Path"/>
<param name="tmpLocalFile" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Called when we're all done writing to the target. A local FS will
do nothing, because we've written to exactly the right place. A remote
FS will copy the contents of tmpLocalFile to the correct target at
fsOutputFile.
@param fsOutputFile path of output file
@param tmpLocalFile path to local tmp file]]>
</doc>
</method>
<method name="close"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[No more filesystem operations are needed. Will
release any held locks.]]>
</doc>
</method>
<method name="getUsed" return="long"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Return the total size of all files in the filesystem.]]>
</doc>
</method>
<method name="getBlockSize" return="long"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="Use getFileStatus() instead">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[@deprecated Use getFileStatus() instead]]>
</doc>
</method>
<method name="getDefaultBlockSize" return="long"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="use {@link #getDefaultBlockSize(Path)} instead">
<doc>
<![CDATA[Return the number of bytes that large input files should be optimally
be split into to minimize i/o time.
@deprecated use {@link #getDefaultBlockSize(Path)} instead]]>
</doc>
</method>
<method name="getDefaultBlockSize" return="long"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<doc>
<![CDATA[Return the number of bytes that large input files should be optimally
be split into to minimize i/o time. The given path will be used to
locate the actual filesystem. The full path does not have to exist.
@param f path of file
@return the default block size for the path's filesystem]]>
</doc>
</method>
<method name="getDefaultReplication" return="short"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="use {@link #getDefaultReplication(Path)} instead">
<doc>
<![CDATA[Get the default replication.
@deprecated use {@link #getDefaultReplication(Path)} instead]]>
</doc>
</method>
<method name="getDefaultReplication" return="short"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<doc>
<![CDATA[Get the default replication for a path. The given path will be used to
locate the actual filesystem. The full path does not have to exist.
@param path of the file
@return default replication for the path's filesystem]]>
</doc>
</method>
<method name="getFileStatus" return="org.apache.hadoop.fs.FileStatus"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Return a file status object that represents the path.
@param f The path we want information from
@return a FileStatus object
@throws FileNotFoundException when the path does not exist;
IOException see specific implementation]]>
</doc>
</method>
<method name="access"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<param name="mode" type="org.apache.hadoop.fs.permission.FsAction"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Checks if the user can access a path. The mode specifies which access
checks to perform. If the requested permissions are granted, then the
method returns normally. If access is denied, then the method throws an
{@link AccessControlException}.
<p/>
The default implementation of this method calls {@link #getFileStatus(Path)}
and checks the returned permissions against the requested permissions.
Note that the getFileStatus call will be subject to authorization checks.
Typically, this requires search (execute) permissions on each directory in
the path's prefix, but this is implementation-defined. Any file system
that provides a richer authorization model (such as ACLs) may override the
default implementation so that it checks against that model instead.
<p>
In general, applications should avoid using this method, due to the risk of
time-of-check/time-of-use race conditions. The permissions on a file may
change immediately after the access call returns. Most applications should
prefer running specific file system actions as the desired user represented
by a {@link UserGroupInformation}.
@param path Path to check
@param mode type of access to check
@throws AccessControlException if access is denied
@throws FileNotFoundException if the path does not exist
@throws IOException see specific implementation]]>
</doc>
</method>
<method name="fixRelativePart" return="org.apache.hadoop.fs.Path"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="p" type="org.apache.hadoop.fs.Path"/>
<doc>
<![CDATA[See {@link FileContext#fixRelativePart}]]>
</doc>
</method>
<method name="createSymlink"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="target" type="org.apache.hadoop.fs.Path"/>
<param name="link" type="org.apache.hadoop.fs.Path"/>
<param name="createParent" type="boolean"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileAlreadyExistsException" type="org.apache.hadoop.fs.FileAlreadyExistsException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="ParentNotDirectoryException" type="org.apache.hadoop.fs.ParentNotDirectoryException"/>
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[See {@link FileContext#createSymlink(Path, Path, boolean)}]]>
</doc>
</method>
<method name="getFileLinkStatus" return="org.apache.hadoop.fs.FileStatus"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[See {@link FileContext#getFileLinkStatus(Path)}]]>
</doc>
</method>
<method name="supportsSymlinks" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See {@link AbstractFileSystem#supportsSymlinks()}]]>
</doc>
</method>
<method name="getLinkTarget" return="org.apache.hadoop.fs.Path"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[See {@link FileContext#getLinkTarget(Path)}]]>
</doc>
</method>
<method name="resolveLink" return="org.apache.hadoop.fs.Path"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[See {@link AbstractFileSystem#getLinkTarget(Path)}]]>
</doc>
</method>
<method name="getFileChecksum" return="org.apache.hadoop.fs.FileChecksum"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Get the checksum of a file.
@param f The file path
@return The file checksum. The default return value is null,
which indicates that no checksum algorithm is implemented
in the corresponding FileSystem.]]>
</doc>
</method>
<method name="getFileChecksum" return="org.apache.hadoop.fs.FileChecksum"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="length" type="long"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Get the checksum of a file, from the beginning of the file till the
specific length.
@param f The file path
@param length The length of the file range for checksum calculation
@return The file checksum.]]>
</doc>
</method>
<method name="setVerifyChecksum"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="verifyChecksum" type="boolean"/>
<doc>
<![CDATA[Set the verify checksum flag. This is only applicable if the
corresponding FileSystem supports checksum. By default doesn't do anything.
@param verifyChecksum]]>
</doc>
</method>
<method name="setWriteChecksum"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="writeChecksum" type="boolean"/>
<doc>
<![CDATA[Set the write checksum flag. This is only applicable if the
corresponding FileSystem supports checksum. By default doesn't do anything.
@param writeChecksum]]>
</doc>
</method>
<method name="getStatus" return="org.apache.hadoop.fs.FsStatus"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Returns a status object describing the use and capacity of the
file system. If the file system has multiple partitions, the
use and capacity of the root partition is reflected.
@return a FsStatus object
@throws IOException
see specific implementation]]>
</doc>
</method>
<method name="getStatus" return="org.apache.hadoop.fs.FsStatus"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="p" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Returns a status object describing the use and capacity of the
file system. If the file system has multiple partitions, the
use and capacity of the partition pointed to by the specified
path is reflected.
@param p Path for which status should be obtained. null means
the default partition.
@return a FsStatus object
@throws IOException
see specific implementation]]>
</doc>
</method>
<method name="setPermission"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="p" type="org.apache.hadoop.fs.Path"/>
<param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Set permission of a path.
@param p
@param permission]]>
</doc>
</method>
<method name="setOwner"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="p" type="org.apache.hadoop.fs.Path"/>
<param name="username" type="java.lang.String"/>
<param name="groupname" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Set owner of a path (i.e. a file or a directory).
The parameters username and groupname cannot both be null.
@param p The path
@param username If it is null, the original username remains unchanged.
@param groupname If it is null, the original groupname remains unchanged.]]>
</doc>
</method>
<method name="setTimes"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="p" type="org.apache.hadoop.fs.Path"/>
<param name="mtime" type="long"/>
<param name="atime" type="long"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Set access time of a file
@param p The path
@param mtime Set the modification time of this file.
The number of milliseconds since Jan 1, 1970.
A value of -1 means that this call should not set modification time.
@param atime Set the access time of this file.
The number of milliseconds since Jan 1, 1970.
A value of -1 means that this call should not set access time.]]>
</doc>
</method>
<method name="createSnapshot" return="org.apache.hadoop.fs.Path"
abstract="false" native="false" synchronized="false"
static="false" final="true" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Create a snapshot with a default name.
@param path The directory where snapshots will be taken.
@return the snapshot path.]]>
</doc>
</method>
<method name="createSnapshot" return="org.apache.hadoop.fs.Path"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<param name="snapshotName" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Create a snapshot
@param path The directory where snapshots will be taken.
@param snapshotName The name of the snapshot
@return the snapshot path.]]>
</doc>
</method>
<method name="renameSnapshot"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<param name="snapshotOldName" type="java.lang.String"/>
<param name="snapshotNewName" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Rename a snapshot
@param path The directory path where the snapshot was taken
@param snapshotOldName Old name of the snapshot
@param snapshotNewName New name of the snapshot
@throws IOException]]>
</doc>
</method>
<method name="deleteSnapshot"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<param name="snapshotName" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Delete a snapshot of a directory
@param path The directory that the to-be-deleted snapshot belongs to
@param snapshotName The name of the snapshot]]>
</doc>
</method>
<method name="modifyAclEntries"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<param name="aclSpec" type="java.util.List"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Modifies ACL entries of files and directories. This method can add new ACL
entries or modify the permissions on existing ACL entries. All existing
ACL entries that are not specified in this call are retained without
changes. (Modifications are merged into the current ACL.)
@param path Path to modify
@param aclSpec List<AclEntry> describing modifications
@throws IOException if an ACL could not be modified]]>
</doc>
</method>
<method name="removeAclEntries"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<param name="aclSpec" type="java.util.List"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Removes ACL entries from files and directories. Other ACL entries are
retained.
@param path Path to modify
@param aclSpec List<AclEntry> describing entries to remove
@throws IOException if an ACL could not be modified]]>
</doc>
</method>
<method name="removeDefaultAcl"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Removes all default ACL entries from files and directories.
@param path Path to modify
@throws IOException if an ACL could not be modified]]>
</doc>
</method>
<method name="removeAcl"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Removes all but the base ACL entries of files and directories. The entries
for user, group, and others are retained for compatibility with permission
bits.
@param path Path to modify
@throws IOException if an ACL could not be removed]]>
</doc>
</method>
<method name="setAcl"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<param name="aclSpec" type="java.util.List"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Fully replaces ACL of files and directories, discarding all existing
entries.
@param path Path to modify
@param aclSpec List<AclEntry> describing modifications, must include entries
for user, group, and others for compatibility with permission bits.
@throws IOException if an ACL could not be modified]]>
</doc>
</method>
<method name="getAclStatus" return="org.apache.hadoop.fs.permission.AclStatus"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Gets the ACL of a file or directory.
@param path Path to get
@return AclStatus describing the ACL of the file or directory
@throws IOException if an ACL could not be read]]>
</doc>
</method>
<method name="setXAttr"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<param name="name" type="java.lang.String"/>
<param name="value" type="byte[]"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Set an xattr of a file or directory.
The name must be prefixed with the namespace followed by ".". For example,
"user.attr".
<p/>
Refer to the HDFS extended attributes user documentation for details.
@param path Path to modify
@param name xattr name.
@param value xattr value.
@throws IOException]]>
</doc>
</method>
<method name="setXAttr"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<param name="name" type="java.lang.String"/>
<param name="value" type="byte[]"/>
<param name="flag" type="java.util.EnumSet"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Set an xattr of a file or directory.
The name must be prefixed with the namespace followed by ".". For example,
"user.attr".
<p/>
Refer to the HDFS extended attributes user documentation for details.
@param path Path to modify
@param name xattr name.
@param value xattr value.
@param flag xattr set flag
@throws IOException]]>
</doc>
</method>
<method name="getXAttr" return="byte[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<param name="name" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Get an xattr name and value for a file or directory.
The name must be prefixed with the namespace followed by ".". For example,
"user.attr".
<p/>
Refer to the HDFS extended attributes user documentation for details.
@param path Path to get extended attribute
@param name xattr name.
@return byte[] xattr value.
@throws IOException]]>
</doc>
</method>
<method name="getXAttrs" return="java.util.Map"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Get all of the xattr name/value pairs for a file or directory.
Only those xattrs which the logged-in user has permissions to view
are returned.
<p/>
Refer to the HDFS extended attributes user documentation for details.
@param path Path to get extended attributes
@return Map<String, byte[]> describing the XAttrs of the file or directory
@throws IOException]]>
</doc>
</method>
<method name="getXAttrs" return="java.util.Map"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<param name="names" type="java.util.List"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Get all of the xattrs name/value pairs for a file or directory.
Only those xattrs which the logged-in user has permissions to view
are returned.
<p/>
Refer to the HDFS extended attributes user documentation for details.
@param path Path to get extended attributes
@param names XAttr names.
@return Map<String, byte[]> describing the XAttrs of the file or directory
@throws IOException]]>
</doc>
</method>
<method name="listXAttrs" return="java.util.List"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Get all of the xattr names for a file or directory.
Only those xattr names which the logged-in user has permissions to view
are returned.
<p/>
Refer to the HDFS extended attributes user documentation for details.
@param path Path to get extended attributes
@return List<String> of the XAttr names of the file or directory
@throws IOException]]>
</doc>
</method>
<method name="removeXAttr"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<param name="name" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Remove an xattr of a file or directory.
The name must be prefixed with the namespace followed by ".". For example,
"user.attr".
<p/>
Refer to the HDFS extended attributes user documentation for details.
@param path Path to remove extended attribute
@param name xattr name
@throws IOException]]>
</doc>
</method>
<method name="getFileSystemClass" return="java.lang.Class"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="scheme" type="java.lang.String"/>
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="getStatistics" return="java.util.Map"
abstract="false" native="false" synchronized="true"
static="true" final="false" visibility="public"
deprecated="use {@link #getAllStatistics} instead">
<doc>
<![CDATA[Get the Map of Statistics object indexed by URI Scheme.
@return a Map having a key as URI scheme and value as Statistics object
@deprecated use {@link #getAllStatistics} instead]]>
</doc>
</method>
<method name="getAllStatistics" return="java.util.List"
abstract="false" native="false" synchronized="true"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Return the FileSystem classes that have Statistics]]>
</doc>
</method>
<method name="getStatistics" return="org.apache.hadoop.fs.FileSystem.Statistics"
abstract="false" native="false" synchronized="true"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="scheme" type="java.lang.String"/>
<param name="cls" type="java.lang.Class"/>
<doc>
<![CDATA[Get the statistics for a particular file system
@param cls the class to lookup
@return a statistics object]]>
</doc>
</method>
<method name="clearStatistics"
abstract="false" native="false" synchronized="true"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Reset all statistics for all file systems]]>
</doc>
</method>
<method name="printStatistics"
abstract="false" native="false" synchronized="true"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Print all statistics for all file systems]]>
</doc>
</method>
<method name="areSymlinksEnabled" return="boolean"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="enableSymlinks"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
</method>
<field name="FS_DEFAULT_NAME_KEY" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
</field>
<field name="DEFAULT_FS" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
</field>
<field name="LOG" type="org.apache.commons.logging.Log"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
</field>
<field name="SHUTDOWN_HOOK_PRIORITY" type="int"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Priority of the FileSystem shutdown hook.]]>
</doc>
</field>
<field name="statistics" type="org.apache.hadoop.fs.FileSystem.Statistics"
transient="false" volatile="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<doc>
<![CDATA[The statistics for this file system.]]>
</doc>
</field>
<doc>
<![CDATA[An abstract base class for a fairly generic filesystem. It
may be implemented as a distributed filesystem, or as a "local"
one that reflects the locally-connected disk. The local version
exists for small Hadoop instances and for testing.
<p>
All user code that may potentially use the Hadoop Distributed
File System should be written to use a FileSystem object. The
Hadoop DFS is a multi-machine system that appears as a single
disk. It's useful because of its fault tolerance and potentially
very large capacity.
<p>
The local implementation is {@link LocalFileSystem} and distributed
implementation is DistributedFileSystem.]]>
</doc>
</class>
<!-- end class org.apache.hadoop.fs.FileSystem -->
<!-- start class org.apache.hadoop.fs.FileSystem.Statistics -->
<class name="FileSystem.Statistics" extends="java.lang.Object"
abstract="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<constructor name="FileSystem.Statistics" type="java.lang.String"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<constructor name="FileSystem.Statistics" type="org.apache.hadoop.fs.FileSystem.Statistics"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Copy constructor.
@param other The input Statistics object which is cloned.]]>
</doc>
</constructor>
<method name="getThreadStatistics" return="org.apache.hadoop.fs.FileSystem.Statistics.StatisticsData"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get or create the thread-local data associated with the current thread.]]>
</doc>
</method>
<method name="incrementBytesRead"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="newBytes" type="long"/>
<doc>
<![CDATA[Increment the bytes read in the statistics
@param newBytes the additional bytes read]]>
</doc>
</method>
<method name="incrementBytesWritten"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="newBytes" type="long"/>
<doc>
<![CDATA[Increment the bytes written in the statistics
@param newBytes the additional bytes written]]>
</doc>
</method>
<method name="incrementReadOps"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="count" type="int"/>
<doc>
<![CDATA[Increment the number of read operations
@param count number of read operations]]>
</doc>
</method>
<method name="incrementLargeReadOps"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="count" type="int"/>
<doc>
<![CDATA[Increment the number of large read operations
@param count number of large read operations]]>
</doc>
</method>
<method name="incrementWriteOps"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="count" type="int"/>
<doc>
<![CDATA[Increment the number of write operations
@param count number of write operations]]>
</doc>
</method>
<method name="getBytesRead" return="long"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the total number of bytes read
@return the number of bytes]]>
</doc>
</method>
<method name="getBytesWritten" return="long"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the total number of bytes written
@return the number of bytes]]>
</doc>
</method>
<method name="getReadOps" return="int"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the number of file system read operations such as list files
@return number of read operations]]>
</doc>
</method>
<method name="getLargeReadOps" return="int"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the number of large file system read operations such as list files
under a large directory
@return number of large read operations]]>
</doc>
</method>
<method name="getWriteOps" return="int"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the number of file system write operations such as create, append
rename etc.
@return number of write operations]]>
</doc>
</method>
<method name="toString" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="reset"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Resets all statistics to 0.
In order to reset, we add up all the thread-local statistics data, and
set rootData to the negative of that.
This may seem like a counterintuitive way to reset the statsitics. Why
can't we just zero out all the thread-local data? Well, thread-local
data can only be modified by the thread that owns it. If we tried to
modify the thread-local data from this thread, our modification might get
interleaved with a read-modify-write operation done by the thread that
owns the data. That would result in our update getting lost.
The approach used here avoids this problem because it only ever reads
(not writes) the thread-local data. Both reads and writes to rootData
are done under the lock, so we're free to modify rootData from any thread
that holds the lock.]]>
</doc>
</method>
<method name="getScheme" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the uri scheme associated with this statistics object.
@return the schema associated with this set of statistics]]>
</doc>
</method>
<doc>
<![CDATA[Tracks statistics about how many reads, writes, and so forth have been
done in a FileSystem.
Since there is only one of these objects per FileSystem, there will
typically be many threads writing to this object. Almost every operation
on an open file will involve a write to this object. In contrast, reading
statistics is done infrequently by most programs, and not at all by others.
Hence, this is optimized for writes.
Each thread writes to its own thread-local area of memory. This removes
contention and allows us to scale up to many, many threads. To read
statistics, the reader thread totals up the contents of all of the
thread-local data areas.]]>
</doc>
</class>
<!-- end class org.apache.hadoop.fs.FileSystem.Statistics -->
<!-- start class org.apache.hadoop.fs.FileSystem.Statistics.StatisticsData -->
<class name="FileSystem.Statistics.StatisticsData" extends="java.lang.Object"
abstract="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<method name="toString" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getBytesRead" return="long"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getBytesWritten" return="long"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getReadOps" return="int"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getLargeReadOps" return="int"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getWriteOps" return="int"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<doc>
<![CDATA[Statistics data.
There is only a single writer to thread-local StatisticsData objects.
Hence, volatile is adequate here-- we do not need AtomicLong or similar
to prevent lost updates.
The Java specification guarantees that updates to volatile longs will
be perceived as atomic with respect to other threads, which is all we
need.]]>
</doc>
</class>
<!-- end class org.apache.hadoop.fs.FileSystem.Statistics.StatisticsData -->
<!-- start class org.apache.hadoop.fs.FileUtil -->
<class name="FileUtil" extends="java.lang.Object"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="FileUtil"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="stat2Paths" return="org.apache.hadoop.fs.Path[]"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="stats" type="org.apache.hadoop.fs.FileStatus[]"/>
<doc>
<![CDATA[convert an array of FileStatus to an array of Path
@param stats
an array of FileStatus objects
@return an array of paths corresponding to the input]]>
</doc>
</method>
<method name="stat2Paths" return="org.apache.hadoop.fs.Path[]"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="stats" type="org.apache.hadoop.fs.FileStatus[]"/>
<param name="path" type="org.apache.hadoop.fs.Path"/>
<doc>
<![CDATA[convert an array of FileStatus to an array of Path.
If stats if null, return path
@param stats
an array of FileStatus objects
@param path
default path to return in stats is null
@return an array of paths corresponding to the input]]>
</doc>
</method>
<method name="fullyDelete" return="boolean"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="dir" type="java.io.File"/>
<doc>
<![CDATA[Delete a directory and all its contents. If
we return false, the directory may be partially-deleted.
(1) If dir is symlink to a file, the symlink is deleted. The file pointed
to by the symlink is not deleted.
(2) If dir is symlink to a directory, symlink is deleted. The directory
pointed to by symlink is not deleted.
(3) If dir is a normal file, it is deleted.
(4) If dir is a normal directory, then dir and all its contents recursively
are deleted.]]>
</doc>
</method>
<method name="fullyDelete" return="boolean"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="dir" type="java.io.File"/>
<param name="tryGrantPermissions" type="boolean"/>
<doc>
<![CDATA[Delete a directory and all its contents. If
we return false, the directory may be partially-deleted.
(1) If dir is symlink to a file, the symlink is deleted. The file pointed
to by the symlink is not deleted.
(2) If dir is symlink to a directory, symlink is deleted. The directory
pointed to by symlink is not deleted.
(3) If dir is a normal file, it is deleted.
(4) If dir is a normal directory, then dir and all its contents recursively
are deleted.
@param dir the file or directory to be deleted
@param tryGrantPermissions true if permissions should be modified to delete a file.
@return true on success false on failure.]]>
</doc>
</method>
<method name="readLink" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="java.io.File"/>
<doc>
<![CDATA[Returns the target of the given symlink. Returns the empty string if
the given path does not refer to a symlink or there is an error
accessing the symlink.
@param f File representing the symbolic link.
@return The target of the symbolic link, empty string on error or if not
a symlink.]]>
</doc>
</method>
<method name="fullyDeleteContents" return="boolean"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="dir" type="java.io.File"/>
<doc>
<![CDATA[Delete the contents of a directory, not the directory itself. If
we return false, the directory may be partially-deleted.
If dir is a symlink to a directory, all the contents of the actual
directory pointed to by dir will be deleted.]]>
</doc>
</method>
<method name="fullyDeleteContents" return="boolean"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="dir" type="java.io.File"/>
<param name="tryGrantPermissions" type="boolean"/>
<doc>
<![CDATA[Delete the contents of a directory, not the directory itself. If
we return false, the directory may be partially-deleted.
If dir is a symlink to a directory, all the contents of the actual
directory pointed to by dir will be deleted.
@param tryGrantPermissions if 'true', try grant +rwx permissions to this
and all the underlying directories before trying to delete their contents.]]>
</doc>
</method>
<method name="fullyDelete"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="Use {@link FileSystem#delete(Path, boolean)}">
<param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
<param name="dir" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Recursively delete a directory.
@param fs {@link FileSystem} on which the path is present
@param dir directory to recursively delete
@throws IOException
@deprecated Use {@link FileSystem#delete(Path, boolean)}]]>
</doc>
</method>
<method name="copy" return="boolean"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="srcFS" type="org.apache.hadoop.fs.FileSystem"/>
<param name="src" type="org.apache.hadoop.fs.Path"/>
<param name="dstFS" type="org.apache.hadoop.fs.FileSystem"/>
<param name="dst" type="org.apache.hadoop.fs.Path"/>
<param name="deleteSource" type="boolean"/>
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Copy files between FileSystems.]]>
</doc>
</method>
<method name="copy" return="boolean"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="srcFS" type="org.apache.hadoop.fs.FileSystem"/>
<param name="srcs" type="org.apache.hadoop.fs.Path[]"/>
<param name="dstFS" type="org.apache.hadoop.fs.FileSystem"/>
<param name="dst" type="org.apache.hadoop.fs.Path"/>
<param name="deleteSource" type="boolean"/>
<param name="overwrite" type="boolean"/>
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="copy" return="boolean"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="srcFS" type="org.apache.hadoop.fs.FileSystem"/>
<param name="src" type="org.apache.hadoop.fs.Path"/>
<param name="dstFS" type="org.apache.hadoop.fs.FileSystem"/>
<param name="dst" type="org.apache.hadoop.fs.Path"/>
<param name="deleteSource" type="boolean"/>
<param name="overwrite" type="boolean"/>
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Copy files between FileSystems.]]>
</doc>
</method>
<method name="copy" return="boolean"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="srcFS" type="org.apache.hadoop.fs.FileSystem"/>
<param name="srcStatus" type="org.apache.hadoop.fs.FileStatus"/>
<param name="dstFS" type="org.apache.hadoop.fs.FileSystem"/>
<param name="dst" type="org.apache.hadoop.fs.Path"/>
<param name="deleteSource" type="boolean"/>
<param name="overwrite" type="boolean"/>
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Copy files between FileSystems.]]>
</doc>
</method>
<method name="copyMerge" return="boolean"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="srcFS" type="org.apache.hadoop.fs.FileSystem"/>
<param name="srcDir" type="org.apache.hadoop.fs.Path"/>
<param name="dstFS" type="org.apache.hadoop.fs.FileSystem"/>
<param name="dstFile" type="org.apache.hadoop.fs.Path"/>
<param name="deleteSource" type="boolean"/>
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
<param name="addString" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Copy all files in a directory to one output file (merge).]]>
</doc>
</method>
<method name="copy" return="boolean"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="src" type="java.io.File"/>
<param name="dstFS" type="org.apache.hadoop.fs.FileSystem"/>
<param name="dst" type="org.apache.hadoop.fs.Path"/>
<param name="deleteSource" type="boolean"/>
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Copy local files to a FileSystem.]]>
</doc>
</method>
<method name="copy" return="boolean"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="srcFS" type="org.apache.hadoop.fs.FileSystem"/>
<param name="src" type="org.apache.hadoop.fs.Path"/>
<param name="dst" type="java.io.File"/>
<param name="deleteSource" type="boolean"/>
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Copy FileSystem files to local files.]]>
</doc>
</method>
<method name="makeShellPath" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="filename" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Convert a os-native filename to a path that works for the shell.
@param filename The filename to convert
@return The unix pathname
@throws IOException on windows, there can be problems with the subprocess]]>
</doc>
</method>
<method name="makeShellPath" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="file" type="java.io.File"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Convert a os-native filename to a path that works for the shell.
@param file The filename to convert
@return The unix pathname
@throws IOException on windows, there can be problems with the subprocess]]>
</doc>
</method>
<method name="makeShellPath" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="file" type="java.io.File"/>
<param name="makeCanonicalPath" type="boolean"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Convert a os-native filename to a path that works for the shell.
@param file The filename to convert
@param makeCanonicalPath
Whether to make canonical path for the file passed
@return The unix pathname
@throws IOException on windows, there can be problems with the subprocess]]>
</doc>
</method>
<method name="getDU" return="long"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="dir" type="java.io.File"/>
<doc>
<![CDATA[Takes an input dir and returns the du on that local directory. Very basic
implementation.
@param dir
The input dir to get the disk space of this local dir
@return The total disk space of the input local directory]]>
</doc>
</method>
<method name="unZip"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="inFile" type="java.io.File"/>
<param name="unzipDir" type="java.io.File"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Given a File input it will unzip the file in a the unzip directory
passed as the second parameter
@param inFile The zip file as input
@param unzipDir The unzip directory where to unzip the zip file.
@throws IOException]]>
</doc>
</method>
<method name="unTar"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="inFile" type="java.io.File"/>
<param name="untarDir" type="java.io.File"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Given a Tar File as input it will untar the file in a the untar directory
passed as the second parameter
This utility will untar ".tar" files and ".tar.gz","tgz" files.
@param inFile The tar file as input.
@param untarDir The untar directory where to untar the tar file.
@throws IOException]]>
</doc>
</method>
<method name="symLink" return="int"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="target" type="java.lang.String"/>
<param name="linkname" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Create a soft link between a src and destination
only on a local disk. HDFS does not support this.
On Windows, when symlink creation fails due to security
setting, we will log a warning. The return code in this
case is 2.
@param target the target for symlink
@param linkname the symlink
@return 0 on success]]>
</doc>
</method>
<method name="chmod" return="int"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="filename" type="java.lang.String"/>
<param name="perm" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
<exception name="InterruptedException" type="java.lang.InterruptedException"/>
<doc>
<![CDATA[Change the permissions on a filename.
@param filename the name of the file to change
@param perm the permission string
@return the exit code from the command
@throws IOException
@throws InterruptedException]]>
</doc>
</method>
<method name="chmod" return="int"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="filename" type="java.lang.String"/>
<param name="perm" type="java.lang.String"/>
<param name="recursive" type="boolean"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Change the permissions on a file / directory, recursively, if
needed.
@param filename name of the file whose permissions are to change
@param perm permission string
@param recursive true, if permissions should be changed recursively
@return the exit code from the command.
@throws IOException]]>
</doc>
</method>
<method name="setOwner"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="file" type="java.io.File"/>
<param name="username" type="java.lang.String"/>
<param name="groupname" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Set the ownership on a file / directory. User name and group name
cannot both be null.
@param file the file to change
@param username the new user owner name
@param groupname the new group owner name
@throws IOException]]>
</doc>
</method>
<method name="setReadable" return="boolean"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="java.io.File"/>
<param name="readable" type="boolean"/>
<doc>
<![CDATA[Platform independent implementation for {@link File#setReadable(boolean)}
File#setReadable does not work as expected on Windows.
@param f input file
@param readable
@return true on success, false otherwise]]>
</doc>
</method>
<method name="setWritable" return="boolean"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="java.io.File"/>
<param name="writable" type="boolean"/>
<doc>
<![CDATA[Platform independent implementation for {@link File#setWritable(boolean)}
File#setWritable does not work as expected on Windows.
@param f input file
@param writable
@return true on success, false otherwise]]>
</doc>
</method>
<method name="setExecutable" return="boolean"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="java.io.File"/>
<param name="executable" type="boolean"/>
<doc>
<![CDATA[Platform independent implementation for {@link File#setExecutable(boolean)}
File#setExecutable does not work as expected on Windows.
Note: revoking execute permission on folders does not have the same
behavior on Windows as on Unix platforms. Creating, deleting or renaming
a file within that folder will still succeed on Windows.
@param f input file
@param executable
@return true on success, false otherwise]]>
</doc>
</method>
<method name="canRead" return="boolean"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="java.io.File"/>
<doc>
<![CDATA[Platform independent implementation for {@link File#canRead()}
@param f input file
@return On Unix, same as {@link File#canRead()}
On Windows, true if process has read access on the path]]>
</doc>
</method>
<method name="canWrite" return="boolean"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="java.io.File"/>
<doc>
<![CDATA[Platform independent implementation for {@link File#canWrite()}
@param f input file
@return On Unix, same as {@link File#canWrite()}
On Windows, true if process has write access on the path]]>
</doc>
</method>
<method name="canExecute" return="boolean"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="java.io.File"/>
<doc>
<![CDATA[Platform independent implementation for {@link File#canExecute()}
@param f input file
@return On Unix, same as {@link File#canExecute()}
On Windows, true if process has execute access on the path]]>
</doc>
</method>
<method name="setPermission"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="java.io.File"/>
<param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Set permissions to the required value. Uses the java primitives instead
of forking if group == other.
@param f the file to change
@param permission the new permissions
@throws IOException]]>
</doc>
</method>
<method name="createLocalTempFile" return="java.io.File"
abstract="false" native="false" synchronized="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<param name="basefile" type="java.io.File"/>
<param name="prefix" type="java.lang.String"/>
<param name="isDeleteOnExit" type="boolean"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Create a tmp file for a base file.
@param basefile the base file of the tmp
@param prefix file name prefix of tmp
@param isDeleteOnExit if true, the tmp will be deleted when the VM exits
@return a newly created tmp file
@exception IOException If a tmp file cannot created
@see java.io.File#createTempFile(String, String, File)
@see java.io.File#deleteOnExit()]]>
</doc>
</method>
<method name="replaceFile"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="src" type="java.io.File"/>
<param name="target" type="java.io.File"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Move the src file to the name specified by target.
@param src the source file
@param target the target file
@exception IOException If this operation fails]]>
</doc>
</method>
<method name="listFiles" return="java.io.File[]"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="dir" type="java.io.File"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[A wrapper for {@link File#listFiles()}. This java.io API returns null
when a dir is not a directory or for any I/O error. Instead of having
null check everywhere File#listFiles() is used, we will add utility API
to get around this problem. For the majority of cases where we prefer
an IOException to be thrown.
@param dir directory for which listing should be performed
@return list of files or empty list
@exception IOException for invalid directory or for a bad disk.]]>
</doc>
</method>
<method name="list" return="java.lang.String[]"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="dir" type="java.io.File"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[A wrapper for {@link File#list()}. This java.io API returns null
when a dir is not a directory or for any I/O error. Instead of having
null check everywhere File#list() is used, we will add utility API
to get around this problem. For the majority of cases where we prefer
an IOException to be thrown.
@param dir directory for which listing should be performed
@return list of file names or empty string list
@exception IOException for invalid directory or for a bad disk.]]>
</doc>
</method>
<method name="createJarWithClassPath" return="java.lang.String[]"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="inputClassPath" type="java.lang.String"/>
<param name="pwd" type="org.apache.hadoop.fs.Path"/>
<param name="callerEnv" type="java.util.Map"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="createJarWithClassPath" return="java.lang.String[]"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="inputClassPath" type="java.lang.String"/>
<param name="pwd" type="org.apache.hadoop.fs.Path"/>
<param name="targetDir" type="org.apache.hadoop.fs.Path"/>
<param name="callerEnv" type="java.util.Map"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Create a jar file at the given path, containing a manifest with a classpath
that references all specified entries.
Some platforms may have an upper limit on command line length. For example,
the maximum command line length on Windows is 8191 characters, but the
length of the classpath may exceed this. To work around this limitation,
use this method to create a small intermediate jar with a manifest that
contains the full classpath. It returns the absolute path to the new jar,
which the caller may set as the classpath for a new process.
Environment variable evaluation is not supported within a jar manifest, so
this method expands environment variables before inserting classpath entries
to the manifest. The method parses environment variables according to
platform-specific syntax (%VAR% on Windows, or $VAR otherwise). On Windows,
environment variables are case-insensitive. For example, %VAR% and %var%
evaluate to the same value.
Specifying the classpath in a jar manifest does not support wildcards, so
this method expands wildcards internally. Any classpath entry that ends
with * is translated to all files at that path with extension .jar or .JAR.
@param inputClassPath String input classpath to bundle into the jar manifest
@param pwd Path to working directory to save jar
@param targetDir path to where the jar execution will have its working dir
@param callerEnv Map<String, String> caller's environment variables to use
for expansion
@return String[] with absolute path to new jar in position 0 and
unexpanded wild card entry path in position 1
@throws IOException if there is an I/O error while writing the jar file]]>
</doc>
</method>
<field name="SYMLINK_NO_PRIVILEGE" type="int"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
</field>
<doc>
<![CDATA[A collection of file-processing util methods]]>
</doc>
</class>
<!-- end class org.apache.hadoop.fs.FileUtil -->
<!-- start class org.apache.hadoop.fs.FileUtil.HardLink -->
<class name="FileUtil.HardLink" extends="org.apache.hadoop.fs.HardLink"
abstract="false"
static="true" final="false" visibility="public"
deprecated="Use {@link org.apache.hadoop.fs.HardLink}">
<constructor name="FileUtil.HardLink"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<doc>
<![CDATA[Class for creating hardlinks.
Supports Unix, WindXP.
@deprecated Use {@link org.apache.hadoop.fs.HardLink}]]>
</doc>
</class>
<!-- end class org.apache.hadoop.fs.FileUtil.HardLink -->
<!-- start class org.apache.hadoop.fs.FilterFileSystem -->
<class name="FilterFileSystem" extends="org.apache.hadoop.fs.FileSystem"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="FilterFileSystem"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<constructor name="FilterFileSystem" type="org.apache.hadoop.fs.FileSystem"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="getRawFileSystem" return="org.apache.hadoop.fs.FileSystem"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the raw file system
@return FileSystem being filtered]]>
</doc>
</method>
<method name="initialize"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.net.URI"/>
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Called after a new FileSystem instance is constructed.
@param name a uri whose authority section names the host, port, etc.
for this FileSystem
@param conf the configuration]]>
</doc>
</method>
<method name="getUri" return="java.net.URI"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns a URI whose scheme and authority identify this FileSystem.]]>
</doc>
</method>
<method name="getCanonicalUri" return="java.net.URI"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
</method>
<method name="canonicalizeUri" return="java.net.URI"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="uri" type="java.net.URI"/>
</method>
<method name="makeQualified" return="org.apache.hadoop.fs.Path"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<doc>
<![CDATA[Make sure that a path specifies a FileSystem.]]>
</doc>
</method>
<method name="checkPath"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<doc>
<![CDATA[Check that a Path belongs to this FileSystem.]]>
</doc>
</method>
<method name="getFileBlockLocations" return="org.apache.hadoop.fs.BlockLocation[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="file" type="org.apache.hadoop.fs.FileStatus"/>
<param name="start" type="long"/>
<param name="len" type="long"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="resolvePath" return="org.apache.hadoop.fs.Path"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="p" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="open" return="org.apache.hadoop.fs.FSDataInputStream"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="bufferSize" type="int"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Opens an FSDataInputStream at the indicated Path.
@param f the file name to open
@param bufferSize the size of the buffer to be used.]]>
</doc>
</method>
<method name="append" return="org.apache.hadoop.fs.FSDataOutputStream"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="bufferSize" type="int"/>
<param name="progress" type="org.apache.hadoop.util.Progressable"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="concat"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="psrcs" type="org.apache.hadoop.fs.Path[]"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
<param name="overwrite" type="boolean"/>
<param name="bufferSize" type="int"/>
<param name="replication" type="short"/>
<param name="blockSize" type="long"/>
<param name="progress" type="org.apache.hadoop.util.Progressable"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
<param name="flags" type="java.util.EnumSet"/>
<param name="bufferSize" type="int"/>
<param name="replication" type="short"/>
<param name="blockSize" type="long"/>
<param name="progress" type="org.apache.hadoop.util.Progressable"/>
<param name="checksumOpt" type="org.apache.hadoop.fs.Options.ChecksumOpt"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="createNonRecursive" return="org.apache.hadoop.fs.FSDataOutputStream"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
<param name="flags" type="java.util.EnumSet"/>
<param name="bufferSize" type="int"/>
<param name="replication" type="short"/>
<param name="blockSize" type="long"/>
<param name="progress" type="org.apache.hadoop.util.Progressable"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="setReplication" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="src" type="org.apache.hadoop.fs.Path"/>
<param name="replication" type="short"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Set replication for an existing file.
@param src file name
@param replication new replication
@throws IOException
@return true if successful;
false if file does not exist or is a directory]]>
</doc>
</method>
<method name="rename" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="src" type="org.apache.hadoop.fs.Path"/>
<param name="dst" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Renames Path src to Path dst. Can take place on local fs
or remote DFS.]]>
</doc>
</method>
<method name="delete" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="recursive" type="boolean"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Delete a file]]>
</doc>
</method>
<method name="listStatus" return="org.apache.hadoop.fs.FileStatus[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[List files in a directory.]]>
</doc>
</method>
<method name="listCorruptFileBlocks" return="org.apache.hadoop.fs.RemoteIterator"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="listLocatedStatus" return="org.apache.hadoop.fs.RemoteIterator"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[List files and its block locations in a directory.]]>
</doc>
</method>
<method name="getHomeDirectory" return="org.apache.hadoop.fs.Path"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="setWorkingDirectory"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="newDir" type="org.apache.hadoop.fs.Path"/>
<doc>
<![CDATA[Set the current working directory for the given file system. All relative
paths will be resolved relative to it.
@param newDir]]>
</doc>
</method>
<method name="getWorkingDirectory" return="org.apache.hadoop.fs.Path"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the current working directory for the given file system
@return the directory pathname]]>
</doc>
</method>
<method name="getInitialWorkingDirectory" return="org.apache.hadoop.fs.Path"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
</method>
<method name="getStatus" return="org.apache.hadoop.fs.FsStatus"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="p" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="mkdirs" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="copyFromLocalFile"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="delSrc" type="boolean"/>
<param name="src" type="org.apache.hadoop.fs.Path"/>
<param name="dst" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The src file is on the local disk. Add it to FS at
the given dst name.
delSrc indicates if the source should be removed]]>
</doc>
</method>
<method name="copyFromLocalFile"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="delSrc" type="boolean"/>
<param name="overwrite" type="boolean"/>
<param name="srcs" type="org.apache.hadoop.fs.Path[]"/>
<param name="dst" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The src files are on the local disk. Add it to FS at
the given dst name.
delSrc indicates if the source should be removed]]>
</doc>
</method>
<method name="copyFromLocalFile"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="delSrc" type="boolean"/>
<param name="overwrite" type="boolean"/>
<param name="src" type="org.apache.hadoop.fs.Path"/>
<param name="dst" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The src file is on the local disk. Add it to FS at
the given dst name.
delSrc indicates if the source should be removed]]>
</doc>
</method>
<method name="copyToLocalFile"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="delSrc" type="boolean"/>
<param name="src" type="org.apache.hadoop.fs.Path"/>
<param name="dst" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The src file is under FS, and the dst is on the local disk.
Copy it from FS control to the local dst name.
delSrc indicates if the src will be removed or not.]]>
</doc>
</method>
<method name="startLocalOutput" return="org.apache.hadoop.fs.Path"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="fsOutputFile" type="org.apache.hadoop.fs.Path"/>
<param name="tmpLocalFile" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Returns a local File that the user can write output to. The caller
provides both the eventual FS target name and the local working
file. If the FS is local, we write directly into the target. If
the FS is remote, we write into the tmp local area.]]>
</doc>
</method>
<method name="completeLocalOutput"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="fsOutputFile" type="org.apache.hadoop.fs.Path"/>
<param name="tmpLocalFile" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Called when we're all done writing to the target. A local FS will
do nothing, because we've written to exactly the right place. A remote
FS will copy the contents of tmpLocalFile to the correct target at
fsOutputFile.]]>
</doc>
</method>
<method name="getUsed" return="long"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Return the total size of all files in the filesystem.]]>
</doc>
</method>
<method name="getDefaultBlockSize" return="long"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getDefaultReplication" return="short"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getServerDefaults" return="org.apache.hadoop.fs.FsServerDefaults"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="getDefaultBlockSize" return="long"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
</method>
<method name="getDefaultReplication" return="short"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
</method>
<method name="getServerDefaults" return="org.apache.hadoop.fs.FsServerDefaults"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="getFileStatus" return="org.apache.hadoop.fs.FileStatus"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Get file status.]]>
</doc>
</method>
<method name="access"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<param name="mode" type="org.apache.hadoop.fs.permission.FsAction"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="createSymlink"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="target" type="org.apache.hadoop.fs.Path"/>
<param name="link" type="org.apache.hadoop.fs.Path"/>
<param name="createParent" type="boolean"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileAlreadyExistsException" type="org.apache.hadoop.fs.FileAlreadyExistsException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="ParentNotDirectoryException" type="org.apache.hadoop.fs.ParentNotDirectoryException"/>
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="getFileLinkStatus" return="org.apache.hadoop.fs.FileStatus"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="supportsSymlinks" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getLinkTarget" return="org.apache.hadoop.fs.Path"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="resolveLink" return="org.apache.hadoop.fs.Path"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="getFileChecksum" return="org.apache.hadoop.fs.FileChecksum"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="getFileChecksum" return="org.apache.hadoop.fs.FileChecksum"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="length" type="long"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="setVerifyChecksum"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="verifyChecksum" type="boolean"/>
</method>
<method name="setWriteChecksum"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="writeChecksum" type="boolean"/>
</method>
<method name="getConf" return="org.apache.hadoop.conf.Configuration"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="close"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="setOwner"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="p" type="org.apache.hadoop.fs.Path"/>
<param name="username" type="java.lang.String"/>
<param name="groupname" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="setTimes"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="p" type="org.apache.hadoop.fs.Path"/>
<param name="mtime" type="long"/>
<param name="atime" type="long"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="setPermission"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="p" type="org.apache.hadoop.fs.Path"/>
<param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="primitiveCreate" return="org.apache.hadoop.fs.FSDataOutputStream"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="absolutePermission" type="org.apache.hadoop.fs.permission.FsPermission"/>
<param name="flag" type="java.util.EnumSet"/>
<param name="bufferSize" type="int"/>
<param name="replication" type="short"/>
<param name="blockSize" type="long"/>
<param name="progress" type="org.apache.hadoop.util.Progressable"/>
<param name="checksumOpt" type="org.apache.hadoop.fs.Options.ChecksumOpt"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="primitiveMkdir" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="abdolutePermission" type="org.apache.hadoop.fs.permission.FsPermission"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="getChildFileSystems" return="org.apache.hadoop.fs.FileSystem[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="createSnapshot" return="org.apache.hadoop.fs.Path"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<param name="snapshotName" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="renameSnapshot"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<param name="snapshotOldName" type="java.lang.String"/>
<param name="snapshotNewName" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="deleteSnapshot"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<param name="snapshotName" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="modifyAclEntries"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<param name="aclSpec" type="java.util.List"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="removeAclEntries"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<param name="aclSpec" type="java.util.List"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="removeDefaultAcl"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="removeAcl"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="setAcl"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<param name="aclSpec" type="java.util.List"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="getAclStatus" return="org.apache.hadoop.fs.permission.AclStatus"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="setXAttr"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<param name="name" type="java.lang.String"/>
<param name="value" type="byte[]"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="setXAttr"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<param name="name" type="java.lang.String"/>
<param name="value" type="byte[]"/>
<param name="flag" type="java.util.EnumSet"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="getXAttr" return="byte[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<param name="name" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="getXAttrs" return="java.util.Map"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="getXAttrs" return="java.util.Map"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<param name="names" type="java.util.List"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="listXAttrs" return="java.util.List"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="removeXAttr"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<param name="name" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<field name="fs" type="org.apache.hadoop.fs.FileSystem"
transient="false" volatile="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
</field>
<field name="swapScheme" type="java.lang.String"
transient="false" volatile="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
</field>
<doc>
<![CDATA[A <code>FilterFileSystem</code> contains
some other file system, which it uses as
its basic file system, possibly transforming
the data along the way or providing additional
functionality. The class <code>FilterFileSystem</code>
itself simply overrides all methods of
<code>FileSystem</code> with versions that
pass all requests to the contained file
system. Subclasses of <code>FilterFileSystem</code>
may further override some of these methods
and may also provide additional methods
and fields.]]>
</doc>
</class>
<!-- end class org.apache.hadoop.fs.FilterFileSystem -->
<!-- start interface org.apache.hadoop.fs.FsConstants -->
<interface name="FsConstants" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<field name="LOCAL_FS_URI" type="java.net.URI"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
</field>
<field name="FTP_SCHEME" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
</field>
<field name="MAX_PATH_LINKS" type="int"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
</field>
<field name="VIEWFS_URI" type="java.net.URI"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[ViewFs: viewFs file system (ie the mount file system on client side)]]>
</doc>
</field>
<field name="VIEWFS_SCHEME" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
</field>
<doc>
<![CDATA[FileSystem related constants.]]>
</doc>
</interface>
<!-- end interface org.apache.hadoop.fs.FsConstants -->
<!-- start class org.apache.hadoop.fs.FSDataInputStream -->
<class name="FSDataInputStream" extends="java.io.DataInputStream"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="org.apache.hadoop.fs.Seekable"/>
<implements name="org.apache.hadoop.fs.PositionedReadable"/>
<implements name="org.apache.hadoop.fs.ByteBufferReadable"/>
<implements name="org.apache.hadoop.fs.HasFileDescriptor"/>
<implements name="org.apache.hadoop.fs.CanSetDropBehind"/>
<implements name="org.apache.hadoop.fs.CanSetReadahead"/>
<implements name="org.apache.hadoop.fs.HasEnhancedByteBufferAccess"/>
<constructor name="FSDataInputStream" type="java.io.InputStream"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="seek"
abstract="false" native="false" synchronized="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="desired" type="long"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Seek to the given offset.
@param desired offset to seek to]]>
</doc>
</method>
<method name="getPos" return="long"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Get the current position in the input stream.
@return current position in the input stream]]>
</doc>
</method>
<method name="read" return="int"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="position" type="long"/>
<param name="buffer" type="byte[]"/>
<param name="offset" type="int"/>
<param name="length" type="int"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Read bytes from the given position in the stream to the given buffer.
@param position position in the input stream to seek
@param buffer buffer into which data is read
@param offset offset into the buffer in which data is written
@param length maximum number of bytes to read
@return total number of bytes read into the buffer, or <code>-1</code>
if there is no more data because the end of the stream has been
reached]]>
</doc>
</method>
<method name="readFully"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="position" type="long"/>
<param name="buffer" type="byte[]"/>
<param name="offset" type="int"/>
<param name="length" type="int"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Read bytes from the given position in the stream to the given buffer.
Continues to read until <code>length</code> bytes have been read.
@param position position in the input stream to seek
@param buffer buffer into which data is read
@param offset offset into the buffer in which data is written
@param length the number of bytes to read
@throws EOFException If the end of stream is reached while reading.
If an exception is thrown an undetermined number
of bytes in the buffer may have been written.]]>
</doc>
</method>
<method name="readFully"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="position" type="long"/>
<param name="buffer" type="byte[]"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[See {@link #readFully(long, byte[], int, int)}.]]>
</doc>
</method>
<method name="seekToNewSource" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="targetPos" type="long"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Seek to the given position on an alternate copy of the data.
@param targetPos position to seek to
@return true if a new source is found, false otherwise]]>
</doc>
</method>
<method name="getWrappedStream" return="java.io.InputStream"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get a reference to the wrapped input stream. Used by unit tests.
@return the underlying input stream]]>
</doc>
</method>
<method name="read" return="int"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="buf" type="java.nio.ByteBuffer"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="getFileDescriptor" return="java.io.FileDescriptor"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="setReadahead"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="readahead" type="java.lang.Long"/>
<exception name="IOException" type="java.io.IOException"/>
<exception name="UnsupportedOperationException" type="java.lang.UnsupportedOperationException"/>
</method>
<method name="setDropBehind"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="dropBehind" type="java.lang.Boolean"/>
<exception name="IOException" type="java.io.IOException"/>
<exception name="UnsupportedOperationException" type="java.lang.UnsupportedOperationException"/>
</method>
<method name="read" return="java.nio.ByteBuffer"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="bufferPool" type="org.apache.hadoop.io.ByteBufferPool"/>
<param name="maxLength" type="int"/>
<param name="opts" type="java.util.EnumSet"/>
<exception name="IOException" type="java.io.IOException"/>
<exception name="UnsupportedOperationException" type="java.lang.UnsupportedOperationException"/>
</method>
<method name="read" return="java.nio.ByteBuffer"
abstract="false" native="false" synchronized="false"
static="false" final="true" visibility="public"
deprecated="not deprecated">
<param name="bufferPool" type="org.apache.hadoop.io.ByteBufferPool"/>
<param name="maxLength" type="int"/>
<exception name="IOException" type="java.io.IOException"/>
<exception name="UnsupportedOperationException" type="java.lang.UnsupportedOperationException"/>
</method>
<method name="releaseBuffer"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="buffer" type="java.nio.ByteBuffer"/>
</method>
<doc>
<![CDATA[Utility that wraps a {@link FSInputStream} in a {@link DataInputStream}
and buffers input through a {@link BufferedInputStream}.]]>
</doc>
</class>
<!-- end class org.apache.hadoop.fs.FSDataInputStream -->
<!-- start class org.apache.hadoop.fs.FSDataOutputStream -->
<class name="FSDataOutputStream" extends="java.io.DataOutputStream"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="org.apache.hadoop.fs.Syncable"/>
<implements name="org.apache.hadoop.fs.CanSetDropBehind"/>
<constructor name="FSDataOutputStream" type="java.io.OutputStream"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<exception name="IOException" type="java.io.IOException"/>
</constructor>
<constructor name="FSDataOutputStream" type="java.io.OutputStream, org.apache.hadoop.fs.FileSystem.Statistics"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<exception name="IOException" type="java.io.IOException"/>
</constructor>
<constructor name="FSDataOutputStream" type="java.io.OutputStream, org.apache.hadoop.fs.FileSystem.Statistics, long"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<exception name="IOException" type="java.io.IOException"/>
</constructor>
<method name="getPos" return="long"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Get the current position in the output stream.
@return the current position in the output stream]]>
</doc>
</method>
<method name="close"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Close the underlying output stream.]]>
</doc>
</method>
<method name="getWrappedStream" return="java.io.OutputStream"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get a reference to the wrapped output stream.
@return the underlying output stream]]>
</doc>
</method>
<method name="sync"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="hflush"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="hsync"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="setDropBehind"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="dropBehind" type="java.lang.Boolean"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<doc>
<![CDATA[Utility that wraps a {@link OutputStream} in a {@link DataOutputStream}.]]>
</doc>
</class>
<!-- end class org.apache.hadoop.fs.FSDataOutputStream -->
<!-- start class org.apache.hadoop.fs.FSError -->
<class name="FSError" extends="java.lang.Error"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Thrown for unexpected filesystem errors, presumed to reflect disk errors
in the native filesystem.]]>
</doc>
</class>
<!-- end class org.apache.hadoop.fs.FSError -->
<!-- start class org.apache.hadoop.fs.FSExceptionMessages -->
<class name="FSExceptionMessages" extends="java.lang.Object"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="FSExceptionMessages"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<field name="STREAM_IS_CLOSED" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[The operation failed because the stream is closed: {@value}]]>
</doc>
</field>
<field name="NEGATIVE_SEEK" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Negative offset seek forbidden : {@value}]]>
</doc>
</field>
<field name="CANNOT_SEEK_PAST_EOF" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Seeks : {@value}]]>
</doc>
</field>
<doc>
<![CDATA[Standard strings to use in exception messages in filesystems
HDFS is used as the reference source of the strings]]>
</doc>
</class>
<!-- end class org.apache.hadoop.fs.FSExceptionMessages -->
<!-- start class org.apache.hadoop.fs.FsServerDefaults -->
<class name="FsServerDefaults" extends="java.lang.Object"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="org.apache.hadoop.io.Writable"/>
<constructor name="FsServerDefaults"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<constructor name="FsServerDefaults" type="long, int, int, short, int, boolean, long, org.apache.hadoop.util.DataChecksum.Type"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="getBlockSize" return="long"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getBytesPerChecksum" return="int"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getWritePacketSize" return="int"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getReplication" return="short"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getFileBufferSize" return="int"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getEncryptDataTransfer" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getTrashInterval" return="long"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getChecksumType" return="org.apache.hadoop.util.DataChecksum.Type"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="write"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="out" type="java.io.DataOutput"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="readFields"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="in" type="java.io.DataInput"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<doc>
<![CDATA[Provides server default configuration values to clients.]]>
</doc>
</class>
<!-- end class org.apache.hadoop.fs.FsServerDefaults -->
<!-- start class org.apache.hadoop.fs.FsShell.Help -->
<class name="FsShell.Help" extends="org.apache.hadoop.fs.shell.FsCommand"
abstract="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<constructor name="FsShell.Help"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
</constructor>
<method name="processRawArguments"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="args" type="java.util.LinkedList"/>
</method>
<field name="NAME" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
</field>
<field name="USAGE" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
</field>
<field name="DESCRIPTION" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
</field>
<doc>
<![CDATA[Displays short usage of commands sans the long description]]>
</doc>
</class>
<!-- end class org.apache.hadoop.fs.FsShell.Help -->
<!-- start class org.apache.hadoop.fs.FsShell.Usage -->
<class name="FsShell.Usage" extends="org.apache.hadoop.fs.shell.FsCommand"
abstract="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<constructor name="FsShell.Usage"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
</constructor>
<method name="processRawArguments"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="args" type="java.util.LinkedList"/>
</method>
<field name="NAME" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
</field>
<field name="USAGE" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
</field>
<field name="DESCRIPTION" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
</field>
<doc>
<![CDATA[Display help for commands with their short usage and long description]]>
</doc>
</class>
<!-- end class org.apache.hadoop.fs.FsShell.Usage -->
<!-- start class org.apache.hadoop.fs.FsShellPermissions.Chgrp -->
<class name="FsShellPermissions.Chgrp" extends="org.apache.hadoop.fs.FsShellPermissions.Chown"
abstract="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="FsShellPermissions.Chgrp"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="parseOwnerGroup"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="groupStr" type="java.lang.String"/>
</method>
<field name="NAME" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
</field>
<field name="USAGE" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
</field>
<field name="DESCRIPTION" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
</field>
<doc>
<![CDATA[Used to change group of files]]>
</doc>
</class>
<!-- end class org.apache.hadoop.fs.FsShellPermissions.Chgrp -->
<!-- start class org.apache.hadoop.fs.FsShellPermissions.Chmod -->
<class name="FsShellPermissions.Chmod" extends="org.apache.hadoop.fs.FsShellPermissions"
abstract="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="FsShellPermissions.Chmod"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="processOptions"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="args" type="java.util.LinkedList"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="processPath"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="item" type="org.apache.hadoop.fs.shell.PathData"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<field name="NAME" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
</field>
<field name="USAGE" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
</field>
<field name="DESCRIPTION" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
</field>
<field name="pp" type="org.apache.hadoop.fs.permission.ChmodParser"
transient="false" volatile="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
</field>
<doc>
<![CDATA[The pattern is almost as flexible as mode allowed by chmod shell command.
The main restriction is that we recognize only rwxXt. To reduce errors we
also enforce octal mode specifications of either 3 digits without a sticky
bit setting or four digits with a sticky bit setting.]]>
</doc>
</class>
<!-- end class org.apache.hadoop.fs.FsShellPermissions.Chmod -->
<!-- start class org.apache.hadoop.fs.FsShellPermissions.Chown -->
<class name="FsShellPermissions.Chown" extends="org.apache.hadoop.fs.FsShellPermissions"
abstract="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="FsShellPermissions.Chown"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="processOptions"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="args" type="java.util.LinkedList"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="parseOwnerGroup"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="ownerStr" type="java.lang.String"/>
<doc>
<![CDATA[Parse the first argument into an owner and group
@param ownerStr string describing new ownership]]>
</doc>
</method>
<method name="processPath"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="item" type="org.apache.hadoop.fs.shell.PathData"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<field name="NAME" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
</field>
<field name="USAGE" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
</field>
<field name="DESCRIPTION" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
</field>
<field name="owner" type="java.lang.String"
transient="false" volatile="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
</field>
<field name="group" type="java.lang.String"
transient="false" volatile="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
</field>
<doc>
<![CDATA[Used to change owner and/or group of files]]>
</doc>
</class>
<!-- end class org.apache.hadoop.fs.FsShellPermissions.Chown -->
<!-- start class org.apache.hadoop.fs.FsStatus -->
<class name="FsStatus" extends="java.lang.Object"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="org.apache.hadoop.io.Writable"/>
<constructor name="FsStatus" type="long, long, long"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Construct a FsStatus object, using the specified statistics]]>
</doc>
</constructor>
<method name="getCapacity" return="long"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Return the capacity in bytes of the file system]]>
</doc>
</method>
<method name="getUsed" return="long"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Return the number of bytes used on the file system]]>
</doc>
</method>
<method name="getRemaining" return="long"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Return the number of remaining bytes on the file system]]>
</doc>
</method>
<method name="write"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="out" type="java.io.DataOutput"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="readFields"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="in" type="java.io.DataInput"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<doc>
<![CDATA[This class is used to represent the capacity, free and used space on a
{@link FileSystem}.]]>
</doc>
</class>
<!-- end class org.apache.hadoop.fs.FsStatus -->
<!-- start class org.apache.hadoop.fs.GlobFilter -->
<class name="GlobFilter" extends="java.lang.Object"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="org.apache.hadoop.fs.PathFilter"/>
<constructor name="GlobFilter" type="java.lang.String"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Creates a glob filter with the specified file pattern.
@param filePattern the file pattern.
@throws IOException thrown if the file pattern is incorrect.]]>
</doc>
</constructor>
<constructor name="GlobFilter" type="java.lang.String, org.apache.hadoop.fs.PathFilter"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Creates a glob filter with the specified file pattern and an user filter.
@param filePattern the file pattern.
@param filter user filter in addition to the glob pattern.
@throws IOException thrown if the file pattern is incorrect.]]>
</doc>
</constructor>
<method name="accept" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
</method>
<doc>
<![CDATA[A filter for POSIX glob pattern with brace expansions.]]>
</doc>
</class>
<!-- end class org.apache.hadoop.fs.GlobFilter -->
<!-- start class org.apache.hadoop.fs.HardLink -->
<class name="HardLink" extends="java.lang.Object"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="HardLink"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="getLinkMultArgLength" return="int"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="protected"
deprecated="not deprecated">
<param name="fileDir" type="java.io.File"/>
<param name="fileBaseNames" type="java.lang.String[]"/>
<param name="linkDir" type="java.io.File"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Calculate the nominal length of all contributors to the total
commandstring length, including fixed overhead of the OS-dependent
command. It's protected rather than private, to assist unit testing,
but real clients are not expected to need it -- see the way
createHardLinkMult() uses it internally so the user doesn't need to worry
about it.
@param fileDir - source directory, parent of fileBaseNames
@param fileBaseNames - array of path-less file names, relative
to the source directory
@param linkDir - target directory where the hardlinks will be put
@return - total data length (must not exceed maxAllowedCmdArgLength)
@throws IOException]]>
</doc>
</method>
<method name="getMaxAllowedCmdArgLength" return="int"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="protected"
deprecated="not deprecated">
<doc>
<![CDATA[Return this private value for use by unit tests.
Shell commands are not allowed to have a total string length
exceeding this size.]]>
</doc>
</method>
<method name="createHardLink"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="file" type="java.io.File"/>
<param name="linkName" type="java.io.File"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Creates a hardlink
@param file - existing source file
@param linkName - desired target link file]]>
</doc>
</method>
<method name="createHardLinkMult"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="parentDir" type="java.io.File"/>
<param name="fileBaseNames" type="java.lang.String[]"/>
<param name="linkDir" type="java.io.File"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Creates hardlinks from multiple existing files within one parent
directory, into one target directory.
@param parentDir - directory containing source files
@param fileBaseNames - list of path-less file names, as returned by
parentDir.list()
@param linkDir - where the hardlinks should be put. It must already exist.
If the list of files is too long (overflows maxAllowedCmdArgLength),
we will automatically split it into multiple invocations of the
underlying method.]]>
</doc>
</method>
<method name="createHardLinkMult" return="int"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="protected"
deprecated="not deprecated">
<param name="parentDir" type="java.io.File"/>
<param name="fileBaseNames" type="java.lang.String[]"/>
<param name="linkDir" type="java.io.File"/>
<param name="maxLength" type="int"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="getLinkCount" return="int"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="fileName" type="java.io.File"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Retrieves the number of links to the specified file.]]>
</doc>
</method>
<field name="linkStats" type="org.apache.hadoop.fs.HardLink.LinkStats"
transient="false" volatile="false"
static="false" final="true" visibility="public"
deprecated="not deprecated">
</field>
<doc>
<![CDATA[Class for creating hardlinks.
Supports Unix/Linux, Windows via winutils , and Mac OS X.
The HardLink class was formerly a static inner class of FSUtil,
and the methods provided were blatantly non-thread-safe.
To enable volume-parallel Update snapshots, we now provide static
threadsafe methods that allocate new buffer string arrays
upon each call. We also provide an API to hardlink all files in a
directory with a single command, which is up to 128 times more
efficient - and minimizes the impact of the extra buffer creations.]]>
</doc>
</class>
<!-- end class org.apache.hadoop.fs.HardLink -->
<!-- start class org.apache.hadoop.fs.HardLink.LinkStats -->
<class name="HardLink.LinkStats" extends="java.lang.Object"
abstract="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="HardLink.LinkStats"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="clear"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="report" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<field name="countDirs" type="int"
transient="false" volatile="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</field>
<field name="countSingleLinks" type="int"
transient="false" volatile="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</field>
<field name="countMultLinks" type="int"
transient="false" volatile="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</field>
<field name="countFilesMultLinks" type="int"
transient="false" volatile="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</field>
<field name="countEmptyDirs" type="int"
transient="false" volatile="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</field>
<field name="countPhysicalFileCopies" type="int"
transient="false" volatile="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</field>
<doc>
<![CDATA[HardLink statistics counters and methods.
Not multi-thread safe, obviously.
Init is called during HardLink instantiation, above.
These are intended for use by knowledgeable clients, not internally,
because many of the internal methods are static and can't update these
per-instance counters.]]>
</doc>
</class>
<!-- end class org.apache.hadoop.fs.HardLink.LinkStats -->
<!-- start class org.apache.hadoop.fs.HarFileSystem -->
<class name="HarFileSystem" extends="org.apache.hadoop.fs.FileSystem"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="HarFileSystem"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[public construction of harfilesystem]]>
</doc>
</constructor>
<constructor name="HarFileSystem" type="org.apache.hadoop.fs.FileSystem"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Constructor to create a HarFileSystem with an
underlying filesystem.
@param fs underlying file system]]>
</doc>
</constructor>
<method name="getScheme" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Return the protocol scheme for the FileSystem.
<p/>
@return <code>har</code>]]>
</doc>
</method>
<method name="initialize"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.net.URI"/>
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Initialize a Har filesystem per har archive. The
archive home directory is the top level directory
in the filesystem that contains the HAR archive.
Be careful with this method, you do not want to go
on creating new Filesystem instances per call to
path.getFileSystem().
the uri of Har is
har://underlyingfsscheme-host:port/archivepath.
or
har:///archivepath. This assumes the underlying filesystem
to be used in case not specified.]]>
</doc>
</method>
<method name="getConf" return="org.apache.hadoop.conf.Configuration"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getHarVersion" return="int"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="getWorkingDirectory" return="org.apache.hadoop.fs.Path"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[return the top level archive.]]>
</doc>
</method>
<method name="getInitialWorkingDirectory" return="org.apache.hadoop.fs.Path"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getStatus" return="org.apache.hadoop.fs.FsStatus"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="p" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="getCanonicalUri" return="java.net.URI"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<doc>
<![CDATA[Used for delegation token related functionality. Must delegate to
underlying file system.]]>
</doc>
</method>
<method name="canonicalizeUri" return="java.net.URI"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="uri" type="java.net.URI"/>
</method>
<method name="getUri" return="java.net.URI"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns the uri of this filesystem.
The uri is of the form
har://underlyingfsschema-host:port/pathintheunderlyingfs]]>
</doc>
</method>
<method name="checkPath"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
</method>
<method name="resolvePath" return="org.apache.hadoop.fs.Path"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="p" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="makeQualified" return="org.apache.hadoop.fs.Path"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
</method>
<method name="getFileBlockLocations" return="org.apache.hadoop.fs.BlockLocation[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="file" type="org.apache.hadoop.fs.FileStatus"/>
<param name="start" type="long"/>
<param name="len" type="long"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Get block locations from the underlying fs and fix their
offsets and lengths.
@param file the input file status to get block locations
@param start the start of the desired range in the contained file
@param len the length of the desired range
@return block locations for this segment of file
@throws IOException]]>
</doc>
</method>
<method name="getHarHash" return="int"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="p" type="org.apache.hadoop.fs.Path"/>
<doc>
<![CDATA[the hash of the path p inside the filesystem
@param p the path in the harfilesystem
@return the hash code of the path.]]>
</doc>
</method>
<method name="getFileStatus" return="org.apache.hadoop.fs.FileStatus"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[return the filestatus of files in har archive.
The permission returned are that of the archive
index files. The permissions are not persisted
while creating a hadoop archive.
@param f the path in har filesystem
@return filestatus.
@throws IOException]]>
</doc>
</method>
<method name="getFileChecksum" return="org.apache.hadoop.fs.FileChecksum"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="length" type="long"/>
<doc>
<![CDATA[@return null since no checksum algorithm is implemented.]]>
</doc>
</method>
<method name="open" return="org.apache.hadoop.fs.FSDataInputStream"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">