com.entrust.toolkit.smproxy

Class SMProxySocketFactory

java.lang.Object

javax.net.SocketFactory

com.entrust.toolkit.smproxy.SMProxySocketFactory

All Implemented Interfaces:

java.util.Comparator<javax.net.SocketFactory>

public class SMProxySocketFactory
extends javax.net.SocketFactory
implements java.util.Comparator<javax.net.SocketFactory>

Provides an SMProxy specific version of an SocketFactory class.

Since:

8.1

Constructor Summary

Constructors

Constructor and Description
SMProxySocketFactory(SMProxyWrapper wrapper)

Method Summary

Methods

Modifier and Type	Method and Description
int	compare(javax.net.SocketFactory o1, javax.net.SocketFactory o2) The LDAP Service Provider calls Comparator.compare() method for equality comparison of the socket factories whose connections are being checked for equality by the pooling mechanism.
java.net.Socket	createSocket() Creates an unconnected proxy Socket.
java.net.Socket	createSocket(java.net.InetAddress address, int port) Creates an SMProxySocketWrapper socket and connects it to the specified port number at the specified address.
java.net.Socket	createSocket(java.net.InetAddress address, int port, java.net.InetAddress localAddress, int localPort) Creates an SMProxySocketWrapper socket and connect it to the specified remote address on the specified remote port.
java.net.Socket	createSocket(java.lang.String host, int port) Creates an SMProxySocketWraper socket and connects it to the specified remote host at the specified remote port.
java.net.Socket	createSocket(java.lang.String host, int port, java.net.InetAddress localHost, int localPort) Creates an SMProxySocketWrapper socket and connects it to the specified remote host on the specified remote port.
static javax.net.SocketFactory	getDefault() Get the default socket from a static instance.
static void	setDefault(SMProxyWrapper wrapper) Set the SMProxyWrapper which should be used by the static call to getDefault().

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Comparator

equals

Constructor Detail

SMProxySocketFactory

public SMProxySocketFactory(SMProxyWrapper wrapper)

Method Detail

getDefault

public static javax.net.SocketFactory getDefault()

Get the default socket from a static instance.

Returns:

SocketFactory A newly created socket factory configured with an SMProxyWrapper.

createSocket

public java.net.Socket createSocket()
                             throws java.io.IOException

Creates an unconnected proxy Socket.

Overrides:

createSocket in class javax.net.SocketFactory

Throws:

java.io.IOException

setDefault

public static void setDefault(SMProxyWrapper wrapper)

Set the SMProxyWrapper which should be used by the static call to getDefault().

Parameters:

wrapper - The SMProxyWrapper

createSocket

public java.net.Socket createSocket(java.lang.String host,
                           int port)
                             throws java.io.IOException,
                                    java.net.UnknownHostException

Creates an SMProxySocketWraper socket and connects it to the specified remote host at the specified remote port. This socket is configured using the socket options established for this factory.

Note, when connection with JNDI, this is the method JNDI uses to connect to the SMProxyServer

Specified by:

createSocket in class javax.net.SocketFactory

Parameters:

host - the Hostname to connect

port - the port to connect

Throws:

java.io.IOException

java.net.UnknownHostException

createSocket

public java.net.Socket createSocket(java.net.InetAddress address,
                           int port)
                             throws java.io.IOException

Creates an SMProxySocketWrapper socket and connects it to the specified port number at the specified address. This socket is configured using the socket options established for this factory.

Specified by:

createSocket in class javax.net.SocketFactory

Throws:

java.io.IOException

createSocket

public java.net.Socket createSocket(java.lang.String host,
                           int port,
                           java.net.InetAddress localHost,
                           int localPort)
                             throws java.io.IOException,
                                    java.net.UnknownHostException

Creates an SMProxySocketWrapper socket and connects it to the specified remote host on the specified remote port. The socket will also be bound to the local address and port supplied. This socket is configured using the socket options established for this factory.

Specified by:

createSocket in class javax.net.SocketFactory

Throws:

java.io.IOException

java.net.UnknownHostException

createSocket

public java.net.Socket createSocket(java.net.InetAddress address,
                           int port,
                           java.net.InetAddress localAddress,
                           int localPort)
                             throws java.io.IOException

Creates an SMProxySocketWrapper socket and connect it to the specified remote address on the specified remote port. The socket will also be bound to the local address and port supplied. The socket is configured using the socket options established for this factory.

Specified by:

createSocket in class javax.net.SocketFactory

Throws:

java.io.IOException

compare

public int compare(javax.net.SocketFactory o1,
          javax.net.SocketFactory o2)

The LDAP Service Provider calls Comparator.compare() method for equality comparison of the socket factories whose connections are being checked for equality by the pooling mechanism. The socket factory comparison should ensure that the socket factory parameters that influence the connection equality are being compared.

Specified by:

compare in interface java.util.Comparator<javax.net.SocketFactory>

Parameters:

o1 - the first object to be compared.

o2 - the second object to be compared.

Returns:

a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.