org.glassfish.grizzly.http.server
Class ServerConfiguration

java.lang.Object
  org.glassfish.grizzly.http.server.ServerConfiguration

public class ServerConfiguration
extends Object

Configuration options for a particular HttpServer instance.

Method Summary

void	addHttpService(HttpService httpService, String... mapping) Adds the specified HttpService with its associated mapping(s).
void	addJmxEventListener(JmxEventListener listener) Add a JmxEventListener which will be notified when the HttpServer is started and JMX was enabled prior to starting or if the HttpServer was started with JMX disabled, but JMX was enabled at a later point in time.
protected HttpService	buildService()
String	getDocRoot()
String	getHttpServerName()
String	getHttpServerVersion()
Iterator<JmxEventListener>	getJmxEventListeners()
HttpServerMonitoringConfig	getMonitoringConfig() Get the web server monitoring config.
String	getName()
boolean	isJmxEnabled()
boolean	removeHttpService(HttpService httpService) Removes the specified HttpService.
void	removeJmxEventListener(JmxEventListener listener) Removes the specified JmxEventListener.
void	setDocRoot(String docRoot)
void	setHttpServerName(String httpServerName) Sets the server name used for HTTP response headers and default generated error pages.
void	setHttpServerVersion(String httpServerVersion) Sets the version of the server info sent in HTTP response headers and the default generated error pages.
void	setJmxEnabled(boolean jmxEnabled) Enables JMX for this HttpServer.
void	setName(String name) Sets the logical name of this HttpServer instance.

Methods inherited from class java.lang.Object

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

Method Detail

getDocRoot

public String getDocRoot()

setDocRoot

public void setDocRoot(String docRoot)

addHttpService

public void addHttpService(HttpService httpService,
                           String... mapping)

Adds the specified HttpService with its associated mapping(s). Requests will be dispatched to a HttpService based on these mapping values.

Parameters:

httpService - a HttpService

mapping - context path mapping information.

removeHttpService

public boolean removeHttpService(HttpService httpService)

Removes the specified HttpService.

Returns:

true, if the operation was successful, otherwise false

buildService

protected HttpService buildService()

Returns:

the HttpService to be used by this server instance. This may be a single HttpService or a composite of multiple HttpService instances wrapped by a HttpServiceChain.

getMonitoringConfig

public HttpServerMonitoringConfig getMonitoringConfig()

Get the web server monitoring config.

Returns:

the web server monitoring config.

getName

public String getName()

Returns:

the logical name of this HttpServer instance. If no name is explicitly specified, the default value will be HttpServer. If there is more than once HttpServer per virtual machine, the server name will be HttpServer-[(instance count - 1)].

setName

public void setName(String name)

Sets the logical name of this HttpServer instance. The logical name cannot be changed after the server has been started.

Parameters:

name - server name

isJmxEnabled

public boolean isJmxEnabled()

Returns:

true if JMX has been enabled for this HttpServer. If true the HttpServer management object will be registered at the root of the JMX tree with the name of [instance-name] where instance name is the value returned by getName().

setJmxEnabled

public void setJmxEnabled(boolean jmxEnabled)

Enables JMX for this HttpServer. This value can be changed at runtime.

Parameters:

jmxEnabled - true to enable JMX otherwise false

addJmxEventListener

public void addJmxEventListener(JmxEventListener listener)

Add a JmxEventListener which will be notified when the HttpServer is started and JMX was enabled prior to starting or if the HttpServer was started with JMX disabled, but JMX was enabled at a later point in time.

Parameters:

listener - the JmxEventListener to add.

removeJmxEventListener

public void removeJmxEventListener(JmxEventListener listener)

Removes the specified JmxEventListener.

Parameters:

listener - the JmxEventListener to remove.

getJmxEventListeners

public Iterator<JmxEventListener> getJmxEventListeners()

Returns:

an Iterator of all registered JmxEventListeners.

getHttpServerName

public String getHttpServerName()

Returns:

the server name used for headers and default error pages.

setHttpServerName

public void setHttpServerName(String httpServerName)

Sets the server name used for HTTP response headers and default generated error pages. If not value is explicitly set, this value defaults to Grizzly.

Parameters:

httpServerName - server name

getHttpServerVersion

public String getHttpServerVersion()

Returns:

the version of this server used for headers and default error pages.

setHttpServerVersion

public void setHttpServerVersion(String httpServerVersion)

Sets the version of the server info sent in HTTP response headers and the default generated error pages. If not value is explicitly set, this value defaults to the current version of the Grizzly runtime.

Parameters:

httpServerVersion - server version