1 /**
2 * Copyright The Apache Software Foundation
3 *
4 * Licensed to the Apache Software Foundation (ASF) under one or more
5 * contributor license agreements. See the NOTICE file distributed with this
6 * work for additional information regarding copyright ownership. The ASF
7 * licenses this file to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
16 * License for the specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.hadoop.hbase.io.hfile.bucket;
20
21 import org.apache.hadoop.hbase.classification.InterfaceAudience;
22
23 /**
24 * A class implementing PersistentIOEngine interface supports persistent and file integrity verify
25 * for {@link BucketCache}
26 */
27 @InterfaceAudience.Private
28 public interface PersistentIOEngine extends IOEngine {
29
30 /**
31 * Using an encryption algorithm to calculate a checksum, the default encryption algorithm is MD5
32 * @param algorithm which algorithm to calculate checksum
33 * @return the checksum which is convert to HexString
34 */
35 byte[] calculateChecksum(String algorithm);
36
37 /**
38 * Verify cache files's integrity
39 * @param persistentChecksum the persistent checksum
40 * @param algorithm which algorithm to calculate checksum
41 * @return true if verify successfully
42 */
43 boolean verifyFileIntegrity(byte[] persistentChecksum, String algorithm);
44 }