View Javadoc

1   /*
2    * The MIT License
3    *
4    * Original work sponsored and donated by National Board of e-Health (NSI), Denmark (http://www.nsi.dk)
5    *
6    * Copyright (C) 2011 National Board of e-Health (NSI), Denmark (http://www.nsi.dk)
7    *
8    * Permission is hereby granted, free of charge, to any person obtaining a copy of
9    * this software and associated documentation files (the "Software"), to deal in
10   * the Software without restriction, including without limitation the rights to
11   * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
12   * of the Software, and to permit persons to whom the Software is furnished to do
13   * so, subject to the following conditions:
14   *
15   * The above copyright notice and this permission notice shall be included in all
16   * copies or substantial portions of the Software.
17   *
18   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24   * SOFTWARE.
25   *
26   * $HeadURL$
27   * $Id$
28   */
29  package dk.sosi.seal.pki;
30  
31  import java.security.cert.X509Certificate;
32  
33  /**
34   * This is a generic cache of certificates with get/put operations.
35   * Note that implementations are NOT expected to be synchronized.
36   * You should instead synchronize on the wrapping CachingCertificateStore
37   *
38   * @author ksr@lakeside.dk
39   * @author $LastChangedBy: ksr@lakeside.dk $
40   * @version $Revision: 8000 $
41   * @since 2.1
42   */
43  public interface CertificateCache {
44      enum Category {
45          FederationCert, IntermediateCert
46      }
47  
48      /**
49       * Retrieve the cross certificate based on the supplied URL.
50       *
51       * @param category
52       * @param key The remote location of the cross certificate.  @return The cross certificate.
53       */
54      public void putCertificate(Category category, String key, X509Certificate certificate) throws PKIException;
55  
56      /**
57       * Retrieve the certificate based on the supplied key.
58       *
59       * @param category
60       * @param key The location of the certificate.
61       * @return The certificate.
62       */
63      public X509Certificate getCertificate(Category category, String key) throws PKIException;
64  }