se.entra.phantom.server

Interface ServerSocketInterface2

All Superinterfaces:

ServerSocketInterface

All Known Subinterfaces:

ServerSocketInterface3

All Known Implementing Classes:

DefaultServerSocket, NetPhantomJSSEServerSocket

public interface ServerSocketInterface2
extends ServerSocketInterface

ServerSocketInterface2 is used by servers to listen for requests from clients for [SSL] connections. The ServerSocketInterface2 listens on the specified port; optional arguments specify the backlog of client connection requests.

As SSL requires additional parameters that are generally implementation dependent, the "server.ini" file object is passed along. This makes it possible to access information in - typically - the "[SSL]" section of the file.

Field Summary

Fields inherited from interface se.entra.phantom.server.ServerSocketInterface

SSLINFO_CLIENTCERT_ISSUER, SSLINFO_CLIENTCERT_PUBLICKEYFORMAT, SSLINFO_CLIENTCERT_SERIALNUMBER, SSLINFO_CLIENTCERT_SIGNATUREALGORITHM, SSLINFO_CLIENTCERT_SUBJECT, SSLINFO_CLIENTCERT_VALIDFROM, SSLINFO_CLIENTCERT_VALIDTO, SSLINFO_CLIENTCERT_VERSION, SSLINFO_GETCIPHER, SSLINFO_GETEFFECTIVEBITS, SSLINFO_ISENCRYPTED, SSLINFO_ISSTRONGENCRYPTED

Method Summary

Modifier and Type	Method and Description
ISocket	acceptNoHandshake() Listens for a connection to be made to this socket and accepts it.
ServerSocketInterface2	createServerSocket(String id, int port, int mapToPort, int count, InetAddress address) Creates the ServerSocket listener.
void	initialize(IniFile ini, String name) Initializes the server socket with information in the INI file for the SSL protocol.
void	performAcceptHandshake(ISocket s) Performs the accept handshake for SSL.

Methods inherited from interface se.entra.phantom.server.ServerSocketInterface

close, getInetAddress, getInformation, getLocalAddress, getLocalName, getLocalPort, getMapToPort, getPortID, isEncrypted, isLoadBalanced, isStrongEncrypted, isUsingSSL, renegotiateSession, setExternalSSL, setLoadBalancing, toString

Method Detail

initialize

void initialize(IniFile ini,
                String name)
         throws IOException

Initializes the server socket with information in the INI file for the SSL protocol. This method is called for non-SSL server sockets with the name parameter set to null.

Parameters:

ini - the "server.ini" file from where the potential SSL package reads information to create the server socket.

name - the section name in the INI file where all settings are stored (null when no SSL).

Throws:

IOException - When there is an I/O failure.

createServerSocket

ServerSocketInterface2 createServerSocket(String id,
                                          int port,
                                          int mapToPort,
                                          int count,
                                          InetAddress address)
                                   throws IOException

Creates the ServerSocket listener. Because this is an interface, the creation routine must create the [SSL]ServerSocket with the appropriate parameters. This will cause a listen for connection requests with the specified port, backlog count.

Parameters:

id - the ID of the port.

port - the port.

mapToPort - the port externally mapped.

count - the number of queued connection requests.

address - the address to listen to (null means all local addresses).

Returns:

The server socket interface, for SSL, it is an instance of ServerSocketInterface3.

Throws:

IOException - When there is an I/O failure.

acceptNoHandshake

ISocket acceptNoHandshake()
                   throws IOException

Listens for a connection to be made to this socket and accepts it. The method blocks until a connection is made (without a potential SSL handshake is complete).

Throws:

IOException - if an I/O error occurs when waiting for a connection.

performAcceptHandshake

void performAcceptHandshake(ISocket s)
                     throws IOException

Performs the accept handshake for SSL.

Throws:

IOException - if an I/O error occurs when waiting for a connection.