/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License, Version 1.0 only
 * (the "License").  You may not use this file except in compliance
 * with the License.
 *
 * You can obtain a copy of the license at
 * trunk/opends/resource/legal-notices/OpenDS.LICENSE
 * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at
 * trunk/opends/resource/legal-notices/OpenDS.LICENSE.  If applicable,
 * add the following below this CDDL HEADER, with the fields enclosed
 * by brackets "[]" replaced with your own identifying information:
 *      Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 *
 *
 *      Copyright 2009-2010 Sun Microsystems, Inc.
 */

package org.opends.sdk;



import java.net.InetAddress;
import java.net.InetSocketAddress;
import java.net.SocketAddress;

import com.sun.opends.sdk.ldap.LDAPConnectionFactoryImpl;
import com.sun.opends.sdk.util.Validator;



/**
 * A factory class which can be used to obtain connections to an LDAP Directory
 * Server.
 */
public final class LDAPConnectionFactory implements ConnectionFactory
{
  // We implement the factory using the pimpl idiom in order have
  // cleaner Javadoc which does not expose implementation methods from
  // AbstractConnectionFactory.

  private final LDAPConnectionFactoryImpl impl;



  /**
   * Creates a new LDAP connection factory which can be used to create LDAP
   * connections to the Directory Server at the provided address.
   *
   * @param address
   *          The address of the Directory Server.
   * @throws NullPointerException
   *           If {@code address} was {@code null}.
   */
  public LDAPConnectionFactory(final SocketAddress address)
      throws NullPointerException
  {
    this(address, new LDAPOptions());
  }



  /**
   * Creates a new LDAP connection factory which can be used to create LDAP
   * connections to the Directory Server at the provided address.
   *
   * @param address
   *          The address of the Directory Server.
   * @param options
   *          The LDAP options to use when creating connections.
   * @throws NullPointerException
   *           If {@code address} or {@code options} was {@code null}.
   */
  public LDAPConnectionFactory(final SocketAddress address,
      final LDAPOptions options) throws NullPointerException
  {
    Validator.ensureNotNull(address, options);
    this.impl = new LDAPConnectionFactoryImpl(address, options);
  }



  /**
   * Creates a new LDAP connection factory which can be used to create LDAP
   * connections to the Directory Server at the provided host and port address.
   *
   * @param host
   *          The host name.
   * @param port
   *          The port number.
   * @throws NullPointerException
   *           If {@code host} was {@code null}.
   */
  public LDAPConnectionFactory(final String host, final int port)
      throws NullPointerException
  {
    this(host, port, new LDAPOptions());
  }



  /**
   * Creates a new LDAP connection factory which can be used to create LDAP
   * connections to the Directory Server at the provided host and port address.
   *
   * @param host
   *          The host name.
   * @param port
   *          The port number.
   * @param options
   *          The LDAP options to use when creating connections.
   * @throws NullPointerException
   *           If {@code host} or {@code options} was {@code null}.
   */
  public LDAPConnectionFactory(final String host, final int port,
      final LDAPOptions options) throws NullPointerException
  {
    Validator.ensureNotNull(host, options);
    final SocketAddress address = new InetSocketAddress(host, port);
    this.impl = new LDAPConnectionFactoryImpl(address, options);
  }



  /**
   * Returns the {@code InetAddress} that this LDAP listener is listening on.
   *
   * @return The {@code InetAddress} that this LDAP listener is listening on, or
   *         {@code null} if it is unknown.
   */
  public InetAddress getAddress()
  {
    final SocketAddress socketAddress = getSocketAddress();
    if (socketAddress instanceof InetSocketAddress)
    {
      final InetSocketAddress inetSocketAddress = (InetSocketAddress) socketAddress;
      return inetSocketAddress.getAddress();
    }
    else
    {
      return null;
    }
  }



  /**
   * {@inheritDoc}
   */
  @Override
  public FutureResult<AsynchronousConnection> getAsynchronousConnection(
      final ResultHandler<? super AsynchronousConnection> handler)
  {
    return impl.getAsynchronousConnection(handler);
  }



  /**
   * {@inheritDoc}
   */
  @Override
  public Connection getConnection() throws ErrorResultException,
      InterruptedException
  {
    return impl.getConnection();
  }



  /**
   * Returns the host name that this LDAP listener is listening on.
   *
   * @return The host name that this LDAP listener is listening on, or
   *         {@code null} if it is unknown.
   */
  public String getHostname()
  {
    final SocketAddress socketAddress = getSocketAddress();
    if (socketAddress instanceof InetSocketAddress)
    {
      final InetSocketAddress inetSocketAddress = (InetSocketAddress) socketAddress;
      return inetSocketAddress.getHostName();
    }
    else
    {
      return null;
    }
  }



  /**
   * Returns the port that this LDAP listener is listening on.
   *
   * @return The port that this LDAP listener is listening on, or {@code -1} if
   *         it is unknown.
   */
  public int getPort()
  {
    final SocketAddress socketAddress = getSocketAddress();
    if (socketAddress instanceof InetSocketAddress)
    {
      final InetSocketAddress inetSocketAddress = (InetSocketAddress) socketAddress;
      return inetSocketAddress.getPort();
    }
    else
    {
      return -1;
    }
  }



  /**
   * Returns the address that this LDAP listener is listening on.
   *
   * @return The address that this LDAP listener is listening on.
   */
  public SocketAddress getSocketAddress()
  {
    return impl.getSocketAddress();
  }



  /**
   * {@inheritDoc}
   */
  @Override
  public String toString()
  {
    return impl.toString();
  }
}