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 package org.apache.hadoop.hbase;
19
20 import java.io.IOException;
21 import java.util.Map;
22
23 import org.apache.hadoop.classification.InterfaceAudience;
24 import org.apache.hadoop.classification.InterfaceStability;
25
26 /**
27 * Get, remove and modify table descriptors.
28 * Used by servers to host descriptors.
29 */
30 @InterfaceAudience.Public
31 @InterfaceStability.Evolving
32 public interface TableDescriptors {
33 /**
34 * @param tableName
35 * @return HTableDescriptor for tablename
36 * @throws IOException
37 */
38 HTableDescriptor get(final TableName tableName)
39 throws IOException;
40
41 /**
42 * Get Map of all NamespaceDescriptors for a given namespace.
43 * @return Map of all descriptors.
44 * @throws IOException
45 */
46 Map<String, HTableDescriptor> getByNamespace(String name)
47 throws IOException;
48
49 /**
50 * Get Map of all HTableDescriptors. Populates the descriptor cache as a
51 * side effect.
52 * @return Map of all descriptors.
53 * @throws IOException
54 */
55 Map<String, HTableDescriptor> getAll()
56 throws IOException;
57
58 /**
59 * Add or update descriptor
60 * @param htd Descriptor to set into TableDescriptors
61 * @throws IOException
62 */
63 void add(final HTableDescriptor htd)
64 throws IOException;
65
66 /**
67 * @param tablename
68 * @return Instance of table descriptor or null if none found.
69 * @throws IOException
70 */
71 HTableDescriptor remove(final TableName tablename)
72 throws IOException;
73 }