com.goldencode.p2j.ui.client.driver.web

Class EmbeddedWebServerImpl

java.lang.Object

com.goldencode.p2j.ui.client.driver.web.EmbeddedWebServerImpl

All Implemented Interfaces:

EmbeddedWebServer

public class EmbeddedWebServerImpl
extends java.lang.Object
implements EmbeddedWebServer

Web screen driver shared implementation of an embedded web server.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EmbeddedWebServerImpl.I18NWebResources Represents the I18n web resources: WebClient_en_US.json ...................

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	AJAX_TARGET WebSocket target.
private org.eclipse.jetty.util.resource.Resource	cpres Classpath resource instance.
private java.lang.String	externalHost The external host, IP or domain used to access this server.
private org.eclipse.jetty.server.Handler[]	hdlrs Page handlers for our specific targets.
private static EmbeddedWebServerImpl.I18NWebResources	I18N Represents the I18n web resources for the web client
private static CentralLogger	LOG Logger.
private java.lang.String	name Driver name to use in logging.
private GenericWebServer	server Embedded web server instance.
private GenericWebSocketCreator	sfact WebSocket factory.
private static java.lang.String	spec URI format specification.

Constructor Summary

Constructors

Constructor and Description
EmbeddedWebServerImpl(java.lang.String name, GenericWebSocketCreator sfact, org.eclipse.jetty.util.resource.Resource cpres, org.eclipse.jetty.server.Handler[] hdlrs) Create an instance.

Method Summary

Modifier and Type	Method and Description
void	addHandler(org.eclipse.jetty.server.Handler handler) Adds a custom handler.
static org.eclipse.jetty.util.resource.Resource	calcResourceBase(java.lang.Class<?> origin, java.lang.String path) Calculate the path in the jar file for the given path as an extention of the origin class' package and return that resource base as a classpath resource.
org.eclipse.jetty.server.HttpConfiguration	getHttpConfiguration() Returns the common http configuration.
java.lang.String	getServerURI() Get the embedded web server's URI.
static java.util.function.Supplier<java.util.Map.Entry<java.lang.String,java.lang.String>>	getTranslations(java.lang.String lang, java.util.Set<java.lang.String> cachedLanguages, java.lang.String defaultValue) Returns the supplier of a raw (unescaped) json string that holds all available translations for the given language.
void	removeHandler(org.eclipse.jetty.server.Handler handler) Removes the handler from the list of handlers.
void	shutdownServer() Shutdown the embedded web server.
java.lang.String	startupServer(ServerKeyStore keyStore, BootstrapConfig config, java.lang.String host, int port) Startup the embedded web server using the application server's KeyStore to build a suitable SSL context.
void	waitInitialization() Wait for the page to notify that it has fully initialized its JS code.
void	waitInitialization(WebClientProtocol webSocket) Wait for the page to notify that it has fully initialized its JS code.

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.

spec

private static final java.lang.String spec

URI format specification.

See Also:

Constant Field Values

AJAX_TARGET

private static final java.lang.String AJAX_TARGET

WebSocket target.

See Also:

Constant Field Values

I18N

private static final EmbeddedWebServerImpl.I18NWebResources I18N

Represents the I18n web resources for the web client

server

private GenericWebServer server

Embedded web server instance.

name

private java.lang.String name

Driver name to use in logging.

sfact

private GenericWebSocketCreator sfact

WebSocket factory.

cpres

private org.eclipse.jetty.util.resource.Resource cpres

Classpath resource instance.

hdlrs

private org.eclipse.jetty.server.Handler[] hdlrs

Page handlers for our specific targets.

externalHost

private java.lang.String externalHost

The external host, IP or domain used to access this server.

Constructor Detail

EmbeddedWebServerImpl

public EmbeddedWebServerImpl(java.lang.String name,
                             GenericWebSocketCreator sfact,
                             org.eclipse.jetty.util.resource.Resource cpres,
                             org.eclipse.jetty.server.Handler[] hdlrs)

Create an instance.

Parameters:

name - Driver name to use in logging.

sfact - WebSocket factory.

cpres - Classpath resource instance.

hdlrs - Page handlers for our specific targets.

Method Detail

startupServer

public java.lang.String startupServer(ServerKeyStore keyStore,
                                      BootstrapConfig config,
                                      java.lang.String host,
                                      int port)

Startup the embedded web server using the application server's KeyStore to build a suitable SSL context.

Specified by:

startupServer in interface EmbeddedWebServer

Parameters:

keyStore - The exported server KeyStore.

config - Client configuration.

port - An explicit port to start the web server or 0 to let the OS assign one.

host - An explicit host to start the web server or null to use the server's host.

Returns:

The embedded web server's URI.

shutdownServer

public void shutdownServer()

Shutdown the embedded web server.

Specified by:

shutdownServer in interface EmbeddedWebServer

getServerURI

public java.lang.String getServerURI()

Get the embedded web server's URI.

Specified by:

getServerURI in interface EmbeddedWebServer

Returns:

A string representing the server's URI.

calcResourceBase

public static org.eclipse.jetty.util.resource.Resource calcResourceBase(java.lang.Class<?> origin,
                                                                        java.lang.String path)

Calculate the path in the jar file for the given path as an extention of the origin class' package and return that resource base as a classpath resource. The result can be used in a resource handler as the location for accessing static resources.

Parameters:

origin - A class in the package being targeted as the starting path for the resource. The package will be looked up from this class, any class in that package will work as the class is not used for anything else.

path - The relative sub-directory to add to the package to get the full base path. This should NOT have either a leading or trailing path separator ('/') included.

Returns:

The calculated resource base.

getTranslations

public static java.util.function.Supplier<java.util.Map.Entry<java.lang.String,java.lang.String>> getTranslations(java.lang.String lang,
                                                                                                                  java.util.Set<java.lang.String> cachedLanguages,
                                                                                                                  java.lang.String defaultValue)

Returns the supplier of a raw (unescaped) json string that holds all available translations for the given language. If the language is not given or its translation resource does not exist, then the default resource is used.

Parameters:

lang - The language identifier

cachedLanguages - The set of cached languages

defaultValue - The default value if i18n resources is not found for the given language

Returns:

The supplier of the language identifier and I18N resources for the given language.

waitInitialization

public void waitInitialization()

Wait for the page to notify that it has fully initialized its JS code.

This implementation is a no-op.

Specified by:

waitInitialization in interface EmbeddedWebServer

addHandler

public void addHandler(org.eclipse.jetty.server.Handler handler)

Adds a custom handler.

Specified by:

addHandler in interface EmbeddedWebServer

Parameters:

handler - The handler to add.

removeHandler

public void removeHandler(org.eclipse.jetty.server.Handler handler)

Removes the handler from the list of handlers.

Specified by:

removeHandler in interface EmbeddedWebServer

Parameters:

handler - The handler to remove.

getHttpConfiguration

public org.eclipse.jetty.server.HttpConfiguration getHttpConfiguration()

Returns the common http configuration.

Returns:

The common http configuration

waitInitialization

public void waitInitialization(WebClientProtocol webSocket)

Wait for the page to notify that it has fully initialized its JS code.

Parameters:

webSocket - The socket where to wait for a message.