se.entra.phantom.server

Class DefaultServerSocket

java.lang.Object

se.entra.phantom.server.SocketHelper

se.entra.phantom.server.DefaultServerSocket

All Implemented Interfaces:

ServerSocketInterface, ServerSocketInterface2

public class DefaultServerSocket
extends SocketHelper
implements ServerSocketInterface2

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 class se.entra.phantom.server.SocketHelper

id, isLoadBalanced

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

Constructor Summary

Constructors

Constructor and Description
DefaultServerSocket() Constructor for the default server socket from NetPhantom Server.

Method Summary

Methods

Modifier and Type	Method and Description
Socket	accept() Listens for a connection to be made to this socket and accepts it.
Socket	acceptNoHandshake() Listens for a connection to be made to this socket and accepts it.
void	close() Closes this socket.
ServerSocketInterface2	createServerSocket(String id, int port, int mapToPort, int count, InetAddress address) Creates the ServerSocket listener.
InetAddress	getInetAddress() Returns the local address of this server socket.
String	getInformation(Socket socket, int index) Returns SSL information about this socket.
int	getLocalPort() Returns the port on which this socket is listening.
int	getMapToPort() Gets the port number being mapped to externally.
void	initialize(IniFile ini, String name) Initializes the server socket with information in the INI file for the SSL protocol.
boolean	isEncrypted(Socket socket) Checks if encryption (with SSL with any encryption - not only signing) is used.
boolean	isStrongEncrypted(Socket socket) Checks if strong encryption (using SSL) is used.
boolean	isUsingSSL() Returns if SSL is used or not.
void	performAcceptHandshake(Socket s) Performs the accept handshake for SSL.
boolean	renegotiateSession(Socket socket, boolean isStrongEncryptionRequired, boolean isClientAuthenticationRequired, String accessControlID) If an SSL connection is not using strong encryption or if a client certificate is required, call this method.
void	setExternalSSL(boolean isExternal) Sets the external SSL flag.
String	toString() Returns the implementation address and implementation port of this socket as a String.

Methods inherited from class se.entra.phantom.server.SocketHelper

getLocalAddress, getLocalName, getPortID, isLoadBalanced, setLoadBalancing

Methods inherited from class java.lang.Object

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

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

getLocalAddress, getLocalName, getPortID, isLoadBalanced, setLoadBalancing

Constructor Detail

DefaultServerSocket

public DefaultServerSocket()

Constructor for the default server socket from NetPhantom Server.

Method Detail

initialize

public 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.

Specified by:

initialize in interface ServerSocketInterface2

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.

setExternalSSL

public void setExternalSSL(boolean isExternal)

Sets the external SSL flag. The method isUsingSSL may then return true even if the interface is not really SSL.

Specified by:

setExternalSSL in interface ServerSocketInterface

createServerSocket

public 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.

Specified by:

createServerSocket in interface ServerSocketInterface2

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).

Throws:

IOException - When there is an I/O failure.

accept

public Socket accept()
              throws IOException

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

Specified by:

accept in interface ServerSocketInterface2

Throws:

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

acceptNoHandshake

public Socket 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).

Specified by:

acceptNoHandshake in interface ServerSocketInterface2

Throws:

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

performAcceptHandshake

public void performAcceptHandshake(Socket s)
                            throws IOException

Performs the accept handshake for SSL.

Specified by:

performAcceptHandshake in interface ServerSocketInterface2

Throws:

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

getInetAddress

public InetAddress getInetAddress()

Returns the local address of this server socket.

Specified by:

getInetAddress in interface ServerSocketInterface

Returns:

the address to which this socket is connected, or null if the socket is not yet connected. If the server socket is not yet created, null is returned.

getLocalPort

public int getLocalPort()

Returns the port on which this socket is listening.

Specified by:

getLocalPort in interface ServerSocketInterface

Returns:

the port number to which this socket is listening. If the server socket is not yet created, -1 is returned.

getMapToPort

public int getMapToPort()

Gets the port number being mapped to externally. If no mapping is done, the same value as getLocalPort is returned.

Specified by:

getMapToPort in interface ServerSocketInterface

Returns:

the port number to which this socket is listening and is mapped to. If the server socket is not yet created, -1 is returned.

getInformation

public String getInformation(Socket socket,
                    int index)

Returns SSL information about this socket.

Specified by:

getInformation in interface ServerSocketInterface

Parameters:

index - index of the information requested.

Returns:

level 1=0/1, level2=0, level3=0, level4="".

isUsingSSL

public boolean isUsingSSL()

Returns if SSL is used or not. If external SSL is set, this method return true.

Specified by:

isUsingSSL in interface ServerSocketInterface

Returns:

false.

isEncrypted

public boolean isEncrypted(Socket socket)

Checks if encryption (with SSL with any encryption - not only signing) is used.

Specified by:

isEncrypted in interface ServerSocketInterface

Returns:

If external SSL is set, this method return true.

isStrongEncrypted

public boolean isStrongEncrypted(Socket socket)

Checks if strong encryption (using SSL) is used.

Specified by:

isStrongEncrypted in interface ServerSocketInterface

Returns:

false - always.

renegotiateSession

public boolean renegotiateSession(Socket socket,
                         boolean isStrongEncryptionRequired,
                         boolean isClientAuthenticationRequired,
                         String accessControlID)

If an SSL connection is not using strong encryption or if a client certificate is required, call this method.

Specified by:

renegotiateSession in interface ServerSocketInterface

Returns:

false always, because the socket is not an SSL socket connection.

close

public void close()
           throws IOException

Closes this socket.

Specified by:

close in interface ServerSocketInterface

Throws:

IOException - if an I/O error occurs when closing the socket.

toString

public String toString()

Returns the implementation address and implementation port of this socket as a String.

Specified by:

toString in interface ServerSocketInterface

Overrides:

toString in class Object

Returns:

a string representation of this socket.