se.entra.phantom.server

Class PortManager

java.lang.Object

se.entra.phantom.server.PortManager

public class PortManager
extends Object

Handles all the server socket port listeners.

Constructor Summary

Constructors

Constructor and Description
PortManager(IniFile ini, int clusterServerNumber) Creates the listeners on the ports specified in [Port] section in item 'portID'.

Method Summary

Modifier and Type	Method and Description
void	closeClientListener() Closes and disposes of the connection listener.
boolean	closeClientListener(String name) Closes and disposes of the connection listener.
boolean	closeClientListener(String name, boolean doRemove) Closes and disposes of the connection listener.
boolean	createClientListener(String name) Create a port listener.
boolean	createClientListenerEx(String name) Create a port listener.
SocketClientConnectionListener[]	getAllPorts() Gets an array of all the ports.
Transaction	getAvailablePorts(Transaction trans) Gets the ports available for load balancing.
int	getDefaultSSLPort() Gets the default port number to use for SSL.
LetsEncryptDomain	getLetsEncryptDomain(String domain) Gets a Let's Encrypt domain instance.
int	getPortState(String name) Checks if the port state.
boolean	isClosed(String name) Checks if a port is started.
boolean	isStarted(String name) Checks if a port is started.
boolean	isStopped(String name) Checks if a port is started.
void	startClientListener(ClientConnectionListener listener) This method starts listening for connections.
void	startClientListener(ClientConnectionListener listener, int errorMessageID) This method starts listening for connections.
boolean	startClientListener(String name) Starts listening for connections.
void	stopClientListener() Stops listening for connections.
boolean	stopClientListener(String name) Stops listening for connections.

Methods inherited from class java.lang.Object

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

Constructor Detail

PortManager

public PortManager(IniFile ini,
                   int clusterServerNumber)
            throws IOException

Creates the listeners on the ports specified in [Port] section in item 'portID'.

Throws:

IOException - for listener creation error.

Method Detail

getLetsEncryptDomain

public LetsEncryptDomain getLetsEncryptDomain(String domain)

Gets a Let's Encrypt domain instance.

createClientListenerEx

public boolean createClientListenerEx(String name)
                               throws IOException

Create a port listener.

Throws:

IOException - for failures.

createClientListener

public boolean createClientListener(String name)

Create a port listener.

startClientListener

public void startClientListener(ClientConnectionListener listener)
                         throws IOException

This method starts listening for connections.

Throws:

IOException - if an I/O error occurs.

startClientListener

public void startClientListener(ClientConnectionListener listener,
                                int errorMessageID)

This method starts listening for connections.

startClientListener

public boolean startClientListener(String name)
                            throws IOException

Starts listening for connections.

Returns:

true if successful, false if port name didn't exist.

Throws:

IOException - if an I/O error occurs.

stopClientListener

public void stopClientListener()

Stops listening for connections.

stopClientListener

public boolean stopClientListener(String name)

Stops listening for connections.

Returns:

true if successful, false if port name didn't exist.

closeClientListener

public void closeClientListener()

Closes and disposes of the connection listener.

closeClientListener

public boolean closeClientListener(String name)

Closes and disposes of the connection listener.

Returns:

true if successful, false if port name didn't exist.

closeClientListener

public boolean closeClientListener(String name,
                                   boolean doRemove)

Closes and disposes of the connection listener.

Returns:

true if successful, false if port name didn't exist.

getPortState

public int getPortState(String name)

Checks if the port state.

Parameters:

name - the port ID name (it is made upper case).

Returns:

-1 the port name is not found.
0 the port is started.
1 the port is stopped.
2 the port is closed.

isStarted

public boolean isStarted(String name)

Checks if a port is started.

isStopped

public boolean isStopped(String name)

Checks if a port is started.

isClosed

public boolean isClosed(String name)

Checks if a port is started.

getAvailablePorts

public Transaction getAvailablePorts(Transaction trans)

Gets the ports available for load balancing. The transaction is sent to the controller server. Matching of ports is done using the Port ID.

getAllPorts

public SocketClientConnectionListener[] getAllPorts()

Gets an array of all the ports.

getDefaultSSLPort

public int getDefaultSSLPort()

Gets the default port number to use for SSL.

Returns:

The port number: if -1, none is found. If zero (0), the default https port (443) should be used. Otherwise it will be the external SSL port number to use (if it exists), otherwise the normal SSL port number.