NetworkListener (grizzly-http-server 2.3.16 API)

java.lang.Object
- org.glassfish.grizzly.http.server.NetworkListener

public class NetworkListener
extends Object

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_NETWORK_HOST` The default network host to which the `HttpServer` will bind to in order to service `HTTP` requests.
`static int`	`DEFAULT_NETWORK_PORT` The default network port to which the `HttpServer` will bind to in order to service `HTTP` requests.

Constructor Summary

Constructors
Constructor and Description
`NetworkListener(String name)` Constructs a new `NetworkListener` using the specified `name`.
`NetworkListener(String name, boolean isBindToInherited)` Constructs a new `NetworkListener` using the specified `name`, which, depending on `isBindToInherited` will or will not be bound to an inherited Channel.
`NetworkListener(String name, String host)` Constructs a new `NetworkListener` using the specified `name` and `host`.
`NetworkListener(String name, String host, int port)` Constructs a new `NetworkListener` using the specified `name`, `host`, and `port`.
`NetworkListener(String name, String host, PortRange portRange)` Constructs a new `NetworkListener` using the specified `name`, `host`, and `port`.

Method Summary

Methods
Modifier and Type	Method and Description
`Object`	`createManagementObject()`
`boolean`	`deregisterAddOn(AddOn addon)` Deregisters `AddOn` from this NetworkListener.
`AddOn[]`	`getAddOns()` Return the array of the registered `AddOn`s.
`protected ArraySet<AddOn>`	`getAddOnSet()` Returns the direct addons collection, registered on the NetworkListener.
`String`	`getCompressibleMimeTypes()` Deprecated. use `getCompressionConfig().getCompressableMimeTypes()`
`String`	`getCompression()` Deprecated. use `getCompressionConfig().getCompressionMode().name()`
`CompressionConfig`	`getCompressionConfig()` Returns `CompressionConfig` configuration.
`int`	`getCompressionMinSize()` Deprecated. use `getCompressionConfig().getCompressionMinSize()`
`ErrorPageGenerator`	`getDefaultErrorPageGenerator()` Returns the `NetworkListener` default `ErrorPageGenerator`.
`FileCache`	`getFileCache()`
`FilterChain`	`getFilterChain()`
`String`	`getHost()`
`HttpCodecFilter`	`getHttpCodecFilter()`
`HttpServerFilter`	`getHttpServerFilter()`
`KeepAlive`	`getKeepAlive()`
`int`	`getMaxBufferedPostSize()` Gets the maximum POST body size, which can buffered in memory.
`int`	`getMaxFormPostSize()` Gets the maximum size of the POST body generated by an HTML form.
`int`	`getMaxHttpHeaderSize()`
`int`	`getMaxPendingBytes()`
`int`	`getMaxRequestHeaders()` Returns the maximum number of headers allowed for a request.
`int`	`getMaxResponseHeaders()` Returns the maximum number of headers allowed for a response.
`String`	`getName()`
`String`	`getNoCompressionUserAgents()` Deprecated. use `getCompressionConfig().getNoCompressionUserAgents()`
`int`	`getPort()`
`PortRange`	`getPortRange()`
`String`	`getRestrictedUserAgents()`
`String`	`getScheme()` Get the HTTP request scheme, which if non-null overrides default one picked up by framework during runtime.
`SSLEngineConfigurator`	`getSslEngineConfig()`
`int`	`getTransactionTimeout()`
`TCPNIOTransport`	`getTransport()`
`int`	`getUploadTimeout()`
`String`	`getUriEncoding()`
`boolean`	`isAuthPassThroughEnabled()`
`boolean`	`isChunkingEnabled()`
`boolean`	`isDisableUploadTimeout()`
`boolean`	`isPaused()`
`boolean`	`isSecure()`
`boolean`	`isSendFileEnabled()`
`boolean`	`isStarted()`
`boolean`	`isTraceEnabled()`
`void`	`pause()` Pauses the listener.
`boolean`	`registerAddOn(AddOn addon)` Registers `AddOn` on this NetworkListener.
`void`	`resume()` Resumes a paused listener.
`void`	`setAuthPassThroughEnabled(boolean authPassthroughEnabled)`
`void`	`setChunkingEnabled(boolean chunkingEnabled)` Enable/disable chunking of an HTTP response body if no content length has been explictly specified.
`void`	`setCompressibleMimeTypes(String compressibleMimeTypes)` Deprecated. use `getCompressionConfig().setCompressableMimeTypes(Set<String>)`
`void`	`setCompression(String compression)` Deprecated. use `getCompressionConfig().setCompressionMode(mode)`
`void`	`setCompressionMinSize(int compressionMinSize)` Deprecated. use `getCompressionConfig().setCompressionMinSize(int)`
`void`	`setDefaultErrorPageGenerator(ErrorPageGenerator defaultErrorPageGenerator)` Sets the `NetworkListener` default `ErrorPageGenerator`.
`void`	`setDisableUploadTimeout(boolean disableUploadTimeout)`
`void`	`setMaxBufferedPostSize(int maxBufferedPostSize)` Sets the maximum POST body size, which can buffered in memory.
`void`	`setMaxFormPostSize(int maxFormPostSize)` Sets the maximum size of the POST body generated by an HTML form.
`void`	`setMaxHttpHeaderSize(int maxHttpHeaderSize)` Configures the maximum header size for an HTTP request.
`void`	`setMaxPendingBytes(int maxPendingBytes)` The maximum size, in bytes, of all data waiting to be written to the associated `Connection`.
`void`	`setMaxRequestHeaders(int maxRequestHeaders)` Sets the maximum number of headers allowed for a request.
`void`	`setMaxResponseHeaders(int maxResponseHeaders)` Sets the maximum number of headers allowed for a response.
`void`	`setNoCompressionUserAgents(String noCompressionUserAgents)` Deprecated. use `getCompressionConfig().setNoCompressionUserAgents(Set<String>)`
`void`	`setRestrictedUserAgents(String restrictedUserAgents)`
`void`	`setScheme(String scheme)` Set the HTTP request scheme, which if non-null overrides default one picked up by framework during runtime.
`void`	`setSecure(boolean secure)` Enable or disable security for this listener.
`void`	`setSendFileEnabled(boolean sendFileEnabled)`
`void`	`setSSLEngineConfig(SSLEngineConfigurator sslEngineConfig)` Provides customization of the `SSLEngine` used by this listener.
`void`	`setTraceEnabled(boolean traceEnabled)`
`void`	`setTransactionTimeout(int transactionTimeout)` Sets the time, in seconds, within which a request must complete its processing.
`void`	`setTransport(TCPNIOTransport transport)` This allows the developer to specify a custom `TCPNIOTransport` implementation to be used by this listener.
`void`	`setUploadTimeout(int uploadTimeout)`
`void`	`setUriEncoding(String uriEncoding)`
`GrizzlyFuture<NetworkListener>`	`shutdown()` Gracefully shuts down the listener.
`GrizzlyFuture<NetworkListener>`	`shutdown(long gracePeriod, TimeUnit timeUnit)`
`void`	`shutdownNow()` Immediately shuts down the listener.
`void`	`start()` Starts the listener.
`void`	`stop()` Deprecated. use `shutdownNow()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_NETWORK_HOST
```
public static final String DEFAULT_NETWORK_HOST
```
    The default network host to which the HttpServer will bind to in order to service HTTP requests.
    
    See Also:
    Constant Field Values
  - DEFAULT_NETWORK_PORT
```
public static final int DEFAULT_NETWORK_PORT
```
    The default network port to which the HttpServer will bind to in order to service HTTP requests.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - NetworkListener
```
public NetworkListener(String name)
```
    Constructs a new NetworkListener using the specified name. The listener's host and port will default to DEFAULT_NETWORK_HOST and DEFAULT_NETWORK_PORT.
    
    Parameters:
    name - the logical name of the listener.
  - NetworkListener
```
public NetworkListener(String name,
               boolean isBindToInherited)
```
    Constructs a new NetworkListener using the specified name, which, depending on isBindToInherited will or will not be bound to an inherited Channel.
    
    Parameters:
    name - the logical name of the listener.
    isBindToInherited - if true the NetworkListener will be bound to an inherited Channel, otherwise default DEFAULT_NETWORK_HOST and DEFAULT_NETWORK_PORT will be used.
    See Also:
    System.inheritedChannel()
  - NetworkListener
```
public NetworkListener(String name,
               String host)
```
    Constructs a new NetworkListener using the specified name and host. The listener's port will default to DEFAULT_NETWORK_PORT.
    
    Parameters:
    name - the logical name of the listener.
    host - the network host to which this listener will bind.
  - NetworkListener
```
public NetworkListener(String name,
               String host,
               int port)
```
    Constructs a new NetworkListener using the specified name, host, and port.
    
    Parameters:
    name - the logical name of the listener.
    host - the network host to which this listener will bind.
    port - the network port to which this listener will bind..
  - NetworkListener
```
public NetworkListener(String name,
               String host,
               PortRange portRange)
```
    Constructs a new NetworkListener using the specified name, host, and port.
    
    Parameters:
    name - the logical name of the listener.
    host - the network host to which this listener will bind.
    portRange - the network port range to which this listener will bind..
- Method Detail
  - getName
```
public String getName()
```
    Returns:
    the logical name of this listener.
  - getHost
```
public String getHost()
```
    Returns:
    the network host to which this listener is configured to bind to.
  - getPort
```
public int getPort()
```
    Returns:
    the network port to which this listener is configured to bind to. If the HttpServer has not been started yet - the returned value may be: -1, if PortRange will be used to bind the listener; 0, if the port will be assigned by OS; 0 < N < 65536, the port this listener will be bound to. If HttpServer has been started - the value returned is the port the this listener is bound to.
  - getPortRange
```
public PortRange getPortRange()
```
    Returns:
    the network port range to which this listener is configured to bind to.
  - getKeepAlive
```
public KeepAlive getKeepAlive()
```
    Returns:
    the configuration for the keep-alive HTTP connections.
  - getTransport
```
public TCPNIOTransport getTransport()
```
    Returns:
    the TCPNIOTransport used by this listener.
  - setTransport
```
public void setTransport(TCPNIOTransport transport)
```
    This allows the developer to specify a custom TCPNIOTransport implementation to be used by this listener.
    
    Attempts to change the transport implementation while the listener is running will be ignored.
    
    Parameters:
    transport - a custom TCPNIOTransport implementation.
  - getAddOns
```
public AddOn[] getAddOns()
```
    Return the array of the registered AddOns. Please note, possible array modifications wont affect the NetworkListener's addons list.
    
    Returns:
    the array of the registered AddOns.
  - getAddOnSet
```
protected ArraySet<AddOn> getAddOnSet()
```
    Returns the direct addons collection, registered on the NetworkListener.
    
    Returns:
    the direct addons collection, registered on the NetworkListener.
  - registerAddOn
```
public boolean registerAddOn(AddOn addon)
```
    Registers AddOn on this NetworkListener.
    
    Parameters:
    addon - the AddOn to be registered.
    
    Returns:
    true, if the AddOn wasn't registered before, otherwise the existing AddOn will be replaced and this method returns false.
  - deregisterAddOn
```
public boolean deregisterAddOn(AddOn addon)
```
    Deregisters AddOn from this NetworkListener.
    
    Parameters:
    addon - the AddOn to deregister.
    
    Returns:
    true, if the AddOn was successfully removed, or false the the AddOn wasn't registered on the NetworkListener.
  - isChunkingEnabled
```
public boolean isChunkingEnabled()
```
    Returns:
    true if the HTTP response bodies should be chunked if not content length has been explicitly specified.
  - setChunkingEnabled
```
public void setChunkingEnabled(boolean chunkingEnabled)
```
    Enable/disable chunking of an HTTP response body if no content length has been explictly specified. Chunking is enabled by default.
    
    Parameters:
    chunkingEnabled - true to enable chunking; false to disable.
  - isSecure
```
public boolean isSecure()
```
    Returns:
    true if this is a secure listener, otherwise false. Listeners are not secure by default.
  - setSecure
```
public void setSecure(boolean secure)
```
    Enable or disable security for this listener.
    
    Attempts to change this value while the listener is running will be ignored.
    
    Parameters:
    secure - if true this listener will be secure.
  - getScheme
```
public String getScheme()
```
    Get the HTTP request scheme, which if non-null overrides default one picked up by framework during runtime.
    
    Returns:
    the HTTP request scheme
    Since:
    
    2.2.4
  - setScheme
```
public void setScheme(String scheme)
```
    Set the HTTP request scheme, which if non-null overrides default one picked up by framework during runtime.
    
    Parameters:
    scheme - the HTTP request scheme
    Since:
    
    2.2.4
  - getMaxRequestHeaders
```
public int getMaxRequestHeaders()
```
    Returns the maximum number of headers allowed for a request.
    
    Since:
    
    2.2.11
  - setMaxRequestHeaders
```
public void setMaxRequestHeaders(int maxRequestHeaders)
```
    Sets the maximum number of headers allowed for a request. If the specified value is less than zero, then there may be an unlimited number of headers (memory permitting).
    
    Since:
    
    2.2.11
  - getMaxResponseHeaders
```
public int getMaxResponseHeaders()
```
    Returns the maximum number of headers allowed for a response.
    
    Since:
    
    2.2.11
  - setMaxResponseHeaders
```
public void setMaxResponseHeaders(int maxResponseHeaders)
```
    Sets the maximum number of headers allowed for a response. If the specified value is less than zero, then there may be an unlimited number of headers (memory permitting).
    
    Since:
    
    2.2.11
  - getSslEngineConfig
```
public SSLEngineConfigurator getSslEngineConfig()
```
    Returns:
    the SSLEngine configuration for this listener.
  - setSSLEngineConfig
```
public void setSSLEngineConfig(SSLEngineConfigurator sslEngineConfig)
```
    Provides customization of the SSLEngine used by this listener.
    
    Attempts to change this value while the listener is running will be ignored.
    
    Parameters:
    sslEngineConfig - custom SSL configuration.
  - getMaxHttpHeaderSize
```
public int getMaxHttpHeaderSize()
```
    Returns:
    the maximum header size for an HTTP request.
  - setMaxHttpHeaderSize
```
public void setMaxHttpHeaderSize(int maxHttpHeaderSize)
```
    Configures the maximum header size for an HTTP request.
    
    Attempts to change this value while the listener is running will be ignored.
    
    Parameters:
    maxHttpHeaderSize - the maximum header size for an HTTP request.
  - getFilterChain
```
public FilterChain getFilterChain()
```
    Returns:
    the FilterChain used to by the TCPNIOTransport associated with this listener.
  - getFileCache
```
public FileCache getFileCache()
```
    Returns:
    the FileCache associated with this listener.
  - getMaxPendingBytes
```
public int getMaxPendingBytes()
```
    Returns:
    the maximum size, in bytes, of all data waiting to be written to the associated Connection. If not explicitly set, the value will be -1 which effectively disables resource enforcement.
  - setMaxPendingBytes
```
public void setMaxPendingBytes(int maxPendingBytes)
```
    The maximum size, in bytes, of all data waiting to be written to the associated Connection. If the value is zero or less, then no resource enforcement will take place.
    
    Parameters:
    maxPendingBytes - the maximum size, in bytes, of all data waiting to be written to the associated Connection.
  - isPaused
```
public boolean isPaused()
```
    Returns:
    true if this listener has been paused, otherwise false
  - isStarted
```
public boolean isStarted()
```
    Returns:
    true if the listener has been started, otherwise false.
  - start
```
public void start()
           throws IOException
```
    Starts the listener.
    
    Throws:
    
    IOException - if an error occurs when attempting to start the listener.
  - shutdown
```
public GrizzlyFuture<NetworkListener> shutdown(long gracePeriod,
                                      TimeUnit timeUnit)
```
  - shutdown
```
public GrizzlyFuture<NetworkListener> shutdown()
```
    Gracefully shuts down the listener.
    Any exceptions thrown during the shutdown process will be propagated to the returned GrizzlyFuture.
  - shutdownNow
```
public void shutdownNow()
                 throws IOException
```
    Immediately shuts down the listener.
    
    Throws:
    
    IOException - if an error occurs when attempting to shut down the listener
  - stop
```
public void stop()
          throws IOException
```
    Deprecated. use shutdownNow()
    
    Immediately shuts down the listener.
    
    Throws:
    
    IOException - if an error occurs when attempting to shut down the listener
  - pause
```
public void pause()
```
    Pauses the listener.
    
    Throws:
    
    IOException - if an error occurs when attempting to pause the listener.
  - resume
```
public void resume()
```
    Resumes a paused listener.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
    
    Returns:
    a value containing the name, host, port, and secure status of this listener.
  - createManagementObject
```
public Object createManagementObject()
```
  - getHttpServerFilter
```
public HttpServerFilter getHttpServerFilter()
```
  - getHttpCodecFilter
```
public HttpCodecFilter getHttpCodecFilter()
```
  - isAuthPassThroughEnabled
```
public boolean isAuthPassThroughEnabled()
```
  - setAuthPassThroughEnabled
```
public void setAuthPassThroughEnabled(boolean authPassthroughEnabled)
```
  - getCompressionConfig
```
public CompressionConfig getCompressionConfig()
```
    Returns CompressionConfig configuration.
    
    Since:
    
    2.3.5
  - getCompression
```
public String getCompression()
```
    Deprecated. use getCompressionConfig().getCompressionMode().name()
  - setCompression
```
public void setCompression(String compression)
```
    Deprecated. use getCompressionConfig().setCompressionMode(mode)
  - getCompressionMinSize
```
public int getCompressionMinSize()
```
    Deprecated. use getCompressionConfig().getCompressionMinSize()
  - setCompressionMinSize
```
public void setCompressionMinSize(int compressionMinSize)
```
    Deprecated. use getCompressionConfig().setCompressionMinSize(int)
  - getCompressibleMimeTypes
```
public String getCompressibleMimeTypes()
```
    Deprecated. use getCompressionConfig().getCompressableMimeTypes()
  - setCompressibleMimeTypes
```
public void setCompressibleMimeTypes(String compressibleMimeTypes)
```
    Deprecated. use getCompressionConfig().setCompressableMimeTypes(Set<String>)
  - getNoCompressionUserAgents
```
public String getNoCompressionUserAgents()
```
    Deprecated. use getCompressionConfig().getNoCompressionUserAgents()
  - setNoCompressionUserAgents
```
public void setNoCompressionUserAgents(String noCompressionUserAgents)
```
    Deprecated. use getCompressionConfig().setNoCompressionUserAgents(Set<String>)
  - isDisableUploadTimeout
```
public boolean isDisableUploadTimeout()
```
  - setDisableUploadTimeout
```
public void setDisableUploadTimeout(boolean disableUploadTimeout)
```
  - getMaxFormPostSize
```
public int getMaxFormPostSize()
```
    Gets the maximum size of the POST body generated by an HTML form. -1 value means no size limits applied.
    
    Since:
    
    2.3
  - setMaxFormPostSize
```
public void setMaxFormPostSize(int maxFormPostSize)
```
    Sets the maximum size of the POST body generated by an HTML form. -1 value means no size limits applied.
    
    Since:
    
    2.3
  - getMaxBufferedPostSize
```
public int getMaxBufferedPostSize()
```
    Gets the maximum POST body size, which can buffered in memory. -1 value means no size limits applied.
    
    Since:
    
    2.3
  - setMaxBufferedPostSize
```
public void setMaxBufferedPostSize(int maxBufferedPostSize)
```
    Sets the maximum POST body size, which can buffered in memory. -1 value means no size limits applied.
    
    Since:
    
    2.3
  - getRestrictedUserAgents
```
public String getRestrictedUserAgents()
```
  - setRestrictedUserAgents
```
public void setRestrictedUserAgents(String restrictedUserAgents)
```
  - isTraceEnabled
```
public boolean isTraceEnabled()
```
  - setTraceEnabled
```
public void setTraceEnabled(boolean traceEnabled)
```
  - getUploadTimeout
```
public int getUploadTimeout()
```
  - setUploadTimeout
```
public void setUploadTimeout(int uploadTimeout)
```
  - getUriEncoding
```
public String getUriEncoding()
```
  - setUriEncoding
```
public void setUriEncoding(String uriEncoding)
```
  - getTransactionTimeout
```
public int getTransactionTimeout()
```
    Returns:
    The timeout, in seconds, within which a request must complete its processing. If not explicitly set, no transaction timeout will be enforced.
  - setTransactionTimeout
```
public void setTransactionTimeout(int transactionTimeout)
```
    Sets the time, in seconds, within which a request must complete its processing. A value less than or equal to zero will disable this timeout. Note that this configuration option is only considered when the transport's Transport.getWorkerThreadPool() thread pool is used to run a HttpHandler.
    
    Parameters:
    transactionTimeout - timeout in seconds
  - isSendFileEnabled
```
public boolean isSendFileEnabled()
```
    Since:
    
    2.2
    
    See Also:
    ServerFilterConfiguration.isSendFileEnabled()
  - setSendFileEnabled
```
public void setSendFileEnabled(boolean sendFileEnabled)
```
    Since:
    
    2.2
    
    See Also:
    ServerFilterConfiguration.setSendFileEnabled(boolean)
  - getDefaultErrorPageGenerator
```
public ErrorPageGenerator getDefaultErrorPageGenerator()
```
    Returns the NetworkListener default ErrorPageGenerator.
  - setDefaultErrorPageGenerator
```
public void setDefaultErrorPageGenerator(ErrorPageGenerator defaultErrorPageGenerator)
```
    Sets the NetworkListener default ErrorPageGenerator.
    
    Parameters:
    defaultErrorPageGenerator -

Class NetworkListener

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_NETWORK_HOST

DEFAULT_NETWORK_PORT

Constructor Detail

NetworkListener

NetworkListener

NetworkListener

NetworkListener

NetworkListener

Method Detail

getName

getHost

getPort

getPortRange

getKeepAlive

getTransport

setTransport

getAddOns

getAddOnSet

registerAddOn

deregisterAddOn

isChunkingEnabled

setChunkingEnabled

isSecure

setSecure

getScheme

setScheme

getMaxRequestHeaders

setMaxRequestHeaders

getMaxResponseHeaders

setMaxResponseHeaders

getSslEngineConfig

setSSLEngineConfig

getMaxHttpHeaderSize

setMaxHttpHeaderSize

getFilterChain

getFileCache

getMaxPendingBytes

setMaxPendingBytes

isPaused

isStarted

start

shutdown

shutdown

shutdownNow

stop

pause

resume

toString

createManagementObject

getHttpServerFilter

getHttpCodecFilter

isAuthPassThroughEnabled

setAuthPassThroughEnabled

getCompressionConfig

getCompression

setCompression

getCompressionMinSize

setCompressionMinSize

getCompressibleMimeTypes

setCompressibleMimeTypes

getNoCompressionUserAgents

setNoCompressionUserAgents

isDisableUploadTimeout

setDisableUploadTimeout

getMaxFormPostSize

setMaxFormPostSize

getMaxBufferedPostSize

setMaxBufferedPostSize

getRestrictedUserAgents

setRestrictedUserAgents

isTraceEnabled

setTraceEnabled

getUploadTimeout

setUploadTimeout