Package org.apache.activemq.artemis.component

Class WebServerComponent

java.lang.Object

org.apache.activemq.artemis.component.WebServerComponent

All Implemented Interfaces:

ExternalComponent, org.apache.activemq.artemis.core.server.ActiveMQComponent, org.apache.activemq.artemis.core.server.ServiceComponent, org.apache.activemq.artemis.marker.WebServerComponentMarker

public class WebServerComponent
extends Object
implements ExternalComponent, org.apache.activemq.artemis.marker.WebServerComponentMarker

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_SCAN_PERIOD_VALUE
static final boolean	DEFAULT_SNI_HOST_CHECK_VALUE
static final boolean	DEFAULT_SNI_REQUIRED_VALUE
static final boolean	DEFAULT_SSL_AUTO_RELOAD_VALUE
static final String	WEB_CONSOLE_DISPLAY_NAME

Constructor Summary

Constructors

Constructor	Description
WebServerComponent()

Method Summary

Modifier and Type	Method	Description
void	configure(ComponentDTO config, String artemisInstance, String artemisHome)
protected org.eclipse.jetty.ee9.webapp.WebAppContext	createWebAppContext(String url, String warFile, Path warDirectory, String virtualHost)
int	getPort()	Deprecated.
int	getPort(int connectorIndex)
List<Pair<org.eclipse.jetty.ee9.webapp.WebAppContext,String>>	getWebContextData()
org.eclipse.jetty.server.Server	getWebServer()
boolean	isStarted()
void	start()
void	stop()
void	stop(boolean isShutdown)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.activemq.artemis.core.server.ActiveMQComponent

asyncStop

Field Details

WEB_CONSOLE_DISPLAY_NAME

public static final String WEB_CONSOLE_DISPLAY_NAME

DEFAULT_SNI_HOST_CHECK_VALUE

public static final boolean DEFAULT_SNI_HOST_CHECK_VALUE

See Also:

• Constant Field Values

DEFAULT_SNI_REQUIRED_VALUE

public static final boolean DEFAULT_SNI_REQUIRED_VALUE

See Also:

• Constant Field Values

DEFAULT_SSL_AUTO_RELOAD_VALUE

public static final boolean DEFAULT_SSL_AUTO_RELOAD_VALUE

See Also:

• Constant Field Values

DEFAULT_SCAN_PERIOD_VALUE

public static final int DEFAULT_SCAN_PERIOD_VALUE

See Also:

• Constant Field Values

Constructor Details

WebServerComponent

public WebServerComponent()

Method Details

configure

public void configure(ComponentDTO config,
 String artemisInstance,
 String artemisHome)
               throws Exception

Specified by:

configure in interface ExternalComponent

Throws:

Exception

start

public void start()
           throws Exception

Specified by:

start in interface org.apache.activemq.artemis.core.server.ActiveMQComponent

Throws:

Exception

isStarted

public boolean isStarted()

Specified by:

isStarted in interface org.apache.activemq.artemis.core.server.ActiveMQComponent

getPort

@Deprecated
public int getPort()

Deprecated.

Returns started server's port number; useful if it was specified as 0 (to use a random port).

Returns:

started server's port number; useful if it was specified as 0 (to use a random port)

getPort

public int getPort(int connectorIndex)

createWebAppContext

protected org.eclipse.jetty.ee9.webapp.WebAppContext createWebAppContext(String url,
 String warFile,
 Path warDirectory,
 String virtualHost)

stop

public void stop()
          throws Exception

Specified by:

stop in interface org.apache.activemq.artemis.core.server.ActiveMQComponent

Throws:

Exception

stop

public void stop(boolean isShutdown)
          throws Exception

Specified by:

stop in interface org.apache.activemq.artemis.core.server.ServiceComponent

Throws:

Exception

getWebContextData

public List<Pair<org.eclipse.jetty.ee9.webapp.WebAppContext,String>> getWebContextData()

getWebServer

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