Class JavaToLDAPSocketFactory

  • All Implemented Interfaces:
    LDAPSocketFactory

    @NotMutable
    @ThreadSafety(level=COMPLETELY_THREADSAFE)
    public final class JavaToLDAPSocketFactory
    extends javax.net.SocketFactory
    implements LDAPSocketFactory
    This class provides an LDAPSocketFactory implementation that wraps a standard Java socket factory to use when creating sockets. It will also appear as a standard Java socket factory.

    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 LDAPSocketFactory interface.
    • Constructor Summary

      Constructors 
      Constructor Description
      JavaToLDAPSocketFactory​(javax.net.SocketFactory f)
      Creates a new instance of this class that will use the provided socket factory.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.net.Socket createSocket​(java.lang.String host, int port)
      Creates a new socket to the specified server.
      java.net.Socket createSocket​(java.lang.String host, int port, java.net.InetAddress localAddress, int localPort)
      Creates a new socket to the specified server.
      java.net.Socket createSocket​(java.net.InetAddress address, int port)
      Creates a new socket to the specified server.
      java.net.Socket createSocket​(java.net.InetAddress address, int port, java.net.InetAddress localAddress, int localPort)
      Creates a new socket to the specified server.
      java.net.Socket makeSocket​(java.lang.String host, int port)
      Creates a socket to use when connecting to the directory sever.
      • Methods inherited from class javax.net.SocketFactory

        createSocket, getDefault
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • JavaToLDAPSocketFactory

        public JavaToLDAPSocketFactory​(javax.net.SocketFactory f)
        Creates a new instance of this class that will use the provided socket factory.
        Parameters:
        f - The socket factory to use to create the LDAP socket factory.
    • Method Detail

      • createSocket

        public java.net.Socket createSocket​(java.lang.String host,
                                            int port)
                                     throws java.io.IOException
        Creates a new socket to the specified server.
        Specified by:
        createSocket in class javax.net.SocketFactory
        Parameters:
        host - The host to which the connection should be established.
        port - The port to which the connection should be established.
        Returns:
        The socket that was created.
        Throws:
        java.io.IOException - If a problem occurs while creating the socket.
      • createSocket

        public java.net.Socket createSocket​(java.lang.String host,
                                            int port,
                                            java.net.InetAddress localAddress,
                                            int localPort)
                                     throws java.io.IOException
        Creates a new socket to the specified server.
        Specified by:
        createSocket in class javax.net.SocketFactory
        Parameters:
        host - The host to which the connection should be established.
        port - The port to which the connection should be established.
        localAddress - The local address to use for the connection. This will be ignored.
        localPort - The local port to use for the connection. This will be ignored.
        Returns:
        The socket that was created.
        Throws:
        java.io.IOException - If a problem occurs while creating the socket.
      • createSocket

        public java.net.Socket createSocket​(java.net.InetAddress address,
                                            int port)
                                     throws java.io.IOException
        Creates a new socket to the specified server.
        Specified by:
        createSocket in class javax.net.SocketFactory
        Parameters:
        address - The address to which the connection should be established.
        port - The port to which the connection should be established.
        Returns:
        The socket that was created.
        Throws:
        java.io.IOException - If a problem occurs while creating the socket.
      • createSocket

        public java.net.Socket createSocket​(java.net.InetAddress address,
                                            int port,
                                            java.net.InetAddress localAddress,
                                            int localPort)
                                     throws java.io.IOException
        Creates a new socket to the specified server.
        Specified by:
        createSocket in class javax.net.SocketFactory
        Parameters:
        address - The address to which the connection should be established.
        port - The port to which the connection should be established.
        localAddress - The local address to use for the connection. This will be ignored.
        localPort - The local port to use for the connection. This will be ignored.
        Returns:
        The socket that was created.
        Throws:
        java.io.IOException - If a problem occurs while creating the socket.
      • makeSocket

        public java.net.Socket makeSocket​(java.lang.String host,
                                          int port)
                                   throws LDAPException
        Creates a socket to use when connecting to the directory sever.
        Specified by:
        makeSocket in interface LDAPSocketFactory
        Parameters:
        host - The address of the server to which the socket should be connected.
        port - The port of the server to which the socket should be connected.
        Returns:
        The connected socket to use to communicate with the directory server.
        Throws:
        LDAPException - If a problem occurs while establishing the connection.