com.unboundid.ldap.sdk.migrate.ldapjdk.LDAPSocketFactory Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2009-2017 UnboundID Corp.
 * All Rights Reserved.
 */
/*
 * Copyright (C) 2009-2017 UnboundID Corp.
 *
 * 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.migrate.ldapjdk;



import java.net.Socket;

import com.unboundid.util.Extensible;
import com.unboundid.util.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;



/**
 * This interface defines a method that can be used to construct the socket to
 * use when communicating with the directory server.
 * 


 * This class is primarily intended to be used in the process of updating
 * applications which use the Netscape Directory SDK for Java to switch to or
 * coexist with the UnboundID LDAP SDK for Java.  For applications not written
 * using the Netscape Directory SDK for Java, the standard Java socket factory
 * may be used directly without the need for the {@code LDAPSocketFactory}
 * interface.
 */
@Extensible()
@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_THREADSAFE)
public interface LDAPSocketFactory
{
  /**
   * Creates a socket to use when connecting to the directory sever.
   *
   * @param  host  The address of the server to which the socket should be
   *               connected.
   * @param  port  The port of the server to which the socket should be
   *               connected.
   *
   * @return  The connected socket to use to communicate with the directory
   *          server.
   *
   * @throws  LDAPException  If a problem occurs while establishing the
   *                         connection.
   */
  Socket makeSocket(final String host, final int port)
         throws LDAPException;
}