View Javadoc
1   /*
2    * Copyright (c) 1998, 2006, Oracle and/or its affiliates. All rights reserved.
3    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4    *
5    * This code is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU General Public License version 2 only, as
7    * published by the Free Software Foundation.  Oracle designates this
8    * particular file as subject to the "Classpath" exception as provided
9    * by Oracle in the LICENSE file that accompanied this code.
10   *
11   * This code is distributed in the hope that it will be useful, but WITHOUT
12   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13   * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14   * version 2 for more details (a copy is included in the LICENSE file that
15   * accompanied this code).
16   *
17   * You should have received a copy of the GNU General Public License version
18   * 2 along with this work; if not, write to the Free Software Foundation,
19   * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20   *
21   * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22   * or visit www.oracle.com if you need additional information or have any
23   * questions.
24   */
25  
26  package java.security.cert;
27  
28  /**
29   * This class is an abstraction of certificate revocation lists (CRLs) that
30   * have different formats but important common uses. For example, all CRLs
31   * share the functionality of listing revoked certificates, and can be queried
32   * on whether or not they list a given certificate.
33   * <p>
34   * Specialized CRL types can be defined by subclassing off of this abstract
35   * class.
36   *
37   * @author Hemma Prafullchandra
38   *
39   *
40   * @see X509CRL
41   * @see CertificateFactory
42   *
43   * @since 1.2
44   */
45  
46  public abstract class CRL {
47  
48      // the CRL type
49      private String type;
50  
51      /**
52       * Creates a CRL of the specified type.
53       *
54       * @param type the standard name of the CRL type.
55       * See Appendix A in the <a href=
56       * "../../../../technotes/guides/security/crypto/CryptoSpec.html#AppA">
57       * Java Cryptography Architecture API Specification &amp; Reference </a>
58       * for information about standard CRL types.
59       */
60      protected CRL(String type) {
61          this.type = type;
62      }
63  
64      /**
65       * Returns the type of this CRL.
66       *
67       * @return the type of this CRL.
68       */
69      public final String getType() {
70          return this.type;
71      }
72  
73      /**
74       * Returns a string representation of this CRL.
75       *
76       * @return a string representation of this CRL.
77       */
78      public abstract String toString();
79  
80      /**
81       * Checks whether the given certificate is on this CRL.
82       *
83       * @param cert the certificate to check for.
84       * @return true if the given certificate is on this CRL,
85       * false otherwise.
86       */
87      public abstract boolean isRevoked(Certificate cert);
88  }