org.apache.brooklyn.launcher

Class BrooklynWebServer

java.lang.Object

org.apache.brooklyn.launcher.BrooklynWebServer

public class BrooklynWebServer
extends java.lang.Object

Starts the brooklyn REST server running, connected to the given management context

Constructor Summary

Constructors

Constructor and Description
BrooklynWebServer(ManagementContext managementContext)
BrooklynWebServer(ManagementContext managementContext, int port)
BrooklynWebServer(ManagementContext managementContext, int port, java.lang.String warUrl)
BrooklynWebServer(java.util.Map<?,?> flags, ManagementContext managementContext) accepts flags: port, war (url of war file which is the root), wars (map of context-prefix to url), attrs (map of attribute-name : object pairs passed to the servlet)

Method Summary

Modifier and Type	Method and Description
BrooklynWebServer	addAttribute(java.lang.String field, java.lang.Object value) Deprecated. use setAttribute
BrooklynWebServer	addWar(java.lang.String path, java.lang.String warUrl) specifies a WAR to use at a given context path (only if server not yet started); cf deploy(path, url)
BrooklynWebServer	addWar(WebAppContextProvider contextProvider)
<T> BrooklynWebServer	configure(ConfigKey<T> key, T value)
org.eclipse.jetty.webapp.WebAppContext	deploy(java.lang.String pathSpec, java.lang.String war)
void	deploy(org.eclipse.jetty.webapp.WebAppContext context)
org.eclipse.jetty.webapp.WebAppContext	deploy(WebAppContextProvider contextProvider) Serve the given WAR at the given pathSpec.
int	getActualPort() returns port where this is running, or -1 if not yet known
java.net.InetAddress	getAddress() interface/address where this server is or will be listening; if bound to 0.0.0.0 (all NICs, e.g.
boolean	getHttpsEnabled()
PortRange	getRequestedPort()
org.eclipse.jetty.webapp.WebAppContext	getRootContext()
java.lang.String	getRootUrl() URL for accessing this web server (root context)
org.eclipse.jetty.server.Server	getServer()
BrooklynWebServer	putAttributes(java.util.Map newAttrs) Specifies attributes passed to deployed webapps (in addition to BrooklynServiceAttributes.BROOKLYN_MANAGEMENT_CONTEXT
BrooklynWebServer	setAttribute(java.lang.String field, java.lang.Object value) Specifies an attribute passed to deployed webapps (in addition to BrooklynServiceAttributes.BROOKLYN_MANAGEMENT_CONTEXT
BrooklynWebServer	setBindAddress(java.net.InetAddress address) InetAddress to which server should bind; defaults to 0.0.0.0 (although common call path is to set to 127.0.0.1 when security is not set)
BrooklynWebServer	setHttpsEnabled(java.lang.Boolean httpsEnabled)
BrooklynWebServer	setPort(java.lang.Object port)
BrooklynWebServer	setPublicAddress(java.net.InetAddress address) Sets the public address that the server's management context's REST API will be available on
void	setShutdownHandler(ShutdownHandler shutdownHandler)
BrooklynWebServer	setWar(java.lang.String url) sets the WAR to use as the root context (only if server not yet started); cf deploy("/", url)
BrooklynWebServer	skipSecurity()
BrooklynWebServer	skipSecurity(boolean skipSecurity)
void	start() Starts the embedded web application server.
void	stop() Asks the app server to stop and waits for it to finish up.

Methods inherited from class java.lang.Object

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

Constructor Detail

BrooklynWebServer

public BrooklynWebServer(ManagementContext managementContext)

BrooklynWebServer

public BrooklynWebServer(java.util.Map<?,?> flags,
                         ManagementContext managementContext)

accepts flags: port, war (url of war file which is the root), wars (map of context-prefix to url), attrs (map of attribute-name : object pairs passed to the servlet)

BrooklynWebServer

public BrooklynWebServer(ManagementContext managementContext,
                         int port)

BrooklynWebServer

public BrooklynWebServer(ManagementContext managementContext,
                         int port,
                         java.lang.String warUrl)

Method Detail

skipSecurity

public BrooklynWebServer skipSecurity()

skipSecurity

public BrooklynWebServer skipSecurity(boolean skipSecurity)

setShutdownHandler

public void setShutdownHandler(@Nullable
                               ShutdownHandler shutdownHandler)

setPort

public BrooklynWebServer setPort(java.lang.Object port)

setHttpsEnabled

public BrooklynWebServer setHttpsEnabled(java.lang.Boolean httpsEnabled)

getHttpsEnabled

public boolean getHttpsEnabled()

getRequestedPort

public PortRange getRequestedPort()

getActualPort

public int getActualPort()

returns port where this is running, or -1 if not yet known

getAddress

public java.net.InetAddress getAddress()

interface/address where this server is or will be listening; if bound to 0.0.0.0 (all NICs, e.g. because security is set) this will return one NIC where this is bound

getRootUrl

public java.lang.String getRootUrl()

URL for accessing this web server (root context)

setWar

public BrooklynWebServer setWar(java.lang.String url)

sets the WAR to use as the root context (only if server not yet started); cf deploy("/", url)

addWar

public BrooklynWebServer addWar(java.lang.String path,
                                java.lang.String warUrl)

specifies a WAR to use at a given context path (only if server not yet started); cf deploy(path, url)

addWar

public BrooklynWebServer addWar(WebAppContextProvider contextProvider)

setBindAddress

public BrooklynWebServer setBindAddress(java.net.InetAddress address)

InetAddress to which server should bind; defaults to 0.0.0.0 (although common call path is to set to 127.0.0.1 when security is not set)

setPublicAddress

public BrooklynWebServer setPublicAddress(java.net.InetAddress address)

Sets the public address that the server's management context's REST API will be available on

addAttribute

@Deprecated
public BrooklynWebServer addAttribute(java.lang.String field,
                                                  java.lang.Object value)

Deprecated. use setAttribute

setAttribute

public BrooklynWebServer setAttribute(java.lang.String field,
                                      java.lang.Object value)

Specifies an attribute passed to deployed webapps (in addition to BrooklynServiceAttributes.BROOKLYN_MANAGEMENT_CONTEXT

configure

public <T> BrooklynWebServer configure(ConfigKey<T> key,
                                       T value)

putAttributes

public BrooklynWebServer putAttributes(java.util.Map newAttrs)

Specifies attributes passed to deployed webapps (in addition to BrooklynServiceAttributes.BROOKLYN_MANAGEMENT_CONTEXT

start

public void start()
           throws java.lang.Exception

Starts the embedded web application server.

Throws:

java.lang.Exception

stop

public void stop()
          throws java.lang.Exception

Asks the app server to stop and waits for it to finish up.

Throws:

java.lang.Exception

deploy

public org.eclipse.jetty.webapp.WebAppContext deploy(java.lang.String pathSpec,
                                                     java.lang.String war)

deploy

public org.eclipse.jetty.webapp.WebAppContext deploy(WebAppContextProvider contextProvider)

Serve the given WAR at the given pathSpec. If not yet started, it is remembered until start. If the server is already running the context for this WAR is started.

Returns:

the context created and added as a handler (and possibly already started if server is started, so be careful with any changes you make to it!)

deploy

public void deploy(org.eclipse.jetty.webapp.WebAppContext context)

getServer

public org.eclipse.jetty.server.Server getServer()

getRootContext

public org.eclipse.jetty.webapp.WebAppContext getRootContext()