123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <!--
- | Generated by Apache Maven Doxia at 2025-05-04
- | Rendered using Apache Maven Stylus Skin 1.5
- -->
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <title>Apache Hadoop 3.5.0-SNAPSHOT – interface org.apache.hadoop.fs.Abortable</title>
- <style type="text/css" media="all">
- @import url("../css/maven-base.css");
- @import url("../css/maven-theme.css");
- @import url("../css/site.css");
- </style>
- <link rel="stylesheet" href="../css/print.css" type="text/css" media="print" />
- <meta name="Date-Revision-yyyymmdd" content="20250504" />
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
- </head>
- <body class="composite">
- <div id="banner">
- <a href="http://hadoop.apache.org/" id="bannerLeft">
- <img src="http://hadoop.apache.org/images/hadoop-logo.jpg" alt="" />
- </a>
- <a href="http://www.apache.org/" id="bannerRight">
- <img src="http://www.apache.org/images/asf_logo_wide.png" alt="" />
- </a>
- <div class="clear">
- <hr/>
- </div>
- </div>
- <div id="breadcrumbs">
-
- <div class="xright"> <a href="http://wiki.apache.org/hadoop" class="externalLink">Wiki</a>
- |
- <a href="https://gitbox.apache.org/repos/asf/hadoop.git" class="externalLink">git</a>
- |
- <a href="http://hadoop.apache.org/" class="externalLink">Apache Hadoop</a>
-
- | Last Published: 2025-05-04
- | Version: 3.5.0-SNAPSHOT
- </div>
- <div class="clear">
- <hr/>
- </div>
- </div>
- <div id="leftColumn">
- <div id="navcolumn">
-
- <h5>General</h5>
- <ul>
- <li class="none">
- <a href="../../../index.html">Overview</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-common/SingleCluster.html">Single Node Setup</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-common/ClusterSetup.html">Cluster Setup</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-common/CommandsManual.html">Commands Reference</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-common/FileSystemShell.html">FileSystem Shell</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-common/Compatibility.html">Compatibility Specification</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-common/DownstreamDev.html">Downstream Developer's Guide</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-common/AdminCompatibilityGuide.html">Admin Compatibility Guide</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-common/InterfaceClassification.html">Interface Classification</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-common/filesystem/index.html">FileSystem Specification</a>
- </li>
- </ul>
- <h5>Common</h5>
- <ul>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-common/CLIMiniCluster.html">CLI Mini Cluster</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-common/FairCallQueue.html">Fair Call Queue</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-common/NativeLibraries.html">Native Libraries</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-common/Superusers.html">Proxy User</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-common/RackAwareness.html">Rack Awareness</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-common/SecureMode.html">Secure Mode</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-common/ServiceLevelAuth.html">Service Level Authorization</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-common/HttpAuthentication.html">HTTP Authentication</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-common/CredentialProviderAPI.html">Credential Provider API</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-kms/index.html">Hadoop KMS</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-common/Tracing.html">Tracing</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-common/UnixShellGuide.html">Unix Shell Guide</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-common/registry/index.html">Registry</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-common/AsyncProfilerServlet.html">Async Profiler</a>
- </li>
- </ul>
- <h5>HDFS</h5>
- <ul>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-hdfs/HdfsDesign.html">Architecture</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-hdfs/HdfsUserGuide.html">User Guide</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-hdfs/HDFSCommands.html">Commands Reference</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-hdfs/HDFSHighAvailabilityWithQJM.html">NameNode HA With QJM</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-hdfs/HDFSHighAvailabilityWithNFS.html">NameNode HA With NFS</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-hdfs/ObserverNameNode.html">Observer NameNode</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-hdfs/Federation.html">Federation</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-hdfs/ViewFs.html">ViewFs</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-hdfs/ViewFsOverloadScheme.html">ViewFsOverloadScheme</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-hdfs/HdfsSnapshots.html">Snapshots</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-hdfs/HdfsEditsViewer.html">Edits Viewer</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-hdfs/HdfsImageViewer.html">Image Viewer</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-hdfs/HdfsPermissionsGuide.html">Permissions and HDFS</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-hdfs/HdfsQuotaAdminGuide.html">Quotas and HDFS</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-hdfs/LibHdfs.html">libhdfs (C API)</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-hdfs/WebHDFS.html">WebHDFS (REST API)</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-hdfs-httpfs/index.html">HttpFS</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-hdfs/ShortCircuitLocalReads.html">Short Circuit Local Reads</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-hdfs/CentralizedCacheManagement.html">Centralized Cache Management</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-hdfs/HdfsNfsGateway.html">NFS Gateway</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-hdfs/HdfsRollingUpgrade.html">Rolling Upgrade</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-hdfs/ExtendedAttributes.html">Extended Attributes</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-hdfs/TransparentEncryption.html">Transparent Encryption</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-hdfs/HdfsMultihoming.html">Multihoming</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-hdfs/ArchivalStorage.html">Storage Policies</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-hdfs/MemoryStorage.html">Memory Storage Support</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-hdfs/SLGUserGuide.html">Synthetic Load Generator</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-hdfs/HDFSErasureCoding.html">Erasure Coding</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-hdfs/HDFSDiskbalancer.html">Disk Balancer</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-hdfs/HdfsUpgradeDomain.html">Upgrade Domain</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-hdfs/HdfsDataNodeAdminGuide.html">DataNode Admin</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-hdfs-rbf/HDFSRouterFederation.html">Router Federation</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-hdfs/HdfsProvidedStorage.html">Provided Storage</a>
- </li>
- </ul>
- <h5>MapReduce</h5>
- <ul>
- <li class="none">
- <a href="../../../hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html">Tutorial</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapredCommands.html">Commands Reference</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduce_Compatibility_Hadoop1_Hadoop2.html">Compatibility with 1.x</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-mapreduce-client/hadoop-mapreduce-client-core/EncryptedShuffle.html">Encrypted Shuffle</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-mapreduce-client/hadoop-mapreduce-client-core/PluggableShuffleAndPluggableSort.html">Pluggable Shuffle/Sort</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-mapreduce-client/hadoop-mapreduce-client-core/DistributedCacheDeploy.html">Distributed Cache Deploy</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-mapreduce-client/hadoop-mapreduce-client-core/SharedCacheSupport.html">Support for YARN Shared Cache</a>
- </li>
- </ul>
- <h5>MapReduce REST APIs</h5>
- <ul>
- <li class="none">
- <a href="../../../hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapredAppMasterRest.html">MR Application Master</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-mapreduce-client/hadoop-mapreduce-client-hs/HistoryServerRest.html">MR History Server</a>
- </li>
- </ul>
- <h5>YARN</h5>
- <ul>
- <li class="none">
- <a href="../../../hadoop-yarn/hadoop-yarn-site/YARN.html">Architecture</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-yarn/hadoop-yarn-site/YarnCommands.html">Commands Reference</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-yarn/hadoop-yarn-site/CapacityScheduler.html">Capacity Scheduler</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-yarn/hadoop-yarn-site/FairScheduler.html">Fair Scheduler</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-yarn/hadoop-yarn-site/ResourceManagerRestart.html">ResourceManager Restart</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-yarn/hadoop-yarn-site/ResourceManagerHA.html">ResourceManager HA</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-yarn/hadoop-yarn-site/ResourceModel.html">Resource Model</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-yarn/hadoop-yarn-site/NodeLabel.html">Node Labels</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-yarn/hadoop-yarn-site/NodeAttributes.html">Node Attributes</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-yarn/hadoop-yarn-site/WebApplicationProxy.html">Web Application Proxy</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-yarn/hadoop-yarn-site/TimelineServer.html">Timeline Server</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-yarn/hadoop-yarn-site/TimelineServiceV2.html">Timeline Service V.2</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-yarn/hadoop-yarn-site/WritingYarnApplications.html">Writing YARN Applications</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-yarn/hadoop-yarn-site/YarnApplicationSecurity.html">YARN Application Security</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-yarn/hadoop-yarn-site/NodeManager.html">NodeManager</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-yarn/hadoop-yarn-site/DockerContainers.html">Running Applications in Docker Containers</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-yarn/hadoop-yarn-site/RuncContainers.html">Running Applications in runC Containers</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-yarn/hadoop-yarn-site/NodeManagerCgroups.html">Using CGroups</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-yarn/hadoop-yarn-site/SecureContainer.html">Secure Containers</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-yarn/hadoop-yarn-site/ReservationSystem.html">Reservation System</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-yarn/hadoop-yarn-site/GracefulDecommission.html">Graceful Decommission</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-yarn/hadoop-yarn-site/OpportunisticContainers.html">Opportunistic Containers</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-yarn/hadoop-yarn-site/Federation.html">YARN Federation</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-yarn/hadoop-yarn-site/SharedCache.html">Shared Cache</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-yarn/hadoop-yarn-site/UsingGpus.html">Using GPU</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-yarn/hadoop-yarn-site/UsingFPGA.html">Using FPGA</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-yarn/hadoop-yarn-site/PlacementConstraints.html">Placement Constraints</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-yarn/hadoop-yarn-site/YarnUI2.html">YARN UI2</a>
- </li>
- </ul>
- <h5>YARN REST APIs</h5>
- <ul>
- <li class="none">
- <a href="../../../hadoop-yarn/hadoop-yarn-site/WebServicesIntro.html">Introduction</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-yarn/hadoop-yarn-site/ResourceManagerRest.html">Resource Manager</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-yarn/hadoop-yarn-site/NodeManagerRest.html">Node Manager</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-yarn/hadoop-yarn-site/TimelineServer.html#Timeline_Server_REST_API_v1">Timeline Server</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-yarn/hadoop-yarn-site/TimelineServiceV2.html#Timeline_Service_v.2_REST_API">Timeline Service V.2</a>
- </li>
- </ul>
- <h5>YARN Service</h5>
- <ul>
- <li class="none">
- <a href="../../../hadoop-yarn/hadoop-yarn-site/yarn-service/Overview.html">Overview</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-yarn/hadoop-yarn-site/yarn-service/QuickStart.html">QuickStart</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-yarn/hadoop-yarn-site/yarn-service/Concepts.html">Concepts</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-yarn/hadoop-yarn-site/yarn-service/YarnServiceAPI.html">Yarn Service API</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-yarn/hadoop-yarn-site/yarn-service/ServiceDiscovery.html">Service Discovery</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-yarn/hadoop-yarn-site/yarn-service/SystemServices.html">System Services</a>
- </li>
- </ul>
- <h5>Hadoop Compatible File Systems</h5>
- <ul>
- <li class="none">
- <a href="../../../hadoop-aliyun/tools/hadoop-aliyun/index.html">Aliyun OSS</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-aws/tools/hadoop-aws/index.html">Amazon S3</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-azure/index.html">Azure Blob Storage</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-azure-datalake/index.html">Azure Data Lake Storage</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-cos/cloud-storage/index.html">Tencent COS</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-huaweicloud/index.html">Huaweicloud OBS</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-tos/cloud-storage/index.html">VolcanoEngine TOS</a>
- </li>
- </ul>
- <h5>Auth</h5>
- <ul>
- <li class="none">
- <a href="../../../hadoop-auth/index.html">Overview</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-auth/Examples.html">Examples</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-auth/Configuration.html">Configuration</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-auth/BuildingIt.html">Building</a>
- </li>
- </ul>
- <h5>Tools</h5>
- <ul>
- <li class="none">
- <a href="../../../hadoop-streaming/HadoopStreaming.html">Hadoop Streaming</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-archives/HadoopArchives.html">Hadoop Archives</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-archive-logs/HadoopArchiveLogs.html">Hadoop Archive Logs</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-distcp/DistCp.html">DistCp</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-federation-balance/HDFSFederationBalance.html">HDFS Federation Balance</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-gridmix/GridMix.html">GridMix</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-rumen/Rumen.html">Rumen</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-resourceestimator/ResourceEstimator.html">Resource Estimator Service</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-sls/SchedulerLoadSimulator.html">Scheduler Load Simulator</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-common/Benchmarking.html">Hadoop Benchmarking</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-dynamometer/Dynamometer.html">Dynamometer</a>
- </li>
- </ul>
- <h5>Reference</h5>
- <ul>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-common/release/">Changelog and Release Notes</a>
- </li>
- <li class="none">
- <a href="../../../api/index.html">Java API docs</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-common/UnixShellAPI.html">Unix Shell API</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-common/Metrics.html">Metrics</a>
- </li>
- </ul>
- <h5>Configuration</h5>
- <ul>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-common/core-default.xml">core-default.xml</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-hdfs/hdfs-default.xml">hdfs-default.xml</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-hdfs-rbf/hdfs-rbf-default.xml">hdfs-rbf-default.xml</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-mapreduce-client/hadoop-mapreduce-client-core/mapred-default.xml">mapred-default.xml</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-yarn/hadoop-yarn-common/yarn-default.xml">yarn-default.xml</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-kms/kms-default.html">kms-default.xml</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-hdfs-httpfs/httpfs-default.html">httpfs-default.xml</a>
- </li>
- <li class="none">
- <a href="../../../hadoop-project-dist/hadoop-common/DeprecatedProperties.html">Deprecated Properties</a>
- </li>
- </ul>
- <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
- <img alt="Built by Maven" src="../images/logos/maven-feather.png"/>
- </a>
-
- </div>
- </div>
- <div id="bodyColumn">
- <div id="contentBox">
- <!---
- Licensed under the Apache License, Version 2.0 (the "License");
- you may not use this file except in compliance with the License.
- You may obtain a copy of the License at
- http://www.apache.org/licenses/LICENSE-2.0
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License. See accompanying LICENSE file.
- -->
- <!-- ============================================================= -->
- <!-- CLASS: FileSystem -->
- <!-- ============================================================= -->
- <h1>interface <code>org.apache.hadoop.fs.Abortable</code></h1>
- <ul>
- <li><a href="#Method_abort.28.29">Method abort()</a></li>
- <li><a href="#Method_abort.28.29_on_an_output_stream">Method abort() on an output stream</a></li>
- <li><a href="#Preconditions">Preconditions</a></li>
- <li><a href="#Postconditions">Postconditions</a>
- <ul>
- <li><a href="#Cleanup">Cleanup</a></li>
- <li><a href="#Thread_safety_and_atomicity">Thread safety and atomicity</a></li></ul></li>
- <li><a href="#Path.2FStream_capability_.E2.80.9Cfs.capability.outputstream.abortable.E2.80.9D">Path/Stream capability “fs.capability.outputstream.abortable”</a></li></ul>
- <p>Abort the active operation such that the output does not become manifest.</p>
- <p>Specifically, if supported on an <a href="outputstream.html">output stream</a>, a successful <code>abort()</code> MUST guarantee that the stream will not be made visible in the <code>close()</code> operation.</p>
- <div class="source">
- <div class="source">
- <pre>@InterfaceAudience.Public
- @InterfaceStability.Unstable
- public interface Abortable {
- /**
- * Abort the active operation without the output becoming visible.
- *
- * This is to provide ability to cancel the write on stream; once
- * a stream is aborted, the write MUST NOT become visible.
- *
- * @throws UnsupportedOperationException if the operation is not supported.
- * @return the result.
- */
- AbortableResult abort();
- /**
- * Interface for the result of aborts; allows subclasses to extend
- * (IOStatistics etc) or for future enhancements if ever needed.
- */
- interface AbortableResult {
- /**
- * Was the stream already closed/aborted?
- * @return true if a close/abort operation had already
- * taken place.
- */
- boolean alreadyClosed();
- /**
- * Any exception caught during cleanup operations,
- * exceptions whose raising/catching does not change
- * the semantics of the abort.
- * @return an exception or null.
- */
- IOException anyCleanupException();
- }
- }
- </pre></div></div>
- <section>
- <h2><a name="Method_abort.28.29"></a>Method <code>abort()</code></h2>
- <p>Aborts the ongoing operation such that no output SHALL become visible when the operation is completed.</p>
- <p>Unless and until other File System classes implement <code>Abortable</code>, the interface is specified purely for output streams.</p></section><section>
- <h2><a name="Method_abort.28.29_on_an_output_stream"></a>Method <code>abort()</code> on an output stream</h2>
- <p><code>Abortable.abort()</code> MUST only be supported on output streams whose output is only made visible when <code>close()</code> is called, for example. output streams returned by the S3A FileSystem.</p></section><section>
- <h2><a name="Preconditions"></a>Preconditions</h2>
- <p>The stream MUST implement <code>Abortable</code> and <code>StreamCapabilities</code>.</p>
- <div class="source">
- <div class="source">
- <pre>if unsupported:
- throw UnsupportedException
- if not isOpen(stream):
- no-op
- StreamCapabilities.hasCapability("fs.capability.outputstream.abortable") == True
- </pre></div></div>
- </section><section>
- <h2><a name="Postconditions"></a>Postconditions</h2>
- <p>After <code>abort()</code> returns, the filesystem MUST be unchanged:</p>
- <div class="source">
- <div class="source">
- <pre>FS' = FS
- </pre></div></div>
- <p>A successful <code>abort()</code> operation MUST guarantee that when the stream<code>close()</code> is invoked no output shall be manifest.</p>
- <ul>
- <li>The stream MUST retry any remote calls needed to force the abort outcome.</li>
- <li>If any file was present at the destination path, it MUST remain unchanged.</li>
- </ul>
- <p>Strictly then:</p>
- <blockquote>
- <p>if <code>Abortable.abort()</code> does not raise <code>UnsupportedOperationException</code> then returns, then it guarantees that the write SHALL NOT become visible and that any existing data in the filesystem at the destination path SHALL continue to be available.</p>
- </blockquote>
- <ol style="list-style-type: decimal">
- <li>Calls to <code>write()</code> methods MUST fail.</li>
- <li>Calls to <code>flush()</code> MUST be no-ops (applications sometimes call this on closed streams)</li>
- <li>Subsequent calls to <code>abort()</code> MUST be no-ops.</li>
- <li><code>close()</code> MUST NOT manifest the file, and MUST NOT raise an exception</li>
- </ol>
- <p>That is, the postconditions of <code>close()</code> becomes:</p>
- <div class="source">
- <div class="source">
- <pre>FS' = FS
- </pre></div></div>
- <section>
- <h3><a name="Cleanup"></a>Cleanup</h3>
- <ul>
- <li>
- <p>If temporary data is stored in the local filesystem or in the store’s upload infrastructure then this MAY be cleaned up; best-effort is expected here.</p>
- </li>
- <li>
- <p>The stream SHOULD NOT retry cleanup operations; any failure there MUST be caught and added to <code>AbortResult</code></p>
- </li>
- </ul><section>
- <h4><a name="Returned_AbortResult"></a>Returned <code>AbortResult</code></h4>
- <p>The <code>AbortResult</code> value returned is primarily for testing and logging.</p>
- <p><code>alreadyClosed()</code>: MUST return <code>true</code> if the write had already been aborted or closed;</p>
- <p><code>anyCleanupException();</code>: SHOULD return any IOException raised during any optional cleanup operations.</p></section></section><section>
- <h3><a name="Thread_safety_and_atomicity"></a>Thread safety and atomicity</h3>
- <p>Output streams themselves aren’t formally required to be thread safe, but as applications do sometimes assume they are, this call MUST be thread safe.</p></section></section><section>
- <h2><a name="Path.2FStream_capability_.E2.80.9Cfs.capability.outputstream.abortable.E2.80.9D"></a>Path/Stream capability “fs.capability.outputstream.abortable”</h2>
- <p>An application MUST be able to verify that a stream supports the <code>Abortable.abort()</code> operation without actually calling it. This is done through the <code>StreamCapabilities</code> interface.</p>
- <ol style="list-style-type: decimal">
- <li>
- <p>If a stream instance supports <code>Abortable</code> then it MUST return <code>true</code> in the probe <code>hasCapability("fs.capability.outputstream.abortable")</code></p>
- </li>
- <li>
- <p>If a stream instance does not support <code>Abortable</code> then it MUST return <code>false</code> in the probe <code>hasCapability("fs.capability.outputstream.abortable")</code></p>
- </li>
- </ol>
- <p>That is: if a stream declares its support for the feature, a call to <code>abort()</code> SHALL meet the defined semantics of the operation.</p>
- <p>FileSystem/FileContext implementations SHOULD declare support similarly, to allow for applications to probe for the feature in the destination directory/path.</p>
- <p>If a filesystem supports <code>Abortable</code> under a path <code>P</code> then it SHOULD return <code>true</code> to <code>PathCababilities.hasPathCapability(path, "fs.capability.outputstream.abortable")</code> This is to allow applications to verify that the store supports the feature.</p>
- <p>If a filesystem does not support <code>Abortable</code> under a path <code>P</code> then it MUST return <code>false</code> to <code>PathCababilities.hasPathCapability(path, "fs.capability.outputstream.abortable")</code></p></section>
- </div>
- </div>
- <div class="clear">
- <hr/>
- </div>
- <div id="footer">
- <div class="xright">
- © 2008-2025
- Apache Software Foundation
-
- - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a>.
- Apache Maven, Maven, Apache, the Apache feather logo, and the Apache Maven project logos are trademarks of The Apache Software Foundation.
- </div>
- <div class="clear">
- <hr/>
- </div>
- </div>
- </body>
- </html>
|