WebViewConfiguration

java.lang.Object
- org.kepler.webview.server.WebViewConfiguration

```
public class WebViewConfiguration
extends java.lang.Object
```
Utility class to read WebView configuration.

Author:

Daniel Crawl

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_WEBVIEW_SECURE_SERVER_PORT` The default secure sever port.
`static int`	`DEFAULT_WEBVIEW_SERVER_INSTANCES` The default number of server instances.
`static int`	`DEFAULT_WEBVIEW_SERVER_PORT` The default server port.
`static java.lang.String`	`DEFAULT_WEBVIEW_SERVER_ROOT_DIR` The default root directory.
`static java.lang.String`	`WEBVIEW_SERVER_DAEMON_FLAG` Command line flag to run the server in daemon mode.
`static java.lang.String`	`WEBVIEW_SERVER_INSTANCES_FLAG` Command line flag to specify the number of server instances.
`static java.lang.String`	`WEBVIEW_SERVER_PORT_FLAG` Command line flag to specify the server port.
`static java.lang.String`	`WEBVIEW_SERVER_ROOT_DIR_FLAG` Command line flag to specify the root directory.
`static java.lang.String`	`WEBVIEW_START_SERVER_FLAG` Command line flag to start the server.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`deployInKubernetes()`
`static boolean`	`enableHttps()` Returns true if the http server should use ssl.
`static boolean`	`enableHttpServerTableOfContents()` Returns true if the http server table of contents should be enabled.
`static java.lang.String`	`getAppClassName(java.lang.String appName)` Get the class name of an app.
`static java.util.List<ConfigurationProperty>`	`getAppProperties(java.lang.String appName, java.lang.String confName)` Get config properties for an app.
`static io.vertx.ext.auth.AuthProvider`	`getAuthProvider()` Get an authentication provider based on the authentication type specified in the configuration.
`static java.lang.String`	`getHazelcastDiscoveryDnsServiceName()`
`static boolean`	`getHttpServerAllowWorkflowDownloads()` Returns true if the http server allows workflows to be downloaded.
`static boolean`	`getHttpServerAppendIndexHtml()`
`static java.lang.String`	`getHttpServerCorsAllowOriginPattern()` Get the CORS allow origin pattern.
`static boolean`	`getHttpServerCorsEnabled()` Returns true if the http server allows CORS.
`static java.util.Set<java.lang.String>`	`getHttpServerDirectoriesToIndex()` Get list of server directories that can be indexed.
`static int`	`getHttpServerInstances()` Get the number of instances of http servers to start.
`static java.lang.String`	`getHttpServerLogPath()` Get the log directory and file name for the http server.
`static java.lang.String`	`getHttpServerMetadataFileName()` Get the metadata file name.
`static int`	`getHttpServerPort()`
`static java.lang.String`	`getHttpServerRedirectHostname()` Get the hostname to redirect http requests to.
`static int`	`getHttpServerRedirectPort()` Get the port to redirect http requests to.
`static int`	`getHttpServerRedirectStatus()` Get the http redirect status code.
`static java.lang.String`	`getHttpServerRootDir()` Returns the root directory for the HTTP Server.
`static long`	`getHttpServerSessionTimeout()` Get the timeout, in milliseconds, for the session if not accessed.
`static java.lang.String`	`getHttpServerTableOfContentsPath()` Get the path regex of the http server table of contents.
`static int`	`getHttpServerWorkerThreads()` Returns the number of threads for the worker pool.
`static long`	`getHttpServerWorkflowTimeout()` Get the timeout, in milliseconds, for workflow execution.
`static java.lang.String`	`getHttpsPEMCertPath()` Get the SSL PEM Certificate file path.
`static java.lang.String`	`getHttpsPEMKeyPath()` Get the SSL PEM Key file path.
`static int`	`getHttpsServerPort()` Get the port number for the https server.
`static java.util.Set<java.lang.String>`	`getPreloadModels()` Returns any models to be preloaded.
`static java.lang.String`	`getROHubAuthToken()` Returns the auth token for ROHUB.
`static java.lang.String`	`getROHubURI()` Returns the URI for ROHUB REST API.
`static java.lang.String`	`getSimpleAuthGroup(java.lang.String username, java.lang.String password)` Get the authorization group.
`static boolean`	`shouldHttpServerRedirect()`
`static boolean`	`shouldStartCluster()` Get if vertx should start in clustered mode.
`static boolean`	`shouldStartClusterHazelcast()` Get if vertx should use hazelcast for clustered mode.
`static boolean`	`shouldStartHttpServer()` Returns true if the web view http server should start.
`static boolean`	`shouldStartHttpServerAsDaemon()` Returns true if the web view http server should start in daemon mode.

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

- Field Detail
  - WEBVIEW_SERVER_PORT_FLAG
```
public static final java.lang.String WEBVIEW_SERVER_PORT_FLAG
```
    Command line flag to specify the server port.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_WEBVIEW_SERVER_PORT
```
public static final int DEFAULT_WEBVIEW_SERVER_PORT
```
    The default server port.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_WEBVIEW_SECURE_SERVER_PORT
```
public static final int DEFAULT_WEBVIEW_SECURE_SERVER_PORT
```
    The default secure sever port.
    
    See Also:
    
    Constant Field Values
  - WEBVIEW_SERVER_ROOT_DIR_FLAG
```
public static final java.lang.String WEBVIEW_SERVER_ROOT_DIR_FLAG
```
    Command line flag to specify the root directory.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_WEBVIEW_SERVER_ROOT_DIR
```
public static final java.lang.String DEFAULT_WEBVIEW_SERVER_ROOT_DIR
```
    The default root directory.
    
    See Also:
    
    Constant Field Values
  - WEBVIEW_START_SERVER_FLAG
```
public static final java.lang.String WEBVIEW_START_SERVER_FLAG
```
    Command line flag to start the server.
    
    See Also:
    
    Constant Field Values
  - WEBVIEW_SERVER_DAEMON_FLAG
```
public static final java.lang.String WEBVIEW_SERVER_DAEMON_FLAG
```
    Command line flag to run the server in daemon mode.
    
    See Also:
    
    Constant Field Values
  - WEBVIEW_SERVER_INSTANCES_FLAG
```
public static final java.lang.String WEBVIEW_SERVER_INSTANCES_FLAG
```
    Command line flag to specify the number of server instances.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_WEBVIEW_SERVER_INSTANCES
```
public static final int DEFAULT_WEBVIEW_SERVER_INSTANCES
```
    The default number of server instances.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - enableHttpServerTableOfContents
```
public static boolean enableHttpServerTableOfContents()
```
    Returns true if the http server table of contents should be enabled.
  - enableHttps
```
public static boolean enableHttps()
```
    Returns true if the http server should use ssl.
  - getPreloadModels
```
public static java.util.Set<java.lang.String> getPreloadModels()
```
    Returns any models to be preloaded.
  - getROHubAuthToken
```
public static java.lang.String getROHubAuthToken()
```
    Returns the auth token for ROHUB.
  - getROHubURI
```
public static java.lang.String getROHubURI()
```
    Returns the URI for ROHUB REST API.
  - getSimpleAuthGroup
```
public static java.lang.String getSimpleAuthGroup(java.lang.String username,
                                                  java.lang.String password)
```
    Get the authorization group.
    
    Parameters:
    
    username - The user name.
    
    password - The password.
    
    Returns:
    
    Returns null if username not found, or password does not match.
  - getAppClassName
```
public static java.lang.String getAppClassName(java.lang.String appName)
```
    Get the class name of an app.
  - getAppProperties
```
public static java.util.List<ConfigurationProperty> getAppProperties(java.lang.String appName,
                                                                     java.lang.String confName)
```
    Get config properties for an app.
  - getAuthProvider
```
public static io.vertx.ext.auth.AuthProvider getAuthProvider()
```
    Get an authentication provider based on the authentication type specified in the configuration.
  - getHttpServerCorsAllowOriginPattern
```
public static java.lang.String getHttpServerCorsAllowOriginPattern()
```
    Get the CORS allow origin pattern.
  - getHttpServerCorsEnabled
```
public static boolean getHttpServerCorsEnabled()
```
    Returns true if the http server allows CORS.
  - getHttpServerAllowWorkflowDownloads
```
public static boolean getHttpServerAllowWorkflowDownloads()
```
    Returns true if the http server allows workflows to be downloaded.
  - getHttpServerAppendIndexHtml
```
public static boolean getHttpServerAppendIndexHtml()
```
  - getHttpServerDirectoriesToIndex
```
public static java.util.Set<java.lang.String> getHttpServerDirectoriesToIndex()
```
    Get list of server directories that can be indexed.
  - getHttpServerInstances
```
public static int getHttpServerInstances()
```
    Get the number of instances of http servers to start.
  - getHttpServerLogPath
```
public static java.lang.String getHttpServerLogPath()
```
    Get the log directory and file name for the http server.
  - getHttpServerMetadataFileName
```
public static java.lang.String getHttpServerMetadataFileName()
```
    Get the metadata file name.
  - getHttpServerPort
```
public static int getHttpServerPort()
```
  - getHttpServerRedirectStatus
```
public static int getHttpServerRedirectStatus()
```
    Get the http redirect status code.
  - getHttpServerRedirectHostname
```
public static java.lang.String getHttpServerRedirectHostname()
```
    Get the hostname to redirect http requests to.
  - getHttpServerRedirectPort
```
public static int getHttpServerRedirectPort()
```
    Get the port to redirect http requests to.
  - getHttpServerRootDir
```
public static java.lang.String getHttpServerRootDir()
```
    Returns the root directory for the HTTP Server. If none specified, returns null.
  - getHttpServerSessionTimeout
```
public static long getHttpServerSessionTimeout()
```
    Get the timeout, in milliseconds, for the session if not accessed.
  - getHttpServerTableOfContentsPath
```
public static java.lang.String getHttpServerTableOfContentsPath()
```
    Get the path regex of the http server table of contents.
  - getHttpServerWorkerThreads
```
public static int getHttpServerWorkerThreads()
```
    Returns the number of threads for the worker pool.
  - getHttpServerWorkflowTimeout
```
public static long getHttpServerWorkflowTimeout()
```
    Get the timeout, in milliseconds, for workflow execution. Returns -1 for no timeout.
  - getHttpsServerPort
```
public static int getHttpsServerPort()
```
    Get the port number for the https server.
  - getHttpsPEMKeyPath
```
public static java.lang.String getHttpsPEMKeyPath()
```
    Get the SSL PEM Key file path.
  - getHttpsPEMCertPath
```
public static java.lang.String getHttpsPEMCertPath()
```
    Get the SSL PEM Certificate file path.
  - shouldHttpServerRedirect
```
public static boolean shouldHttpServerRedirect()
```
  - shouldStartHttpServer
```
public static boolean shouldStartHttpServer()
```
    Returns true if the web view http server should start.
  - shouldStartHttpServerAsDaemon
```
public static boolean shouldStartHttpServerAsDaemon()
```
    Returns true if the web view http server should start in daemon mode.
  - deployInKubernetes
```
public static boolean deployInKubernetes()
```
  - getHazelcastDiscoveryDnsServiceName
```
public static java.lang.String getHazelcastDiscoveryDnsServiceName()
```
  - shouldStartClusterHazelcast
```
public static boolean shouldStartClusterHazelcast()
```
    Get if vertx should use hazelcast for clustered mode.
  - shouldStartCluster
```
public static boolean shouldStartCluster()
```
    Get if vertx should start in clustered mode.

Class WebViewConfiguration

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

WEBVIEW_SERVER_PORT_FLAG

DEFAULT_WEBVIEW_SERVER_PORT

DEFAULT_WEBVIEW_SECURE_SERVER_PORT

WEBVIEW_SERVER_ROOT_DIR_FLAG

DEFAULT_WEBVIEW_SERVER_ROOT_DIR

WEBVIEW_START_SERVER_FLAG

WEBVIEW_SERVER_DAEMON_FLAG

WEBVIEW_SERVER_INSTANCES_FLAG

DEFAULT_WEBVIEW_SERVER_INSTANCES

Method Detail

enableHttpServerTableOfContents

enableHttps

getPreloadModels

getROHubAuthToken

getROHubURI

getSimpleAuthGroup

getAppClassName

getAppProperties

getAuthProvider

getHttpServerCorsAllowOriginPattern

getHttpServerCorsEnabled

getHttpServerAllowWorkflowDownloads

getHttpServerAppendIndexHtml

getHttpServerDirectoriesToIndex

getHttpServerInstances

getHttpServerLogPath

getHttpServerMetadataFileName

getHttpServerPort

getHttpServerRedirectStatus

getHttpServerRedirectHostname

getHttpServerRedirectPort

getHttpServerRootDir

getHttpServerSessionTimeout

getHttpServerTableOfContentsPath

getHttpServerWorkerThreads

getHttpServerWorkflowTimeout

getHttpsServerPort

getHttpsPEMKeyPath

getHttpsPEMCertPath

shouldHttpServerRedirect

shouldStartHttpServer

shouldStartHttpServerAsDaemon

deployInKubernetes

getHazelcastDiscoveryDnsServiceName

shouldStartClusterHazelcast

shouldStartCluster