001/*
002 * CDDL HEADER START
003 *
004 * The contents of this file are subject to the terms of the
005 * Common Development and Distribution License, Version 1.0 only
006 * (the "License").  You may not use this file except in compliance
007 * with the License.
008 *
009 * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
010 * or http://forgerock.org/license/CDDLv1.0.html.
011 * See the License for the specific language governing permissions
012 * and limitations under the License.
013 *
014 * When distributing Covered Code, include this CDDL HEADER in each
015 * file and include the License file at legal-notices/CDDLv1_0.txt.
016 * If applicable, add the following below this CDDL HEADER, with the
017 * fields enclosed by brackets "[]" replaced with your own identifying
018 * information:
019 *      Portions Copyright [yyyy] [name of copyright owner]
020 *
021 * CDDL HEADER END
022 *
023 *
024 *      Copyright 2006-2009 Sun Microsystems, Inc.
025 *      Portions Copyright 2013-2015 ForgeRock AS
026 */
027package org.opends.server.extensions;
028
029import org.forgerock.i18n.LocalizableMessageBuilder;
030
031/**
032 * This interface defines a set of methods that must be implemented by a class
033 * (expected to be a client connection) that can dynamically enable and disable
034 * the TLS connection security provider.  This will be used by the StartTLS
035 * extended operation handler to perform the core function of enabling TLS on an
036 * established connection.
037 */
038public interface TLSCapableConnection
039{
040  /**
041   * Prepares this connection for using TLS and returns whether TLS protection
042   * is actually available for the underlying client connection. If there is any
043   * reason that TLS protection cannot be enabled on this client connection,
044   * then it should be appended to the provided buffer.
045   *
046   * @param  unavailableReason  The buffer used to hold the reason that TLS is
047   *                            not available on the underlying client
048   *                            connection.
049   *
050   * @return  <CODE>true</CODE> if TLS is available on the underlying client
051   *          connection, or <CODE>false</CODE> if it is not.
052   */
053  boolean prepareTLS(LocalizableMessageBuilder unavailableReason);
054}
055