Field Detail

• BROOKLYN_WAR_URL

  public static final java.lang.String BROOKLYN_WAR_URL

  See Also:

  Constant Field Values

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

• setSecurityFilter

  public void setSecurityFilter(java.lang.Class<BrooklynPropertiesSecurityFilter> filterClazz)

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

• 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

  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

• installAsServletFilter

  public static void installAsServletFilter(org.eclipse.jetty.servlet.ServletContextHandler 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 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!)

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