org.ldaptive.provider.netscape.NetscapeConnectionFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ldaptive-netscape Show documentation
ldaptive netscape provider
There is a newer version: 1.0.13
/*
  $Id: NetscapeConnectionFactory.java 2885 2014-02-05 21:28:49Z dfisher $

  Copyright (C) 2003-2014 Virginia Tech.
  All rights reserved.

  SEE LICENSE FOR MORE INFORMATION

  Author:  Middleware Services
  Email:   [email protected]
  Version: $Revision: 2885 $
  Updated: $Date: 2014-02-05 16:28:49 -0500 (Wed, 05 Feb 2014) $
*/
package org.ldaptive.provider.netscape;

import netscape.ldap.LDAPConnection;
import netscape.ldap.LDAPConstraints;
import netscape.ldap.LDAPException;
import netscape.ldap.LDAPSocketFactory;
import org.ldaptive.LdapException;
import org.ldaptive.LdapURL;
import org.ldaptive.provider.AbstractProviderConnectionFactory;
import org.ldaptive.provider.ConnectionException;

/**
 * Creates ldap connections using the Netscape LDAPConnection class.
 *
 * @author  Middleware Services
 * @version  $Revision: 2885 $ $Date: 2014-02-05 16:28:49 -0500 (Wed, 05 Feb 2014) $
 */
public class NetscapeConnectionFactory
  extends AbstractProviderConnectionFactory
{

  /** LDAP protocol version. */
  public static final int LDAP_VERSION = 3;

  /** Netscape connection constraints. */
  private final LDAPConstraints ldapConstraints;

  /** Socket factory to use for LDAP and LDAPS. */
  private final LDAPSocketFactory socketFactory;

  /** Amount of time in milliseconds that connect operations will block. */
  private final int connectTimeout;

  /** Amount of time in milliseconds that operations will wait. */
  private final int timeLimit;


  /**
   * Creates a new Netscape connection factory.
   *
   * @param  url  of the ldap to connect to
   * @param  config  provider configuration
   * @param  constraints  connection constraints
   * @param  factory  ldap socket factory
   * @param  cTimeout  connection timeout
   * @param  rTimeout  response timeout
   */
  public NetscapeConnectionFactory(
    final String url,
    final NetscapeProviderConfig config,
    final LDAPConstraints constraints,
    final LDAPSocketFactory factory,
    final int cTimeout,
    final int rTimeout)
  {
    super(url, config);
    ldapConstraints = constraints;
    socketFactory = factory;
    connectTimeout = cTimeout;
    timeLimit = rTimeout;
  }


  /** {@inheritDoc} */
  @Override
  protected NetscapeConnection createInternal(final String url)
    throws LdapException
  {
    final LdapURL ldapUrl = new LdapURL(url);
    NetscapeConnection conn = null;
    boolean closeConn = false;
    try {
      LDAPConnection lc;
      if (socketFactory != null) {
        lc = new LDAPConnection(socketFactory);
      } else {
        lc = new LDAPConnection();
      }
      if (connectTimeout > 0) {
        lc.setConnectTimeout(connectTimeout);
      }
      conn = new NetscapeConnection(lc, getProviderConfig());
      if (timeLimit > 0) {
        conn.setTimeLimit(timeLimit);
      }
      lc.connect(
        LDAP_VERSION,
        ldapUrl.getLastEntry().getHostname(),
        ldapUrl.getLastEntry().getPort(),
        null,
        null,
        ldapConstraints);
    } catch (LDAPException e) {
      closeConn = true;
      throw new ConnectionException(
        e,
        org.ldaptive.ResultCode.valueOf(e.getLDAPResultCode()));
    } finally {
      if (closeConn) {
        try {
          if (conn != null) {
            conn.close(null);
          }
        } catch (LdapException e) {
          logger.debug("Problem tearing down connection", e);
        }
      }
    }
    return conn;
  }
}