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 NET_TOPOLOGY_TABLE_MAPPING_FILE_KEY =
069 "net.topology.table.file.name";
070
071 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
072 public static final String FS_TRASH_CHECKPOINT_INTERVAL_KEY =
073 "fs.trash.checkpoint.interval";
074 /** Default value for FS_TRASH_CHECKPOINT_INTERVAL_KEY */
075 public static final long FS_TRASH_CHECKPOINT_INTERVAL_DEFAULT = 0;
076
077 // TBD: Code is still using hardcoded values (e.g. "fs.automatic.close")
078 // instead of constant (e.g. FS_AUTOMATIC_CLOSE_KEY)
079 //
080 /** Not used anywhere, looks like default value for FS_LOCAL_BLOCK_SIZE */
081 public static final long FS_LOCAL_BLOCK_SIZE_DEFAULT = 32*1024*1024;
082 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
083 public static final String FS_AUTOMATIC_CLOSE_KEY = "fs.automatic.close";
084 /** Default value for FS_AUTOMATIC_CLOSE_KEY */
085 public static final boolean FS_AUTOMATIC_CLOSE_DEFAULT = true;
086 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
087 public static final String FS_FILE_IMPL_KEY = "fs.file.impl";
088 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
089 public static final String FS_FTP_HOST_KEY = "fs.ftp.host";
090 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
091 public static final String FS_FTP_HOST_PORT_KEY = "fs.ftp.host.port";
092 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
093 public static final String FS_TRASH_INTERVAL_KEY = "fs.trash.interval";
094 /** Default value for FS_TRASH_INTERVAL_KEY */
095 public static final long FS_TRASH_INTERVAL_DEFAULT = 0;
096
097 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
098 public static final String IO_MAPFILE_BLOOM_SIZE_KEY =
099 "io.mapfile.bloom.size";
100 /** Default value for IO_MAPFILE_BLOOM_SIZE_KEY */
101 public static final int IO_MAPFILE_BLOOM_SIZE_DEFAULT = 1024*1024;
102 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
103 public static final String IO_MAPFILE_BLOOM_ERROR_RATE_KEY =
104 "io.mapfile.bloom.error.rate" ;
105 /** Default value for IO_MAPFILE_BLOOM_ERROR_RATE_KEY */
106 public static final float IO_MAPFILE_BLOOM_ERROR_RATE_DEFAULT = 0.005f;
107 /** Codec class that implements Lzo compression algorithm */
108 public static final String IO_COMPRESSION_CODEC_LZO_CLASS_KEY =
109 "io.compression.codec.lzo.class";
110 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
111 public static final String IO_MAP_INDEX_INTERVAL_KEY =
112 "io.map.index.interval";
113 /** Default value for IO_MAP_INDEX_INTERVAL_DEFAULT */
114 public static final int IO_MAP_INDEX_INTERVAL_DEFAULT = 128;
115 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
116 public static final String IO_MAP_INDEX_SKIP_KEY = "io.map.index.skip";
117 /** Default value for IO_MAP_INDEX_SKIP_KEY */
118 public static final int IO_MAP_INDEX_SKIP_DEFAULT = 0;
119 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
120 public static final String IO_SEQFILE_COMPRESS_BLOCKSIZE_KEY =
121 "io.seqfile.compress.blocksize";
122 /** Default value for IO_SEQFILE_COMPRESS_BLOCKSIZE_KEY */
123 public static final int IO_SEQFILE_COMPRESS_BLOCKSIZE_DEFAULT = 1000000;
124 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
125 public static final String IO_FILE_BUFFER_SIZE_KEY =
126 "io.file.buffer.size";
127 /** Default value for IO_FILE_BUFFER_SIZE_KEY */
128 public static final int IO_FILE_BUFFER_SIZE_DEFAULT = 4096;
129 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
130 public static final String IO_SKIP_CHECKSUM_ERRORS_KEY =
131 "io.skip.checksum.errors";
132 /** Default value for IO_SKIP_CHECKSUM_ERRORS_KEY */
133 public static final boolean IO_SKIP_CHECKSUM_ERRORS_DEFAULT = false;
134 /**
135 * @deprecated Moved to mapreduce, see mapreduce.task.io.sort.mb
136 * in mapred-default.xml
137 * See https://issues.apache.org/jira/browse/HADOOP-6801
138 */
139 public static final String IO_SORT_MB_KEY = "io.sort.mb";
140 /** Default value for IO_SORT_MB_DEFAULT */
141 public static final int IO_SORT_MB_DEFAULT = 100;
142 /**
143 * @deprecated Moved to mapreduce, see mapreduce.task.io.sort.factor
144 * in mapred-default.xml
145 * See https://issues.apache.org/jira/browse/HADOOP-6801
146 */
147 public static final String IO_SORT_FACTOR_KEY = "io.sort.factor";
148 /** Default value for IO_SORT_FACTOR_DEFAULT */
149 public static final int IO_SORT_FACTOR_DEFAULT = 100;
150 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
151 public static final String IO_SERIALIZATIONS_KEY = "io.serializations";
152
153 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
154 public static final String TFILE_IO_CHUNK_SIZE_KEY = "tfile.io.chunk.size";
155 /** Default value for TFILE_IO_CHUNK_SIZE_DEFAULT */
156 public static final int TFILE_IO_CHUNK_SIZE_DEFAULT = 1024*1024;
157 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
158 public static final String TFILE_FS_INPUT_BUFFER_SIZE_KEY =
159 "tfile.fs.input.buffer.size";
160 /** Default value for TFILE_FS_INPUT_BUFFER_SIZE_KEY */
161 public static final int TFILE_FS_INPUT_BUFFER_SIZE_DEFAULT = 256*1024;
162 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
163 public static final String TFILE_FS_OUTPUT_BUFFER_SIZE_KEY =
164 "tfile.fs.output.buffer.size";
165 /** Default value for TFILE_FS_OUTPUT_BUFFER_SIZE_KEY */
166 public static final int TFILE_FS_OUTPUT_BUFFER_SIZE_DEFAULT = 256*1024;
167
168 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
169 public static final String IPC_CLIENT_CONNECTION_MAXIDLETIME_KEY =
170 "ipc.client.connection.maxidletime";
171 /** Default value for IPC_CLIENT_CONNECTION_MAXIDLETIME_KEY */
172 public static final int IPC_CLIENT_CONNECTION_MAXIDLETIME_DEFAULT = 10000; // 10s
173 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
174 public static final String IPC_CLIENT_CONNECT_MAX_RETRIES_KEY =
175 "ipc.client.connect.max.retries";
176 /** Default value for IPC_CLIENT_CONNECT_MAX_RETRIES_KEY */
177 public static final int IPC_CLIENT_CONNECT_MAX_RETRIES_DEFAULT = 10;
178 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
179 public static final String IPC_CLIENT_CONNECT_MAX_RETRIES_ON_SOCKET_TIMEOUTS_KEY =
180 "ipc.client.connect.max.retries.on.timeouts";
181 /** Default value for IPC_CLIENT_CONNECT_MAX_RETRIES_ON_SOCKET_TIMEOUTS_KEY */
182 public static final int IPC_CLIENT_CONNECT_MAX_RETRIES_ON_SOCKET_TIMEOUTS_DEFAULT = 45;
183 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
184 public static final String IPC_CLIENT_TCPNODELAY_KEY =
185 "ipc.client.tcpnodelay";
186 /** Defalt value for IPC_CLIENT_TCPNODELAY_KEY */
187 public static final boolean IPC_CLIENT_TCPNODELAY_DEFAULT = false;
188 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
189 public static final String IPC_SERVER_LISTEN_QUEUE_SIZE_KEY =
190 "ipc.server.listen.queue.size";
191 /** Default value for IPC_SERVER_LISTEN_QUEUE_SIZE_KEY */
192 public static final int IPC_SERVER_LISTEN_QUEUE_SIZE_DEFAULT = 128;
193 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
194 public static final String IPC_CLIENT_KILL_MAX_KEY = "ipc.client.kill.max";
195 /** Default value for IPC_CLIENT_KILL_MAX_KEY */
196 public static final int IPC_CLIENT_KILL_MAX_DEFAULT = 10;
197 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
198 public static final String IPC_CLIENT_IDLETHRESHOLD_KEY =
199 "ipc.client.idlethreshold";
200 /** Default value for IPC_CLIENT_IDLETHRESHOLD_DEFAULT */
201 public static final int IPC_CLIENT_IDLETHRESHOLD_DEFAULT = 4000;
202 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
203 public static final String IPC_SERVER_TCPNODELAY_KEY =
204 "ipc.server.tcpnodelay";
205 /** Default value for IPC_SERVER_TCPNODELAY_KEY */
206 public static final boolean IPC_SERVER_TCPNODELAY_DEFAULT = false;
207
208 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
209 public static final String HADOOP_RPC_SOCKET_FACTORY_CLASS_DEFAULT_KEY =
210 "hadoop.rpc.socket.factory.class.default";
211 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
212 public static final String HADOOP_SOCKS_SERVER_KEY = "hadoop.socks.server";
213 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
214 public static final String HADOOP_UTIL_HASH_TYPE_KEY =
215 "hadoop.util.hash.type";
216 /** Default value for HADOOP_UTIL_HASH_TYPE_KEY */
217 public static final String HADOOP_UTIL_HASH_TYPE_DEFAULT = "murmur";
218 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
219 public static final String HADOOP_SECURITY_GROUP_MAPPING =
220 "hadoop.security.group.mapping";
221 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
222 public static final String HADOOP_SECURITY_GROUPS_CACHE_SECS =
223 "hadoop.security.groups.cache.secs";
224 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
225 public static final String HADOOP_SECURITY_AUTHENTICATION =
226 "hadoop.security.authentication";
227 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
228 public static final String HADOOP_SECURITY_AUTHORIZATION =
229 "hadoop.security.authorization";
230 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
231 public static final String HADOOP_SECURITY_INSTRUMENTATION_REQUIRES_ADMIN =
232 "hadoop.security.instrumentation.requires.admin";
233 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */
234 public static final String HADOOP_SECURITY_SERVICE_USER_NAME_KEY =
235 "hadoop.security.service.user.name.key";
236 }
237