public class HttpServerOptions extends NetServerOptions
HttpServer instance| Modifier and Type | Field and Description |
|---|---|
static boolean |
DEFAULT_COMPRESSION_SUPPORTED
Default value of whether compression is supported = false
|
static int |
DEFAULT_MAX_WEBSOCKET_FRAME_SIZE
Default max websocket framesize = 65536
|
static int |
DEFAULT_PORT
Default port the server will listen on = 80
|
DEFAULT_ACCEPT_BACKLOG, DEFAULT_CLIENT_AUTH_REQUIRED, DEFAULT_HOSTDEFAULT_IDLE_TIMEOUT, DEFAULT_SO_LINGER, DEFAULT_SSL, DEFAULT_TCP_KEEP_ALIVE, DEFAULT_TCP_NO_DELAY, DEFAULT_USE_POOLED_BUFFERSDEFAULT_RECEIVE_BUFFER_SIZE, DEFAULT_REUSE_ADDRESS, DEFAULT_SEND_BUFFER_SIZE, DEFAULT_TRAFFIC_CLASS| Constructor and Description |
|---|
HttpServerOptions()
Default constructor
|
HttpServerOptions(HttpServerOptions other)
Copy constructor
|
HttpServerOptions(JsonObject json)
Create an options from JSON
|
| Modifier and Type | Method and Description |
|---|---|
HttpServerOptions |
addCrlPath(String crlPath)
Add a CRL path
|
HttpServerOptions |
addCrlValue(Buffer crlValue)
Add a CRL value
|
HttpServerOptions |
addEnabledCipherSuite(String suite)
Add an enabled cipher suite
|
boolean |
equals(Object o) |
int |
getMaxWebsocketFrameSize() |
String |
getWebsocketSubProtocols() |
int |
hashCode() |
boolean |
isCompressionSupported() |
HttpServerOptions |
setAcceptBacklog(int acceptBacklog)
Set the accept back log
|
HttpServerOptions |
setClientAuthRequired(boolean clientAuthRequired)
Set whether client auth is required
|
HttpServerOptions |
setCompressionSupported(boolean compressionSupported)
Set whether the server supports compression
|
HttpServerOptions |
setHost(String host)
Set the host
|
HttpServerOptions |
setIdleTimeout(int idleTimeout) |
HttpServerOptions |
setKeyStoreOptions(JksOptions options)
Set the key/cert options in jks format, aka Java keystore.
|
HttpServerOptions |
setMaxWebsocketFrameSize(int maxWebsocketFrameSize)
Set the maximum websocket frames size
|
HttpServerOptions |
setPemKeyCertOptions(PemKeyCertOptions options)
Set the key/cert store options in pem format.
|
HttpServerOptions |
setPemTrustOptions(PemTrustOptions options)
Set the trust options in pem format
|
HttpServerOptions |
setPfxKeyCertOptions(PfxOptions options)
Set the key/cert options in pfx format.
|
HttpServerOptions |
setPfxTrustOptions(PfxOptions options)
Set the trust options in pfx format
|
HttpServerOptions |
setPort(int port)
Set the port
|
HttpServerOptions |
setReceiveBufferSize(int receiveBufferSize)
Set the TCP receive buffer size
|
HttpServerOptions |
setReuseAddress(boolean reuseAddress)
Set the value of reuse address
|
HttpServerOptions |
setSendBufferSize(int sendBufferSize)
Set the TCP send buffer size
|
HttpServerOptions |
setSoLinger(int soLinger)
Set whether SO_linger keep alive is enabled
|
HttpServerOptions |
setSsl(boolean ssl)
Set whether SSL/TLS is enabled
|
HttpServerOptions |
setTcpKeepAlive(boolean tcpKeepAlive)
Set whether TCP keep alive is enabled
|
HttpServerOptions |
setTcpNoDelay(boolean tcpNoDelay)
Set whether TCP no delay is enabled
|
HttpServerOptions |
setTrafficClass(int trafficClass)
Set the value of traffic class
|
HttpServerOptions |
setTrustStoreOptions(JksOptions options)
Set the trust options in jks format, aka Java trustore
|
HttpServerOptions |
setUsePooledBuffers(boolean usePooledBuffers)
Set whether Netty pooled buffers are enabled
|
HttpServerOptions |
setWebsocketSubProtocol(String subProtocols)
Set the websocket subprotocols supported by the server.
|
getAcceptBacklog, getHost, getPort, isClientAuthRequiredgetCrlPaths, getCrlValues, getEnabledCipherSuites, getIdleTimeout, getKeyCertOptions, getSoLinger, getTrustOptions, isSsl, isTcpKeepAlive, isTcpNoDelay, isUsePooledBuffersgetReceiveBufferSize, getSendBufferSize, getTrafficClass, isReuseAddresspublic static final int DEFAULT_PORT
public static final boolean DEFAULT_COMPRESSION_SUPPORTED
public static final int DEFAULT_MAX_WEBSOCKET_FRAME_SIZE
public HttpServerOptions()
public HttpServerOptions(HttpServerOptions other)
other - the options to copypublic HttpServerOptions(JsonObject json)
json - the JSONpublic HttpServerOptions setSendBufferSize(int sendBufferSize)
NetworkOptionssetSendBufferSize in class NetServerOptionssendBufferSize - the buffers size, in bytespublic HttpServerOptions setReceiveBufferSize(int receiveBufferSize)
NetworkOptionssetReceiveBufferSize in class NetServerOptionsreceiveBufferSize - the buffers size, in bytespublic HttpServerOptions setReuseAddress(boolean reuseAddress)
NetworkOptionssetReuseAddress in class NetServerOptionsreuseAddress - the value of reuse addresspublic HttpServerOptions setTrafficClass(int trafficClass)
NetworkOptionssetTrafficClass in class NetServerOptionstrafficClass - the value of traffic classpublic HttpServerOptions setTcpNoDelay(boolean tcpNoDelay)
TCPSSLOptionssetTcpNoDelay in class NetServerOptionstcpNoDelay - true if TCP no delay is enabled (Nagle disabled)public HttpServerOptions setTcpKeepAlive(boolean tcpKeepAlive)
TCPSSLOptionssetTcpKeepAlive in class NetServerOptionstcpKeepAlive - true if TCP keep alive is enabledpublic HttpServerOptions setSoLinger(int soLinger)
TCPSSLOptionssetSoLinger in class NetServerOptionssoLinger - true if SO_linger is enabledpublic HttpServerOptions setUsePooledBuffers(boolean usePooledBuffers)
TCPSSLOptionssetUsePooledBuffers in class NetServerOptionsusePooledBuffers - true if pooled buffers enabledpublic HttpServerOptions setIdleTimeout(int idleTimeout)
setIdleTimeout in class NetServerOptionspublic HttpServerOptions setSsl(boolean ssl)
TCPSSLOptionssetSsl in class NetServerOptionsssl - true if enabledpublic HttpServerOptions setKeyStoreOptions(JksOptions options)
TCPSSLOptionssetKeyStoreOptions in class NetServerOptionsoptions - the key store in jks formatpublic HttpServerOptions setPfxKeyCertOptions(PfxOptions options)
TCPSSLOptionssetPfxKeyCertOptions in class NetServerOptionsoptions - the key cert options in pfx formatpublic HttpServerOptions setPemKeyCertOptions(PemKeyCertOptions options)
TCPSSLOptionssetPemKeyCertOptions in class NetServerOptionsoptions - the options in pem formatpublic HttpServerOptions setTrustStoreOptions(JksOptions options)
TCPSSLOptionssetTrustStoreOptions in class NetServerOptionsoptions - the options in jks formatpublic HttpServerOptions setPemTrustOptions(PemTrustOptions options)
TCPSSLOptionssetPemTrustOptions in class NetServerOptionsoptions - the options in pem formatpublic HttpServerOptions setPfxTrustOptions(PfxOptions options)
TCPSSLOptionssetPfxTrustOptions in class NetServerOptionsoptions - the options in pfx formatpublic HttpServerOptions addEnabledCipherSuite(String suite)
TCPSSLOptionsaddEnabledCipherSuite in class NetServerOptionssuite - the suitepublic HttpServerOptions addCrlPath(String crlPath) throws NullPointerException
TCPSSLOptionsaddCrlPath in class NetServerOptionscrlPath - the pathNullPointerExceptionpublic HttpServerOptions addCrlValue(Buffer crlValue) throws NullPointerException
TCPSSLOptionsaddCrlValue in class NetServerOptionscrlValue - the valueNullPointerExceptionpublic HttpServerOptions setAcceptBacklog(int acceptBacklog)
NetServerOptionssetAcceptBacklog in class NetServerOptionsacceptBacklog - accept backlogpublic HttpServerOptions setPort(int port)
NetServerOptionssetPort in class NetServerOptionsport - the portpublic HttpServerOptions setHost(String host)
NetServerOptionssetHost in class NetServerOptionshost - the hostpublic boolean isCompressionSupported()
public HttpServerOptions setCompressionSupported(boolean compressionSupported)
compressionSupported - true if compression supportedpublic int getMaxWebsocketFrameSize()
public HttpServerOptions setMaxWebsocketFrameSize(int maxWebsocketFrameSize)
maxWebsocketFrameSize - the maximum frame size in bytes.public HttpServerOptions setWebsocketSubProtocol(String subProtocols)
subProtocols - comma separated list of subprotocolspublic String getWebsocketSubProtocols()
public HttpServerOptions setClientAuthRequired(boolean clientAuthRequired)
NetServerOptionssetClientAuthRequired in class NetServerOptionsclientAuthRequired - true if client auth is requiredpublic boolean equals(Object o)
equals in class NetServerOptionspublic int hashCode()
hashCode in class NetServerOptionsCopyright © 2015. All Rights Reserved.