org.glassfish.grizzly.http.server

Class ServerConfiguration

java.lang.Object

org.glassfish.grizzly.http.server.ServerFilterConfiguration

org.glassfish.grizzly.http.server.ServerConfiguration

public class ServerConfiguration
extends ServerFilterConfiguration

Configuration options for a particular HttpServer instance.

Field Summary

Fields inherited from class org.glassfish.grizzly.http.server.ServerFilterConfiguration

MAX_REQUEST_PARAMETERS, USE_SEND_FILE

Method Summary

Methods

Modifier and Type	Method and Description
void	addHttpHandler(HttpHandler httpHandler) Adds the specified HttpHandler as a root handler.
void	addHttpHandler(HttpHandler httpHandler, HttpHandlerRegistration... mapping) Adds the specified HttpHandler with its associated mapping(s).
void	addHttpHandler(HttpHandler httpHandler, String... mappings) Adds the specified HttpHandler 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.
Map<HttpHandler,String[]>	getHttpHandlers() Deprecated. please use #getHttpHandlersMap()
Map<HttpHandler,HttpHandlerRegistration[]>	getHttpHandlersWithMapping() Returns the HttpHandler map.
Set<JmxEventListener>	getJmxEventListeners()
long	getMaxPayloadRemainderToSkip()
HttpServerMonitoringConfig	getMonitoringConfig() Get the web server monitoring config.
String	getName()
boolean	isAllowPayloadForUndefinedHttpMethods() The flag, which enables/disables payload support for HTTP methods, for which HTTP spec doesn't clearly state whether they support payload.
boolean	isJmxEnabled()
boolean	removeHttpHandler(HttpHandler httpHandler) Removes the specified HttpHandler.
void	removeJmxEventListener(JmxEventListener listener) Removes the specified JmxEventListener.
void	setAllowPayloadForUndefinedHttpMethods(boolean allowPayloadForUndefinedHttpMethods) The flag, which enables/disables payload support for HTTP methods, for which HTTP spec doesn't clearly state whether they support payload.
void	setJmxEnabled(boolean jmxEnabled) Enables JMX for this HttpServer.
void	setMaxPayloadRemainderToSkip(long maxPayloadRemainderToSkip) Set the maximum request payload remainder (in bytes) HttpServerFilter will try to swallow after HTTP request processing is over in order to keep the connection alive.
void	setName(String name) Sets the logical name of this HttpServer instance.

Methods inherited from class org.glassfish.grizzly.http.server.ServerFilterConfiguration

getBackendConfiguration, getDefaultErrorPageGenerator, getDefaultQueryEncoding, getHttpServerName, getHttpServerVersion, getMaxBufferedPostSize, getMaxFormPostSize, getMaxPostSize, getMaxRequestParameters, getScheme, getSessionManager, getSessionTimeoutSeconds, isGracefulShutdownSupported, isPassTraceRequest, isReuseSessionID, isSendFileEnabled, isTraceEnabled, setBackendConfiguration, setDefaultErrorPageGenerator, setDefaultQueryEncoding, setGracefulShutdownSupported, setHttpServerName, setHttpServerVersion, setMaxBufferedPostSize, setMaxFormPostSize, setMaxPostSize, setMaxRequestParameters, setPassTraceRequest, setReuseSessionID, setScheme, setSendFileEnabled, setSessionManager, setSessionTimeoutSeconds, setTraceEnabled

Methods inherited from class java.lang.Object

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

Method Detail

addHttpHandler

public void addHttpHandler(HttpHandler httpHandler)

Adds the specified HttpHandler as a root handler.

Parameters:

httpHandler - a HttpHandler

addHttpHandler

public void addHttpHandler(HttpHandler httpHandler,
                  String... mappings)

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

Parameters:

httpHandler - a HttpHandler

mappings - context path mapping information.

addHttpHandler

public void addHttpHandler(HttpHandler httpHandler,
                  HttpHandlerRegistration... mapping)

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

Parameters:

httpHandler - a HttpHandler

mapping - context path mapping information.

removeHttpHandler

public boolean removeHttpHandler(HttpHandler httpHandler)

Removes the specified HttpHandler.

Returns:

true, if the operation was successful, otherwise false

getHttpHandlers

public Map<HttpHandler,String[]> getHttpHandlers()

Deprecated. please use #getHttpHandlersMap()

Returns the HttpHandler map. Please note, the returned map is read-only.

Returns:

the HttpHandler map.

getHttpHandlersWithMapping

public Map<HttpHandler,HttpHandlerRegistration[]> getHttpHandlersWithMapping()

Returns the HttpHandler map. Please note, the returned map is read-only.

Returns:

the HttpHandler map.

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 Set<JmxEventListener> getJmxEventListeners()

Returns:

an Iterator of all registered JmxEventListeners.

isAllowPayloadForUndefinedHttpMethods

public boolean isAllowPayloadForUndefinedHttpMethods()

The flag, which enables/disables payload support for HTTP methods, for which HTTP spec doesn't clearly state whether they support payload. Known "undefined" methods are: GET, HEAD, DELETE.

Returns:

true if "undefined" methods support payload, or false otherwise

Since:

2.3.12

setAllowPayloadForUndefinedHttpMethods

public void setAllowPayloadForUndefinedHttpMethods(boolean allowPayloadForUndefinedHttpMethods)

The flag, which enables/disables payload support for HTTP methods, for which HTTP spec doesn't clearly state whether they support payload. Known "undefined" methods are: GET, HEAD, DELETE.

Parameters:

allowPayloadForUndefinedHttpMethods - true if "undefined" methods support payload, or false otherwise

Since:

2.3.12

getMaxPayloadRemainderToSkip

public long getMaxPayloadRemainderToSkip()

Returns:

the maximum request payload remainder (in bytes) HttpServerFilter will try to swallow after HTTP request processing is over in order to keep the connection alive. If the remainder is too large - the connection will be closed. -1 means no limits will be applied.

Since:

2.3.13

setMaxPayloadRemainderToSkip

public void setMaxPayloadRemainderToSkip(long maxPayloadRemainderToSkip)

Set the maximum request payload remainder (in bytes) HttpServerFilter will try to swallow after HTTP request processing is over in order to keep the connection alive. If the remainder is too large - the connection will be closed. -1 means no limits will be applied.

Parameters:

maxPayloadRemainderToSkip -

Since:

2.3.13