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

File KeyPairGenerator.java

 

Code metrics

0
0
0
1
50
10
0
-
-
0
-

Classes

Class Line # Actions
KeyPairGenerator 36 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.cipher.asymmetric.AsymmetricKeyPair;
24    import org.xwiki.crypto.params.generator.KeyGenerationParameters;
25   
26    /**
27    * Component role for a key pair generator.
28    *
29    * Component providing this role is usually tightly coupled with those implementing the AsymmetricKeyFactory for the
30    * same hints. So, overriding one of these components usually requires to override both.
31    *
32    * @version $Id: 71f803a57026ccfb06a7e0ddd026794a507e8fbd $
33    * @since 5.4M1
34    */
35    @Role
 
36    public interface KeyPairGenerator
37    {
38    /**
39    * @return a new key pair based on default parameters.
40    */
41    AsymmetricKeyPair generate();
42   
43    /**
44    * Generate a new key pair based on given parameters.
45    *
46    * @param params the key generation parameters.
47    * @return a new key pair based the given parameters.
48    */
49    AsymmetricKeyPair generate(KeyGenerationParameters params);
50    }