1 package org.apache.commons.openpgp;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one or more
5 * contributor license agreements. See the NOTICE file distributed with
6 * this work for additional information regarding copyright ownership.
7 * The ASF licenses this file to You under the Apache License, Version 2.0
8 * (the "License"); you may not use this file except in compliance with
9 * the License. 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,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 */
19
20 import org.bouncycastle.openpgp.PGPPublicKey;
21 import org.bouncycastle.openpgp.PGPSecretKey;
22
23 /**
24 * Interface describing a key ring for use in signing or verifying data.
25 *
26 * @author <a href="mailto:brett@apache.org">Brett Porter</a>
27 */
28 public interface KeyRing
29 {
30 String ROLE = KeyRing.class.getName();
31
32 /**
33 * @return
34 * @todo seems like the wrong place
35 */
36 char[] getPassword();
37
38 /**
39 * @param keyId
40 * @return
41 * @todo remove BC specifics
42 */
43 PGPSecretKey getSecretKey( String keyId );
44
45 /**
46 * @param keyId
47 * @return
48 * @todo remove BC specifics
49 */
50 PGPPublicKey getPublicKey( String keyId );
51
52 /**
53 * @param keyId
54 * @return
55 * @todo remove BC specifics
56 */
57 PGPSecretKey getSecretKey( long keyId );
58
59 /**
60 * @param keyId
61 * @return
62 * @todo remove BC specifics
63 */
64 PGPPublicKey getPublicKey( long keyId );
65 }