Grizzly NIO 5.0.2 · org.glassfish.grizzly.http.server.HttpServer

Modifier and Type	Field and Description
private volatile ExecutorService	auxExecutorService
pack-priv volatile DelayedExecutor	delayedExecutor
private final HttpHandlerChain	httpHandlerChain HttpHandler, which processes HTTP requests
protected volatile GrizzlyJmxManager	jmxManager
private final Map<String, NetworkListener>	listeners Mapping of `NetworkListener`s, by name, used by this server instance.
private static final Logger	LOGGER
protected volatile Object	managementObject
private final ServerConfiguration	serverConfig Configuration details for this server instance.
private FutureImpl<HttpServer>	shutdownFuture Future to control graceful shutdown status
private State	state Flag indicating whether or not this server instance has been started.

Access	Constructor and Description
public	HttpServer()

Method Summary

Modifier and Type	Method and Description
public synchronized void	addListener(final NetworkListener the `NetworkListener` to associate with this server instance. listener) Adds the specified `listener` to the server instance.
private void	configureAuxThreadPool()
protected Set<ContentEncoding>	configureCompressionEncodings(final NetworkListener listener)
private void	configureListener(final NetworkListener listener)
private void	configureMonitoring(final NetworkListener listener)
public static HttpServer	createSimpleServer() Returns: a `HttpServer` configured to listen to requests on `NetworkListener#DEFAULT_NETWORK_HOST`:`NetworkListener#DEFAULT_NETWORK_PORT`, using the directory in which the server was launched the server's document root
public static HttpServer	createSimpleServer(final String the document root, can be `null` when no static pages are needed docRoot) Returns: a `HttpServer` configured to listen to requests on `NetworkListener#DEFAULT_NETWORK_HOST`:`NetworkListener#DEFAULT_NETWORK_PORT`, using the specified `docRoot` as the server's document root
public static HttpServer	createSimpleServer(final String the document root, can be `null` when no static pages are needed docRoot, final int the network port to which this listener will bind port) Returns: a `HttpServer` configured to listen to requests on `NetworkListener#DEFAULT_NETWORK_HOST`:`port`, using the specified `docRoot` as the server's document root
public static HttpServer	createSimpleServer(final String the document root, can be `null` when no static pages are needed docRoot, final PortRange port range to attempt to bind to range) Returns: a `HttpServer` configured to listen to requests on `NetworkListener#DEFAULT_NETWORK_HOST`:`[port-range]`, using the specified `docRoot` as the server's document root
public static HttpServer	createSimpleServer(final String the document root, can be `null` when no static pages are needed docRoot, final SocketAddress the endpoint address to which this listener will bind socketAddress) Returns: a `HttpServer` configured to listen to requests on `socketAddress`, using the specified `docRoot` as the server's document root
public static HttpServer	createSimpleServer(final String the document root, can be `null` when no static pages are needed docRoot, final String the network port to which this listener will bind host, final int the network port to which this listener will bind port) Returns: a `HttpServer` configured to listen to requests on `host`:`port`, using the specified `docRoot` as the server's document root
public static HttpServer	createSimpleServer(final String the document root, can be `null` when no static pages are needed docRoot, final String the network port to which this listener will bind host, final PortRange port range to attempt to bind to range) Returns: a `HttpServer` configured to listen to requests on `host`:`[port-range]`, using the specified `docRoot` as the server's document root
protected void	disableJMX()
protected void	enableJMX()
public HttpHandler	getHttpHandler() Returns: the `HttpHandler` used by this `HttpServer` instance.
public synchronized NetworkListener	getListener(final String the `NetworkListener` name. name) Returns: the `NetworkListener`, if any, associated with the specified `name`.
public synchronized Collection<NetworkListener>	getListeners() Returns: a `read only` `Collection` over the listeners associated with this `HttpServer` instance.
public Object	getManagementObject(boolean clear)
public final ServerConfiguration	getServerConfiguration() Returns: the `ServerConfiguration` used to configure this `HttpServer` instance
public boolean	isStarted() Returns: `true` if this `HttpServer` has been started.
pack-priv synchronized void	onAddHttpHandler(HttpHandler httpHandler, final HttpHandlerRegistration[] registrations) Modifies handlers mapping during runtime.
pack-priv synchronized void	onRemoveHttpHandler(HttpHandler httpHandler) Modifies handlers mapping during runtime.
public synchronized NetworkListener	Returns: `NetworkListener`, that has been removed, or `null` if the listener with the given name doesn't exist removeListener(final String the name of the `NetworkListener` to remove. name) Removes the `NetworkListener` associated with the specified `name`.
private void	setupHttpHandler()
public synchronized GrizzlyFuture<HttpServer>	shutdown(final long gracePeriod, final TimeUnit timeUnit)
public synchronized GrizzlyFuture<HttpServer>	shutdown() Gracefully shuts down the `HttpServer` instance.
public synchronized void	shutdownNow() Immediately shuts down the `HttpServer` instance.
public synchronized void	start() Starts the `HttpServer`.
public void	stop() Deprecated use `shutdownNow()` Immediately shuts down the `HttpServer` instance.
private void	stopAuxThreadPool()
private void	tearDownHttpHandler()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

auxExecutorService	back to summary
private volatile ExecutorService auxExecutorService

delayedExecutor	back to summary
pack-priv volatile DelayedExecutor delayedExecutor

httpHandlerChain	back to summary
private final HttpHandlerChain httpHandlerChain HttpHandler, which processes HTTP requests

jmxManager	back to summary
protected volatile GrizzlyJmxManager jmxManager

listeners	back to summary
private final Map<String, NetworkListener> listeners Mapping of `NetworkListener`s, by name, used by this server instance.

LOGGER	back to summary
private static final Logger LOGGER

managementObject	back to summary
protected volatile Object managementObject

serverConfig	back to summary
private final ServerConfiguration serverConfig Configuration details for this server instance.

shutdownFuture	back to summary
private FutureImpl<HttpServer> shutdownFuture Future to control graceful shutdown status

state	back to summary
private State state Flag indicating whether or not this server instance has been started.

HttpServer	back to summary
public HttpServer()

Method Detail

addListener back to summary

addListener	back to summary
public synchronized void addListener(final NetworkListener listener) Adds the specified `listener` to the server instance. If the server is already running when this method is called, the listener will be started. Parameters listener:NetworkListener the `NetworkListener` to associate with this server instance.

public synchronized void addListener(final NetworkListener listener)

Adds the specified listener to the server instance.

If the server is already running when this method is called, the listener will be started.

Parameters

listener:NetworkListener: the NetworkListener to associate with this server instance.

configureAuxThreadPool	back to summary
private void configureAuxThreadPool()

configureCompressionEncodings	back to summary
protected Set<ContentEncoding> configureCompressionEncodings(final NetworkListener listener)

configureListener	back to summary
private void configureListener(final NetworkListener listener)

configureMonitoring	back to summary
private void configureMonitoring(final NetworkListener listener) Annotations @SuppressWarnings:unchecked

createSimpleServer	back to summary
public static HttpServer createSimpleServer() Returns:HttpServer a `HttpServer` configured to listen to requests on `NetworkListener#DEFAULT_NETWORK_HOST`:`NetworkListener#DEFAULT_NETWORK_PORT`, using the directory in which the server was launched the server's document root

createSimpleServer	back to summary
public static HttpServer createSimpleServer(final String docRoot) Parameters docRoot:String the document root, can be `null` when no static pages are needed Returns:HttpServer a `HttpServer` configured to listen to requests on `NetworkListener#DEFAULT_NETWORK_HOST`:`NetworkListener#DEFAULT_NETWORK_PORT`, using the specified `docRoot` as the server's document root

createSimpleServer back to summary

createSimpleServer	back to summary
public static HttpServer createSimpleServer(final String docRoot, final int port) Parameters docRoot:String the document root, can be `null` when no static pages are needed port:int the network port to which this listener will bind Returns:HttpServer a `HttpServer` configured to listen to requests on `NetworkListener#DEFAULT_NETWORK_HOST`:`port`, using the specified `docRoot` as the server's document root

public static HttpServer createSimpleServer(final String docRoot, final int port)

Parameters

docRoot:String: the document root, can be null when no static pages are needed
port:int: the network port to which this listener will bind

Returns:HttpServer

a HttpServer configured to listen to requests on NetworkListener#DEFAULT_NETWORK_HOST:port, using the specified docRoot as the server's document root

createSimpleServer back to summary

createSimpleServer	back to summary
public static HttpServer createSimpleServer(final String docRoot, final PortRange range) Parameters docRoot:String the document root, can be `null` when no static pages are needed range:PortRange port range to attempt to bind to Returns:HttpServer a `HttpServer` configured to listen to requests on `NetworkListener#DEFAULT_NETWORK_HOST`:`[port-range]`, using the specified `docRoot` as the server's document root

public static HttpServer createSimpleServer(final String docRoot, final PortRange range)

Parameters

docRoot:String: the document root, can be null when no static pages are needed
range:PortRange: port range to attempt to bind to

Returns:HttpServer

a HttpServer configured to listen to requests on NetworkListener#DEFAULT_NETWORK_HOST:[port-range], using the specified docRoot as the server's document root

createSimpleServer back to summary

createSimpleServer	back to summary
public static HttpServer createSimpleServer(final String docRoot, final SocketAddress socketAddress) Parameters docRoot:String the document root, can be `null` when no static pages are needed socketAddress:SocketAddress the endpoint address to which this listener will bind Returns:HttpServer a `HttpServer` configured to listen to requests on `socketAddress`, using the specified `docRoot` as the server's document root

public static HttpServer createSimpleServer(final String docRoot, final SocketAddress socketAddress)

Parameters

docRoot:String: the document root, can be null when no static pages are needed
socketAddress:SocketAddress: the endpoint address to which this listener will bind

Returns:HttpServer

a HttpServer configured to listen to requests on socketAddress, using the specified docRoot as the server's document root

createSimpleServer back to summary

createSimpleServer	back to summary
public static HttpServer createSimpleServer(final String docRoot, final String host, final int port) Parameters docRoot:String the document root, can be `null` when no static pages are needed host:String the network port to which this listener will bind port:int the network port to which this listener will bind Returns:HttpServer a `HttpServer` configured to listen to requests on `host`:`port`, using the specified `docRoot` as the server's document root

public static HttpServer createSimpleServer(final String docRoot, final String host, final int port)

Parameters

docRoot:String: the document root, can be null when no static pages are needed
host:String: the network port to which this listener will bind
port:int: the network port to which this listener will bind

Returns:HttpServer

a HttpServer configured to listen to requests on host:port, using the specified docRoot as the server's document root

createSimpleServer back to summary

createSimpleServer	back to summary
public static HttpServer createSimpleServer(final String docRoot, final String host, final PortRange range) Parameters docRoot:String the document root, can be `null` when no static pages are needed host:String the network port to which this listener will bind range:PortRange port range to attempt to bind to Returns:HttpServer a `HttpServer` configured to listen to requests on `host`:`[port-range]`, using the specified `docRoot` as the server's document root

public static HttpServer createSimpleServer(final String docRoot, final String host, final PortRange range)

Parameters

docRoot:String: the document root, can be null when no static pages are needed
host:String: the network port to which this listener will bind
range:PortRange: port range to attempt to bind to

Returns:HttpServer

a HttpServer configured to listen to requests on host:[port-range], using the specified docRoot as the server's document root

disableJMX	back to summary
protected void disableJMX()

enableJMX	back to summary
protected void enableJMX()

getHttpHandler	back to summary
public HttpHandler getHttpHandler() Returns:HttpHandler the `HttpHandler` used by this `HttpServer` instance.

getListener	back to summary
public synchronized NetworkListener getListener(final String name) Parameters name:String the `NetworkListener` name. Returns:NetworkListener the `NetworkListener`, if any, associated with the specified `name`.

getListeners	back to summary
public synchronized Collection<NetworkListener> getListeners() Returns:Collection<NetworkListener> a `read only` `Collection` over the listeners associated with this `HttpServer` instance.

getManagementObject	back to summary
public Object getManagementObject(boolean clear)

getServerConfiguration	back to summary
public final ServerConfiguration getServerConfiguration() Returns:ServerConfiguration the `ServerConfiguration` used to configure this `HttpServer` instance

isStarted	back to summary
public boolean isStarted() Returns:boolean `true` if this `HttpServer` has been started.

onAddHttpHandler	back to summary
pack-priv synchronized void onAddHttpHandler(HttpHandler httpHandler, final HttpHandlerRegistration[] registrations) Modifies handlers mapping during runtime.

onRemoveHttpHandler	back to summary
pack-priv synchronized void onRemoveHttpHandler(HttpHandler httpHandler) Modifies handlers mapping during runtime.

removeListener back to summary

removeListener	back to summary
public synchronized NetworkListener removeListener(final String name) Removes the `NetworkListener` associated with the specified `name`. If the server is running when this method is invoked, the listener will be stopped before being returned. Parameters name:String the name of the `NetworkListener` to remove. Returns:NetworkListener `NetworkListener`, that has been removed, or `null` if the listener with the given name doesn't exist Annotations @SuppressWarnings:UnusedReturnValue

public synchronized NetworkListener removeListener(final String name)

Removes the NetworkListener associated with the specified name.

If the server is running when this method is invoked, the listener will be stopped before being returned.

Parameters

name:String: the name of the NetworkListener to remove.

Returns:NetworkListener

NetworkListener, that has been removed, or null if the listener with the given name doesn't exist

Annotations

@SuppressWarnings:UnusedReturnValue

setupHttpHandler	back to summary
private void setupHttpHandler()

shutdown	back to summary
public synchronized GrizzlyFuture<HttpServer> shutdown(final long gracePeriod, final TimeUnit timeUnit)

shutdown	back to summary
public synchronized GrizzlyFuture<HttpServer> shutdown() Gracefully shuts down the `HttpServer` instance.

shutdownNow	back to summary
public synchronized void shutdownNow() Immediately shuts down the `HttpServer` instance.

start back to summary

start	back to summary
public synchronized void start() throws IOException Starts the `HttpServer`. Exceptions IOException: if an error occurs while attempting to start the server.

public synchronized void start() throws IOException

Starts the HttpServer.

Exceptions

IOException:: if an error occurs while attempting to start the server.

stop back to summary

stop	back to summary
public void stop() Deprecated use `shutdownNow()` Immediately shuts down the `HttpServer` instance. Annotations @Deprecated

public void stop()

Deprecated

use shutdownNow()

Immediately shuts down the HttpServer instance.

Annotations

@Deprecated

stopAuxThreadPool	back to summary
private void stopAuxThreadPool()

tearDownHttpHandler	back to summary
private void tearDownHttpHandler()

public Class HttpServer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail