All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.unboundid.ldap.sdk.FastestConnectThread Maven / Gradle / Ivy

/*
 * Copyright 2012-2022 Ping Identity Corporation
 * All Rights Reserved.
 */
/*
 * Copyright 2012-2022 Ping Identity Corporation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
/*
 * Copyright (C) 2012-2022 Ping Identity Corporation
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License (GPLv2 only)
 * or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, see .
 */
package com.unboundid.ldap.sdk;



import java.util.concurrent.BlockingQueue;
import java.util.concurrent.atomic.AtomicBoolean;
import javax.net.SocketFactory;

import com.unboundid.util.Debug;
import com.unboundid.util.NotNull;
import com.unboundid.util.Nullable;
import com.unboundid.util.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;



/**
 * This class provides a thread that will be used to attempt a connection to a
 * directory server in conjunction with the {@link FastestConnectServerSet}.
 */
@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
final class FastestConnectThread
      extends Thread
{
  // The flag that will be used to indicate whether a connection has already
  // been selected by the server set.
  @NotNull private final AtomicBoolean connectionSelected;

  // The bind request to use to authenticate connections created by this
  // server set.
  @Nullable private final BindRequest bindRequest;

  // The queue that should be used to return the result to the server set.
  @NotNull private final BlockingQueue resultQueue;

  // The port to which the connection should be established.
  private final int port;

  // The LDAP connection to be established.
  @NotNull private final LDAPConnection connection;

  // The health check to use to evaluate the suitability of the established
  // connection.
  @Nullable private final LDAPConnectionPoolHealthCheck healthCheck;

  // The post-connect processor to invoke against connections created by this
  // server set.
  @Nullable private final PostConnectProcessor postConnectProcessor;

  // The address to which the connection should be established.
  @NotNull private final String address;



  /**
   * Creates a new instance of this connect thread with the provided
   * information.
   *
   * @param  address               The address of the server to which the
   *                               connection should be established.
   * @param  port                  The port of the server to which the
   *                               connection should be established.
   * @param  socketFactory         The socket factory that should be used for
   *                               the connection.
   * @param  connectionOptions     The set of connection options that should be
   *                               used for the connection.
   * @param  bindRequest           The bind request that should be used to
   *                               authenticate newly-established connections.
   *                               It may be {@code null} if this server set
   *                               should not perform any authentication.
   * @param  postConnectProcessor  The post-connect processor that should be
   *                               invoked on newly-established connections.  It
   *                               may be {@code null} if this server set should
   *                               not perform any post-connect processing.
   * @param  healthCheck           The health check to use to evaluate the
   *                               suitability of the established connection.
   *                               It may be {@code null} if no health check is
   *                               needed.
   * @param  resultQueue           The queue that should be used to return the
   *                               result to the server set.
   * @param  connectionSelected    A flag that will be used to indicate whether
   *                               a connection has already been selected by the
   *                               associated server set.
   */
  FastestConnectThread(@NotNull final String address, final int port,
       @NotNull final SocketFactory socketFactory,
       @NotNull final LDAPConnectionOptions connectionOptions,
       @Nullable final BindRequest bindRequest,
       @Nullable final PostConnectProcessor postConnectProcessor,
       @Nullable final LDAPConnectionPoolHealthCheck healthCheck,
       @NotNull final BlockingQueue resultQueue,
       @NotNull final AtomicBoolean connectionSelected)
  {
    super("Fastest Connect Thread for " + address + ':' + port);
    setDaemon(true);

    this.address = address;
    this.port = port;
    this.bindRequest = bindRequest;
    this.postConnectProcessor = postConnectProcessor;
    this.healthCheck = healthCheck;
    this.resultQueue = resultQueue;
    this.connectionSelected = connectionSelected;

    connection = new LDAPConnection(socketFactory, connectionOptions);
  }



  /**
   * Attempts to establish the connection and return it to the server set if it
   * is acceptable.
   */
  @Override()
  public void run()
  {
    boolean returned = false;

    try
    {
      connection.connect(address, port);
      ServerSet.doBindPostConnectAndHealthCheckProcessing(connection,
           bindRequest, postConnectProcessor, healthCheck);
      returned = (connectionSelected.compareAndSet(false, true) &&
          resultQueue.offer(connection));
    }
    catch (final Exception e)
    {
      Debug.debugException(e);
      resultQueue.offer(e);
    }
    finally
    {
      if (! returned)
      {
        connection.close();
      }
    }
  }
}