001/* Certificate.java -- deprecated interface for modeling digital certificates 002 Copyright (C) 1998, 2002, 2004 Free Software Foundation, Inc. 003 004This file is part of GNU Classpath. 005 006GNU Classpath is free software; you can redistribute it and/or modify 007it under the terms of the GNU General Public License as published by 008the Free Software Foundation; either version 2, or (at your option) 009any later version. 010 011GNU Classpath is distributed in the hope that it will be useful, but 012WITHOUT ANY WARRANTY; without even the implied warranty of 013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 014General Public License for more details. 015 016You should have received a copy of the GNU General Public License 017along with GNU Classpath; see the file COPYING. If not, write to the 018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 01902110-1301 USA. 020 021Linking this library statically or dynamically with other modules is 022making a combined work based on this library. Thus, the terms and 023conditions of the GNU General Public License cover the whole 024combination. 025 026As a special exception, the copyright holders of this library give you 027permission to link this library with independent modules to produce an 028executable, regardless of the license terms of these independent 029modules, and to copy and distribute the resulting executable under 030terms of your choice, provided that you also meet, for each linked 031independent module, the terms and conditions of the license of that 032module. An independent module is a module which is not derived from 033or based on this library. If you modify this library, you may extend 034this exception to your version of the library, but you are not 035obligated to do so. If you do not wish to do so, delete this 036exception statement from your version. */ 037 038 039package java.security; 040 041import java.io.IOException; 042import java.io.InputStream; 043import java.io.OutputStream; 044 045/** 046 * This interface models a digital certificate which verifies the 047 * authenticity of a party. This class simply allows certificate 048 * information to be queried, it does not guarantee that the certificate 049 * is valid. 050 * 051 * <p>This class is deprecated in favor of the new java.security.cert package. 052 * It exists for backward compatibility only. 053 * 054 * @author Aaron M. Renn (arenn@urbanophile.com) 055 * @since 1.1 056 * @deprecated use {@link java.security.cert} instead 057 * @status updated to 1.4 058 */ 059public interface Certificate 060{ 061 /** 062 * This method returns the <code>Principal</code> that is guaranteeing 063 * this certificate. 064 * 065 * @return the <code>Principal</code> guaranteeing the certificate 066 */ 067 Principal getGuarantor(); 068 069 /** 070 * This method returns the <code>Principal</code> being guaranteed by 071 * this certificate. 072 * 073 * @return the <code>Principal</code> guaranteed by this certificate 074 */ 075 Principal getPrincipal(); 076 077 /** 078 * This method returns the public key for the <code>Principal</code> that 079 * is being guaranteed. 080 * 081 * @return the <code>PublicKey</code> of the Principal being guaranteed 082 */ 083 PublicKey getPublicKey(); 084 085 /** 086 * This method writes the certificate to an <code>OutputStream</code> in 087 * a format that can be understood by the <code>decode</code> method. 088 * 089 * @param out the <code>OutputStream</code> to write to 090 * @throws KeyException if there is a problem with the certificate 091 * @throws IOException if an error occurs writing to the stream 092 * @see #decode(InputStream) 093 * @see #getFormat() 094 */ 095 void encode(OutputStream out) throws KeyException, IOException; 096 097 /** 098 * This method reads an encoded certificate from an <code>InputStream</code>. 099 * 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