/*
 * The contents of this file are subject to the terms of the Common Development and
 * Distribution License (the License). You may not use this file except in compliance with the
 * License.
 *
 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
 * specific language governing permission and limitations under the License.
 *
 * When distributing Covered Software, include this CDDL Header Notice in each file and include
 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
 * Header, with the fields enclosed by brackets [] replaced by your own identifying
 * information: "Portions Copyright [year] [name of copyright owner]".
 *
 * Copyright 2006-2008 Sun Microsystems, Inc.
 * Portions Copyright 2014-2015 ForgeRock AS.
 */
package org.opends.server.protocols.jmx;

import java.io.IOException;
import java.net.InetAddress;
import java.net.ServerSocket;
import java.rmi.server.RMIServerSocketFactory;

/**
 * An implementation of the socketServer.
 * <p>
 * The RMI connector class starts and stops the JMX RMI connector server.
 * There are 2 different connector servers
 * <ul>
 * <li>the RMI Client connector server, supporting TLS-encrypted communication,
 * server authentication by certificate and client
 * authentication by providing appropriate LDAP credentials through
 * SASL/PLAIN.</li>
 * <li>the RMI client connector server, supporting TLS-encrypted communication,
 * server authentication by certificate, client
 * authentication by certificate and identity assertion through SASL/PLAIN.</li>
 * </ul>
 * <p>
 * Each connector is registered into the JMX MBean server.
 */
public class OpendsRmiServerSocketFactory implements RMIServerSocketFactory
{
  /** The address to listen on, which could be INADDR_ANY. */
  private final InetAddress listenAddress;

  /** The created ServerSocket. */
  private ServerSocket serverSocket;

  /**
   * Create a new socket factory which will listen on the specified address.
   *
   * @param listenAddress The address to listen on.
   */
  public OpendsRmiServerSocketFactory(InetAddress listenAddress)
  {
    this.listenAddress = listenAddress;
  }

  /** {@inheritDoc} */
  @Override
  public ServerSocket createServerSocket(int port) throws IOException
  {
    serverSocket = new ServerSocket(port, 50, listenAddress);
    return serverSocket;
  }

  /**
   * Close the underlying socket.
   *
   * @throws IOException If an I/O error occurs when closing the socket.
   */
  void close() throws IOException
  {
    if (serverSocket != null)
    {
      serverSocket.close();
      serverSocket = null;
    }
  }
}