1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.crypto

File DigestFactory.java

 

Code metrics

0
0
0
1
65
12
0
-
-
0
-

Classes

Class Line # Actions
DigestFactory 32 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

Source view

1    /*
2    * See the NOTICE file distributed with this work for additional
3    * information regarding copyright ownership.
4    *
5    * This is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU Lesser General Public License as
7    * published by the Free Software Foundation; either version 2.1 of
8    * the License, or (at your option) any later version.
9    *
10    * This software is distributed in the hope that it will be useful,
11    * but WITHOUT ANY WARRANTY; without even the implied warranty of
12    * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13    * Lesser General Public License for more details.
14    *
15    * You should have received a copy of the GNU Lesser General Public
16    * License along with this software; if not, write to the Free
17    * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
18    * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
19    */
20    package org.xwiki.crypto;
21   
22    import org.xwiki.component.annotation.Role;
23    import org.xwiki.crypto.params.DigestParameters;
24   
25    /**
26    * Factory for creating new digest instance.
27    *
28    * @version $Id: 73a42489eae6371e2659b7d8eedee53e77bd5461 $
29    * @since 5.4M1
30    */
31    @Role
 
32    public interface DigestFactory
33    {
34    /**
35    * @return the algorithm name of created ciphers (ie: AES, CAST5, ...)
36    */
37    String getDigestAlgorithmName();
38   
39    /**
40    * @return the block size of created ciphers (in bytes).
41    */
42    int getDigestSize();
43   
44    /**
45    * @return an initialized digest ready to process data.
46    */
47    Digest getInstance();
48   
49    /**
50    * This is a very usual need, since most digest does not take parameters, but this will allow digest that take
51    * parameters to be implemented as well.
52    *
53    * @param parameters digest parameters to initialize the digest.
54    * @return an initialized digest ready to process data based on given parameters.
55    */
56    Digest getInstance(DigestParameters parameters);
57   
58    /**
59    * Create a new initialized digest from serialized encoding.
60    *
61    * @param encoded encoded parameters to initialize this digest.
62    * @return an initialized digest ready to process data based on encoded data.
63    */
64    Digest getInstance(byte[] encoded);
65    }