/*
*
*
* Copyright 1990-2007 Sun Microsystems, Inc. All Rights Reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License version
* 2 only, as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License version 2 for more details (a copy is
* included at /legal/license.txt).
*
* You should have received a copy of the GNU General Public License
* version 2 along with this work; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA
*
* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
* Clara, CA 95054 or visit www.sun.com if you need additional
* information or have any questions.
*/
package javax.microedition.io;
import java.lang.String;
import java.io.IOException;
import javax.microedition.pki.Certificate;
import javax.microedition.pki.CertificateException;
/**
* This interface defines methods
* to access information about a secure network connection.
* Protocols that implement secure connections may use this interface
* to report the security parameters of the connection.
* <p>
* It provides the certificate, protocol, version, and cipher suite,
* etc. in use.
*
* @see CertificateException
* @see SecureConnection
* @see HttpsConnection
*/
public interface SecurityInfo {
/**
* Returns the <CODE>Certificate</CODE> used to establish the
* secure connection with the server.
*
* @return the <CODE>Certificate</CODE> used to establish the
* secure connection with the server.
*/
public Certificate getServerCertificate();
/**
* Returns the protocol version.
* If appropriate, it should contain the major and minor versions
* for the protocol separated with a "." (Unicode U+002E).
* <pre>
* For SSL V3 it MUST return "3.0"
* For TLS 1.0 it MUST return "3.1"
* For WTLS (WAP-199) it MUST return "1"
* For WAP TLS Profile and Tunneling Specification it MUST return "3.1"
*</pre>
* @return a String containing the version of the protocol;
* the return value MUST NOT be <CODE>null</CODE>.
*/
public String getProtocolVersion();
/**
* Returns the secure protocol name.
*
* @return a <code>String</code> containing the secure protocol identifier;
* if TLS (RFC 2246) or WAP TLS Profile and Tunneling (WAP-219-TLS)
* is used for the connection the return value is "TLS";
* if SSL V3 (The SSL Protocol Version 3.0) is used for the connection;
* the return value is "SSL");
* if WTLS (WAP 199) is used for the connection the return value is "WTLS".
*/
public String getProtocolName();
/**
* Returns the name of the cipher suite in use for the connection.
* The name returned is from the CipherSuite column of the CipherSuite
* definitions table in Appendix C of RFC 2246. If the cipher suite is
* not in Appendix C, the name returned is non-null and its contents
* are not specified. For non-TLS implementations the cipher suite name
* should be selected according to the actual key exchange, cipher,
* and hash
* combination used to establish the connection, so that regardless of
* whether the secure connection uses SSL V3
* or TLS 1.0 or WTLS or WAP TLS Profile and Tunneling,
* equivalent cipher suites have the same name.
*
* @return a <code>String</code> containing the name of the cipher suite
* in use.
*/
public String getCipherSuite();
}
|