KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > geronimo > util > crypto > Digest


1 /**
2  * Licensed to the Apache Software Foundation (ASF) under one or more
3  * contributor license agreements. See the NOTICE file distributed with
4  * this work for additional information regarding copyright ownership.
5  * The ASF licenses this file to You under the Apache License, Version 2.0
6  * (the "License"); you may not use this file except in compliance with
7  * the License. You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17
18 package org.apache.geronimo.util.crypto;
19
20 /**
21  * interface that a message digest conforms to.
22  */
23 public interface Digest
24 {
25     /**
26      * return the algorithm name
27      *
28      * @return the algorithm name
29      */
30     public String JavaDoc getAlgorithmName();
31
32     /**
33      * return the size, in bytes, of the digest produced by this message digest.
34      *
35      * @return the size, in bytes, of the digest produced by this message digest.
36      */
37     public int getDigestSize();
38
39     /**
40      * update the message digest with a single byte.
41      *
42      * @param in the input byte to be entered.
43      */
44     public void update(byte in);
45
46     /**
47      * update the message digest with a block of bytes.
48      *
49      * @param in the byte array containing the data.
50      * @param inOff the offset into the byte array where the data starts.
51      * @param len the length of the data.
52      */
53     public void update(byte[] in, int inOff, int len);
54
55     /**
56      * close the digest, producing the final digest value. The doFinal
57      * call leaves the digest reset.
58      *
59      * @param out the array the digest is to be copied into.
60      * @param outOff the offset into the out array the digest is to start at.
61      */
62     public int doFinal(byte[] out, int outOff);
63
64     /**
65      * reset the digest back to it's initial state.
66      */
67     public void reset();
68 }
69
Popular Tags