1 | /** |
---|
2 | * Licensed to the Apache Software Foundation (ASF) under one |
---|
3 | * or more contributor license agreements. See the NOTICE file |
---|
4 | * distributed with this work for additional information |
---|
5 | * regarding copyright ownership. The ASF licenses this file |
---|
6 | * to you under the Apache License, Version 2.0 (the |
---|
7 | * "License"); you may not use this file except in compliance |
---|
8 | * with the License. You may obtain a copy of the License at |
---|
9 | * |
---|
10 | * http://www.apache.org/licenses/LICENSE-2.0 |
---|
11 | * |
---|
12 | * Unless required by applicable law or agreed to in writing, software |
---|
13 | * distributed under the License is distributed on an "AS IS" BASIS, |
---|
14 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
---|
15 | * See the License for the specific language governing permissions and |
---|
16 | * limitations under the License. |
---|
17 | */ |
---|
18 | |
---|
19 | package org.apache.hadoop.fs.s3; |
---|
20 | |
---|
21 | import java.io.File; |
---|
22 | import java.io.IOException; |
---|
23 | import java.net.URI; |
---|
24 | import java.util.Set; |
---|
25 | |
---|
26 | import org.apache.hadoop.conf.Configuration; |
---|
27 | import org.apache.hadoop.fs.Path; |
---|
28 | |
---|
29 | /** |
---|
30 | * A facility for storing and retrieving {@link INode}s and {@link Block}s. |
---|
31 | */ |
---|
32 | public interface FileSystemStore { |
---|
33 | |
---|
34 | void initialize(URI uri, Configuration conf) throws IOException; |
---|
35 | String getVersion() throws IOException; |
---|
36 | |
---|
37 | void storeINode(Path path, INode inode) throws IOException; |
---|
38 | void storeBlock(Block block, File file) throws IOException; |
---|
39 | |
---|
40 | boolean inodeExists(Path path) throws IOException; |
---|
41 | boolean blockExists(long blockId) throws IOException; |
---|
42 | |
---|
43 | INode retrieveINode(Path path) throws IOException; |
---|
44 | File retrieveBlock(Block block, long byteRangeStart) throws IOException; |
---|
45 | |
---|
46 | void deleteINode(Path path) throws IOException; |
---|
47 | void deleteBlock(Block block) throws IOException; |
---|
48 | |
---|
49 | Set<Path> listSubPaths(Path path) throws IOException; |
---|
50 | Set<Path> listDeepSubPaths(Path path) throws IOException; |
---|
51 | |
---|
52 | /** |
---|
53 | * Delete everything. Used for testing. |
---|
54 | * @throws IOException |
---|
55 | */ |
---|
56 | void purge() throws IOException; |
---|
57 | |
---|
58 | /** |
---|
59 | * Diagnostic method to dump all INodes to the console. |
---|
60 | * @throws IOException |
---|
61 | */ |
---|
62 | void dump() throws IOException; |
---|
63 | } |
---|