IBM WebSphere Application ServerTM
Release 8

com.ibm.websphere.ssl.protocol
Class SSLServerSocketFactory

java.lang.Object
  extended by javax.net.ServerSocketFactory
      extended by javax.net.ssl.SSLServerSocketFactory
          extended by com.ibm.websphere.ssl.protocol.SSLServerSocketFactory

public class SSLServerSocketFactory
extends javax.net.ssl.SSLServerSocketFactory

This class is for creating SSLServerSockets. It utilizes the com.ibm.websphere.ssl.JSSEHelper APIs to retrieve WebSphere SSL configuration information. You can pass in a Properties object containing SSL properties, an SSL alias, or allow it to return the default SSL properties.

Since:
WAS 6.1
Version:
1.0
See Also:
JSSEHelper

Constructor Summary
SSLServerSocketFactory()
           This is the default constructor which will retrieve the default SSL configuration for creating ServerSockets.
SSLServerSocketFactory(java.util.Properties sslprops)
           This constructor allows you to pass in a set of SSL properties used for creating ServerSockets.
SSLServerSocketFactory(java.lang.String alias)
           This constructor allows you to pass in an SSL alias to retrieve an SSL configuration other than the default for creating ServerSockets.
SSLServerSocketFactory(java.lang.String alias, java.lang.String localEndPointName)
           This constructor allows you to pass in an SSL alias or localEndPointName, depending upon what is available.
 
Method Summary
 java.net.ServerSocket createServerSocket()
           Returns an unbound server socket.
 java.net.ServerSocket createServerSocket(int port)
           Returns a server socket bound to the specified port.
 java.net.ServerSocket createServerSocket(int port, int backlog)
           Returns a server socket bound to the specified port, and uses the specified connection backlog.
 java.net.ServerSocket createServerSocket(int port, int backlog, java.net.InetAddress ifAddress)
           Returns a server socket bound to the specified port, with a specified listen backlog and local IP.
static javax.net.ServerSocketFactory getDefault()
           Returns a copy of the environment's default socket factory.
 java.lang.String[] getDefaultCipherSuites()
           Returns the list of cipher suites which are enabled by default.
 java.lang.String[] getSupportedCipherSuites()
           Returns the names of the cipher suites which could be enabled for use on an SSL connection created by this factory.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SSLServerSocketFactory

public SSLServerSocketFactory()

This is the default constructor which will retrieve the default SSL configuration for creating ServerSockets. It first tries to find the javax.net.ssl.* properties and if not present will choose the default SSL configuration.


SSLServerSocketFactory

public SSLServerSocketFactory(java.lang.String alias)

This constructor allows you to pass in an SSL alias to retrieve an SSL configuration other than the default for creating ServerSockets. If the alias is not found, the default SSL configuration will be used.

Parameters:
String - alias

SSLServerSocketFactory

public SSLServerSocketFactory(java.util.Properties sslprops)

This constructor allows you to pass in a set of SSL properties used for creating ServerSockets.

Parameters:
java.util.Properties - sslprops

SSLServerSocketFactory

public SSLServerSocketFactory(java.lang.String alias,
                              java.lang.String localEndPointName)

This constructor allows you to pass in an SSL alias or localEndPointName, depending upon what is available. You may specified null for any parameters. If SSL alias is specified, a direct selection will occur and default properties will be used if the alias is not found. If localEndPointName is specified, a group selection will occur where the localEndPoint will be used to determine if an SSL config is associated with that endpoint. If not, it will move up the topology to determine the next management scope that has an SSL configuration associated which this EndPoint falls under (e.g., server -> node -> cell, etc.).

Parameters:
String - alias
String - localEndPointName
Method Detail

getDefault

public static javax.net.ServerSocketFactory getDefault()

Returns a copy of the environment's default socket factory.


getDefaultCipherSuites

public java.lang.String[] getDefaultCipherSuites()

Returns the list of cipher suites which are enabled by default.

Specified by:
getDefaultCipherSuites in class javax.net.ssl.SSLServerSocketFactory

getSupportedCipherSuites

public java.lang.String[] getSupportedCipherSuites()

Returns the names of the cipher suites which could be enabled for use on an SSL connection created by this factory.

Specified by:
getSupportedCipherSuites in class javax.net.ssl.SSLServerSocketFactory

createServerSocket

public java.net.ServerSocket createServerSocket()
                                         throws java.io.IOException

Returns an unbound server socket. The socket is configured with the socket options (such as accept timeout) given to this factory.

Overrides:
createServerSocket in class javax.net.ServerSocketFactory
Returns:
java.net.ServerSocket
Throws:
java.io.IOException

createServerSocket

public java.net.ServerSocket createServerSocket(int port)
                                         throws java.io.IOException

Returns a server socket bound to the specified port. The socket is configured with the socket options (such as accept timeout) given to this factory.

Specified by:
createServerSocket in class javax.net.ServerSocketFactory
Parameters:
int - port
Returns:
java.net.ServerSocket
Throws:
java.io.IOException

createServerSocket

public java.net.ServerSocket createServerSocket(int port,
                                                int backlog)
                                         throws java.io.IOException

Returns a server socket bound to the specified port, and uses the specified connection backlog. The socket is configured with the socket options (such as accept timeout) given to this factory.

Specified by:
createServerSocket in class javax.net.ServerSocketFactory
Parameters:
int - port
int - backlog
Returns:
java.net.ServerSocket
Throws:
java.io.IOException

createServerSocket

public java.net.ServerSocket createServerSocket(int port,
                                                int backlog,
                                                java.net.InetAddress ifAddress)
                                         throws java.io.IOException

Returns a server socket bound to the specified port, with a specified listen backlog and local IP. The bindAddr argument can be used on a multi-homed host for a ServerSocket that will only accept connect requests to one of its addresses. The socket is configured with the socket options (such as accept timeout) given to this factory.

Specified by:
createServerSocket in class javax.net.ServerSocketFactory
Parameters:
int - port
int - backlog
InetAddress - ifAddress
Returns:
java.net.ServerSocket
Throws:
java.io.IOException

IBM WebSphere Application ServerTM
Release 8