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