001    /**
002     * Licensed to the Apache Software Foundation (ASF) under one
003     * or more contributor license agreements.  See the NOTICE file
004     * distributed with this work for additional information
005     * regarding copyright ownership.  The ASF licenses this file
006     * to you under the Apache License, Version 2.0 (the
007     * "License"); you may not use this file except in compliance
008     * with the License.  You may obtain a copy of the License at
009     *
010     *     http://www.apache.org/licenses/LICENSE-2.0
011     *
012     * Unless required by applicable law or agreed to in writing, software
013     * distributed under the License is distributed on an "AS IS" BASIS,
014     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015     * See the License for the specific language governing permissions and
016     * limitations under the License.
017     */
018    
019    package org.apache.hadoop.fs;
020    
021    import org.apache.hadoop.classification.InterfaceAudience;
022    
023    /** 
024     * This class contains constants for configuration keys used
025     * in the common code.
026     *
027     * It includes all publicly documented configuration keys. In general
028     * this class should not be used directly (use CommonConfigurationKeys
029     * instead)
030     *
031     */
032    
033    @InterfaceAudience.Public
034    public class CommonConfigurationKeysPublic {
035      
036      // The Keys
037      /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
038      public static final String  IO_NATIVE_LIB_AVAILABLE_KEY =
039        "io.native.lib.available";
040      /** Default value for IO_NATIVE_LIB_AVAILABLE_KEY */
041      public static final boolean IO_NATIVE_LIB_AVAILABLE_DEFAULT = true;
042      /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
043      public static final String  NET_TOPOLOGY_SCRIPT_NUMBER_ARGS_KEY =
044        "net.topology.script.number.args";
045      /** Default value for NET_TOPOLOGY_SCRIPT_NUMBER_ARGS_KEY */
046      public static final int     NET_TOPOLOGY_SCRIPT_NUMBER_ARGS_DEFAULT = 100;
047    
048      //FS keys
049      /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
050      public static final String  FS_DEFAULT_NAME_KEY = "fs.defaultFS";
051      /** Default value for FS_DEFAULT_NAME_KEY */
052      public static final String  FS_DEFAULT_NAME_DEFAULT = "file:///";
053      /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
054      public static final String  FS_DF_INTERVAL_KEY = "fs.df.interval"; 
055      /** Default value for FS_DF_INTERVAL_KEY */
056      public static final long    FS_DF_INTERVAL_DEFAULT = 60000;
057    
058    
059      //Defaults are not specified for following keys
060      /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
061      public static final String  NET_TOPOLOGY_SCRIPT_FILE_NAME_KEY =
062        "net.topology.script.file.name";
063      /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
064      public static final String  NET_TOPOLOGY_NODE_SWITCH_MAPPING_IMPL_KEY =
065        "net.topology.node.switch.mapping.impl";
066    
067      /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
068      public static final String  FS_TRASH_CHECKPOINT_INTERVAL_KEY =
069        "fs.trash.checkpoint.interval";
070      /** Default value for FS_TRASH_CHECKPOINT_INTERVAL_KEY */
071      public static final long    FS_TRASH_CHECKPOINT_INTERVAL_DEFAULT = 0;
072    
073      // TBD: Code is still using hardcoded values (e.g. "fs.automatic.close")
074      // instead of constant (e.g. FS_AUTOMATIC_CLOSE_KEY)
075      //
076      /** Not used anywhere, looks like default value for FS_LOCAL_BLOCK_SIZE */
077      public static final long    FS_LOCAL_BLOCK_SIZE_DEFAULT = 32*1024*1024;
078      /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
079      public static final String  FS_AUTOMATIC_CLOSE_KEY = "fs.automatic.close";
080      /** Default value for FS_AUTOMATIC_CLOSE_KEY */
081      public static final boolean FS_AUTOMATIC_CLOSE_DEFAULT = true;
082      /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
083      public static final String  FS_FILE_IMPL_KEY = "fs.file.impl";
084      /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
085      public static final String  FS_FTP_HOST_KEY = "fs.ftp.host";
086      /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
087      public static final String  FS_FTP_HOST_PORT_KEY = "fs.ftp.host.port";
088      /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
089      public static final String  FS_TRASH_INTERVAL_KEY = "fs.trash.interval";
090      /** Default value for FS_TRASH_INTERVAL_KEY */
091      public static final long    FS_TRASH_INTERVAL_DEFAULT = 0;
092    
093      /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
094      public static final String  IO_MAPFILE_BLOOM_SIZE_KEY =
095        "io.mapfile.bloom.size";
096      /** Default value for IO_MAPFILE_BLOOM_SIZE_KEY */
097      public static final int     IO_MAPFILE_BLOOM_SIZE_DEFAULT = 1024*1024;
098      /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
099      public static final String  IO_MAPFILE_BLOOM_ERROR_RATE_KEY =
100        "io.mapfile.bloom.error.rate" ;
101      /** Default value for IO_MAPFILE_BLOOM_ERROR_RATE_KEY */
102      public static final float   IO_MAPFILE_BLOOM_ERROR_RATE_DEFAULT = 0.005f;
103      /** Codec class that implements Lzo compression algorithm */
104      public static final String  IO_COMPRESSION_CODEC_LZO_CLASS_KEY =
105        "io.compression.codec.lzo.class";
106      /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
107      public static final String  IO_MAP_INDEX_INTERVAL_KEY =
108        "io.map.index.interval";
109      /** Default value for IO_MAP_INDEX_INTERVAL_DEFAULT */
110      public static final int     IO_MAP_INDEX_INTERVAL_DEFAULT = 128;
111      /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
112      public static final String  IO_MAP_INDEX_SKIP_KEY = "io.map.index.skip";
113      /** Default value for IO_MAP_INDEX_SKIP_KEY */
114      public static final int     IO_MAP_INDEX_SKIP_DEFAULT = 0;
115      /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
116      public static final String  IO_SEQFILE_COMPRESS_BLOCKSIZE_KEY =
117        "io.seqfile.compress.blocksize";
118      /** Default value for IO_SEQFILE_COMPRESS_BLOCKSIZE_KEY */
119      public static final int     IO_SEQFILE_COMPRESS_BLOCKSIZE_DEFAULT = 1000000;
120      /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
121      public static final String  IO_FILE_BUFFER_SIZE_KEY =
122        "io.file.buffer.size";
123      /** Default value for IO_FILE_BUFFER_SIZE_KEY */
124      public static final int     IO_FILE_BUFFER_SIZE_DEFAULT = 4096;
125      /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
126      public static final String  IO_SKIP_CHECKSUM_ERRORS_KEY =
127        "io.skip.checksum.errors";
128      /** Default value for IO_SKIP_CHECKSUM_ERRORS_KEY */
129      public static final boolean IO_SKIP_CHECKSUM_ERRORS_DEFAULT = false;
130      /**
131       * @deprecated Moved to mapreduce, see mapreduce.task.io.sort.mb
132       * in mapred-default.xml
133       * See https://issues.apache.org/jira/browse/HADOOP-6801
134       */
135      public static final String  IO_SORT_MB_KEY = "io.sort.mb";
136      /** Default value for IO_SORT_MB_DEFAULT */
137      public static final int     IO_SORT_MB_DEFAULT = 100;
138      /**
139       * @deprecated Moved to mapreduce, see mapreduce.task.io.sort.factor
140       * in mapred-default.xml
141       * See https://issues.apache.org/jira/browse/HADOOP-6801
142       */
143      public static final String  IO_SORT_FACTOR_KEY = "io.sort.factor";
144      /** Default value for IO_SORT_FACTOR_DEFAULT */
145      public static final int     IO_SORT_FACTOR_DEFAULT = 100;
146      /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
147      public static final String  IO_SERIALIZATIONS_KEY = "io.serializations";
148    
149      /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
150      public static final String  TFILE_IO_CHUNK_SIZE_KEY = "tfile.io.chunk.size";
151      /** Default value for TFILE_IO_CHUNK_SIZE_DEFAULT */
152      public static final int     TFILE_IO_CHUNK_SIZE_DEFAULT = 1024*1024;
153      /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
154      public static final String  TFILE_FS_INPUT_BUFFER_SIZE_KEY =
155        "tfile.fs.input.buffer.size";
156      /** Default value for TFILE_FS_INPUT_BUFFER_SIZE_KEY */
157      public static final int     TFILE_FS_INPUT_BUFFER_SIZE_DEFAULT = 256*1024;
158      /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
159      public static final String  TFILE_FS_OUTPUT_BUFFER_SIZE_KEY =
160        "tfile.fs.output.buffer.size";
161      /** Default value for TFILE_FS_OUTPUT_BUFFER_SIZE_KEY */
162      public static final int     TFILE_FS_OUTPUT_BUFFER_SIZE_DEFAULT = 256*1024;
163    
164      /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
165      public static final String  IPC_CLIENT_CONNECTION_MAXIDLETIME_KEY =
166        "ipc.client.connection.maxidletime";
167      /** Default value for IPC_CLIENT_CONNECTION_MAXIDLETIME_KEY */
168      public static final int     IPC_CLIENT_CONNECTION_MAXIDLETIME_DEFAULT = 10000; // 10s
169      /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
170      public static final String  IPC_CLIENT_CONNECT_MAX_RETRIES_KEY =
171        "ipc.client.connect.max.retries";
172      /** Default value for IPC_CLIENT_CONNECT_MAX_RETRIES_KEY */
173      public static final int     IPC_CLIENT_CONNECT_MAX_RETRIES_DEFAULT = 10;
174      /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
175      public static final String  IPC_CLIENT_TCPNODELAY_KEY =
176        "ipc.client.tcpnodelay";
177      /** Defalt value for IPC_CLIENT_TCPNODELAY_KEY */
178      public static final boolean IPC_CLIENT_TCPNODELAY_DEFAULT = false;
179      /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
180      public static final String  IPC_SERVER_LISTEN_QUEUE_SIZE_KEY =
181        "ipc.server.listen.queue.size";
182      /** Default value for IPC_SERVER_LISTEN_QUEUE_SIZE_KEY */
183      public static final int     IPC_SERVER_LISTEN_QUEUE_SIZE_DEFAULT = 128;
184      /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
185      public static final String  IPC_CLIENT_KILL_MAX_KEY = "ipc.client.kill.max";
186      /** Default value for IPC_CLIENT_KILL_MAX_KEY */
187      public static final int     IPC_CLIENT_KILL_MAX_DEFAULT = 10;
188      /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
189      public static final String  IPC_CLIENT_IDLETHRESHOLD_KEY =
190        "ipc.client.idlethreshold";
191      /** Default value for IPC_CLIENT_IDLETHRESHOLD_DEFAULT */
192      public static final int     IPC_CLIENT_IDLETHRESHOLD_DEFAULT = 4000;
193      /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
194      public static final String  IPC_SERVER_TCPNODELAY_KEY =
195        "ipc.server.tcpnodelay";
196      /** Default value for IPC_SERVER_TCPNODELAY_KEY */
197      public static final boolean IPC_SERVER_TCPNODELAY_DEFAULT = false;
198    
199      /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
200      public static final String  HADOOP_RPC_SOCKET_FACTORY_CLASS_DEFAULT_KEY =
201        "hadoop.rpc.socket.factory.class.default";
202      /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
203      public static final String  HADOOP_SOCKS_SERVER_KEY = "hadoop.socks.server";
204      /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
205      public static final String  HADOOP_UTIL_HASH_TYPE_KEY =
206        "hadoop.util.hash.type";
207      /** Default value for HADOOP_UTIL_HASH_TYPE_KEY */
208      public static final String  HADOOP_UTIL_HASH_TYPE_DEFAULT = "murmur";
209      /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
210      public static final String  HADOOP_SECURITY_GROUP_MAPPING =
211        "hadoop.security.group.mapping";
212      /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
213      public static final String  HADOOP_SECURITY_GROUPS_CACHE_SECS =
214        "hadoop.security.groups.cache.secs";
215      /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
216      public static final String  HADOOP_SECURITY_AUTHENTICATION =
217        "hadoop.security.authentication";
218      /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
219      public static final String HADOOP_SECURITY_AUTHORIZATION =
220        "hadoop.security.authorization";
221      /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
222      public static final String  HADOOP_SECURITY_SERVICE_USER_NAME_KEY =
223        "hadoop.security.service.user.name.key";
224    }
225