Package org.openremote.manager.web

Class ManagerWebService

java.lang.Object

org.openremote.container.web.WebService

org.openremote.manager.web.ManagerWebService

All Implemented Interfaces:

org.openremote.model.ContainerService

public class ManagerWebService
extends org.openremote.container.web.WebService

Nested Class Summary

Nested classes/interfaces inherited from class org.openremote.container.web.WebService

org.openremote.container.web.WebService.DeploymentInstance, org.openremote.container.web.WebService.RequestHandler

Field Summary

Fields

Modifier and Type	Field	Description
static final String	API_PATH
protected Collection<Class<?>>	apiClasses
protected Collection<Object>	apiSingletons
static final List<String>	APP_PATHS
protected Path	builtInAppDocRoot
static final String	CONSOLE_LOADER_APP_PATH
protected Path	customAppDocRoot
protected boolean	initialised
static final String	INSIGHTS_APP_PATH
static final String	MANAGER_APP_PATH
static final String	OR_APP_DOCROOT
static final String	OR_APP_DOCROOT_DEFAULT
static final String	OR_CUSTOM_APP_DOCROOT
static final String	OR_CUSTOM_APP_DOCROOT_DEFAULT
static final String	OR_ROOT_REDIRECT_PATH
static final String	OR_ROOT_REDIRECT_PATH_DEFAULT
protected static final Pattern	PATTERN_REALM_SUB
static final int	PRIORITY
static final String	SHARED_PATH
static final String	SWAGGER_APP_PATH
static final String	UI_CLASSPATH_PREFIX

Fields inherited from class org.openremote.container.web.WebService

alreadyGzippedWriterInterceptor, clientErrorExceptionHandler, containerHostUri, corsFilterRef, defaultResteasyExceptionMapper, devMode, forbiddenResteasyExceptionMapper, host, httpHandlers, jacksonConfig, OR_WEBSERVER_ALLOWED_ORIGINS, OR_WEBSERVER_DUMP_REQUESTS, OR_WEBSERVER_DUMP_REQUESTS_DEFAULT, OR_WEBSERVER_IO_THREADS_MAX, OR_WEBSERVER_IO_THREADS_MAX_DEFAULT, OR_WEBSERVER_LISTEN_HOST, OR_WEBSERVER_LISTEN_HOST_DEFAULT, OR_WEBSERVER_LISTEN_PORT, OR_WEBSERVER_LISTEN_PORT_DEFAULT, OR_WEBSERVER_WORKER_THREADS_MAX, port, undertow, undertowExceptionHandler, WEBSERVER_WORKER_THREADS_MAX_DEFAULT

Fields inherited from interface org.openremote.model.ContainerService

DEFAULT_PRIORITY, HIGH_PRIORITY, LOW_PRIORITY, MED_PRIORITY

Constructor Summary

Constructors

Constructor	Description
ManagerWebService()

Method Summary

Modifier and Type	Method	Description
void	addApiSingleton(Object singleton)	Add resource/provider/etc.
protected io.undertow.server.HttpHandler	createApiHandler(org.openremote.model.Container container, org.jboss.resteasy.spi.ResteasyDeployment resteasyDeployment)
static io.undertow.server.HttpHandler	createFileHandler(org.openremote.model.Container container, io.undertow.server.handlers.resource.ResourceManager resourceManager, String[] requiredRoles)
Collection<Class<?>>	getApiClasses()	Add resource/provider/etc.
Path	getBuiltInAppDocRoot()
Path	getCustomAppDocRoot()
int	getPriority()	Start web service after other services.
void	init(org.openremote.model.Container container)
protected void	serveFilesFromBuiltInAppDocRoot(org.openremote.model.Container container, io.undertow.server.handlers.PathHandler deploymentHandler)
protected void	serveFilesFromClassPath(org.openremote.model.Container container, io.undertow.server.handlers.PathHandler deploymentHandler)
String	toString()

Methods inherited from class org.openremote.container.web.WebService

addServletDeployment, build, configureDeploymentInfo, createResteasyDeployment, getAllowedOrigins, getCorsFilterInfo, getExternalHostnames, getHostUri, getLocalIpAddress, getRequestHandlers, getStandardProviders, getUndertow, pathStartsWithHandler, removeServletDeployment, start, stop

Methods inherited from class java.lang.Object

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

Field Details

PRIORITY

public static final int PRIORITY

See Also:

• Constant Field Values

OR_APP_DOCROOT

public static final String OR_APP_DOCROOT

See Also:

• Constant Field Values

OR_APP_DOCROOT_DEFAULT

public static final String OR_APP_DOCROOT_DEFAULT

See Also:

• Constant Field Values

OR_CUSTOM_APP_DOCROOT

public static final String OR_CUSTOM_APP_DOCROOT

See Also:

• Constant Field Values

OR_CUSTOM_APP_DOCROOT_DEFAULT

public static final String OR_CUSTOM_APP_DOCROOT_DEFAULT

See Also:

• Constant Field Values

OR_ROOT_REDIRECT_PATH

public static final String OR_ROOT_REDIRECT_PATH

See Also:

• Constant Field Values

OR_ROOT_REDIRECT_PATH_DEFAULT

public static final String OR_ROOT_REDIRECT_PATH_DEFAULT

See Also:

• Constant Field Values

API_PATH

public static final String API_PATH

See Also:

• Constant Field Values

MANAGER_APP_PATH

public static final String MANAGER_APP_PATH

See Also:

• Constant Field Values

INSIGHTS_APP_PATH

public static final String INSIGHTS_APP_PATH

See Also:

• Constant Field Values

SWAGGER_APP_PATH

public static final String SWAGGER_APP_PATH

See Also:

• Constant Field Values

CONSOLE_LOADER_APP_PATH

public static final String CONSOLE_LOADER_APP_PATH

See Also:

• Constant Field Values

SHARED_PATH

public static final String SHARED_PATH

See Also:

• Constant Field Values

APP_PATHS

public static final List<String> APP_PATHS

UI_CLASSPATH_PREFIX

public static final String UI_CLASSPATH_PREFIX

See Also:

• Constant Field Values

PATTERN_REALM_SUB

protected static final Pattern PATTERN_REALM_SUB

initialised

protected boolean initialised

builtInAppDocRoot

protected Path builtInAppDocRoot

customAppDocRoot

protected Path customAppDocRoot

apiClasses

protected Collection<Class<?>> apiClasses

apiSingletons

protected Collection<Object> apiSingletons

Constructor Details

ManagerWebService

public ManagerWebService()

Method Details

getPriority

public int getPriority()

Start web service after other services.

Specified by:

getPriority in interface org.openremote.model.ContainerService

Overrides:

getPriority in class org.openremote.container.web.WebService

init

public void init(org.openremote.model.Container container)
          throws Exception

Specified by:

init in interface org.openremote.model.ContainerService

Overrides:

init in class org.openremote.container.web.WebService

Throws:

Exception

serveFilesFromBuiltInAppDocRoot

protected void serveFilesFromBuiltInAppDocRoot(org.openremote.model.Container container,
 io.undertow.server.handlers.PathHandler deploymentHandler)

serveFilesFromClassPath

protected void serveFilesFromClassPath(org.openremote.model.Container container,
 io.undertow.server.handlers.PathHandler deploymentHandler)

getApiClasses

public Collection<Class<?>> getApiClasses()

Add resource/provider/etc. classes to enable REST API

addApiSingleton

public void addApiSingleton(Object singleton)

Add resource/provider/etc. singletons to enable REST API.

getBuiltInAppDocRoot

public Path getBuiltInAppDocRoot()

getCustomAppDocRoot

public Path getCustomAppDocRoot()

createApiHandler

protected io.undertow.server.HttpHandler createApiHandler(org.openremote.model.Container container,
 org.jboss.resteasy.spi.ResteasyDeployment resteasyDeployment)

createFileHandler

public static io.undertow.server.HttpHandler createFileHandler(org.openremote.model.Container container,
 io.undertow.server.handlers.resource.ResourceManager resourceManager,
 String[] requiredRoles)

toString

public String toString()

Overrides:

toString in class Object