se.entra.phantom.server.socket

Class SocketClientConnectionListener

java.lang.Object

se.entra.phantom.server.socket.SocketClientConnectionListener

All Implemented Interfaces:

ClientConnectionInterface

public class SocketClientConnectionListener
extends Object
implements ClientConnectionInterface

This instance creates a server socket at a specified port and waits for clients that want a connection to the server.

Constructor Summary

Constructors

Constructor and Description
SocketClientConnectionListener(PortManager portManager) Constructor.

Method Summary

Modifier and Type	Method and Description
void	closeClientListener() Closes and disposes of the connection listener.
void	createClientListener(IniFile ini, String name) Creates the server socket that will listens to incoming client connections.
InetAddress	getBindAddress() Gets the bind address for the port.
String	getID() Gets the name (ID) of the port.
int	getLocalPort() Gets the physical local port number.
int	getMapToPort() Gets the port number being mapped to.
String	getSSLSection() Gets the SSL section.
ServerSocketInterface3	getSSLServerSocketInterface() Gets the server socket interface for pure SSL connections.
boolean	isClosed() Checks if a connection is closed.
boolean	isLoadBalanced() Checks if this listener is load balanced or not.
boolean	isStarted() Checks if a connection is started.
boolean	isUsingSSL() Returns if SSL is used or not.
boolean	startClientListener(ClientConnectionListener listener) This method starts listening for connections.
boolean	stopClientListener() This method stops listening for connections.
boolean	useExternalSSL() Gets the external SSL flag.
boolean	usesSSLDomains(String sslSection) Checks if the port uses domains with SSL (not external).
boolean	usesSSLWithoutDomains(String sslSection) Checks if the port has no domains with SSL (not external).

Methods inherited from class java.lang.Object

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

Constructor Detail

SocketClientConnectionListener

public SocketClientConnectionListener(PortManager portManager)

Constructor.

Parameters:

portManager - The port manager instance.

Method Detail

createClientListener

public void createClientListener(IniFile ini,
                                 String name)
                          throws IOException

Creates the server socket that will listens to incoming client connections.

The following values are read from the [Port] section of the ini file:

• description
  A describing text of the port entry.
• port
  The port must be between 1 and 65535, inclusive.
• mapToPort
  If specified, the port must be between 1 and 65535, inclusive.
• bindAddress
  The bindAddress argument can be used on a multi-homed host for a server socket that will only accept connect requests to one of its addresses. If bindAddress is left empty, it will default accepting connections on any/all local addresses. The address is either a IP name or a raw IP address (e.g. 123.234.132.243).
• queueLength
  The maximum queue length for incoming connection indications (a request to connect). If a connection indication arrives when the queue is full, the connection is refused.
• sslSection
  The section this INI file describing the SSL settings. Leave empty if no SSL is required. This allows different SSL settings for different ports. Note that each SSL requires extra server memory.
• domains
  A comma separated string listing all SSL domains that will request SSL certificates from Let's Encrypt. This requires the port to use SSL, otherwise the setting is not used.

Specified by:

createClientListener in interface ClientConnectionInterface

Throws:

IOException - if an I/O error occurs.

getBindAddress

public InetAddress getBindAddress()

Gets the bind address for the port.

Returns:

null for no bind address (all available addresses), or the bind address.

startClientListener

public boolean startClientListener(ClientConnectionListener listener)
                            throws IOException

This method starts listening for connections. All connection threads are started at this point.

Specified by:

startClientListener in interface ClientConnectionInterface

Returns:

true if successful, false if already started.

Throws:

IOException - if an I/O error occurs.

stopClientListener

public boolean stopClientListener()

This method stops listening for connections.

Specified by:

stopClientListener in interface ClientConnectionInterface

Returns:

true if successful, false if already stopped.

closeClientListener

public void closeClientListener()

Closes and disposes of the connection listener. This call will wait until all connection threads are stopped.

Specified by:

closeClientListener in interface ClientConnectionInterface

isStarted

public boolean isStarted()

Checks if a connection is started.

Specified by:

isStarted in interface ClientConnectionInterface

isLoadBalanced

public boolean isLoadBalanced()

Checks if this listener is load balanced or not.

Specified by:

isLoadBalanced in interface ClientConnectionInterface

isUsingSSL

public boolean isUsingSSL()

Returns if SSL is used or not.

Specified by:

isUsingSSL in interface ClientConnectionInterface

Returns:

false if port is not yet started.

getID

public String getID()

Gets the name (ID) of the port.

Specified by:

getID in interface ClientConnectionInterface

getLocalPort

public int getLocalPort()

Gets the physical local port number.

Specified by:

getLocalPort in interface ClientConnectionInterface

getMapToPort

public int getMapToPort()

Gets the port number being mapped to.

Specified by:

getMapToPort in interface ClientConnectionInterface

isClosed

public boolean isClosed()

Checks if a connection is closed.

Specified by:

isClosed in interface ClientConnectionInterface

getSSLSection

public String getSSLSection()

Gets the SSL section.

Returns:

The SSL section.

useExternalSSL

public boolean useExternalSSL()

Gets the external SSL flag.

usesSSLDomains

public boolean usesSSLDomains(String sslSection)

Checks if the port uses domains with SSL (not external).

Parameters:

sslSection - The section that should match.

Returns:

true if domains are present and it uses non-external SSL with the same section name, false otherwise.

usesSSLWithoutDomains

public boolean usesSSLWithoutDomains(String sslSection)

Checks if the port has no domains with SSL (not external).

Parameters:

sslSection - The section that should match.

Returns:

true if domains are not present and it uses non-external SSL with the same section name, false otherwise.

getSSLServerSocketInterface

public ServerSocketInterface3 getSSLServerSocketInterface()

Gets the server socket interface for pure SSL connections.

Returns:

The server socket interface, or null for plain sockets or external SSL sockets, or if the server socket is not created.