001/* StartTlsResponse.java -- extended ldap TLS response 002 Copyright (C) 2006 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 javax.naming.ldap; 040 041import java.io.IOException; 042 043import javax.net.ssl.HostnameVerifier; 044import javax.net.ssl.SSLSession; 045import javax.net.ssl.SSLSocketFactory; 046 047/** 048 * @since 1.4 049 */ 050public abstract class StartTlsResponse 051 implements ExtendedResponse 052{ 053 private static final long serialVersionUID = 8372842182579276418L; 054 055 /** 056 * The assigned object identifier for this response. 057 */ 058 public static final String OID = "1.3.6.1.4.1.1466.20037"; 059 060 /** 061 * Create a new instance. 062 */ 063 protected StartTlsResponse() 064 { 065 } 066 067 /** 068 * Return the response identifier. This is simply the value 069 * of the {@link #OID} field. 070 */ 071 public String getID() 072 { 073 return OID; 074 } 075 076 /** 077 * Return the encoded value. This implementation always returns null. 078 */ 079 public byte[] getEncodedValue() 080 { 081 return null; 082 } 083 084 /** 085 * Set the list of cipher suites to use. 086 * @param cipherSuites the list of suites 087 * @see SSLSocketFactory#getSupportedCipherSuites() 088 */ 089 public abstract void setEnabledCipherSuites(String[] cipherSuites); 090 091 /** 092 * Set the hostname verifier to use. This must be called before 093 * {@link #negotiate()}. 094 * @param verifier the hostname verifier 095 */ 096 public abstract void setHostnameVerifier(HostnameVerifier verifier); 097 098 /** 099 * Negotiate the TLS session using the default SSL socket factory. 100 * @return the SSL session 101 * @throws IOException if communication fails for some reason 102 */ 103 public abstract SSLSession negotiate() throws IOException; 104 105 /** 106 * Negotiate the TLS session using the supplied SSL socket factory. 107 * @param factory the socket factory to use 108 * @return the SSL session 109 * @throws IOException if communication fails for some reason 110 */ 111 public abstract SSLSession negotiate(SSLSocketFactory factory) 112 throws IOException; 113 114 /** 115 * Close the connection. 116 * @throws IOException if communication fails for some reason 117 */ 118 public abstract void close() throws IOException; 119}