Standalone (ninja-core 5.3.1 API)

Type Parameters:

T - The concrete standalone implementation (to make the builder pattern work correctly during compilation)

All Known Implementing Classes:

AbstractStandalone
```
public interface Standalone<T extends Standalone>
```
Interface for wrapping an underlying server (e.g. Jetty) to bootstrap Ninja as a standalone application.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`DEFAULT_CONTEXT_PATH`
`static java.lang.String`	`DEFAULT_DEV_NINJA_SSL_KEYSTORE_PASSWORD`
`static java.lang.String`	`DEFAULT_DEV_NINJA_SSL_KEYSTORE_URI`
`static java.lang.String`	`DEFAULT_DEV_NINJA_SSL_TRUSTSTORE_PASSWORD`
`static java.lang.String`	`DEFAULT_DEV_NINJA_SSL_TRUSTSTORE_URI`
`static java.lang.String`	`DEFAULT_HOST`
`static java.lang.Long`	`DEFAULT_IDLE_TIMEOUT`
`static java.lang.Integer`	`DEFAULT_PORT`
`static java.lang.Integer`	`DEFAULT_SSL_PORT`
`static java.lang.String`	`DEFAULT_STANDALONE_CLASS`
`static java.lang.String`	`KEY_NINJA_CONTEXT_PATH`
`static java.lang.String`	`KEY_NINJA_HOST`
`static java.lang.String`	`KEY_NINJA_IDLE_TIMEOUT`
`static java.lang.String`	`KEY_NINJA_PORT`
`static java.lang.String`	`KEY_NINJA_SSL_KEYSTORE_PASSWORD`
`static java.lang.String`	`KEY_NINJA_SSL_KEYSTORE_URI`
`static java.lang.String`	`KEY_NINJA_SSL_PORT`
`static java.lang.String`	`KEY_NINJA_SSL_TRUSTSTORE_PASSWORD`
`static java.lang.String`	`KEY_NINJA_SSL_TRUSTSTORE_URI`
`static java.lang.String`	`KEY_NINJA_STANDALONE_CLASS`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`T`	`configure()` Configures the standalone to prepare for being started.
`T`	`contextPath(java.lang.String contextPath)` Sets the "context path" of the Ninja application.
`T`	`externalConfigurationPath(java.lang.String externalConfigurationPath)`
`java.util.List<java.lang.String>`	`getBaseUrls()` Get the urls for the application that is configured to start.
`java.lang.String`	`getContextPath()`
`java.lang.String`	`getExternalConfigurationPath()`
`java.lang.String`	`getHost()`
`java.lang.Long`	`getIdleTimeout()`
`com.google.inject.Injector`	`getInjector()` Gets the Guice injector that booted the Ninja application.
`java.lang.String`	`getName()`
`NinjaMode`	`getNinjaMode()`
`NinjaPropertiesImpl`	`getNinjaProperties()` Gets the NinjaProperties that were used to configure Ninja.
`java.lang.Integer`	`getPort()`
`java.util.List<java.lang.String>`	`getServerUrls()` Get the urls for the servers that are configured to start.
`java.lang.String`	`getSslKeystorePassword()`
`java.net.URI`	`getSslKeystoreUri()`
`java.lang.Integer`	`getSslPort()`
`java.lang.String`	`getSslTruststorePassword()`
`java.net.URI`	`getSslTruststoreUri()`
`T`	`host(java.lang.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.
`T`	`name(java.lang.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(java.lang.String keystorePassword)`
`T`	`sslKeystoreUri(java.net.URI keystoreUri)`
`T`	`sslPort(int sslPort)`
`T`	`sslTruststorePassword(java.lang.String truststorePassword)`
`T`	`sslTruststoreUri(java.net.URI truststoreUri)`
`T`	`start()` Configures (if not yet done), boots Ninja application and starts the underlying server.

- Field Detail
  - KEY_NINJA_STANDALONE_CLASS
```
static final java.lang.String KEY_NINJA_STANDALONE_CLASS
```
    See Also:
    
    Constant Field Values
  - KEY_NINJA_CONTEXT_PATH
```
static final java.lang.String KEY_NINJA_CONTEXT_PATH
```
    See Also:
    
    Constant Field Values
  - KEY_NINJA_HOST
```
static final java.lang.String KEY_NINJA_HOST
```
    See Also:
    
    Constant Field Values
  - KEY_NINJA_IDLE_TIMEOUT
```
static final java.lang.String KEY_NINJA_IDLE_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - KEY_NINJA_PORT
```
static final java.lang.String KEY_NINJA_PORT
```
    See Also:
    
    Constant Field Values
  - KEY_NINJA_SSL_PORT
```
static final java.lang.String KEY_NINJA_SSL_PORT
```
    See Also:
    
    Constant Field Values
  - KEY_NINJA_SSL_KEYSTORE_URI
```
static final java.lang.String KEY_NINJA_SSL_KEYSTORE_URI
```
    See Also:
    
    Constant Field Values
  - KEY_NINJA_SSL_KEYSTORE_PASSWORD
```
static final java.lang.String KEY_NINJA_SSL_KEYSTORE_PASSWORD
```
    See Also:
    
    Constant Field Values
  - KEY_NINJA_SSL_TRUSTSTORE_URI
```
static final java.lang.String KEY_NINJA_SSL_TRUSTSTORE_URI
```
    See Also:
    
    Constant Field Values
  - KEY_NINJA_SSL_TRUSTSTORE_PASSWORD
```
static final java.lang.String KEY_NINJA_SSL_TRUSTSTORE_PASSWORD
```
    See Also:
    
    Constant Field Values
  - DEFAULT_STANDALONE_CLASS
```
static final java.lang.String DEFAULT_STANDALONE_CLASS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_HOST
```
static final java.lang.String DEFAULT_HOST
```
  - DEFAULT_PORT
```
static final java.lang.Integer DEFAULT_PORT
```
  - DEFAULT_IDLE_TIMEOUT
```
static final java.lang.Long DEFAULT_IDLE_TIMEOUT
```
  - DEFAULT_CONTEXT_PATH
```
static final java.lang.String DEFAULT_CONTEXT_PATH
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SSL_PORT
```
static final java.lang.Integer DEFAULT_SSL_PORT
```
  - DEFAULT_DEV_NINJA_SSL_KEYSTORE_URI
```
static final java.lang.String DEFAULT_DEV_NINJA_SSL_KEYSTORE_URI
```
    See Also:
    
    Constant Field Values
  - DEFAULT_DEV_NINJA_SSL_KEYSTORE_PASSWORD
```
static final java.lang.String DEFAULT_DEV_NINJA_SSL_KEYSTORE_PASSWORD
```
    See Also:
    
    Constant Field Values
  - DEFAULT_DEV_NINJA_SSL_TRUSTSTORE_URI
```
static final java.lang.String DEFAULT_DEV_NINJA_SSL_TRUSTSTORE_URI
```
    See Also:
    
    Constant Field Values
  - DEFAULT_DEV_NINJA_SSL_TRUSTSTORE_PASSWORD
```
static final java.lang.String DEFAULT_DEV_NINJA_SSL_TRUSTSTORE_PASSWORD
```
    See Also:
    
    Constant Field Values
- Method Detail
  - configure
```
T configure()
     throws java.lang.Exception
```
    Configures the standalone to prepare for being started.
    
    Returns:
    
    This standalone
    
    Throws:
    
    java.lang.Exception - Thrown if an exception occurs during configuration
  - run
```
void run()
```
    Configure, start, add shutdown hook, and join. Since this method joins the underlying server (e.g. Jetty), it does not exit until interrupted.
  - start
```
T start()
 throws java.lang.Exception
```
    Configures (if not yet done), boots Ninja application and starts the underlying server.
    
    Returns:
    
    This standalone
    
    Throws:
    
    java.lang.Exception - Thrown if an exception occurs during Ninja boot or server start
  - join
```
T join()
throws java.lang.Exception
```
    Joins the underlying server to wait until its finished.
    
    Returns:
    
    This standalone
    
    Throws:
    
    java.lang.Exception - Thrown if an exception occurs while waiting
  - shutdown
```
T shutdown()
```
    Shutdown Ninja and underlying server as safely as possible (tries not to cause exceptions to be thrown).
    
    Returns:
    
    This standalone
  - getNinjaMode
```
NinjaMode getNinjaMode()
```
  - ninjaMode
```
T ninjaMode(NinjaMode ninjaMode)
```
  - getExternalConfigurationPath
```
java.lang.String getExternalConfigurationPath()
```
  - externalConfigurationPath
```
T externalConfigurationPath(java.lang.String externalConfigurationPath)
```
  - getName
```
java.lang.String getName()
```
  - name
```
T name(java.lang.String name)
```
  - getHost
```
java.lang.String getHost()
```
  - host
```
T host(java.lang.String host)
```
  - getPort
```
java.lang.Integer getPort()
```
  - port
```
T port(int port)
```
  - getContextPath
```
java.lang.String getContextPath()
```
  - contextPath
```
T contextPath(java.lang.String contextPath)
```
    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()
    
    Parameters:
    
    contextPath - The context path such as "/mycontext"
    
    Returns:
    
    This standalone
    
    Throws:
    
    java.lang.IllegalArgumentException - Thrown if the context value is not valid
  - idleTimeout
```
T idleTimeout(long idleTimeout)
```
  - getIdleTimeout
```
java.lang.Long getIdleTimeout()
```
  - getSslPort
```
java.lang.Integer getSslPort()
```
  - sslPort
```
T sslPort(int sslPort)
```
  - getSslKeystoreUri
```
java.net.URI getSslKeystoreUri()
```
  - sslKeystoreUri
```
T sslKeystoreUri(java.net.URI keystoreUri)
```
  - getSslKeystorePassword
```
java.lang.String getSslKeystorePassword()
```
  - sslKeystorePassword
```
T sslKeystorePassword(java.lang.String keystorePassword)
```
  - getSslTruststoreUri
```
java.net.URI getSslTruststoreUri()
```
  - sslTruststoreUri
```
T sslTruststoreUri(java.net.URI truststoreUri)
```
  - getSslTruststorePassword
```
java.lang.String getSslTruststorePassword()
```
  - sslTruststorePassword
```
T sslTruststorePassword(java.lang.String truststorePassword)
```
  - getNinjaProperties
```
NinjaPropertiesImpl getNinjaProperties()
```
    Gets the NinjaProperties that were used to configure Ninja. This value is only accessible after configure() is successfully called.
    
    Returns:
    
    The NinjaProperties implementation
    
    Throws:
    
    java.lang.IllegalStateException - Thrown if attempting to access this variable before configure() is successfully called.
  - getInjector
```
com.google.inject.Injector getInjector()
```
    Gets the Guice injector that booted the Ninja application. This value is only accessible after start() is successfully called.
    
    Returns:
    
    The guice injector
    
    Throws:
    
    java.lang.IllegalStateException - Thrown if attempting to access this variable before start() is successfully called.
  - getServerUrls
```
java.util.List<java.lang.String> getServerUrls()
```
    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.
    
    Returns:
    
    The urls of the server such as http://localhost:8080
    
    See Also:
    
    getServerUrls()
  - getBaseUrls
```
java.util.List<java.lang.String> getBaseUrls()
```
    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.
    
    Returns:
    
    The uri(s) of the application such as http://localhost:8080/context
    
    See Also:
    
    getBaseUrls()
  - isPortEnabled
```
boolean isPortEnabled()
```
    Tests if the clear text HTTP port is enabled. Usually this indicates the "ninja.port" property is > -1.
    
    Returns:
    
    True if enabled otherwise false.
  - isSslPortEnabled
```
boolean isSslPortEnabled()
```
    Tests if the SSL HTTP port is enabled. Usually this indicates the "ninja.ssl.port" property is > -1.
    
    Returns:
    
    True if enabled otherwise false.

Interface Standalone<T extends Standalone>

Field Summary

Method Summary

Field Detail

KEY_NINJA_STANDALONE_CLASS

KEY_NINJA_CONTEXT_PATH

KEY_NINJA_HOST

KEY_NINJA_IDLE_TIMEOUT

KEY_NINJA_PORT

KEY_NINJA_SSL_PORT

KEY_NINJA_SSL_KEYSTORE_URI

KEY_NINJA_SSL_KEYSTORE_PASSWORD

KEY_NINJA_SSL_TRUSTSTORE_URI

KEY_NINJA_SSL_TRUSTSTORE_PASSWORD

DEFAULT_STANDALONE_CLASS

DEFAULT_HOST

DEFAULT_PORT

DEFAULT_IDLE_TIMEOUT

DEFAULT_CONTEXT_PATH

DEFAULT_SSL_PORT

DEFAULT_DEV_NINJA_SSL_KEYSTORE_URI

DEFAULT_DEV_NINJA_SSL_KEYSTORE_PASSWORD

DEFAULT_DEV_NINJA_SSL_TRUSTSTORE_URI

DEFAULT_DEV_NINJA_SSL_TRUSTSTORE_PASSWORD

Method Detail

configure

run

start

join

shutdown

getNinjaMode

ninjaMode

getExternalConfigurationPath

externalConfigurationPath

getName

name

getHost

host

getPort

port

getContextPath

contextPath

idleTimeout

getIdleTimeout

getSslPort

sslPort

getSslKeystoreUri

sslKeystoreUri

getSslKeystorePassword

sslKeystorePassword

getSslTruststoreUri

sslTruststoreUri

getSslTruststorePassword

sslTruststorePassword

getNinjaProperties

getInjector

getServerUrls

getBaseUrls

isPortEnabled

isSslPortEnabled