brooklyn.launcher

Class BrooklynWebServer

java.lang.Object

brooklyn.launcher.BrooklynWebServer

public class BrooklynWebServer
extends Object

Starts the web-app running, connected to the given management context

Field Summary

Fields

Modifier and Type	Field and Description
protected InetAddress	actualAddress actual NIC where this is listening; in the case of 0.0.0.0 being passed in as bindAddress, this will revert to one address (such as localhost)
protected int	actualPort actual port where this gets bound; will be consistent with the "port" passed in but that might be a range and here it is a single port, or -1 if not yet set
protected InetAddress	bindAddress IP of NIC where this server should bind, or null to autodetect (e.g.
static String	BROOKLYN_WAR_URL
protected PortRange	httpPort
protected PortRange	httpsPort
protected boolean	ignoreWebappDeploymentFailures
protected InetAddress	publicAddress The address that this server's management context will be publically available on.
protected PortRange	requestedPort base port to use, for http if enabled or else https; if not set, it uses httpPort or httpsPort
protected org.eclipse.jetty.server.Server	server
protected String	war

Constructor Summary

Constructors

Constructor and Description
BrooklynWebServer(ManagementContext managementContext)
BrooklynWebServer(ManagementContext managementContext, int port)
BrooklynWebServer(ManagementContext managementContext, int port, String warUrl)
BrooklynWebServer(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

Methods

Modifier and Type	Method and Description
BrooklynWebServer	addAttribute(String field, Object value) Deprecated. use setAttribute
protected void	addShutdownHook()
BrooklynWebServer	addWar(String path, String warUrl) specifies a WAR to use at a given context path (only if server not yet started); cf deploy(path, url)
<T> BrooklynWebServer	configure(ConfigKey<T> key, T value)
org.eclipse.jetty.webapp.WebAppContext	deploy(String pathSpec, String warUrl) serve given WAR at the given pathSpec; if not yet started, it is simply remembered until start; if server already running, the context for this WAR is started.
void	deploy(org.eclipse.jetty.webapp.WebAppContext context)
int	getActualPort() returns port where this is running, or -1 if not yet known
InetAddress	getAddress() interface/address where this server is listening; if bound to 0.0.0.0 (all NICs, e.g.
boolean	getHttpsEnabled()
PortRange	getRequestedPort()
org.eclipse.jetty.webapp.WebAppContext	getRootContext()
String	getRootUrl() URL for accessing this web server (root context)
org.eclipse.jetty.server.Server	getServer()
static void	installAsServletFilter(org.eclipse.jetty.servlet.ServletContextHandler context)
BrooklynWebServer	putAttributes(Map newAttrs) Specifies attributes passed to deployed webapps (in addition to BrooklynServiceAttributes.BROOKLYN_MANAGEMENT_CONTEXT
BrooklynWebServer	setAttribute(String field, Object value) Specifies an attribute passed to deployed webapps (in addition to BrooklynServiceAttributes.BROOKLYN_MANAGEMENT_CONTEXT
BrooklynWebServer	setBindAddress(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(Boolean httpsEnabled)
BrooklynWebServer	setPort(Object port)
BrooklynWebServer	setPublicAddress(InetAddress address) Sets the public address that the server's management context's REST API will be available on
void	setSecurityFilter(Class<BrooklynPropertiesSecurityFilter> filterClazz)
BrooklynWebServer	setWar(String url) sets the WAR to use as the root context (only if server not yet started); cf deploy("/", url)
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

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

Field Detail

BROOKLYN_WAR_URL

public static final String BROOKLYN_WAR_URL

See Also:

Constant Field Values

server

protected org.eclipse.jetty.server.Server server

requestedPort

protected PortRange requestedPort

base port to use, for http if enabled or else https; if not set, it uses httpPort or httpsPort

httpPort

protected PortRange httpPort

httpsPort

protected PortRange httpsPort

actualPort

protected volatile int actualPort

actual port where this gets bound; will be consistent with the "port" passed in but that might be a range and here it is a single port, or -1 if not yet set

actualAddress

protected InetAddress actualAddress

actual NIC where this is listening; in the case of 0.0.0.0 being passed in as bindAddress, this will revert to one address (such as localhost)

war

protected String war

bindAddress

protected InetAddress bindAddress

IP of NIC where this server should bind, or null to autodetect (e.g. 0.0.0.0 if security is configured, or loopback if no security)

publicAddress

protected InetAddress publicAddress

The address that this server's management context will be publically available on.

ignoreWebappDeploymentFailures

protected boolean ignoreWebappDeploymentFailures

Constructor Detail

BrooklynWebServer

public BrooklynWebServer(ManagementContext managementContext)

BrooklynWebServer

public BrooklynWebServer(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,
                 String warUrl)

Method Detail

setSecurityFilter

public void setSecurityFilter(Class<BrooklynPropertiesSecurityFilter> filterClazz)

setPort

public BrooklynWebServer setPort(Object port)

setHttpsEnabled

public BrooklynWebServer setHttpsEnabled(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 InetAddress getAddress()

interface/address where this server is 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 String getRootUrl()

URL for accessing this web server (root context)

setWar

public BrooklynWebServer setWar(String url)

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

addWar

public BrooklynWebServer addWar(String path,
                       String warUrl)

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

setBindAddress

public BrooklynWebServer setBindAddress(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(InetAddress address)

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

addAttribute

public BrooklynWebServer addAttribute(String field,
                             Object value)

Deprecated. use setAttribute

setAttribute

public BrooklynWebServer setAttribute(String field,
                             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(Map newAttrs)

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

installAsServletFilter

public static void installAsServletFilter(org.eclipse.jetty.servlet.ServletContextHandler context)

start

public void start()
           throws Exception

Starts the embedded web application server.

Throws:

Exception

stop

public void stop()
          throws Exception

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

Throws:

Exception

deploy

public org.eclipse.jetty.webapp.WebAppContext deploy(String pathSpec,
                                            String warUrl)

serve given WAR at the given pathSpec; if not yet started, it is simply remembered until start; if server 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!)

addShutdownHook

protected void addShutdownHook()

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()