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 019package org.apache.hadoop.fs; 020 021import 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 034public 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 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */ 058 public static final String FS_DU_INTERVAL_KEY = "fs.du.interval"; 059 /** Default value for FS_DU_INTERVAL_KEY */ 060 public static final long FS_DU_INTERVAL_DEFAULT = 600000; 061 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */ 062 public static final String FS_CLIENT_RESOLVE_REMOTE_SYMLINKS_KEY = 063 "fs.client.resolve.remote.symlinks"; 064 /** Default value for FS_CLIENT_RESOLVE_REMOTE_SYMLINKS_KEY */ 065 public static final boolean FS_CLIENT_RESOLVE_REMOTE_SYMLINKS_DEFAULT = true; 066 067 068 //Defaults are not specified for following keys 069 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */ 070 public static final String NET_TOPOLOGY_SCRIPT_FILE_NAME_KEY = 071 "net.topology.script.file.name"; 072 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */ 073 public static final String NET_TOPOLOGY_NODE_SWITCH_MAPPING_IMPL_KEY = 074 "net.topology.node.switch.mapping.impl"; 075 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */ 076 public static final String NET_TOPOLOGY_IMPL_KEY = 077 "net.topology.impl"; 078 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */ 079 public static final String NET_TOPOLOGY_TABLE_MAPPING_FILE_KEY = 080 "net.topology.table.file.name"; 081 082 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */ 083 public static final String FS_TRASH_CHECKPOINT_INTERVAL_KEY = 084 "fs.trash.checkpoint.interval"; 085 /** Default value for FS_TRASH_CHECKPOINT_INTERVAL_KEY */ 086 public static final long FS_TRASH_CHECKPOINT_INTERVAL_DEFAULT = 0; 087 088 // TBD: Code is still using hardcoded values (e.g. "fs.automatic.close") 089 // instead of constant (e.g. FS_AUTOMATIC_CLOSE_KEY) 090 // 091 /** Not used anywhere, looks like default value for FS_LOCAL_BLOCK_SIZE */ 092 public static final long FS_LOCAL_BLOCK_SIZE_DEFAULT = 32*1024*1024; 093 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */ 094 public static final String FS_AUTOMATIC_CLOSE_KEY = "fs.automatic.close"; 095 /** Default value for FS_AUTOMATIC_CLOSE_KEY */ 096 public static final boolean FS_AUTOMATIC_CLOSE_DEFAULT = true; 097 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */ 098 public static final String FS_FILE_IMPL_KEY = "fs.file.impl"; 099 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */ 100 public static final String FS_FTP_HOST_KEY = "fs.ftp.host"; 101 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */ 102 public static final String FS_FTP_HOST_PORT_KEY = "fs.ftp.host.port"; 103 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */ 104 public static final String FS_TRASH_INTERVAL_KEY = "fs.trash.interval"; 105 /** Default value for FS_TRASH_INTERVAL_KEY */ 106 public static final long FS_TRASH_INTERVAL_DEFAULT = 0; 107 108 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */ 109 public static final String IO_MAPFILE_BLOOM_SIZE_KEY = 110 "io.mapfile.bloom.size"; 111 /** Default value for IO_MAPFILE_BLOOM_SIZE_KEY */ 112 public static final int IO_MAPFILE_BLOOM_SIZE_DEFAULT = 1024*1024; 113 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */ 114 public static final String IO_MAPFILE_BLOOM_ERROR_RATE_KEY = 115 "io.mapfile.bloom.error.rate" ; 116 /** Default value for IO_MAPFILE_BLOOM_ERROR_RATE_KEY */ 117 public static final float IO_MAPFILE_BLOOM_ERROR_RATE_DEFAULT = 0.005f; 118 /** Codec class that implements Lzo compression algorithm */ 119 public static final String IO_COMPRESSION_CODEC_LZO_CLASS_KEY = 120 "io.compression.codec.lzo.class"; 121 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */ 122 public static final String IO_MAP_INDEX_INTERVAL_KEY = 123 "io.map.index.interval"; 124 /** Default value for IO_MAP_INDEX_INTERVAL_DEFAULT */ 125 public static final int IO_MAP_INDEX_INTERVAL_DEFAULT = 128; 126 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */ 127 public static final String IO_MAP_INDEX_SKIP_KEY = "io.map.index.skip"; 128 /** Default value for IO_MAP_INDEX_SKIP_KEY */ 129 public static final int IO_MAP_INDEX_SKIP_DEFAULT = 0; 130 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */ 131 public static final String IO_SEQFILE_COMPRESS_BLOCKSIZE_KEY = 132 "io.seqfile.compress.blocksize"; 133 /** Default value for IO_SEQFILE_COMPRESS_BLOCKSIZE_KEY */ 134 public static final int IO_SEQFILE_COMPRESS_BLOCKSIZE_DEFAULT = 1000000; 135 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */ 136 public static final String IO_FILE_BUFFER_SIZE_KEY = 137 "io.file.buffer.size"; 138 /** Default value for IO_FILE_BUFFER_SIZE_KEY */ 139 public static final int IO_FILE_BUFFER_SIZE_DEFAULT = 4096; 140 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */ 141 public static final String IO_SKIP_CHECKSUM_ERRORS_KEY = 142 "io.skip.checksum.errors"; 143 /** Default value for IO_SKIP_CHECKSUM_ERRORS_KEY */ 144 public static final boolean IO_SKIP_CHECKSUM_ERRORS_DEFAULT = false; 145 /** 146 * @deprecated Moved to mapreduce, see mapreduce.task.io.sort.mb 147 * in mapred-default.xml 148 * See https://issues.apache.org/jira/browse/HADOOP-6801 149 */ 150 public static final String IO_SORT_MB_KEY = "io.sort.mb"; 151 /** Default value for IO_SORT_MB_DEFAULT */ 152 public static final int IO_SORT_MB_DEFAULT = 100; 153 /** 154 * @deprecated Moved to mapreduce, see mapreduce.task.io.sort.factor 155 * in mapred-default.xml 156 * See https://issues.apache.org/jira/browse/HADOOP-6801 157 */ 158 public static final String IO_SORT_FACTOR_KEY = "io.sort.factor"; 159 /** Default value for IO_SORT_FACTOR_DEFAULT */ 160 public static final int IO_SORT_FACTOR_DEFAULT = 100; 161 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */ 162 public static final String IO_SERIALIZATIONS_KEY = "io.serializations"; 163 164 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */ 165 public static final String TFILE_IO_CHUNK_SIZE_KEY = "tfile.io.chunk.size"; 166 /** Default value for TFILE_IO_CHUNK_SIZE_DEFAULT */ 167 public static final int TFILE_IO_CHUNK_SIZE_DEFAULT = 1024*1024; 168 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */ 169 public static final String TFILE_FS_INPUT_BUFFER_SIZE_KEY = 170 "tfile.fs.input.buffer.size"; 171 /** Default value for TFILE_FS_INPUT_BUFFER_SIZE_KEY */ 172 public static final int TFILE_FS_INPUT_BUFFER_SIZE_DEFAULT = 256*1024; 173 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */ 174 public static final String TFILE_FS_OUTPUT_BUFFER_SIZE_KEY = 175 "tfile.fs.output.buffer.size"; 176 /** Default value for TFILE_FS_OUTPUT_BUFFER_SIZE_KEY */ 177 public static final int TFILE_FS_OUTPUT_BUFFER_SIZE_DEFAULT = 256*1024; 178 179 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */ 180 public static final String IPC_CLIENT_CONNECTION_MAXIDLETIME_KEY = 181 "ipc.client.connection.maxidletime"; 182 /** Default value for IPC_CLIENT_CONNECTION_MAXIDLETIME_KEY */ 183 public static final int IPC_CLIENT_CONNECTION_MAXIDLETIME_DEFAULT = 10000; // 10s 184 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */ 185 public static final String IPC_CLIENT_CONNECT_TIMEOUT_KEY = 186 "ipc.client.connect.timeout"; 187 /** Default value for IPC_CLIENT_CONNECT_TIMEOUT_KEY */ 188 public static final int IPC_CLIENT_CONNECT_TIMEOUT_DEFAULT = 20000; // 20s 189 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */ 190 public static final String IPC_CLIENT_CONNECT_MAX_RETRIES_KEY = 191 "ipc.client.connect.max.retries"; 192 /** Default value for IPC_CLIENT_CONNECT_MAX_RETRIES_KEY */ 193 public static final int IPC_CLIENT_CONNECT_MAX_RETRIES_DEFAULT = 10; 194 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */ 195 public static final String IPC_CLIENT_CONNECT_RETRY_INTERVAL_KEY = 196 "ipc.client.connect.retry.interval"; 197 /** Default value for IPC_CLIENT_CONNECT_RETRY_INTERVAL_KEY */ 198 public static final int IPC_CLIENT_CONNECT_RETRY_INTERVAL_DEFAULT = 1000; 199 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */ 200 public static final String IPC_CLIENT_CONNECT_MAX_RETRIES_ON_SOCKET_TIMEOUTS_KEY = 201 "ipc.client.connect.max.retries.on.timeouts"; 202 /** Default value for IPC_CLIENT_CONNECT_MAX_RETRIES_ON_SOCKET_TIMEOUTS_KEY */ 203 public static final int IPC_CLIENT_CONNECT_MAX_RETRIES_ON_SOCKET_TIMEOUTS_DEFAULT = 45; 204 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */ 205 public static final String IPC_CLIENT_TCPNODELAY_KEY = 206 "ipc.client.tcpnodelay"; 207 /** Defalt value for IPC_CLIENT_TCPNODELAY_KEY */ 208 public static final boolean IPC_CLIENT_TCPNODELAY_DEFAULT = false; 209 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */ 210 public static final String IPC_SERVER_LISTEN_QUEUE_SIZE_KEY = 211 "ipc.server.listen.queue.size"; 212 /** Default value for IPC_SERVER_LISTEN_QUEUE_SIZE_KEY */ 213 public static final int IPC_SERVER_LISTEN_QUEUE_SIZE_DEFAULT = 128; 214 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */ 215 public static final String IPC_CLIENT_KILL_MAX_KEY = "ipc.client.kill.max"; 216 /** Default value for IPC_CLIENT_KILL_MAX_KEY */ 217 public static final int IPC_CLIENT_KILL_MAX_DEFAULT = 10; 218 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */ 219 public static final String IPC_CLIENT_IDLETHRESHOLD_KEY = 220 "ipc.client.idlethreshold"; 221 /** Default value for IPC_CLIENT_IDLETHRESHOLD_DEFAULT */ 222 public static final int IPC_CLIENT_IDLETHRESHOLD_DEFAULT = 4000; 223 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */ 224 public static final String IPC_SERVER_TCPNODELAY_KEY = 225 "ipc.server.tcpnodelay"; 226 /** Default value for IPC_SERVER_TCPNODELAY_KEY */ 227 public static final boolean IPC_SERVER_TCPNODELAY_DEFAULT = false; 228 229 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */ 230 public static final String HADOOP_RPC_SOCKET_FACTORY_CLASS_DEFAULT_KEY = 231 "hadoop.rpc.socket.factory.class.default"; 232 public static final String HADOOP_RPC_SOCKET_FACTORY_CLASS_DEFAULT_DEFAULT = 233 "org.apache.hadoop.net.StandardSocketFactory"; 234 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */ 235 public static final String HADOOP_SOCKS_SERVER_KEY = "hadoop.socks.server"; 236 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */ 237 public static final String HADOOP_UTIL_HASH_TYPE_KEY = 238 "hadoop.util.hash.type"; 239 /** Default value for HADOOP_UTIL_HASH_TYPE_KEY */ 240 public static final String HADOOP_UTIL_HASH_TYPE_DEFAULT = "murmur"; 241 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */ 242 public static final String HADOOP_SECURITY_GROUP_MAPPING = 243 "hadoop.security.group.mapping"; 244 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */ 245 public static final String HADOOP_SECURITY_GROUPS_CACHE_SECS = 246 "hadoop.security.groups.cache.secs"; 247 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */ 248 public static final long HADOOP_SECURITY_GROUPS_CACHE_SECS_DEFAULT = 249 300; 250 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */ 251 public static final String HADOOP_SECURITY_GROUPS_CACHE_WARN_AFTER_MS = 252 "hadoop.security.groups.cache.warn.after.ms"; 253 public static final long HADOOP_SECURITY_GROUPS_CACHE_WARN_AFTER_MS_DEFAULT = 254 5000; 255 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */ 256 public static final String HADOOP_SECURITY_AUTHENTICATION = 257 "hadoop.security.authentication"; 258 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */ 259 public static final String HADOOP_SECURITY_AUTHORIZATION = 260 "hadoop.security.authorization"; 261 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */ 262 public static final String HADOOP_SECURITY_INSTRUMENTATION_REQUIRES_ADMIN = 263 "hadoop.security.instrumentation.requires.admin"; 264 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */ 265 public static final String HADOOP_SECURITY_SERVICE_USER_NAME_KEY = 266 "hadoop.security.service.user.name.key"; 267 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */ 268 public static final String HADOOP_SECURITY_AUTH_TO_LOCAL = 269 "hadoop.security.auth_to_local"; 270 271 @Deprecated 272 /** Only used by HttpServer. */ 273 public static final String HADOOP_SSL_ENABLED_KEY = "hadoop.ssl.enabled"; 274 @Deprecated 275 /** Only used by HttpServer. */ 276 public static final boolean HADOOP_SSL_ENABLED_DEFAULT = false; 277 278 279 // HTTP policies to be used in configuration 280 // Use HttpPolicy.name() instead 281 @Deprecated 282 public static final String HTTP_POLICY_HTTP_ONLY = "HTTP_ONLY"; 283 @Deprecated 284 public static final String HTTP_POLICY_HTTPS_ONLY = "HTTPS_ONLY"; 285 /** See <a href="{@docRoot}/../core-default.html">core-default.xml</a> */ 286 public static final String HADOOP_RPC_PROTECTION = 287 "hadoop.rpc.protection"; 288 /** Class to override Sasl Properties for a connection */ 289 public static final String HADOOP_SECURITY_SASL_PROPS_RESOLVER_CLASS = 290 "hadoop.security.saslproperties.resolver.class"; 291} 292