ninja.standalone

Class AbstractStandalone<T extends AbstractStandalone>

java.lang.Object

ninja.standalone.AbstractStandalone<T>

Type Parameters:

T - The concrete standalone implementation

All Implemented Interfaces:

Runnable, Standalone<T>

public abstract class AbstractStandalone<T extends AbstractStandalone>
extends Object
implements Standalone<T>, Runnable

Abstract Standalone that implements most functionality required to write a concrete Standalone. Introduces new doStart(), doStop(), and doJoin() methods which are actually where you'll place most of your logic. You'll also want to subclass the configure() method to add any configuration specific to your Standalone. See NinjaJetty for example concrete implementation.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<String>	baseUrls
protected boolean	configured
protected String	contextPath
protected String	externalConfigurationPath
protected String	host
protected Long	idleTimeout
protected org.slf4j.Logger	logger
protected String	name
protected NinjaMode	ninjaMode
protected NinjaPropertiesImpl	ninjaProperties
protected OverlayedNinjaProperties	overlayedNinjaProperties
protected Integer	port
protected List<String>	serverUrls
protected String	sslKeystorePassword
protected URI	sslKeystoreUri
protected Integer	sslPort
protected String	sslTruststorePassword
protected URI	sslTruststoreUri
protected boolean	started

Fields inherited from interface ninja.standalone.Standalone

DEFAULT_CONTEXT_PATH, DEFAULT_DEV_NINJA_SSL_KEYSTORE_PASSWORD, DEFAULT_DEV_NINJA_SSL_KEYSTORE_URI, DEFAULT_DEV_NINJA_SSL_TRUSTSTORE_PASSWORD, DEFAULT_DEV_NINJA_SSL_TRUSTSTORE_URI, DEFAULT_HOST, DEFAULT_IDLE_TIMEOUT, DEFAULT_PORT, DEFAULT_SSL_PORT, DEFAULT_STANDALONE_CLASS, KEY_NINJA_CONTEXT_PATH, KEY_NINJA_HOST, KEY_NINJA_IDLE_TIMEOUT, KEY_NINJA_PORT, KEY_NINJA_SSL_KEYSTORE_PASSWORD, KEY_NINJA_SSL_KEYSTORE_URI, KEY_NINJA_SSL_PORT, KEY_NINJA_SSL_TRUSTSTORE_PASSWORD, KEY_NINJA_SSL_TRUSTSTORE_URI, KEY_NINJA_STANDALONE_CLASS

Constructor Summary

Constructors

Constructor and Description
AbstractStandalone(String name)

Method Summary

Modifier and Type	Method and Description
protected void	checkConfigured()
protected void	checkNotConfigured()
protected void	checkStarted()
T	configure() Configures the standalone to prepare for being started.
T	contextPath(String contextPath) Sets the "context path" of the Ninja application.
protected String	createBaseUrl(String scheme, String host, Integer port, String context)
protected List<String>	createBaseUrls()
protected String	createServerUrl(String scheme, String host, Integer port)
protected List<String>	createServerUrls()
protected SSLContext	createSSLContext()
protected abstract void	doConfigure()
protected abstract void	doJoin()
protected abstract void	doShutdown()
protected abstract void	doStart()
T	externalConfigurationPath(String externalConfigurationPath)
List<String>	getBaseUrls() Get the urls for the application that is configured to start.
String	getContextPath()
String	getExternalConfigurationPath()
String	getHost()
Long	getIdleTimeout()
protected String	getLoggableIdentifier()
String	getName()
NinjaMode	getNinjaMode()
NinjaPropertiesImpl	getNinjaProperties() Gets the NinjaProperties that were used to configure Ninja.
Integer	getPort()
List<String>	getServerUrls() Get the urls for the servers that are configured to start.
String	getSslKeystorePassword()
URI	getSslKeystoreUri()
Integer	getSslPort()
String	getSslTruststorePassword()
URI	getSslTruststoreUri()
T	host(String host)
T	idleTimeout(long idleTimeout)
boolean	isPortEnabled() Tests if the clear text HTTP port is enabled.
boolean	isSslPortEnabled() Tests if the SSL HTTP port is enabled.
T	join() Joins the underlying server to wait until its finished.
protected void	logBaseUrls()
T	name(String name)
T	ninjaMode(NinjaMode ninjaMode)
T	port(int port)
void	run() Configure, start, add shutdown hook, and join.
T	shutdown() Shutdown Ninja and underlying server as safely as possible (tries not to cause exceptions to be thrown).
T	sslKeystorePassword(String keystorePassword)
T	sslKeystoreUri(URI keystoreUri)
T	sslPort(int sslPort)
T	sslTruststorePassword(String truststorePassword)
T	sslTruststoreUri(URI truststoreUri)
T	start() Configures (if not yet done), boots Ninja application and starts the underlying server.
protected Exception	tryToUnwrapInjectorException(Exception exception)

Methods inherited from class java.lang.Object

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

Methods inherited from interface ninja.standalone.Standalone

getInjector

Field Detail

logger

protected final org.slf4j.Logger logger

ninjaMode

protected NinjaMode ninjaMode

externalConfigurationPath

protected String externalConfigurationPath

name

protected String name

host

protected String host

port

protected Integer port

contextPath

protected String contextPath

idleTimeout

protected Long idleTimeout

sslPort

protected Integer sslPort

sslKeystoreUri

protected URI sslKeystoreUri

sslKeystorePassword

protected String sslKeystorePassword

sslTruststoreUri

protected URI sslTruststoreUri

sslTruststorePassword

protected String sslTruststorePassword

configured

protected boolean configured

started

protected boolean started

ninjaProperties

protected NinjaPropertiesImpl ninjaProperties

overlayedNinjaProperties

protected OverlayedNinjaProperties overlayedNinjaProperties

serverUrls

protected List<String> serverUrls

baseUrls

protected List<String> baseUrls

Constructor Detail

AbstractStandalone

public AbstractStandalone(String name)

Method Detail

run

public final void run()

Configure, start, add shutdown hook, and join. Does not exit.

Specified by:

run in interface Runnable

Specified by:

run in interface Standalone<T extends AbstractStandalone>

configure

public final T configure()
                  throws Exception

Description copied from interface: Standalone

Configures the standalone to prepare for being started.

Specified by:

configure in interface Standalone<T extends AbstractStandalone>

Returns:

This standalone

Throws:

Exception - Thrown if an exception occurs during configuration

start

public final T start()
              throws Exception

Description copied from interface: Standalone

Configures (if not yet done), boots Ninja application and starts the underlying server.

Specified by:

start in interface Standalone<T extends AbstractStandalone>

Returns:

This standalone

Throws:

Exception - Thrown if an exception occurs during Ninja boot or server start

join

public final T join()
             throws Exception

Description copied from interface: Standalone

Joins the underlying server to wait until its finished.

Specified by:

join in interface Standalone<T extends AbstractStandalone>

Returns:

This standalone

Throws:

Exception - Thrown if an exception occurs while waiting

shutdown

public final T shutdown()

Description copied from interface: Standalone

Shutdown Ninja and underlying server as safely as possible (tries not to cause exceptions to be thrown).

Specified by:

shutdown in interface Standalone<T extends AbstractStandalone>

Returns:

This standalone

doConfigure

protected abstract void doConfigure()
                             throws Exception

Throws:

Exception

doStart

protected abstract void doStart()
                         throws Exception

Throws:

Exception

doJoin

protected abstract void doJoin()
                        throws Exception

Throws:

Exception

doShutdown

protected abstract void doShutdown()

checkNotConfigured

protected void checkNotConfigured()

checkConfigured

protected void checkConfigured()

checkStarted

protected void checkStarted()

getNinjaMode

public NinjaMode getNinjaMode()

Specified by:

getNinjaMode in interface Standalone<T extends AbstractStandalone>

ninjaMode

public T ninjaMode(NinjaMode ninjaMode)

Specified by:

ninjaMode in interface Standalone<T extends AbstractStandalone>

getExternalConfigurationPath

public String getExternalConfigurationPath()

Specified by:

getExternalConfigurationPath in interface Standalone<T extends AbstractStandalone>

externalConfigurationPath

public T externalConfigurationPath(String externalConfigurationPath)

Specified by:

externalConfigurationPath in interface Standalone<T extends AbstractStandalone>

getName

public String getName()

Specified by:

getName in interface Standalone<T extends AbstractStandalone>

name

public T name(String name)

Specified by:

name in interface Standalone<T extends AbstractStandalone>

getPort

public Integer getPort()

Specified by:

getPort in interface Standalone<T extends AbstractStandalone>

port

public T port(int port)

Specified by:

port in interface Standalone<T extends AbstractStandalone>

getHost

public String getHost()

Specified by:

getHost in interface Standalone<T extends AbstractStandalone>

host

public T host(String host)

Specified by:

host in interface Standalone<T extends AbstractStandalone>

getIdleTimeout

public Long getIdleTimeout()

Specified by:

getIdleTimeout in interface Standalone<T extends AbstractStandalone>

idleTimeout

public T idleTimeout(long idleTimeout)

Specified by:

idleTimeout in interface Standalone<T extends AbstractStandalone>

getContextPath

public String getContextPath()

Specified by:

getContextPath in interface Standalone<T extends AbstractStandalone>

contextPath

public T contextPath(String contextPath)

Description copied from interface: Standalone

Sets the "context path" of the Ninja application. Must follow servlet spects where it starts with a "/" and does not end with a "/". https://docs.oracle.com/javaee/6/api/javax/servlet/ServletContext.html#getContextPath()

Specified by:

contextPath in interface Standalone<T extends AbstractStandalone>

Parameters:

contextPath - The context path such as "/mycontext"

Returns:

This standalone

getSslPort

public Integer getSslPort()

Specified by:

getSslPort in interface Standalone<T extends AbstractStandalone>

sslPort

public T sslPort(int sslPort)

Specified by:

sslPort in interface Standalone<T extends AbstractStandalone>

getSslKeystoreUri

public URI getSslKeystoreUri()

Specified by:

getSslKeystoreUri in interface Standalone<T extends AbstractStandalone>

sslKeystoreUri

public T sslKeystoreUri(URI keystoreUri)

Specified by:

sslKeystoreUri in interface Standalone<T extends AbstractStandalone>

getSslKeystorePassword

public String getSslKeystorePassword()

Specified by:

getSslKeystorePassword in interface Standalone<T extends AbstractStandalone>

sslKeystorePassword

public T sslKeystorePassword(String keystorePassword)

Specified by:

sslKeystorePassword in interface Standalone<T extends AbstractStandalone>

getSslTruststoreUri

public URI getSslTruststoreUri()

Specified by:

getSslTruststoreUri in interface Standalone<T extends AbstractStandalone>

sslTruststoreUri

public T sslTruststoreUri(URI truststoreUri)

Specified by:

sslTruststoreUri in interface Standalone<T extends AbstractStandalone>

getSslTruststorePassword

public String getSslTruststorePassword()

Specified by:

getSslTruststorePassword in interface Standalone<T extends AbstractStandalone>

sslTruststorePassword

public T sslTruststorePassword(String truststorePassword)

Specified by:

sslTruststorePassword in interface Standalone<T extends AbstractStandalone>

getNinjaProperties

public NinjaPropertiesImpl getNinjaProperties()

Description copied from interface: Standalone

Gets the NinjaProperties that were used to configure Ninja. This value is only accessible after configure() is successfully called.

Specified by:

getNinjaProperties in interface Standalone<T extends AbstractStandalone>

Returns:

The NinjaProperties implementation

getServerUrls

public List<String> getServerUrls()

Description copied from interface: Standalone

Get the urls for the servers that are configured to start. This value does not include the configured contextPath. Returns a value in the form 'scheme://host:port'. Well-known scheme and port combinations will not include the port.

Specified by:

getServerUrls in interface Standalone<T extends AbstractStandalone>

Returns:

The urls of the server such as http://localhost:8080

See Also:

Standalone.getServerUrls()

getBaseUrls

public List<String> getBaseUrls()

Description copied from interface: Standalone

Get the urls for the application that is configured to start. This value includes the configured contextPath. Returns a value in form 'scheme://host:port/context'. Well-known scheme and port combinations will not include the port.

Specified by:

getBaseUrls in interface Standalone<T extends AbstractStandalone>

Returns:

The uri(s) of the application such as http://localhost:8080/context

See Also:

Standalone.getBaseUrls()

isPortEnabled

public boolean isPortEnabled()

Description copied from interface: Standalone

Tests if the clear text HTTP port is enabled. Usually this indicates the "ninja.port" property is > -1.

Specified by:

isPortEnabled in interface Standalone<T extends AbstractStandalone>

Returns:

True if enabled otherwise false.

isSslPortEnabled

public boolean isSslPortEnabled()

Description copied from interface: Standalone

Tests if the SSL HTTP port is enabled. Usually this indicates the "ninja.ssl.port" property is > -1.

Specified by:

isSslPortEnabled in interface Standalone<T extends AbstractStandalone>

Returns:

True if enabled otherwise false.

createServerUrls

protected List<String> createServerUrls()

createBaseUrls

protected List<String> createBaseUrls()

createServerUrl

protected String createServerUrl(String scheme,
                                 String host,
                                 Integer port)

createBaseUrl

protected String createBaseUrl(String scheme,
                               String host,
                               Integer port,
                               String context)

tryToUnwrapInjectorException

protected Exception tryToUnwrapInjectorException(Exception exception)

getLoggableIdentifier

protected String getLoggableIdentifier()

logBaseUrls

protected void logBaseUrls()

createSSLContext

protected SSLContext createSSLContext()
                               throws Exception

Throws:

Exception