1 package org.apache.java.security;
2
3 /* ====================================================================
4 * The Apache Software License, Version 1.1
5 *
6 * Copyright (c) 2001 The Apache Software Foundation. All rights
7 * reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 *
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 *
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in
18 * the documentation and/or other materials provided with the
19 * distribution.
20 *
21 * 3. The end-user documentation included with the redistribution,
22 * if any, must include the following acknowledgment:
23 * "This product includes software developed by the
24 * Apache Software Foundation (http://www.apache.org/)."
25 * Alternately, this acknowledgment may appear in the software itself,
26 * if and wherever such third-party acknowledgments normally appear.
27 *
28 * 4. The names "Apache" and "Apache Software Foundation" and
29 * "Apache Turbine" must not be used to endorse or promote products
30 * derived from this software without prior written permission. For
31 * written permission, please contact apache@apache.org.
32 *
33 * 5. Products derived from this software may not be called "Apache",
34 * "Apache Turbine", nor may "Apache" appear in their name, without
35 * prior written permission of the Apache Software Foundation.
36 *
37 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
41 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48 * SUCH DAMAGE.
49 * ====================================================================
50 *
51 * This software consists of voluntary contributions made by many
52 * individuals on behalf of the Apache Software Foundation. For more
53 * information on the Apache Software Foundation, please see
54 * <http://www.apache.org/>.
55 */
56
57 /***
58 * This interface abstracts a message digest algorithm.
59 *
60 * <p><b>Note:</b> even if standard Java 1.1 APIs already provide a
61 * message digest implementation, this class is used on those Java
62 * runtime environments (like Kaffe) where the package
63 * <code>java.security</code> is highly improbable to be found.
64 *
65 * @author <a href="mailto:mazzocchi@mbox.systemy.it">Stefano Mazzocchi</a>
66 * @version $Id: MessageDigest.java,v 1.1.1.1 2001/08/16 05:08:27 jvanzyl Exp $
67 */
68 public abstract class MessageDigest
69 {
70 /***
71 * Creates the algorithm and reset its state.
72 */
73 public MessageDigest()
74 {
75 this.reset();
76 }
77
78 /***
79 * Append another block to the message.
80 *
81 * @param block A byte[].
82 */
83 public void append(byte[] block)
84 {
85 this.append(block, 0, block.length);
86 }
87
88 /***
89 * Append another block of specified length to the message.
90 *
91 * @param block A byte[].
92 * @param length An int.
93 */
94 public void append(byte[] block,
95 int length)
96 {
97 this.append(block, 0, length);
98 }
99
100 /***
101 * Append another block of specified length to the message
102 * starting at the given offset.
103 *
104 * @param block A byte[].
105 * @param offset An int.
106 * @param length An int.
107 */
108 public abstract void append(byte[] block,
109 int offset,
110 int length);
111
112 /***
113 * Appends a message block and return its message digest.
114 *
115 * @param block A byte[].
116 * @return A byte[].
117 */
118 public byte[] digest(byte[] block)
119 {
120 return this.digest(block, 0, block.length);
121 }
122
123 /***
124 * Appends a message block with specified length and return its
125 * message digest.
126 *
127 * @param block A byte[].
128 * @param length An int.
129 * @return A byte[].
130 */
131 public byte[] digest(byte[] block,
132 int length)
133 {
134 return this.digest(block, 0, length);
135 }
136
137 /***
138 * Appends a message block with specified length starting from the
139 * given offset and return its message digest.
140 *
141 * @param block A byte[].
142 * @param offset An int.
143 * @param length An int.
144 * @return A byte[].
145 */
146 public abstract byte[] digest(byte[] block,
147 int offset,
148 int length);
149
150 /***
151 * Resets the state of the class. <b>Beware</b>: calling this
152 * method erases all data previously inserted.
153 */
154 public abstract void reset();
155 }
This page was automatically generated by Maven