libjava/java/security/Certificate.java

   1 /* Certificate.java -- deprecated interface for modeling digital certificates
   2    Copyright (C) 1998, 2002, 2004  Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38
  39 package java.security;
  40
  41 import java.io.IOException;
  42 import java.io.InputStream;
  43 import java.io.OutputStream;
  44
  45 /**
  46  * This interface models a digital certificate which verifies the
  47  * authenticity of a party.  This class simply allows certificate
  48  * information to be queried, it does not guarantee that the certificate
  49  * is valid.
  50  *
  51  * <p>This class is deprecated in favor of the new java.security.cert package.
  52  * It exists for backward compatibility only.
  53  *
  54  * @author Aaron M. Renn (arenn@urbanophile.com)
  55  * @since 1.1
  56  * @deprecated use {@link java.security.cert} instead
  57  * @status updated to 1.4
  58  */
  59 public interface Certificate
  60 {
  61   /**
  62    * This method returns the <code>Principal</code> that is guaranteeing
  63    * this certificate.
  64    *
  65    * @return the <code>Principal</code> guaranteeing the certificate
  66    */
  67   Principal getGuarantor();
  68
  69   /**
  70    * This method returns the <code>Principal</code> being guaranteed by
  71    * this certificate.
  72    *
  73    * @return the <code>Principal</code> guaranteed by this certificate
  74    */
  75   Principal getPrincipal();
  76
  77   /**
  78    * This method returns the public key for the <code>Principal</code> that
  79    * is being guaranteed.
  80    *
  81    * @return the <code>PublicKey</code> of the Principal being guaranteed
  82    */
  83   PublicKey getPublicKey();
  84
  85   /**
  86    * This method writes the certificate to an <code>OutputStream</code> in
  87    * a format that can be understood by the <code>decode</code> method.
  88    *
  89    * @param out the <code>OutputStream</code> to write to
  90    * @throws KeyException if there is a problem with the certificate
  91    * @throws IOException if an error occurs writing to the stream
  92    * @see #decode(InputStream)
  93    * @see #getFormat()
  94    */
  95   void encode(OutputStream out) throws KeyException, IOException;
  96
  97   /**
  98    * This method reads an encoded certificate from an <code>InputStream</code>.
  99    *
 100    * @param in the <code>InputStream</code> to read from
 101    * @throws KeyException if there is a problem with the certificate data
 102    * @throws IOException if an error occurs reading from the stream
 103    * @see #encode(OutputStream)
 104    * @see #getFormat()
 105    */
 106   void decode(InputStream in) throws KeyException, IOException;
 107
 108   /**
 109    * This method returns the encoding format of the certificate (e.g., "PGP",
 110    * "X.509").  This format is used by the <code>encode</code> and
 111    * <code>decode</code> methods.
 112    *
 113    * @return the encoding format being used
 114    */
 115   String getFormat();
 116
 117   /**
 118    * This method returns a <code>String</code> representation of the contents
 119    * of this certificate.
 120    *
 121    * @param detail true to provided more detailed information
 122    * @return the string representation
 123    */
 124   String toString(boolean detail);
 125 } // interface Certificate