FSF GCC merge 02/23/03
[official-gcc.git] / libjava / java / security / Certificate.java
blobf37d919a73341cb761b7c6035eb1dbd4abd89202
1 /* Certificate.java -- deprecated interface for modeling digital certificates
2 Copyright (C) 1998, 2002 Free Software Foundation, Inc.
4 This file is part of GNU Classpath.
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.
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.
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.
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.
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. */
38 package java.security;
40 import java.io.InputStream;
41 import java.io.OutputStream;
42 import java.io.IOException;
44 /**
45 * This interface models a digital certificate which verifies the
46 * authenticity of a party. This class simply allows certificate
47 * information to be queried, it does not guarantee that the certificate
48 * is valid.
50 * <p>This class is deprecated in favor of the new java.security.cert package.
51 * It exists for backward compatibility only.
53 * @author Aaron M. Renn (arenn@urbanophile.com)
54 * @since 1.1
55 * @deprecated use {@link java.security.cert} instead
56 * @status updated to 1.4
58 public interface Certificate
60 /**
61 * This method returns the <code>Principal</code> that is guaranteeing
62 * this certificate.
64 * @return the <code>Principal</code> guaranteeing the certificate
65 * @deprecated this entire interface is deprecated
67 Principal getGuarantor();
69 /**
70 * This method returns the <code>Principal</code> being guaranteed by
71 * this certificate.
73 * @return the <code>Principal</code> guaranteed by this certificate
74 * @deprecated this entire interface is deprecated
76 Principal getPrincipal();
78 /**
79 * This method returns the public key for the <code>Principal</code> that
80 * is being guaranteed.
82 * @return the <code>PublicKey</code> of the Principal being guaranteed
83 * @deprecated this entire interface is deprecated
85 PublicKey getPublicKey();
87 /**
88 * This method writes the certificate to an <code>OutputStream</code> in
89 * a format that can be understood by the <code>decode</code> method.
91 * @param out the <code>OutputStream</code> to write to
92 * @throws KeyException if there is a problem with the certificate
93 * @throws IOException if an error occurs writing to the stream
94 * @see #decode(InputStream)
95 * @see #getFormat()
96 * @deprecated this entire interface is deprecated
98 void encode(OutputStream out) throws KeyException, IOException;
101 * This method reads an encoded certificate from an <code>InputStream</code>.
103 * @param in the <code>InputStream</code> to read from
104 * @throws KeyException if there is a problem with the certificate data
105 * @throws IOException if an error occurs reading from the stream
106 * @see #encode(OutputStream)
107 * @see #getFormat()
108 * @deprecated this entire interface is deprecated
110 void decode(InputStream in) throws KeyException, IOException;
113 * This method returns the encoding format of the certificate (e.g., "PGP",
114 * "X.509"). This format is used by the <code>encode</code> and
115 * <code>decode</code> methods.
117 * @return the encoding format being used
118 * @deprecated this entire interface is deprecated
120 String getFormat();
123 * This method returns a <code>String</code> representation of the contents
124 * of this certificate.
126 * @param detail true to provided more detailed information
127 * @return the string representation
128 * @deprecated this entire interface is deprecated
130 String toString(boolean detail);
131 } // interface Certificate