AddUndertowListener.HttpsBuilder (Creaper: Commands 2.0.0-Alpha.1 API)

java.lang.Object
- org.wildfly.extras.creaper.commands.undertow.AddUndertowListener.HttpsBuilder

Enclosing class:

AddUndertowListener
```
public static final class AddUndertowListener.HttpsBuilder
extends Object
```
Builder for adding an HTTPS listener

Some details about the attributes can be found at http://wildscribe.github.io/Wildfly/9.0.0.Beta1/subsystem/undertow/server/https-listener/index.html

Field Summary

Fields
Modifier and Type	Field and Description
`protected Boolean`	`allowEncodedSlash`
`protected Boolean`	`allowEqualsInCookiesValues`
`protected Boolean`	`alwaysSetKeepAlive`
`protected Boolean`	`bufferPipelinedData`
`protected String`	`bufferPool`
`protected Boolean`	`decodeUrl`
`protected Boolean`	`enabled`
`protected String`	`listenerName`
`protected Integer`	`maxBufferedRequestSize`
`protected Integer`	`maxCookies`
`protected Integer`	`maxHeaders`
`protected Integer`	`maxHeaderSize`
`protected Integer`	`maxParameters`
`protected Long`	`maxPostSize`
`protected Integer`	`noRequestTimeout`
`protected Integer`	`readTimeout`
`protected Integer`	`receiveBuffer`
`protected Boolean`	`recordRequestStartTime`
`protected Integer`	`requestParseTimeout`
`protected Boolean`	`resolvePeerAddress`
`protected Integer`	`sendBuffer`
`protected String`	`serverName`
`protected String`	`socketBinding`
`protected Integer`	`tcpBacklog`
`protected Boolean`	`tcpKeepAlive`
`protected String`	`urlCharset`
`protected String`	`worker`
`protected Integer`	`writeTimeout`

Constructor Summary

Constructors
Constructor and Description
`HttpsBuilder(String listenerName)` Assumes socket binding called `https`.
`HttpsBuilder(String listenerName, String socketBinding)`
`HttpsBuilder(String listenerName, String serverName, String socketBinding)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`THIS`	`allowEncodedSlash(boolean allowEncodedSlash)` Sets whether request which comes in with encoded / characters (i.e.
`THIS`	`allowEqualsInCookiesValues(boolean allowEqualsInCookiesValues)` Defines whether Undertow will allow non-escaped equals characters in unquoted cookie values.
`THIS`	`alwaysSetKeepAlive(boolean alwaysSetKeepAlive)` Defines whether a Connection: keep-alive header will be added to responses, even when it is not strictly required by the specification.
`THIS`	`bufferPipelinedData(boolean bufferPipelinedData)` Defines whether there should be buffered pipelined requests
`THIS`	`bufferPool(String bufferPool)` Defines the AJP listeners buffer pool
`AddUndertowListener`	`build()`
`THIS`	`decodeUrl(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).
`THIS`	`enabled(boolean enabled)` Defines whether the connector should be started on startup.
`AddUndertowListener.HttpsBuilder`	`enabledCipherSuites(String enabledCipherSuites)` Defines Enabled SSL ciphers.
`AddUndertowListener.HttpsBuilder`	`enabledProtocols(String enabledProtocols)` Defines SSL protocols.
`AddUndertowListener.HttpsBuilder`	`enableHttp2(boolean enableHttp2)` Enables HTTP2 support for this listener.
`AddUndertowListener.HttpsBuilder`	`enableSpdy(boolean enableSpdy)` Enables SPDY support for this listener.
`THIS`	`maxBufferedRequestSize(int maxBufferedRequestSize)` Defines 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 fully buffered in order to perform the renegotiation.
`THIS`	`maxCookies(int maxCookies)` Defines maximum number of cookies that will be parsed.
`THIS`	`maxHeaders(int maxHeaders)` Defines maximum number of headers that will be parsed.
`THIS`	`maxHeaderSize(int maxHeaderSize)` Defines maximum size in bytes of a http request header.
`THIS`	`maxParameters(int maxParameters)` Defines The maximum number of parameters that will be parsed.
`THIS`	`maxPostSize(long maxPostSize)` Defines maximum size of a post that will be accepted
`THIS`	`noRequestTimeout(int noRequestTimeout)` Defines the length of time in milliseconds that the connection can be idle before it is closed by the container.
`THIS`	`readTimeout(int readTimeout)` Defines a read timeout for a socket, in milliseconds.
`THIS`	`receiveBuffer(int receiveBuffer)` The receive buffer size.
`THIS`	`recordRequestStartTime(boolean recordRequestStartTime)` Defines whether Undertow will record the request start time, to allow for request time to be logged.
`THIS`	`requestParseTimeout(int requestParseTimeout)` Defines maximum amount of time (in milliseconds) that can be spent parsing the request.
`THIS`	`resolvePeerAddress(boolean resolvePeerAddress)` Defines whether host dns lookup is enabled.
`AddUndertowListener.HttpsBuilder`	`securityRealm(String securityRealm)` Deprecated. Use `sslContext(String sslContext)` instead
`THIS`	`sendBuffer(int sendBuffer)` Defines send buffer size.
`AddUndertowListener.HttpsBuilder`	`sslContext(String sslContext)` Defines which `org.wildfly.security.ssl-context` should be used by this HTTPS listener.
`THIS`	`tcpBacklog(int tcpBacklog)` Configures a server with the specified backlog.
`THIS`	`tcpKeepAlive(boolean tcpKeepAlive)` Defines whether channel should send TCP keep-alive messages in an implementation-dependent manner.
`THIS`	`urlCharset(String urlCharset)` Defines URL charset.
`AddUndertowListener.HttpsBuilder`	`verifyClient(SslVerifyClient sslVerifyClient)` Defines desired SSL client authentication mode for SSL channels
`THIS`	`worker(String worker)` Defines the listener XNIO worker
`THIS`	`writeTimeout(int writeTimeout)` Configure a write timeout for a socket, in milliseconds.

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

- Field Detail
  - listenerName
```
protected final String listenerName
```
  - serverName
```
protected final String serverName
```
  - allowEncodedSlash
```
protected Boolean allowEncodedSlash
```
  - allowEqualsInCookiesValues
```
protected Boolean allowEqualsInCookiesValues
```
  - alwaysSetKeepAlive
```
protected Boolean alwaysSetKeepAlive
```
  - bufferPipelinedData
```
protected Boolean bufferPipelinedData
```
  - bufferPool
```
protected String bufferPool
```
  - decodeUrl
```
protected Boolean decodeUrl
```
  - enabled
```
protected Boolean enabled
```
  - maxBufferedRequestSize
```
protected Integer maxBufferedRequestSize
```
  - maxCookies
```
protected Integer maxCookies
```
  - maxHeaderSize
```
protected Integer maxHeaderSize
```
  - maxHeaders
```
protected Integer maxHeaders
```
  - maxParameters
```
protected Integer maxParameters
```
  - maxPostSize
```
protected Long maxPostSize
```
  - noRequestTimeout
```
protected Integer noRequestTimeout
```
  - readTimeout
```
protected Integer readTimeout
```
  - receiveBuffer
```
protected Integer receiveBuffer
```
  - recordRequestStartTime
```
protected Boolean recordRequestStartTime
```
  - requestParseTimeout
```
protected Integer requestParseTimeout
```
  - resolvePeerAddress
```
protected Boolean resolvePeerAddress
```
  - sendBuffer
```
protected Integer sendBuffer
```
  - socketBinding
```
protected String socketBinding
```
  - tcpBacklog
```
protected Integer tcpBacklog
```
  - tcpKeepAlive
```
protected Boolean tcpKeepAlive
```
  - urlCharset
```
protected String urlCharset
```
  - worker
```
protected String worker
```
  - writeTimeout
```
protected Integer writeTimeout
```
- Constructor Detail
  - HttpsBuilder
```
public HttpsBuilder(String listenerName,
                    String serverName,
                    String socketBinding)
```
  - HttpsBuilder
```
public HttpsBuilder(String listenerName,
                    String socketBinding)
```
  - HttpsBuilder
```
public HttpsBuilder(String listenerName)
```
    Assumes socket binding called https.
- Method Detail
  - enableHttp2
```
public AddUndertowListener.HttpsBuilder enableHttp2(boolean enableHttp2)
```
    Enables HTTP2 support for this listener.
  - enableSpdy
```
public AddUndertowListener.HttpsBuilder enableSpdy(boolean enableSpdy)
```
    Enables SPDY support for this listener.
  - enabledCipherSuites
```
public AddUndertowListener.HttpsBuilder enabledCipherSuites(String enabledCipherSuites)
```
    Defines Enabled SSL ciphers.
  - enabledProtocols
```
public AddUndertowListener.HttpsBuilder enabledProtocols(String enabledProtocols)
```
    Defines SSL protocols.
  - securityRealm
```
public AddUndertowListener.HttpsBuilder securityRealm(String securityRealm)
```
    Deprecated. Use sslContext(String sslContext) instead
    
    Defines which security realm should be used by the listener.
    
    Note, there is also created AddHttpsSecurityRealm allowing to easily create security realm with specified name
  - sslContext
```
public AddUndertowListener.HttpsBuilder sslContext(String sslContext)
```
    Defines which org.wildfly.security.ssl-context should be used by this HTTPS listener. Note you can use CreateServerSSLContext to create this capability.
    
    Parameters:
    
    sslContext - ssl context name
    
    Returns:
    
    instance of this builder
  - verifyClient
```
public AddUndertowListener.HttpsBuilder verifyClient(SslVerifyClient sslVerifyClient)
```
    Defines desired SSL client authentication mode for SSL channels
  - build
```
public AddUndertowListener build()
```
  - allowEncodedSlash
```
public final THIS allowEncodedSlash(boolean allowEncodedSlash)
```
    Sets whether request which comes in with encoded / characters (i.e. %2F), will these be decoded.
  - allowEqualsInCookiesValues
```
public THIS allowEqualsInCookiesValues(boolean allowEqualsInCookiesValues)
```
    Defines whether 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
```
public THIS alwaysSetKeepAlive(boolean alwaysSetKeepAlive)
```
    Defines whether a Connection: keep-alive header will be added to responses, even when it is not strictly required by the specification.
  - bufferPipelinedData
```
public THIS bufferPipelinedData(boolean bufferPipelinedData)
```
    Defines whether there should be buffered pipelined requests
  - bufferPool
```
public THIS bufferPool(String bufferPool)
```
    Defines the AJP listeners buffer pool
  - decodeUrl
```
public THIS decodeUrl(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.
  - enabled
```
public THIS enabled(boolean enabled)
```
    Defines whether the connector should be started on startup.
  - maxBufferedRequestSize
```
public THIS maxBufferedRequestSize(int maxBufferedRequestSize)
```
    Defines 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 fully buffered in order to perform the renegotiation.
  - maxCookies
```
public THIS maxCookies(int maxCookies)
```
    Defines maximum number of cookies that will be parsed. This is used to protect against hash vulnerabilities.
  - maxHeaderSize
```
public THIS maxHeaderSize(int maxHeaderSize)
```
    Defines maximum size in bytes of a http request header.
  - maxHeaders
```
public THIS maxHeaders(int maxHeaders)
```
    Defines maximum number of headers that will be parsed. This is used to protect against hash vulnerabilities.
  - maxParameters
```
public THIS maxParameters(int maxParameters)
```
    Defines 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
```
public THIS maxPostSize(long maxPostSize)
```
    Defines maximum size of a post that will be accepted
  - noRequestTimeout
```
public THIS noRequestTimeout(int noRequestTimeout)
```
    Defines the length of time in milliseconds that the connection can be idle before it is closed by the container.
  - readTimeout
```
public THIS readTimeout(int readTimeout)
```
    Defines 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
```
public THIS receiveBuffer(int receiveBuffer)
```
    The receive buffer size.
  - recordRequestStartTime
```
public THIS recordRequestStartTime(boolean recordRequestStartTime)
```
    Defines whether Undertow will record the request start time, to allow for request time to be logged. This has a small but measurable performance impact.
  - requestParseTimeout
```
public THIS requestParseTimeout(int requestParseTimeout)
```
    Defines maximum amount of time (in milliseconds) that can be spent parsing the request.
  - resolvePeerAddress
```
public THIS resolvePeerAddress(boolean resolvePeerAddress)
```
    Defines whether host dns lookup is enabled.
  - sendBuffer
```
public THIS sendBuffer(int sendBuffer)
```
    Defines send buffer size.
  - tcpBacklog
```
public THIS tcpBacklog(int tcpBacklog)
```
    Configures a server with the specified backlog.
  - tcpKeepAlive
```
public THIS tcpKeepAlive(boolean tcpKeepAlive)
```
    Defines whether channel should send TCP keep-alive messages in an implementation-dependent manner.
  - urlCharset
```
public THIS urlCharset(String urlCharset)
```
    Defines URL charset.
  - worker
```
public THIS worker(String worker)
```
    Defines the listener XNIO worker
  - writeTimeout
```
public THIS writeTimeout(int 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.

Class AddUndertowListener.HttpsBuilder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

listenerName

serverName

allowEncodedSlash

allowEqualsInCookiesValues

alwaysSetKeepAlive

bufferPipelinedData

bufferPool

decodeUrl

enabled

maxBufferedRequestSize

maxCookies

maxHeaderSize

maxHeaders

maxParameters

maxPostSize

noRequestTimeout

readTimeout

receiveBuffer

recordRequestStartTime

requestParseTimeout

resolvePeerAddress

sendBuffer

socketBinding

tcpBacklog

tcpKeepAlive

urlCharset

worker

writeTimeout

Constructor Detail

HttpsBuilder

HttpsBuilder

HttpsBuilder

Method Detail

enableHttp2

enableSpdy

enabledCipherSuites

enabledProtocols

securityRealm

sslContext

verifyClient

build

allowEncodedSlash

allowEqualsInCookiesValues

alwaysSetKeepAlive

bufferPipelinedData

bufferPool

decodeUrl

enabled

maxBufferedRequestSize

maxCookies

maxHeaderSize

maxHeaders

maxParameters

maxPostSize

noRequestTimeout

readTimeout

receiveBuffer

recordRequestStartTime

requestParseTimeout

resolvePeerAddress

sendBuffer

tcpBacklog

tcpKeepAlive

urlCharset

worker

writeTimeout