vertx-lang-scala-docs_2.12 3.6.2 API - io.vertx.scala.ext.auth.oauth2.OAuth2ClientOptions

Set the list of protocol versions to provide to the server during the Application-Layer Protocol Negotiation. When the list is empty, the client provides a best effort list according to HttpClientOptions:

: [ "h2", "http/1.1" ]
otherwise: [HttpClientOptions]

Definition Classes: OAuth2ClientOptions → HttpClientOptions

def setAuthorizationPath(value: String): OAuth2ClientOptions

Get the Oauth2 authorization resource path.

Get the Oauth2 authorization resource path. e.g.: /oauth/authorize

def setClientID(value: String): OAuth2ClientOptions

Set the provider client id

def setClientSecret(value: String): OAuth2ClientOptions

Set the provider client secret

def setClientSecretParameterName(value: String): OAuth2ClientOptions

Override the HTTP form field name for client secret

def setConnectTimeout(value: Int): OAuth2ClientOptions

Set the connect timeout

Definition Classes: OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase

def setDecoderInitialBufferSize(value: Int): OAuth2ClientOptions

set to initialBufferSizeHttpDecoder the initial buffer of the HttpDecoder.

Definition Classes: OAuth2ClientOptions → HttpClientOptions

def setDefaultHost(value: String): OAuth2ClientOptions

Set the default host name to be used by this client in requests if none is provided when making the request.

Definition Classes: OAuth2ClientOptions → HttpClientOptions

def setDefaultPort(value: Int): OAuth2ClientOptions

Set the default port to be used by this client in requests if none is provided when making the request.

Definition Classes: OAuth2ClientOptions → HttpClientOptions

def setEnabledSecureTransportProtocols(value: Set[String]): OAuth2ClientOptions

Definition Classes: OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions

def setExtraParameters(value: JsonObject): OAuth2ClientOptions

Set extra parameters to be sent to the provider on each request

def setFlow(value: OAuth2FlowType): OAuth2ClientOptions

def setForceSni(value: Boolean): OAuth2ClientOptions

By default, the server name is only sent for Fully Qualified Domain Name (FQDN), setting this property to true forces the server name to be always sent.

Definition Classes: OAuth2ClientOptions → HttpClientOptions

def setHeaders(value: JsonObject): OAuth2ClientOptions

Set custom headers to be sent with every request to the provider

def setHttp2ClearTextUpgrade(value: Boolean): OAuth2ClientOptions

Set to true when an h2c connection is established using an HTTP/1.1 upgrade request, and false when an h2c connection is established directly (with prior knowledge).

Definition Classes: OAuth2ClientOptions → HttpClientOptions

def setHttp2ConnectionWindowSize(value: Int): OAuth2ClientOptions

Set the default HTTP/2 connection window size.

Set the default HTTP/2 connection window size. It overrides the initial window size set by Http2Settings, so the connection window size is greater than for its streams, in order the data throughput.

A value of -1 reuses the initial window size setting.

Definition Classes: OAuth2ClientOptions → HttpClientOptions

def setHttp2KeepAliveTimeout(value: Int): OAuth2ClientOptions

Set the keep alive timeout for HTTP/2 connections, in seconds.

This value determines how long a connection remains unused in the pool before being evicted and closed.

Definition Classes: OAuth2ClientOptions → HttpClientOptions

def setHttp2MaxPoolSize(value: Int): OAuth2ClientOptions

Set the maximum pool size for HTTP/2 connections

Definition Classes: OAuth2ClientOptions → HttpClientOptions

def setHttp2MultiplexingLimit(value: Int): OAuth2ClientOptions

Set a client limit of the number concurrent streams for each HTTP/2 connection, this limits the number of streams the client can create for a connection.

Set a client limit of the number concurrent streams for each HTTP/2 connection, this limits the number of streams the client can create for a connection. The effective number of streams for a connection is the min of this value and the server's initial settings.

Setting the value to -1 means to use the value sent by the server's initial settings. -1 is the default value.

Definition Classes: OAuth2ClientOptions → HttpClientOptions

def setIdleTimeout(value: Int): OAuth2ClientOptions

Set the idle timeout, default time unit is seconds.

Set the idle timeout, default time unit is seconds. Zero means don't timeout. This determines if a connection will timeout and be closed if no data is received within the timeout.

If you want change default time unit, use HttpClientOptions

Definition Classes: OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions

def setIdleTimeoutUnit(value: TimeUnit): OAuth2ClientOptions

Set the idle timeout unit.

Set the idle timeout unit. If not specified, default is seconds.

Definition Classes: OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions

def setInitialSettings(value: Http2Settings): OAuth2ClientOptions

Set the HTTP/2 connection settings immediately sent by to the server when the client connects.

Definition Classes: OAuth2ClientOptions → HttpClientOptions

def setIntrospectionPath(value: String): OAuth2ClientOptions

Set the provider token introspection resource path

def setJWTOptions(value: JWTOptions): OAuth2ClientOptions

def setJdkSslEngineOptions(value: JdkSSLEngineOptions): OAuth2ClientOptions

Definition Classes: OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions

def setJwkPath(value: String): OAuth2ClientOptions

def setKeepAlive(value: Boolean): OAuth2ClientOptions

Set whether keep alive is enabled on the client

Definition Classes: OAuth2ClientOptions → HttpClientOptions

def setKeepAliveTimeout(value: Int): OAuth2ClientOptions

Set the keep alive timeout for HTTP/1.x, in seconds.

This value determines how long a connection remains unused in the pool before being evicted and closed.

Definition Classes: OAuth2ClientOptions → HttpClientOptions

def setKeyStoreOptions(value: JksOptions): OAuth2ClientOptions

Set the key/cert options in jks format, aka Java keystore.

Definition Classes: OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions

def setLocalAddress(value: String): OAuth2ClientOptions

Set the local interface to bind for network connections.

Set the local interface to bind for network connections. When the local address is null, it will pick any local address, the default local address is null.

Definition Classes: OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase

def setLogActivity(value: Boolean): OAuth2ClientOptions

Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.

Definition Classes: OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions

def setLogoutPath(value: String): OAuth2ClientOptions

Set the provider logout path

def setMaxChunkSize(value: Int): OAuth2ClientOptions

Set the maximum HTTP chunk size

Definition Classes: OAuth2ClientOptions → HttpClientOptions

def setMaxHeaderSize(value: Int): OAuth2ClientOptions

Set the maximum length of all headers for HTTP/1.x .

Definition Classes: OAuth2ClientOptions → HttpClientOptions

def setMaxInitialLineLength(value: Int): OAuth2ClientOptions

Set the maximum length of the initial line for HTTP/1.x (e.g.

Set the maximum length of the initial line for HTTP/1.x (e.g. "HTTP/1.1 200 OK")

Definition Classes: OAuth2ClientOptions → HttpClientOptions

def setMaxPoolSize(value: Int): OAuth2ClientOptions

Set the maximum pool size for connections

Definition Classes: OAuth2ClientOptions → HttpClientOptions

def setMaxRedirects(value: Int): OAuth2ClientOptions

Set to maxRedirects the maximum number of redirection a request can follow.

Definition Classes: OAuth2ClientOptions → HttpClientOptions

def setMaxWaitQueueSize(value: Int): OAuth2ClientOptions

Set the maximum requests allowed in the wait queue, any requests beyond the max size will result in a ConnectionPoolTooBusyException.

Set the maximum requests allowed in the wait queue, any requests beyond the max size will result in a ConnectionPoolTooBusyException. If the value is set to a negative number then the queue will be unbounded.

Definition Classes: OAuth2ClientOptions → HttpClientOptions

def setMaxWebsocketFrameSize(value: Int): OAuth2ClientOptions

Set the max websocket frame size

Definition Classes: OAuth2ClientOptions → HttpClientOptions

def setMaxWebsocketMessageSize(value: Int): OAuth2ClientOptions

Set the max websocket message size

Definition Classes: OAuth2ClientOptions → HttpClientOptions

def setMetricsName(value: String): OAuth2ClientOptions

Set the metrics name identifying the reported metrics, useful for grouping metrics with the same name.

Definition Classes: OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase

def setOpenSslEngineOptions(value: OpenSSLEngineOptions): OAuth2ClientOptions

Definition Classes: OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions

def setPemKeyCertOptions(value: PemKeyCertOptions): OAuth2ClientOptions

Set the key/cert store options in pem format.

Definition Classes: OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions

def setPemTrustOptions(value: PemTrustOptions): OAuth2ClientOptions

Set the trust options in pem format

Definition Classes: OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions

def setPfxKeyCertOptions(value: PfxOptions): OAuth2ClientOptions

Set the key/cert options in pfx format.

Definition Classes: OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions

def setPfxTrustOptions(value: PfxOptions): OAuth2ClientOptions

Set the trust options in pfx format

Definition Classes: OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions

def setPipelining(value: Boolean): OAuth2ClientOptions

Set whether pipe-lining is enabled on the client

Definition Classes: OAuth2ClientOptions → HttpClientOptions

def setPipeliningLimit(value: Int): OAuth2ClientOptions

Set the limit of pending requests a pipe-lined HTTP/1 connection can send.

Definition Classes: OAuth2ClientOptions → HttpClientOptions

def setPoolCleanerPeriod(value: Int): OAuth2ClientOptions

Set the connection pool cleaner period in milli seconds, a non positive value disables expiration checks and connections will remain in the pool until they are closed.

Definition Classes: OAuth2ClientOptions → HttpClientOptions

def setProtocolVersion(value: HttpVersion): OAuth2ClientOptions

Set the protocol version.

Definition Classes: OAuth2ClientOptions → HttpClientOptions

def setProxyOptions(value: ProxyOptions): OAuth2ClientOptions

Set proxy options for connections via CONNECT proxy (e.g.

Set proxy options for connections via CONNECT proxy (e.g. Squid) or a SOCKS proxy.

Definition Classes: OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase

def setPubSecKeys(value: Buffer[PubSecKeyOptions]): OAuth2ClientOptions

def setReceiveBufferSize(value: Int): OAuth2ClientOptions

Set the TCP receive buffer size

Definition Classes: OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions

def setReuseAddress(value: Boolean): OAuth2ClientOptions

Set the value of reuse address

Definition Classes: OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions

def setReusePort(value: Boolean): OAuth2ClientOptions

Set the value of reuse port.

This is only supported by native transports.

Definition Classes: OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions

def setRevocationPath(value: String): OAuth2ClientOptions

Set the Oauth2 revocation resource path.

Set the Oauth2 revocation resource path. e.g.: /oauth/revoke

def setScopeSeparator(value: String): OAuth2ClientOptions

Set the provider scope separator

def setSendBufferSize(value: Int): OAuth2ClientOptions

Set the TCP send buffer size

Definition Classes: OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions

def setSendUnmaskedFrames(value: Boolean): OAuth2ClientOptions

Set true when the client wants to skip frame masking.

Set true when the client wants to skip frame masking. You may want to set it true on server by server websocket communication: In this case you are by passing RFC6455 protocol. It's false as default.