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 2013-2014 ForgeRock AS.
025 */
026package org.forgerock.opendj.ldap.spi;
027
028import java.io.Closeable;
029import java.net.InetSocketAddress;
030
031/**
032 * Interface for all classes that actually implement {@code LDAPListener}.
033 * <p>
034 * An implementation class is provided by a {@code TransportProvider}.
035 * <p>
036 * The implementation can be automatically loaded using the
037 * {@code java.util.ServiceLoader} facility if its provider extending
038 * {@code TransportProvider} is declared in the provider-configuration file
039 * {@code META-INF/services/org.forgerock.opendj.ldap.spi.TransportProvider}.
040 */
041public interface LDAPListenerImpl extends Closeable {
042
043    /**
044     * Returns the address that this LDAP listener is listening on.
045     *
046     * @return The address that this LDAP listener is listening on.
047     */
048    InetSocketAddress getSocketAddress();
049
050    /**
051     * Closes this stream and releases any system resources associated
052     * with it. If the stream is already closed then invoking this
053     * method has no effect.
054     */
055    @Override
056    void close();
057
058}