001/* 002 * Copyright 2009-2020 Ping Identity Corporation 003 * All Rights Reserved. 004 */ 005/* 006 * Copyright 2009-2020 Ping Identity Corporation 007 * 008 * Licensed under the Apache License, Version 2.0 (the "License"); 009 * you may not use this file except in compliance with the License. 010 * You may obtain a copy of the License at 011 * 012 * http://www.apache.org/licenses/LICENSE-2.0 013 * 014 * Unless required by applicable law or agreed to in writing, software 015 * distributed under the License is distributed on an "AS IS" BASIS, 016 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 017 * See the License for the specific language governing permissions and 018 * limitations under the License. 019 */ 020/* 021 * Copyright (C) 2009-2020 Ping Identity Corporation 022 * 023 * This program is free software; you can redistribute it and/or modify 024 * it under the terms of the GNU General Public License (GPLv2 only) 025 * or the terms of the GNU Lesser General Public License (LGPLv2.1 only) 026 * as published by the Free Software Foundation. 027 * 028 * This program is distributed in the hope that it will be useful, 029 * but WITHOUT ANY WARRANTY; without even the implied warranty of 030 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 031 * GNU General Public License for more details. 032 * 033 * You should have received a copy of the GNU General Public License 034 * along with this program; if not, see <http://www.gnu.org/licenses>. 035 */ 036package com.unboundid.ldap.sdk.migrate.ldapjdk; 037 038 039 040import java.net.Socket; 041 042import com.unboundid.util.Extensible; 043import com.unboundid.util.ThreadSafety; 044import com.unboundid.util.ThreadSafetyLevel; 045 046 047 048/** 049 * This interface defines a method that can be used to construct the socket to 050 * use when communicating with the directory server. 051 * <BR><BR> 052 * This class is primarily intended to be used in the process of updating 053 * applications which use the Netscape Directory SDK for Java to switch to or 054 * coexist with the UnboundID LDAP SDK for Java. For applications not written 055 * using the Netscape Directory SDK for Java, the standard Java socket factory 056 * may be used directly without the need for the {@code LDAPSocketFactory} 057 * interface. 058 */ 059@Extensible() 060@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_THREADSAFE) 061public interface LDAPSocketFactory 062{ 063 /** 064 * Creates a socket to use when connecting to the directory sever. 065 * 066 * @param host The address of the server to which the socket should be 067 * connected. 068 * @param port The port of the server to which the socket should be 069 * connected. 070 * 071 * @return The connected socket to use to communicate with the directory 072 * server. 073 * 074 * @throws LDAPException If a problem occurs while establishing the 075 * connection. 076 */ 077 Socket makeSocket(String host, int port) 078 throws LDAPException; 079}