Package org.openremote.container.web

Class WebService

java.lang.Object

org.openremote.container.web.WebService

All Implemented Interfaces:

org.openremote.model.ContainerService

public abstract class WebService
extends Object
implements org.openremote.model.ContainerService

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WebService.DeploymentInstance
static class	WebService.RequestHandler

Field Summary

Fields

Modifier and Type	Field	Description
protected static AlreadyGzippedWriterInterceptor	alreadyGzippedWriterInterceptor
protected static ClientErrorExceptionHandler	clientErrorExceptionHandler
protected URI	containerHostUri
protected static AtomicReference<CORSFilter>	corsFilterRef
protected static WebServiceExceptions.DefaultResteasyExceptionMapper	defaultResteasyExceptionMapper
protected boolean	devMode
protected static WebServiceExceptions.ForbiddenResteasyExceptionMapper	forbiddenResteasyExceptionMapper
protected String	host
protected List<WebService.RequestHandler>	httpHandlers
protected static JacksonConfig	jacksonConfig
static final String	OR_WEBSERVER_ALLOWED_ORIGINS
static final String	OR_WEBSERVER_DUMP_REQUESTS
static final boolean	OR_WEBSERVER_DUMP_REQUESTS_DEFAULT
static final String	OR_WEBSERVER_IO_THREADS_MAX
static final int	OR_WEBSERVER_IO_THREADS_MAX_DEFAULT
static final String	OR_WEBSERVER_LISTEN_HOST
static final String	OR_WEBSERVER_LISTEN_HOST_DEFAULT
static final String	OR_WEBSERVER_LISTEN_PORT
static final int	OR_WEBSERVER_LISTEN_PORT_DEFAULT
static final String	OR_WEBSERVER_WORKER_THREADS_MAX
protected int	port
protected io.undertow.Undertow	undertow
protected static WebServiceExceptions.ServletUndertowExceptionHandler	undertowExceptionHandler
static final int	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
WebService()

Method Summary

Modifier and Type	Method	Description
static io.undertow.server.HttpHandler	addServletDeployment(org.openremote.model.Container container, io.undertow.servlet.api.DeploymentInfo deploymentInfo, boolean secure)	Adds a deployment to the default servlet container and returns the started handler.
protected io.undertow.Undertow.Builder	build(org.openremote.model.Container container, io.undertow.Undertow.Builder builder)
static void	configureDeploymentInfo(io.undertow.servlet.api.DeploymentInfo deploymentInfo)
protected org.jboss.resteasy.spi.ResteasyDeployment	createResteasyDeployment(org.openremote.model.Container container, Collection<Class<?>> apiClasses, Collection<Object> apiSingletons, boolean secure)
static Set<String>	getAllowedOrigins(org.openremote.model.Container container)
static io.undertow.servlet.api.FilterInfo	getCorsFilterInfo(org.openremote.model.Container container)
static List<String>	getExternalHostnames(org.openremote.model.Container container)
URI	getHostUri()	Provides the LAN IPv4 address the container is bound to so it can be used in the context provider callbacks; if CB is on the other side of some sort of NAT then this won't work also assumes HTTP
protected static String	getLocalIpAddress()
int	getPriority()	Gets the priority of this service which is used to determine initialization order when services are auto discovered; services with a lower priority are initialized and started first.
List<WebService.RequestHandler>	getRequestHandlers()	When a request comes in the handlers are called in order until a handler returns a non null value; when this happens the returned WebService.RequestHandler is invoked.
static List<Object>	getStandardProviders(boolean devMode)	Get standard JAX-RS providers that are used in the deployment.
io.undertow.Undertow	getUndertow()
void	init(org.openremote.model.Container container)	All services are initialized in the order they have been added to the container (if container started with explicit list of services) otherwise they are initialized in order of ContainerService.getPriority().
static WebService.RequestHandler	pathStartsWithHandler(String name, String path, io.undertow.server.HttpHandler handler)
void	removeServletDeployment(io.undertow.servlet.api.DeploymentInfo deploymentInfo)
void	start(org.openremote.model.Container container)	After initialization, services are started in the order they have been added to the container (if container started with explicit list of services) otherwise they are started in order of ContainerService.getPriority().
void	stop(org.openremote.model.Container container)	When the container is shutting down, it stops all services in the reverse order they were started.

Methods inherited from class java.lang.Object

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

Field Details

OR_WEBSERVER_LISTEN_HOST

public static final String OR_WEBSERVER_LISTEN_HOST

See Also:

• Constant Field Values

OR_WEBSERVER_LISTEN_HOST_DEFAULT

public static final String OR_WEBSERVER_LISTEN_HOST_DEFAULT

See Also:

• Constant Field Values

OR_WEBSERVER_LISTEN_PORT

public static final String OR_WEBSERVER_LISTEN_PORT

See Also:

• Constant Field Values

OR_WEBSERVER_LISTEN_PORT_DEFAULT

public static final int OR_WEBSERVER_LISTEN_PORT_DEFAULT

See Also:

• Constant Field Values

OR_WEBSERVER_DUMP_REQUESTS

public static final String OR_WEBSERVER_DUMP_REQUESTS

See Also:

• Constant Field Values

OR_WEBSERVER_DUMP_REQUESTS_DEFAULT

public static final boolean OR_WEBSERVER_DUMP_REQUESTS_DEFAULT

See Also:

• Constant Field Values

OR_WEBSERVER_ALLOWED_ORIGINS

public static final String OR_WEBSERVER_ALLOWED_ORIGINS

See Also:

• Constant Field Values

OR_WEBSERVER_IO_THREADS_MAX

public static final String OR_WEBSERVER_IO_THREADS_MAX

See Also:

• Constant Field Values

OR_WEBSERVER_IO_THREADS_MAX_DEFAULT

public static final int OR_WEBSERVER_IO_THREADS_MAX_DEFAULT

OR_WEBSERVER_WORKER_THREADS_MAX

public static final String OR_WEBSERVER_WORKER_THREADS_MAX

See Also:

• Constant Field Values

WEBSERVER_WORKER_THREADS_MAX_DEFAULT

public static final int WEBSERVER_WORKER_THREADS_MAX_DEFAULT

corsFilterRef

protected static AtomicReference<CORSFilter> corsFilterRef

devMode

protected boolean devMode

host

protected String host

port

protected int port

undertow

protected io.undertow.Undertow undertow

httpHandlers

protected List<WebService.RequestHandler> httpHandlers

containerHostUri

protected URI containerHostUri

defaultResteasyExceptionMapper

protected static WebServiceExceptions.DefaultResteasyExceptionMapper defaultResteasyExceptionMapper

forbiddenResteasyExceptionMapper

protected static WebServiceExceptions.ForbiddenResteasyExceptionMapper forbiddenResteasyExceptionMapper

jacksonConfig

protected static JacksonConfig jacksonConfig

alreadyGzippedWriterInterceptor

protected static AlreadyGzippedWriterInterceptor alreadyGzippedWriterInterceptor

clientErrorExceptionHandler

protected static ClientErrorExceptionHandler clientErrorExceptionHandler

undertowExceptionHandler

protected static WebServiceExceptions.ServletUndertowExceptionHandler undertowExceptionHandler

Constructor Details

WebService

public WebService()

Method Details

getLocalIpAddress

protected static String getLocalIpAddress()
                                   throws Exception

Throws:

Exception

pathStartsWithHandler

public static WebService.RequestHandler pathStartsWithHandler(String name,
 String path,
 io.undertow.server.HttpHandler handler)

getPriority

public int getPriority()

Description copied from interface: org.openremote.model.ContainerService

Gets the priority of this service which is used to determine initialization order when services are auto discovered; services with a lower priority are initialized and started first.

Specified by:

getPriority in interface org.openremote.model.ContainerService

init

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

Description copied from interface: org.openremote.model.ContainerService

All services are initialized in the order they have been added to the container (if container started with explicit list of services) otherwise they are initialized in order of ContainerService.getPriority().

Specified by:

init in interface org.openremote.model.ContainerService

Throws:

Exception

start

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

Description copied from interface: org.openremote.model.ContainerService

After initialization, services are started in the order they have been added to the container (if container started with explicit list of services) otherwise they are started in order of ContainerService.getPriority().

Specified by:

start in interface org.openremote.model.ContainerService

Throws:

Exception

stop

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

Description copied from interface: org.openremote.model.ContainerService

When the container is shutting down, it stops all services in the reverse order they were started.

Specified by:

stop in interface org.openremote.model.ContainerService

Throws:

Exception

addServletDeployment

public static io.undertow.server.HttpHandler addServletDeployment(org.openremote.model.Container container,
 io.undertow.servlet.api.DeploymentInfo deploymentInfo,
 boolean secure)

Adds a deployment to the default servlet container and returns the started handler.

removeServletDeployment

public void removeServletDeployment(io.undertow.servlet.api.DeploymentInfo deploymentInfo)

configureDeploymentInfo

public static void configureDeploymentInfo(io.undertow.servlet.api.DeploymentInfo deploymentInfo)

getStandardProviders

public static List<Object> getStandardProviders(boolean devMode)

Get standard JAX-RS providers that are used in the deployment.

getRequestHandlers

public List<WebService.RequestHandler> getRequestHandlers()

When a request comes in the handlers are called in order until a handler returns a non null value; when this happens the returned WebService.RequestHandler is invoked.

getHostUri

public URI getHostUri()

Provides the LAN IPv4 address the container is bound to so it can be used in the context provider callbacks; if CB is on the other side of some sort of NAT then this won't work also assumes HTTP

build

protected io.undertow.Undertow.Builder build(org.openremote.model.Container container,
 io.undertow.Undertow.Builder builder)

createResteasyDeployment

protected org.jboss.resteasy.spi.ResteasyDeployment createResteasyDeployment(org.openremote.model.Container container,
 Collection<Class<?>> apiClasses,
 Collection<Object> apiSingletons,
 boolean secure)

getUndertow

public io.undertow.Undertow getUndertow()

getCorsFilterInfo

public static io.undertow.servlet.api.FilterInfo getCorsFilterInfo(org.openremote.model.Container container)

getExternalHostnames

public static List<String> getExternalHostnames(org.openremote.model.Container container)

getAllowedOrigins

public static Set<String> getAllowedOrigins(org.openremote.model.Container container)