WebClientsManager (P2J - Progress 4GL to Java Conversion and Runtime)

java.lang.Object
- com.goldencode.p2j.main.WebClientsManager

All Implemented Interfaces:

WebClientAllocator, WebClientRegistrar, SessionListener
```
public class WebClientsManager
extends java.lang.Object
implements WebClientAllocator, WebClientRegistrar, SessionListener
```
Manages the system resources allocated for web clients.

Field Summary

Fields
Modifier and Type	Field and Description
`private java.util.Map<java.lang.String,java.util.TimerTask>`	`cleaners` Map of cleaners, for each UUID.
`private java.util.Timer`	`cleanerTimer` A timer to clean allocated configurations.
`private static int`	`CONNECTING_TIMEOUT_IN_MILLISECONDS` The time-out in milliseconds that measures a period of time from connecting test starts until it must be completed.
`private int`	`connectionTestTimeout` The time-out in milliseconds that measures a period of time from connecting test starts until it must be completed.
`private static java.util.regex.Pattern`	`DEBUGGER_ADDRESS_PATTERN` The search pattern for the debugger port
`private int`	`from` ports range started from this port number
`private HostsManager`	`hostsManager` The hosts manager
`private static WebClientsManager`	`instance` one instance per standard server
`private boolean`	`javaDebuggerNeeded` True value indicates that remote java debugger agent is provided by jvmArgs
`private int`	`javaDebuggerSinglePortNumber` The java debugger port number if this value is provided by jvmArgs
`private static java.util.regex.Pattern`	`JMX_PORT_PATTERN` The search pattern for the jmx agent port
`private boolean`	`jmxAgentNeeded` True value indicates that remote jmx agent is provided by jvmArgs
`private int`	`jmxAgentSinglePortNumber` The jmx agent port number if this value is provided by jvmArgs
`private static CentralLogger`	`LOG` Logger
`private int`	`maxAgentPort` Holds clientConfig/maxAgentPort value
`private int`	`minAgentPort` Holds clientConfig/minAgentPort value
`private static int`	`POLL_TIMEOUT_IN_MILLISECONDS` The poll timeout in milliseconds to get element from the queue
`private int`	`pollTimeout` The poll timeout in milliseconds to get element from the queue
`private boolean`	`portsRestricted` True value indicates that ports range is given
`private java.lang.String`	`prefix` Prefix is used to build mapping from ports to strings
`private static java.lang.String`	`PROXY_PATH_SEGMENT` The path segment used by default to represent a top level segment for forwarded urls exposed to www.
`private java.lang.String`	`proxyPathSegment` The path segment used to represent a top level segment for forwarded urls
`private int`	`to` ports range bounded by this port number
`private java.util.Map<java.lang.String,WebAllocatedResources>`	`webClientConfigs` Maps client's uuid to its configuration, the client uuid are unique within the given server
`private java.util.Map<java.lang.Integer,WebAllocatedResources>`	`webClientSessions` Maps the web client's remote address pair to its configuration

Constructor Summary

Constructors
Modifier Constructor and Description

private WebClientsManager()
Creates a unique instance per a standard P2J server.

Constructors
Modifier	Constructor and Description
`private`	`WebClientsManager()` Creates a unique instance per a standard P2J server.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WebAllocatedResources`	`allocateClient(java.lang.String[] proxyConfigs, java.lang.String host, java.lang.String uuid, java.lang.String osUser)` Allocates the dedicated port number from the restricted ports range for the new spawned web client.
`java.util.concurrent.BlockingQueue<WebAllocatedResources>`	`createResourceQueue(java.lang.String host)` Create the resource queue filled with web clients ports if web client ports ranges are configured, otherwise null.
`void`	`freeClient(java.lang.String uuid)` Releases the system resources for the web client given by uuid.
`void`	`freeWebClientResources(java.lang.String webClientId)` Releases the web client resources managed by the server.
`static WebClientsManager`	`getInstance()` Returns the web clients manager or null if is is not setup properly.
`private int`	`getTestPort(WebAllocatedResources webClientConfig)` Get the port to test.
`void`	`initialize(Session session)` This method is not implemented by WebClientsManager.
`private boolean`	`isAgentRangeConfigured()` Tests if the agent port range is configured.
`boolean`	`isJavaDebuggerNeeded()` Tests if java debugger agent string is provided by jvmArgs.
`boolean`	`isJmxAgentNeeded()` Tests if jmx agent string is provided by jvmArgs.
`private void`	`logLeakedPorts(WebAllocatedResources webClientConf, java.lang.String host, java.lang.InterruptedException ex)` Log leaked resource not added back to its queue.
`private static int`	`parseDebuggerPort(java.lang.String jvmArgs)` Get the debugger port from the jvm arguments string, otherwise return -1.
`private static int`	`parseJMXPort(java.lang.String jvmArgs)` Get the jmx agent port from the jvm arguments string, otherwise return -1.
`void`	`registerWebClientSession(java.lang.String webClientId, int peerNode)` Registers the P2J session between the server and the web client to release its system resources on the server side in the case if the web client is failed unexpectedly.
`void`	`terminate(Session session)` This method is called when the session is ending.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LOG
```
private static final CentralLogger LOG
```
    Logger
  - JMX_PORT_PATTERN
```
private static final java.util.regex.Pattern JMX_PORT_PATTERN
```
    The search pattern for the jmx agent port
  - DEBUGGER_ADDRESS_PATTERN
```
private static final java.util.regex.Pattern DEBUGGER_ADDRESS_PATTERN
```
    The search pattern for the debugger port
  - POLL_TIMEOUT_IN_MILLISECONDS
```
private static final int POLL_TIMEOUT_IN_MILLISECONDS
```
    The poll timeout in milliseconds to get element from the queue
    
    See Also:
    
    Constant Field Values
  - CONNECTING_TIMEOUT_IN_MILLISECONDS
```
private static final int CONNECTING_TIMEOUT_IN_MILLISECONDS
```
    The time-out in milliseconds that measures a period of time from connecting test starts until it must be completed.
    
    See Also:
    
    Constant Field Values
  - PROXY_PATH_SEGMENT
```
private static final java.lang.String PROXY_PATH_SEGMENT
```
    The path segment used by default to represent a top level segment for forwarded urls exposed to www.
    
    See Also:
    
    Constant Field Values
  - instance
```
private static WebClientsManager instance
```
    one instance per standard server
  - portsRestricted
```
private final boolean portsRestricted
```
    True value indicates that ports range is given
  - from
```
private final int from
```
    ports range started from this port number
  - to
```
private final int to
```
    ports range bounded by this port number
  - prefix
```
private final java.lang.String prefix
```
    Prefix is used to build mapping from ports to strings
  - webClientSessions
```
private final java.util.Map<java.lang.Integer,WebAllocatedResources> webClientSessions
```
    Maps the web client's remote address pair to its configuration
  - cleaners
```
private final java.util.Map<java.lang.String,java.util.TimerTask> cleaners
```
    Map of cleaners, for each UUID. If this is not removed after ClientSpawner.CLIENT_STARTUP_TIMEOUT_SEC, then the config is released.
  - cleanerTimer
```
private final java.util.Timer cleanerTimer
```
    A timer to clean allocated configurations.
  - webClientConfigs
```
private final java.util.Map<java.lang.String,WebAllocatedResources> webClientConfigs
```
    Maps client's uuid to its configuration, the client uuid are unique within the given server
  - hostsManager
```
private final HostsManager hostsManager
```
    The hosts manager
  - minAgentPort
```
private final int minAgentPort
```
    Holds clientConfig/minAgentPort value
  - maxAgentPort
```
private final int maxAgentPort
```
    Holds clientConfig/maxAgentPort value
  - jmxAgentNeeded
```
private final boolean jmxAgentNeeded
```
    True value indicates that remote jmx agent is provided by jvmArgs
  - jmxAgentSinglePortNumber
```
private final int jmxAgentSinglePortNumber
```
    The jmx agent port number if this value is provided by jvmArgs
  - javaDebuggerNeeded
```
private final boolean javaDebuggerNeeded
```
    True value indicates that remote java debugger agent is provided by jvmArgs
  - javaDebuggerSinglePortNumber
```
private final int javaDebuggerSinglePortNumber
```
    The java debugger port number if this value is provided by jvmArgs
  - proxyPathSegment
```
private final java.lang.String proxyPathSegment
```
    The path segment used to represent a top level segment for forwarded urls
  - pollTimeout
```
private final int pollTimeout
```
    The poll timeout in milliseconds to get element from the queue
  - connectionTestTimeout
```
private final int connectionTestTimeout
```
    The time-out in milliseconds that measures a period of time from connecting test starts until it must be completed.
- Constructor Detail
  - WebClientsManager
```
private WebClientsManager()
                   throws java.lang.Exception
```
    Creates a unique instance per a standard P2J server.
    
    Throws:
    
    java.lang.Exception - if it is not setup properly.
- Method Detail
  - getInstance
```
public static WebClientsManager getInstance()
```
    Returns the web clients manager or null if is is not setup properly.
    At this time the code doesn't throw exceptions, it just logs them in the standard error stream.
    
    Returns:
    
    The web clients manager
  - createResourceQueue
```
public java.util.concurrent.BlockingQueue<WebAllocatedResources> createResourceQueue(java.lang.String host)
```
    Create the resource queue filled with web clients ports if web client ports ranges are configured, otherwise null.
    
    Returns:
    
    The resource queue or null
  - isJmxAgentNeeded
```
public boolean isJmxAgentNeeded()
```
    Tests if jmx agent string is provided by jvmArgs.
    
    Returns:
    
    True if jmx agent string is provided by jvmArgs, otherwise false.
  - isJavaDebuggerNeeded
```
public boolean isJavaDebuggerNeeded()
```
    Tests if java debugger agent string is provided by jvmArgs.
    
    Returns:
    
    True if java debugger agent string is provided by jvmArgs, otherwise false.
  - allocateClient
```
public WebAllocatedResources allocateClient(java.lang.String[] proxyConfigs,
                                            java.lang.String host,
                                            java.lang.String uuid,
                                            java.lang.String osUser)
```
    Allocates the dedicated port number from the restricted ports range for the new spawned web client.
    
    Specified by:
    
    allocateClient in interface WebClientAllocator
    
    Parameters:
    
    proxyConfigs - The first element should hold the forwarded host and the second one the corresponding forwarded protocol.
    
    host - The remote host for the spawned web client
    
    uuid - The web client uuid
    
    osUser - The OS user name
    
    Returns:
    
    The web client configuration. The allocated resources for the web client that will be spawned.
  - registerWebClientSession
```
public void registerWebClientSession(java.lang.String webClientId,
                                     int peerNode)
```
    Registers the P2J session between the server and the web client to release its system resources on the server side in the case if the web client is failed unexpectedly.
    
    Specified by:
    
    registerWebClientSession in interface WebClientRegistrar
    
    Parameters:
    
    webClientId - The web client unique identifier
    
    peerNode - The remote node of the P2J session between the server and the web client
  - initialize
```
public void initialize(Session session)
```
    This method is not implemented by WebClientsManager.
    
    Specified by:
    
    initialize in interface SessionListener
    
    Parameters:
    
    session - The session that is starting.
  - freeClient
```
public void freeClient(java.lang.String uuid)
```
    Releases the system resources for the web client given by uuid.
    
    Specified by:
    
    freeClient in interface WebClientAllocator
    
    Parameters:
    
    uuid - The web client uuid
  - freeWebClientResources
```
public void freeWebClientResources(java.lang.String webClientId)
```
    Releases the web client resources managed by the server.
    
    Specified by:
    
    freeWebClientResources in interface WebClientRegistrar
    
    Parameters:
    
    webClientId - The web client unique identifier
  - terminate
```
public void terminate(Session session)
```
    This method is called when the session is ending. Removes this session from the active sessions and to start asynchronous connect test in order to free the unused port.
    
    Specified by:
    
    terminate in interface SessionListener
    
    Parameters:
    
    session - The session that is ending.
  - isAgentRangeConfigured
```
private boolean isAgentRangeConfigured()
```
    Tests if the agent port range is configured.
    
    Returns:
    
    True if the agent port range is configured, otherwise false.
  - logLeakedPorts
```
private void logLeakedPorts(WebAllocatedResources webClientConf,
                            java.lang.String host,
                            java.lang.InterruptedException ex)
```
    Log leaked resource not added back to its queue.
    
    Parameters:
    
    webClientConf - The web client config not added back to its queue
    
    host - The host managed these web resources
    
    ex - The root cause exception
  - getTestPort
```
private int getTestPort(WebAllocatedResources webClientConfig)
```
    Get the port to test.
    
    Parameters:
    
    webClientConfig - The given web client config
    
    Returns:
    
    The port to test
  - parseDebuggerPort
```
private static int parseDebuggerPort(java.lang.String jvmArgs)
```
    Get the debugger port from the jvm arguments string, otherwise return -1.
    
    Parameters:
    
    jvmArgs - The jvm arguments string
    
    Returns:
    
    The debugger port number or -1.
  - parseJMXPort
```
private static int parseJMXPort(java.lang.String jvmArgs)
```
    Get the jmx agent port from the jvm arguments string, otherwise return -1.
    
    Parameters:
    
    jvmArgs - The jvm arguments string
    
    Returns:
    
    The jmx agent port number or -1.

Class WebClientsManager

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG

JMX_PORT_PATTERN

DEBUGGER_ADDRESS_PATTERN

POLL_TIMEOUT_IN_MILLISECONDS

CONNECTING_TIMEOUT_IN_MILLISECONDS

PROXY_PATH_SEGMENT

instance

portsRestricted

from

to

prefix

webClientSessions

cleaners

cleanerTimer

webClientConfigs

hostsManager

minAgentPort

maxAgentPort

jmxAgentNeeded

jmxAgentSinglePortNumber

javaDebuggerNeeded

javaDebuggerSinglePortNumber

proxyPathSegment

pollTimeout

connectionTestTimeout

Constructor Detail

WebClientsManager

Method Detail

getInstance

createResourceQueue

isJmxAgentNeeded

isJavaDebuggerNeeded

allocateClient

registerWebClientSession

initialize

freeClient

freeWebClientResources

terminate

isAgentRangeConfigured

logLeakedPorts

getTestPort

parseDebuggerPort

parseJMXPort