HttpsListener (config-api 0.3.13 API)

java.lang.Object
- org.wildfly.swarm.config.undertow.server.HttpsListener<T>

@Address(value="/subsystem=undertow/server=*/https-listener=*")
public class HttpsListener<T extends HttpsListener<T>>
extends Object

http listener

Constructor Summary

Constructors
Constructor and Description

HttpsListener(String key)

Constructors
Constructor and Description
`HttpsListener(String key)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPropertyChangeListener(PropertyChangeListener listener)` Adds a property change listener
`Boolean`	`allowEncodedSlash()` If a request comes in with encoded / characters (i.e.
`T`	`allowEncodedSlash(Boolean value)` If a request comes in with encoded / characters (i.e.
`Boolean`	`allowEqualsInCookieValue()` If this is true then Undertow will allow non-escaped equals characters in unquoted cookie values.
`T`	`allowEqualsInCookieValue(Boolean value)` If this is true then Undertow will allow non-escaped equals characters in unquoted cookie values.
`Boolean`	`alwaysSetKeepAlive()` If this is true then a Connection: keep-alive header will be added to responses, even when it is not strictly required by the specification.
`T`	`alwaysSetKeepAlive(Boolean value)` If this is true then a Connection: keep-alive header will be added to responses, even when it is not strictly required by the specification.
`Boolean`	`bufferPipelinedData()` If we should buffer pipelined requests.
`T`	`bufferPipelinedData(Boolean value)` If we should buffer pipelined requests.
`String`	`bufferPool()` The AJP listeners buffer pool
`T`	`bufferPool(String value)` The AJP listeners buffer pool
`Long`	`bytesReceived()` The number of bytes that have been received by this listener
`T`	`bytesReceived(Long value)` The number of bytes that have been received by this listener
`Long`	`bytesSent()` The number of bytes that have been sent out on this listener
`T`	`bytesSent(Long value)` The number of bytes that have been sent out on this listener
`Boolean`	`decodeUrl()` If this is true then the parser will decode the URL and query parameters using the selected character encoding (UTF-8 by default).
`T`	`decodeUrl(Boolean value)` If this is true then the parser will decode the URL and query parameters using the selected character encoding (UTF-8 by default).
`T`	`disallowedMethod(String value)` A comma separated list of HTTP methods that are not allowed
`List<String>`	`disallowedMethods()` A comma separated list of HTTP methods that are not allowed
`T`	`disallowedMethods(List<String> value)` A comma separated list of HTTP methods that are not allowed
`T`	`disallowedMethods(String... args)` A comma separated list of HTTP methods that are not allowed
`Boolean`	`enabled()` If the listener is enabled
`T`	`enabled(Boolean value)` If the listener is enabled
`String`	`enabledCipherSuites()` Configures Enabled SSL cyphers
`T`	`enabledCipherSuites(String value)` Configures Enabled SSL cyphers
`String`	`enabledProtocols()` Configures SSL protocols
`T`	`enabledProtocols(String value)` Configures SSL protocols
`Boolean`	`enableHttp2()` Enables HTTP2 support for this listener
`T`	`enableHttp2(Boolean value)` Enables HTTP2 support for this listener
`Boolean`	`enableSpdy()` Enables SPDY support for this listener
`T`	`enableSpdy(Boolean value)` Enables SPDY support for this listener
`Long`	`errorCount()` The number of 500 responses that have been sent by this listener
`T`	`errorCount(Long value)` The number of 500 responses that have been sent by this listener
`String`	`getKey()`
`Integer`	`maxBufferedRequestSize()` Maximum size of a buffered request, in bytesRequests are not usually buffered, the most common case is when performing SSL renegotiation for a POST request, and the post data must be fullybuffered in order to perform the renegotiation.
`T`	`maxBufferedRequestSize(Integer value)` Maximum size of a buffered request, in bytesRequests are not usually buffered, the most common case is when performing SSL renegotiation for a POST request, and the post data must be fullybuffered in order to perform the renegotiation.
`Integer`	`maxConnections()` The maximum number of concurrent connections.
`T`	`maxConnections(Integer value)` The maximum number of concurrent connections.
`Integer`	`maxCookies()` The maximum number of cookies that will be parsed.
`T`	`maxCookies(Integer value)` The maximum number of cookies that will be parsed.
`Integer`	`maxHeaders()` The maximum number of headers that will be parsed.
`T`	`maxHeaders(Integer value)` The maximum number of headers that will be parsed.
`Integer`	`maxHeaderSize()` The maximum size in bytes of a http request header.
`T`	`maxHeaderSize(Integer value)` The maximum size in bytes of a http request header.
`Integer`	`maxParameters()` The maximum number of parameters that will be parsed.
`T`	`maxParameters(Integer value)` The maximum number of parameters that will be parsed.
`Long`	`maxPostSize()` The maximum size of a post that will be accepted
`T`	`maxPostSize(Long value)` The maximum size of a post that will be accepted
`Long`	`maxProcessingTime()` The maximum processing time taken by a request on this listener
`T`	`maxProcessingTime(Long value)` The maximum processing time taken by a request on this listener
`Integer`	`noRequestTimeout()` The length of time in milliseconds that the connection can be idle before it is closed by the container
`T`	`noRequestTimeout(Integer value)` The length of time in milliseconds that the connection can be idle before it is closed by the container
`Long`	`processingTime()` The total processing time of all requests handed by this listener
`T`	`processingTime(Long value)` The total processing time of all requests handed by this listener
`Integer`	`readTimeout()` Configure a read timeout for a socket, in milliseconds.
`T`	`readTimeout(Integer value)` Configure a read timeout for a socket, in milliseconds.
`Integer`	`receiveBuffer()` The receive buffer size.
`T`	`receiveBuffer(Integer value)` The receive buffer size.
`Boolean`	`recordRequestStartTime()` If this is true then Undertow will record the request start time, to allow for request time to be logged.
`T`	`recordRequestStartTime(Boolean value)` If this is true then Undertow will record the request start time, to allow for request time to be logged.
`void`	`removePropertyChangeListener(PropertyChangeListener listener)` Removes a property change listener
`Long`	`requestCount()` The number of requests this listener has served
`T`	`requestCount(Long value)` The number of requests this listener has served
`Integer`	`requestParseTimeout()` The maximum amount of time (in milliseconds) that can be spent parsing the request
`T`	`requestParseTimeout(Integer value)` The maximum amount of time (in milliseconds) that can be spent parsing the request
`Boolean`	`resolvePeerAddress()` Enables host dns lookup
`T`	`resolvePeerAddress(Boolean value)` Enables host dns lookup
`String`	`securityRealm()` The listeners security realm
`T`	`securityRealm(String value)` The listeners security realm
`Integer`	`sendBuffer()` The send buffer size.
`T`	`sendBuffer(Integer value)` The send buffer size.
`String`	`socketBinding()` The AJP listener socket binder
`T`	`socketBinding(String value)` The AJP listener socket binder
`Integer`	`sslSessionCacheSize()` The maximum number of active SSL sessions
`T`	`sslSessionCacheSize(Integer value)` The maximum number of active SSL sessions
`Integer`	`sslSessionTimeout()` The timeout for SSL sessions, in seconds
`T`	`sslSessionTimeout(Integer value)` The timeout for SSL sessions, in seconds
`Integer`	`tcpBacklog()` Configure a server with the specified backlog.
`T`	`tcpBacklog(Integer value)` Configure a server with the specified backlog.
`Boolean`	`tcpKeepAlive()` Configure a channel to send TCP keep-alive messages in an implementation-dependent manner.
`T`	`tcpKeepAlive(Boolean value)` Configure a channel to send TCP keep-alive messages in an implementation-dependent manner.
`String`	`urlCharset()` URL charset
`T`	`urlCharset(String value)` URL charset
`String`	`verifyClient()` The desired SSL client authentication mode for SSL channels
`T`	`verifyClient(String value)` The desired SSL client authentication mode for SSL channels
`String`	`worker()` The AJP listeners XNIO worker
`T`	`worker(String value)` The AJP listeners XNIO worker
`Integer`	`writeTimeout()` Configure a write timeout for a socket, in milliseconds.
`T`	`writeTimeout(Integer value)` Configure a write timeout for a socket, in milliseconds.

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

- Constructor Detail
  - HttpsListener
```
public HttpsListener(String key)
```
- Method Detail
  - getKey
```
public String getKey()
```
  - addPropertyChangeListener
```
public void addPropertyChangeListener(PropertyChangeListener listener)
```
    Adds a property change listener
  - removePropertyChangeListener
```
public void removePropertyChangeListener(PropertyChangeListener listener)
```
    Removes a property change listener
  - allowEncodedSlash
```
@ModelNodeBinding(detypedName="allow-encoded-slash")
public Boolean allowEncodedSlash()
```
    If a request comes in with encoded / characters (i.e. %2F), will these be decoded.
  - allowEncodedSlash
```
public T allowEncodedSlash(Boolean value)
```
    If a request comes in with encoded / characters (i.e. %2F), will these be decoded.
  - allowEqualsInCookieValue
```
@ModelNodeBinding(detypedName="allow-equals-in-cookie-value")
public Boolean allowEqualsInCookieValue()
```
    If this is true then Undertow will allow non-escaped equals characters in unquoted cookie values. Unquoted cookie values may not contain equals characters. If present the value ends before the equals sign. The remainder of the cookie value will be dropped.
  - allowEqualsInCookieValue
```
public T allowEqualsInCookieValue(Boolean value)
```
    If this is true then Undertow will allow non-escaped equals characters in unquoted cookie values. Unquoted cookie values may not contain equals characters. If present the value ends before the equals sign. The remainder of the cookie value will be dropped.
  - alwaysSetKeepAlive
```
@ModelNodeBinding(detypedName="always-set-keep-alive")
public Boolean alwaysSetKeepAlive()
```
    If this is true then a Connection: keep-alive header will be added to responses, even when it is not strictly required by the specification.
  - alwaysSetKeepAlive
```
public T alwaysSetKeepAlive(Boolean value)
```
    If this is true then a Connection: keep-alive header will be added to responses, even when it is not strictly required by the specification.
  - bufferPipelinedData
```
@ModelNodeBinding(detypedName="buffer-pipelined-data")
public Boolean bufferPipelinedData()
```
    If we should buffer pipelined requests.
  - bufferPipelinedData
```
public T bufferPipelinedData(Boolean value)
```
    If we should buffer pipelined requests.
  - bufferPool
```
@ModelNodeBinding(detypedName="buffer-pool")
public String bufferPool()
```
    The AJP listeners buffer pool
  - bufferPool
```
public T bufferPool(String value)
```
    The AJP listeners buffer pool
  - bytesReceived
```
@ModelNodeBinding(detypedName="bytes-received")
public Long bytesReceived()
```
    The number of bytes that have been received by this listener
  - bytesReceived
```
public T bytesReceived(Long value)
```
    The number of bytes that have been received by this listener
  - bytesSent
```
@ModelNodeBinding(detypedName="bytes-sent")
public Long bytesSent()
```
    The number of bytes that have been sent out on this listener
  - bytesSent
```
public T bytesSent(Long value)
```
    The number of bytes that have been sent out on this listener
  - decodeUrl
```
@ModelNodeBinding(detypedName="decode-url")
public Boolean decodeUrl()
```
    If this is true then the parser will decode the URL and query parameters using the selected character encoding (UTF-8 by default). If this is false they will not be decoded. This will allow a later handler to decode them into whatever charset is desired.
  - decodeUrl
```
public T decodeUrl(Boolean value)
```
    If this is true then the parser will decode the URL and query parameters using the selected character encoding (UTF-8 by default). If this is false they will not be decoded. This will allow a later handler to decode them into whatever charset is desired.
  - disallowedMethods
```
@ModelNodeBinding(detypedName="disallowed-methods")
public List<String> disallowedMethods()
```
    A comma separated list of HTTP methods that are not allowed
  - disallowedMethods
```
public T disallowedMethods(List<String> value)
```
    A comma separated list of HTTP methods that are not allowed
  - disallowedMethod
```
public T disallowedMethod(String value)
```
    A comma separated list of HTTP methods that are not allowed
  - disallowedMethods
```
public T disallowedMethods(String... args)
```
    A comma separated list of HTTP methods that are not allowed
  - enableHttp2
```
@ModelNodeBinding(detypedName="enable-http2")
public Boolean enableHttp2()
```
    Enables HTTP2 support for this listener
  - enableHttp2
```
public T enableHttp2(Boolean value)
```
    Enables HTTP2 support for this listener
  - enableSpdy
```
@ModelNodeBinding(detypedName="enable-spdy")
public Boolean enableSpdy()
```
    Enables SPDY support for this listener
  - enableSpdy
```
public T enableSpdy(Boolean value)
```
    Enables SPDY support for this listener
  - enabled
```
@ModelNodeBinding(detypedName="enabled")
public Boolean enabled()
```
    If the listener is enabled
  - enabled
```
public T enabled(Boolean value)
```
    If the listener is enabled
  - enabledCipherSuites
```
@ModelNodeBinding(detypedName="enabled-cipher-suites")
public String enabledCipherSuites()
```
    Configures Enabled SSL cyphers
  - enabledCipherSuites
```
public T enabledCipherSuites(String value)
```
    Configures Enabled SSL cyphers
  - enabledProtocols
```
@ModelNodeBinding(detypedName="enabled-protocols")
public String enabledProtocols()
```
    Configures SSL protocols
  - enabledProtocols
```
public T enabledProtocols(String value)
```
    Configures SSL protocols
  - errorCount
```
@ModelNodeBinding(detypedName="error-count")
public Long errorCount()
```
    The number of 500 responses that have been sent by this listener
  - errorCount
```
public T errorCount(Long value)
```
    The number of 500 responses that have been sent by this listener
  - maxBufferedRequestSize
```
@ModelNodeBinding(detypedName="max-buffered-request-size")
public Integer maxBufferedRequestSize()
```
    Maximum size of a buffered request, in bytesRequests are not usually buffered, the most common case is when performing SSL renegotiation for a POST request, and the post data must be fullybuffered in order to perform the renegotiation.
  - maxBufferedRequestSize
```
public T maxBufferedRequestSize(Integer value)
```
    Maximum size of a buffered request, in bytesRequests are not usually buffered, the most common case is when performing SSL renegotiation for a POST request, and the post data must be fullybuffered in order to perform the renegotiation.
  - maxConnections
```
@ModelNodeBinding(detypedName="max-connections")
public Integer maxConnections()
```
    The maximum number of concurrent connections.
  - maxConnections
```
public T maxConnections(Integer value)
```
    The maximum number of concurrent connections.
  - maxCookies
```
@ModelNodeBinding(detypedName="max-cookies")
public Integer maxCookies()
```
    The maximum number of cookies that will be parsed. This is used to protect against hash vulnerabilities.
  - maxCookies
```
public T maxCookies(Integer value)
```
    The maximum number of cookies that will be parsed. This is used to protect against hash vulnerabilities.
  - maxHeaderSize
```
@ModelNodeBinding(detypedName="max-header-size")
public Integer maxHeaderSize()
```
    The maximum size in bytes of a http request header.
  - maxHeaderSize
```
public T maxHeaderSize(Integer value)
```
    The maximum size in bytes of a http request header.
  - maxHeaders
```
@ModelNodeBinding(detypedName="max-headers")
public Integer maxHeaders()
```
    The maximum number of headers that will be parsed. This is used to protect against hash vulnerabilities.
  - maxHeaders
```
public T maxHeaders(Integer value)
```
    The maximum number of headers that will be parsed. This is used to protect against hash vulnerabilities.
  - maxParameters
```
@ModelNodeBinding(detypedName="max-parameters")
public Integer maxParameters()
```
    The maximum number of parameters that will be parsed. This is used to protect against hash vulnerabilities.This applies to both query parameters, and to POST data, but is not cumulative (i.e. you can potentially have max parameters * 2 total parameters).
  - maxParameters
```
public T maxParameters(Integer value)
```
    The maximum number of parameters that will be parsed. This is used to protect against hash vulnerabilities.This applies to both query parameters, and to POST data, but is not cumulative (i.e. you can potentially have max parameters * 2 total parameters).
  - maxPostSize
```
@ModelNodeBinding(detypedName="max-post-size")
public Long maxPostSize()
```
    The maximum size of a post that will be accepted
  - maxPostSize
```
public T maxPostSize(Long value)
```
    The maximum size of a post that will be accepted
  - maxProcessingTime
```
@ModelNodeBinding(detypedName="max-processing-time")
public Long maxProcessingTime()
```
    The maximum processing time taken by a request on this listener
  - maxProcessingTime
```
public T maxProcessingTime(Long value)
```
    The maximum processing time taken by a request on this listener
  - noRequestTimeout
```
@ModelNodeBinding(detypedName="no-request-timeout")
public Integer noRequestTimeout()
```
    The length of time in milliseconds that the connection can be idle before it is closed by the container
  - noRequestTimeout
```
public T noRequestTimeout(Integer value)
```
    The length of time in milliseconds that the connection can be idle before it is closed by the container
  - processingTime
```
@ModelNodeBinding(detypedName="processing-time")
public Long processingTime()
```
    The total processing time of all requests handed by this listener
  - processingTime
```
public T processingTime(Long value)
```
    The total processing time of all requests handed by this listener
  - readTimeout
```
@ModelNodeBinding(detypedName="read-timeout")
public Integer readTimeout()
```
    Configure a read timeout for a socket, in milliseconds. If the given amount of time elapses without a successful read taking place, the socket's next read will throw a ReadTimeoutException.
  - readTimeout
```
public T readTimeout(Integer value)
```
    Configure a read timeout for a socket, in milliseconds. If the given amount of time elapses without a successful read taking place, the socket's next read will throw a ReadTimeoutException.
  - receiveBuffer
```
@ModelNodeBinding(detypedName="receive-buffer")
public Integer receiveBuffer()
```
    The receive buffer size.
  - receiveBuffer
```
public T receiveBuffer(Integer value)
```
    The receive buffer size.
  - recordRequestStartTime
```
@ModelNodeBinding(detypedName="record-request-start-time")
public Boolean recordRequestStartTime()
```
    If this is true then Undertow will record the request start time, to allow for request time to be logged. This has a small but measurable performance impact
  - recordRequestStartTime
```
public T recordRequestStartTime(Boolean value)
```
    If this is true then Undertow will record the request start time, to allow for request time to be logged. This has a small but measurable performance impact
  - requestCount
```
@ModelNodeBinding(detypedName="request-count")
public Long requestCount()
```
    The number of requests this listener has served
  - requestCount
```
public T requestCount(Long value)
```
    The number of requests this listener has served
  - requestParseTimeout
```
@ModelNodeBinding(detypedName="request-parse-timeout")
public Integer requestParseTimeout()
```
    The maximum amount of time (in milliseconds) that can be spent parsing the request
  - requestParseTimeout
```
public T requestParseTimeout(Integer value)
```
    The maximum amount of time (in milliseconds) that can be spent parsing the request
  - resolvePeerAddress
```
@ModelNodeBinding(detypedName="resolve-peer-address")
public Boolean resolvePeerAddress()
```
    Enables host dns lookup
  - resolvePeerAddress
```
public T resolvePeerAddress(Boolean value)
```
    Enables host dns lookup
  - securityRealm
```
@ModelNodeBinding(detypedName="security-realm")
public String securityRealm()
```
    The listeners security realm
  - securityRealm
```
public T securityRealm(String value)
```
    The listeners security realm
  - sendBuffer
```
@ModelNodeBinding(detypedName="send-buffer")
public Integer sendBuffer()
```
    The send buffer size.
  - sendBuffer
```
public T sendBuffer(Integer value)
```
    The send buffer size.
  - socketBinding
```
@ModelNodeBinding(detypedName="socket-binding")
public String socketBinding()
```
    The AJP listener socket binder
  - socketBinding
```
public T socketBinding(String value)
```
    The AJP listener socket binder
  - sslSessionCacheSize
```
@ModelNodeBinding(detypedName="ssl-session-cache-size")
public Integer sslSessionCacheSize()
```
    The maximum number of active SSL sessions
  - sslSessionCacheSize
```
public T sslSessionCacheSize(Integer value)
```
    The maximum number of active SSL sessions
  - sslSessionTimeout
```
@ModelNodeBinding(detypedName="ssl-session-timeout")
public Integer sslSessionTimeout()
```
    The timeout for SSL sessions, in seconds
  - sslSessionTimeout
```
public T sslSessionTimeout(Integer value)
```
    The timeout for SSL sessions, in seconds
  - tcpBacklog
```
@ModelNodeBinding(detypedName="tcp-backlog")
public Integer tcpBacklog()
```
    Configure a server with the specified backlog.
  - tcpBacklog
```
public T tcpBacklog(Integer value)
```
    Configure a server with the specified backlog.
  - tcpKeepAlive
```
@ModelNodeBinding(detypedName="tcp-keep-alive")
public Boolean tcpKeepAlive()
```
    Configure a channel to send TCP keep-alive messages in an implementation-dependent manner.
  - tcpKeepAlive
```
public T tcpKeepAlive(Boolean value)
```
    Configure a channel to send TCP keep-alive messages in an implementation-dependent manner.
  - urlCharset
```
@ModelNodeBinding(detypedName="url-charset")
public String urlCharset()
```
    URL charset
  - urlCharset
```
public T urlCharset(String value)
```
    URL charset
  - verifyClient
```
@ModelNodeBinding(detypedName="verify-client")
public String verifyClient()
```
    The desired SSL client authentication mode for SSL channels
  - verifyClient
```
public T verifyClient(String value)
```
    The desired SSL client authentication mode for SSL channels
  - worker
```
@ModelNodeBinding(detypedName="worker")
public String worker()
```
    The AJP listeners XNIO worker
  - worker
```
public T worker(String value)
```
    The AJP listeners XNIO worker
  - writeTimeout
```
@ModelNodeBinding(detypedName="write-timeout")
public Integer writeTimeout()
```
    Configure a write timeout for a socket, in milliseconds. If the given amount of time elapses without a successful write taking place, the socket's next write will throw a WriteTimeoutException.
  - writeTimeout
```
public T writeTimeout(Integer value)
```
    Configure a write timeout for a socket, in milliseconds. If the given amount of time elapses without a successful write taking place, the socket's next write will throw a WriteTimeoutException.

Class HttpsListener<T extends HttpsListener<T>>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HttpsListener

Method Detail

getKey

addPropertyChangeListener

removePropertyChangeListener

allowEncodedSlash

allowEncodedSlash

allowEqualsInCookieValue

allowEqualsInCookieValue

alwaysSetKeepAlive

alwaysSetKeepAlive

bufferPipelinedData

bufferPipelinedData

bufferPool

bufferPool

bytesReceived

bytesReceived

bytesSent

bytesSent

decodeUrl

decodeUrl

disallowedMethods

disallowedMethods

disallowedMethod

disallowedMethods

enableHttp2

enableHttp2

enableSpdy

enableSpdy

enabled

enabled

enabledCipherSuites

enabledCipherSuites

enabledProtocols

enabledProtocols

errorCount

errorCount

maxBufferedRequestSize

maxBufferedRequestSize

maxConnections

maxConnections

maxCookies

maxCookies

maxHeaderSize

maxHeaderSize

maxHeaders

maxHeaders

maxParameters

maxParameters

maxPostSize

maxPostSize

maxProcessingTime

maxProcessingTime

noRequestTimeout

noRequestTimeout

processingTime

processingTime

readTimeout

readTimeout

receiveBuffer

receiveBuffer

recordRequestStartTime

recordRequestStartTime

requestCount

requestCount

requestParseTimeout

requestParseTimeout

resolvePeerAddress

resolvePeerAddress

securityRealm

securityRealm

sendBuffer

sendBuffer

socketBinding

socketBinding