vertx-lang-scala-docs_2.12 3.6.0.CR2 API < Back
 

# Packages

-  package root
  Definition Classes
    root
-  package io
  Definition Classes
    root
-  package vertx
  Definition Classes
    io
-  package scala
  Definition Classes
    vertx
-  package ext
  Definition Classes
    scala
-  package auth
  Definition Classes
    ext
-  package oauth2
  Definition Classes
    auth
-  package providers
  Definition Classes
    oauth2
-  package rbac
  Definition Classes
    oauth2
- AccessToken
- KeycloakHelper
- OAuth2Auth
- OAuth2ClientOptions
- OAuth2RBAC
- OAuth2Response

c

io.vertx.scala.ext.auth.oauth2

# OAuth2ClientOptions 

###
Companion object OAuth2ClientOptions

#### class OAuth2ClientOptions extends HttpClientOptions

Options describing how an OAuth2 will make connections.

Linear Supertypes
HttpClientOptions, ClientOptionsBase, TCPSSLOptions, NetworkOptions, AnyRef, Any
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. OAuth2ClientOptions
2. HttpClientOptions
3. ClientOptionsBase
4. TCPSSLOptions
5. NetworkOptions
6. AnyRef
7. Any

1. Hide All
2. Show All

Visibility

1. Public
2. All

### Instance Constructors

1.  new OAuth2ClientOptions(_asJava: ext.auth.oauth2.OAuth2ClientOptions)

### Value Members

1.  final def !=(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
2.  final def ##(): Int
   Definition Classes
     AnyRef → Any
3.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
4.  def addCrlPath(value: String): OAuth2ClientOptions

   Add a CRL path

   Add a CRL path

   Definition Classes
     OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions
5.  def addCrlValue(value: Buffer): OAuth2ClientOptions

   Add a CRL value

   Add a CRL value

   Definition Classes
     OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions
6.  def addEnabledCipherSuite(value: String): OAuth2ClientOptions

   Add an enabled cipher suite, appended to the ordered suites.

   Add an enabled cipher suite, appended to the ordered suites.

   Definition Classes
     OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions
7.  def addEnabledSecureTransportProtocol(value: String): OAuth2ClientOptions

   Sets the list of enabled SSL/TLS protocols.

   Sets the list of enabled SSL/TLS protocols.

   Definition Classes
     OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions
8.  def addPubSecKey(value: PubSecKeyOptions): OAuth2ClientOptions

   The provider PubSec key options

9.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
10.  def asJava: ext.auth.oauth2.OAuth2ClientOptions
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions
11.  def clone(): AnyRef
    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @native() @throws( ... )
12.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
13.  def equals(arg0: Any): Boolean
    Definition Classes
      AnyRef → Any
14.  def finalize(): Unit
    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( classOf[java.lang.Throwable] )
15.  def getAlpnVersions: Buffer[HttpVersion]
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions
16.  def getAuthorizationPath: String
17.  final def getClass(): Class[_]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
18.  def getClientID: String
19.  def getClientSecret: String
20.  def getClientSecretParameterName: String
21.  def getConnectTimeout: Int
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase
22.  def getCrlPaths: Buffer[String]
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions
23.  def getCrlValues: Buffer[Buffer]
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions
24.  def getDecoderInitialBufferSize: Int
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions
25.  def getDefaultHost: String
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions
26.  def getDefaultPort: Int
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions
27.  def getEnabledCipherSuites: Set[String]
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions
28.  def getEnabledSecureTransportProtocols: Set[String]
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions
29.  def getExtraParameters: JsonObject
30.  def getFlow: OAuth2FlowType
31.  def getHeaders: JsonObject
32.  def getHttp2ConnectionWindowSize: Int
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions
33.  def getHttp2KeepAliveTimeout: Int
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions
34.  def getHttp2MaxPoolSize: Int
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions
35.  def getHttp2MultiplexingLimit: Int
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions
36.  def getIdleTimeout: Int
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions
37.  def getIdleTimeoutUnit: TimeUnit
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions
38.  def getInitialSettings: Http2Settings
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions
39.  def getIntrospectionPath: String
40.  def getJWTOptions: JWTOptions
41.  def getJdkSslEngineOptions: JdkSSLEngineOptions
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions
42.  def getJwkPath: String
43.  def getKeepAliveTimeout: Int
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions
44.  def getKeyStoreOptions: JksOptions
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions
45.  def getLocalAddress: String
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase
46.  def getLogActivity: Boolean
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
47.  def getLogoutPath: String
48.  def getMaxChunkSize: Int
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions
49.  def getMaxHeaderSize: Int
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions
50.  def getMaxInitialLineLength: Int
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions
51.  def getMaxPoolSize: Int
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions
52.  def getMaxRedirects: Int
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions
53.  def getMaxWaitQueueSize: Int
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions
54.  def getMaxWebsocketFrameSize: Int
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions
55.  def getMaxWebsocketMessageSize: Int
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions
56.  def getMetricsName: String
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase
57.  def getOpenSslEngineOptions: OpenSSLEngineOptions
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions
58.  def getPemKeyCertOptions: PemKeyCertOptions
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions
59.  def getPemTrustOptions: PemTrustOptions
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions
60.  def getPfxKeyCertOptions: PfxOptions
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions
61.  def getPfxTrustOptions: PfxOptions
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions
62.  def getPipeliningLimit: Int
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions
63.  def getPoolCleanerPeriod: Int
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions
64.  def getProtocolVersion: HttpVersion
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions
65.  def getProxyOptions: ProxyOptions
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase
66.  def getPubSecKeys: Buffer[PubSecKeyOptions]
67.  def getReceiveBufferSize: Int
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
68.  def getRevocationPath: String
69.  def getScopeSeparator: String
70.  def getSendBufferSize: Int
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
71.  def getSite: String
72.  def getSoLinger: Int
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions
73.  def getTokenPath: String
74.  def getTrafficClass: Int
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
75.  def getTrustStoreOptions: JksOptions
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions
76.  def getUserAgent: String
77.  def getUserInfoParameters: JsonObject
78.  def getUserInfoPath: String
79.  def getWebsocketCompressionAllowClientNoContext: Boolean
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions
80.  def getWebsocketCompressionLevel: Int
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions
81.  def getWebsocketCompressionRequestServerNoContext: Boolean
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions
82.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
83.  def isForceSni: Boolean
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions
84.  def isHttp2ClearTextUpgrade: Boolean
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions
85.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
86.  def isKeepAlive: Boolean
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions
87.  def isPipelining: Boolean
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions
88.  def isReuseAddress: Boolean
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
89.  def isReusePort: Boolean
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
90.  def isSendUnmaskedFrames: Boolean
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions
91.  def isSsl: Boolean
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions
92.  def isTcpCork: Boolean
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions
93.  def isTcpFastOpen: Boolean
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions
94.  def isTcpKeepAlive: Boolean
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions
95.  def isTcpNoDelay: Boolean
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions
96.  def isTcpQuickAck: Boolean
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions
97.  def isTrustAll: Boolean
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase
98.  def isTryUseCompression: Boolean
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions
99.  def isUseAlpn: Boolean
    Definition Classes
      OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions
100.  def isUseBasicAuthorizationHeader: Boolean
101.  def isUsePooledBuffers: Boolean
     Definition Classes
       OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions
102.  def isValidateIssuer: Boolean
103.  def isVerifyHost: Boolean
     Definition Classes
       OAuth2ClientOptions → HttpClientOptions
104.  final def ne(arg0: AnyRef): Boolean
     Definition Classes
       AnyRef
105.  final def notify(): Unit
     Definition Classes
       AnyRef
     Annotations
       @native()
106.  final def notifyAll(): Unit
     Definition Classes
       AnyRef
     Annotations
       @native()
107.  def setAlpnVersions(value: Buffer[HttpVersion]): OAuth2ClientOptions

     Set the list of protocol versions to provide to the server during the Application-Layer Protocol Negotiation.

     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
108.  def setAuthorizationPath(value: String): OAuth2ClientOptions

     Get the Oauth2 authorization resource path.

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

109.  def setClientID(value: String): OAuth2ClientOptions

     Set the provider client id

110.  def setClientSecret(value: String): OAuth2ClientOptions

     Set the provider client secret

111.  def setClientSecretParameterName(value: String): OAuth2ClientOptions

     Override the HTTP form field name for client secret

112.  def setConnectTimeout(value: Int): OAuth2ClientOptions

     Set the connect timeout

     Set the connect timeout

     Definition Classes
       OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase
113.  def setDecoderInitialBufferSize(value: Int): OAuth2ClientOptions

     set to `initialBufferSizeHttpDecoder` the initial buffer of the HttpDecoder.

     set to `initialBufferSizeHttpDecoder` the initial buffer of the HttpDecoder.

     Definition Classes
       OAuth2ClientOptions → HttpClientOptions
114.  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.

     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
115.  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.

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

     Definition Classes
       OAuth2ClientOptions → HttpClientOptions
116.  def setEnabledSecureTransportProtocols(value: Set[String]): OAuth2ClientOptions
     Definition Classes
       OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions
117.  def setExtraParameters(value: JsonObject): OAuth2ClientOptions

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

118.  def setFlow(value: OAuth2FlowType): OAuth2ClientOptions
119.  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.

     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
120.  def setHeaders(value: JsonObject): OAuth2ClientOptions

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

121.  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).

     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
122.  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
123.  def setHttp2KeepAliveTimeout(value: Int): OAuth2ClientOptions

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

     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
124.  def setHttp2MaxPoolSize(value: Int): OAuth2ClientOptions

     Set the maximum pool size for HTTP/2 connections

     Set the maximum pool size for HTTP/2 connections

     Definition Classes
       OAuth2ClientOptions → HttpClientOptions
125.  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
126.  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
127.  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
128.  def setInitialSettings(value: Http2Settings): OAuth2ClientOptions

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

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

     Definition Classes
       OAuth2ClientOptions → HttpClientOptions
129.  def setIntrospectionPath(value: String): OAuth2ClientOptions

     Set the provider token introspection resource path

130.  def setJWTOptions(value: JWTOptions): OAuth2ClientOptions
131.  def setJdkSslEngineOptions(value: JdkSSLEngineOptions): OAuth2ClientOptions
     Definition Classes
       OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions
132.  def setJwkPath(value: String): OAuth2ClientOptions
133.  def setKeepAlive(value: Boolean): OAuth2ClientOptions

     Set whether keep alive is enabled on the client

     Set whether keep alive is enabled on the client

     Definition Classes
       OAuth2ClientOptions → HttpClientOptions
134.  def setKeepAliveTimeout(value: Int): OAuth2ClientOptions

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

     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
135.  def setKeyStoreOptions(value: JksOptions): OAuth2ClientOptions

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

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

     Definition Classes
       OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions
136.  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
137.  def setLogActivity(value: Boolean): OAuth2ClientOptions

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

     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
138.  def setLogoutPath(value: String): OAuth2ClientOptions

     Set the provider logout path

139.  def setMaxChunkSize(value: Int): OAuth2ClientOptions

     Set the maximum HTTP chunk size

     Set the maximum HTTP chunk size

     Definition Classes
       OAuth2ClientOptions → HttpClientOptions
140.  def setMaxHeaderSize(value: Int): OAuth2ClientOptions

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

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

     Definition Classes
       OAuth2ClientOptions → HttpClientOptions
141.  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
142.  def setMaxPoolSize(value: Int): OAuth2ClientOptions

     Set the maximum pool size for connections

     Set the maximum pool size for connections

     Definition Classes
       OAuth2ClientOptions → HttpClientOptions
143.  def setMaxRedirects(value: Int): OAuth2ClientOptions

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

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

     Definition Classes
       OAuth2ClientOptions → HttpClientOptions
144.  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
145.  def setMaxWebsocketFrameSize(value: Int): OAuth2ClientOptions

     Set the max websocket frame size

     Set the max websocket frame size

     Definition Classes
       OAuth2ClientOptions → HttpClientOptions
146.  def setMaxWebsocketMessageSize(value: Int): OAuth2ClientOptions

     Set the max websocket message size

     Set the max websocket message size

     Definition Classes
       OAuth2ClientOptions → HttpClientOptions
147.  def setMetricsName(value: String): OAuth2ClientOptions

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

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

     Definition Classes
       OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase
148.  def setOpenSslEngineOptions(value: OpenSSLEngineOptions): OAuth2ClientOptions
     Definition Classes
       OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions
149.  def setPemKeyCertOptions(value: PemKeyCertOptions): OAuth2ClientOptions

     Set the key/cert store options in pem format.

     Set the key/cert store options in pem format.

     Definition Classes
       OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions
150.  def setPemTrustOptions(value: PemTrustOptions): OAuth2ClientOptions

     Set the trust options in pem format

     Set the trust options in pem format

     Definition Classes
       OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions
151.  def setPfxKeyCertOptions(value: PfxOptions): OAuth2ClientOptions

     Set the key/cert options in pfx format.

     Set the key/cert options in pfx format.

     Definition Classes
       OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions
152.  def setPfxTrustOptions(value: PfxOptions): OAuth2ClientOptions

     Set the trust options in pfx format

     Set the trust options in pfx format

     Definition Classes
       OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions
153.  def setPipelining(value: Boolean): OAuth2ClientOptions

     Set whether pipe-lining is enabled on the client

     Set whether pipe-lining is enabled on the client

     Definition Classes
       OAuth2ClientOptions → HttpClientOptions
154.  def setPipeliningLimit(value: Int): OAuth2ClientOptions

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

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

     Definition Classes
       OAuth2ClientOptions → HttpClientOptions
155.  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.

     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
156.  def setProtocolVersion(value: HttpVersion): OAuth2ClientOptions

     Set the protocol version.

     Set the protocol version.

     Definition Classes
       OAuth2ClientOptions → HttpClientOptions
157.  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
158.  def setPubSecKeys(value: Buffer[PubSecKeyOptions]): OAuth2ClientOptions
159.  def setReceiveBufferSize(value: Int): OAuth2ClientOptions

     Set the TCP receive buffer size

     Set the TCP receive buffer size

     Definition Classes
       OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
160.  def setReuseAddress(value: Boolean): OAuth2ClientOptions

     Set the value of reuse address

     Set the value of reuse address

     Definition Classes
       OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
161.  def setReusePort(value: Boolean): OAuth2ClientOptions

     Set the value of reuse port.

     Set the value of reuse port.

     This is only supported by native transports.

     Definition Classes
       OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
162.  def setRevocationPath(value: String): OAuth2ClientOptions

     Set the Oauth2 revocation resource path.

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

163.  def setScopeSeparator(value: String): OAuth2ClientOptions

     Set the provider scope separator

164.  def setSendBufferSize(value: Int): OAuth2ClientOptions

     Set the TCP send buffer size

     Set the TCP send buffer size

     Definition Classes
       OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
165.  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.

     Definition Classes
       OAuth2ClientOptions → HttpClientOptions
166.  def setSite(value: String): OAuth2ClientOptions

     Root URL for the provider

167.  def setSoLinger(value: Int): OAuth2ClientOptions

     Set whether SO_linger keep alive is enabled

     Set whether SO_linger keep alive is enabled

     Definition Classes
       OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions
168.  def setSsl(value: Boolean): OAuth2ClientOptions

     Set whether SSL/TLS is enabled

     Set whether SSL/TLS is enabled

     Definition Classes
       OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions
169.  def setTcpCork(value: Boolean): OAuth2ClientOptions

     Enable the `TCP_CORK` option - only with linux native transport.

     Enable the `TCP_CORK` option - only with linux native transport.

     Definition Classes
       OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions
170.  def setTcpFastOpen(value: Boolean): OAuth2ClientOptions

     Enable the `TCP_FASTOPEN` option - only with linux native transport.

     Enable the `TCP_FASTOPEN` option - only with linux native transport.

     Definition Classes
       OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions
171.  def setTcpKeepAlive(value: Boolean): OAuth2ClientOptions

     Set whether TCP keep alive is enabled

     Set whether TCP keep alive is enabled

     Definition Classes
       OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions
172.  def setTcpNoDelay(value: Boolean): OAuth2ClientOptions

     Set whether TCP no delay is enabled

     Set whether TCP no delay is enabled

     Definition Classes
       OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions
173.  def setTcpQuickAck(value: Boolean): OAuth2ClientOptions

     Enable the `TCP_QUICKACK` option - only with linux native transport.

     Enable the `TCP_QUICKACK` option - only with linux native transport.

     Definition Classes
       OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions
174.  def setTokenPath(value: String): OAuth2ClientOptions

     Get the Oauth2 token resource path.

     Get the Oauth2 token resource path. e.g.: /oauth/token

175.  def setTrafficClass(value: Int): OAuth2ClientOptions

     Set the value of traffic class

     Set the value of traffic class

     Definition Classes
       OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
176.  def setTrustAll(value: Boolean): OAuth2ClientOptions

     Set whether all server certificates should be trusted

     Set whether all server certificates should be trusted

     Definition Classes
       OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase
177.  def setTrustStoreOptions(value: JksOptions): OAuth2ClientOptions

     Set the trust options in jks format, aka Java truststore

     Set the trust options in jks format, aka Java truststore

     Definition Classes
       OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions
178.  def setTryUseCompression(value: Boolean): OAuth2ClientOptions

     Set whether compression is enabled

     Set whether compression is enabled

     Definition Classes
       OAuth2ClientOptions → HttpClientOptions
179.  def setTryUsePerFrameWebsocketCompression(value: Boolean): OAuth2ClientOptions

     Set option to offer per frame WebSocket compression.

     Set option to offer per frame WebSocket compression.

     Definition Classes
       OAuth2ClientOptions → HttpClientOptions
180.  def setTryUsePerMessageWebsocketCompression(value: Boolean): OAuth2ClientOptions

     Set option to offer per message WebSocket compression.

     Set option to offer per message WebSocket compression.

     Definition Classes
       OAuth2ClientOptions → HttpClientOptions
181.  def setUseAlpn(value: Boolean): OAuth2ClientOptions

     Set the ALPN usage.

     Set the ALPN usage.

     Definition Classes
       OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions
182.  def setUseBasicAuthorizationHeader(value: Boolean): OAuth2ClientOptions

     Flag to use HTTP basic auth header with client id, client secret.

183.  def setUsePooledBuffers(value: Boolean): OAuth2ClientOptions

     Set whether Netty pooled buffers are enabled

     Set whether Netty pooled buffers are enabled

     Definition Classes
       OAuth2ClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions
184.  def setUserAgent(value: String): OAuth2ClientOptions

     Set a custom user agent to use when communicating to a provider

185.  def setUserInfoParameters(value: JsonObject): OAuth2ClientOptions

     Set custom parameters to be sent during the userInfo resource request

186.  def setUserInfoPath(value: String): OAuth2ClientOptions

     Set the provider userInfo resource path

187.  def setValidateIssuer(value: Boolean): OAuth2ClientOptions
188.  def setVerifyHost(value: Boolean): OAuth2ClientOptions

     Set whether hostname verification is enabled

     Set whether hostname verification is enabled

     Definition Classes
       OAuth2ClientOptions → HttpClientOptions
189.  def setWebsocketCompressionAllowClientNoContext(value: Boolean): OAuth2ClientOptions

     Set the WebSocket compression allow client no context option.

     Set the WebSocket compression allow client no context option.

     Definition Classes
       OAuth2ClientOptions → HttpClientOptions
190.  def setWebsocketCompressionLevel(value: Int): OAuth2ClientOptions

     Set WebSocket compression level

     Set WebSocket compression level

     Definition Classes
       OAuth2ClientOptions → HttpClientOptions
191.  def setWebsocketCompressionRequestServerNoContext(value: Boolean): OAuth2ClientOptions

     Set the WebSocket compression server no context option

     Set the WebSocket compression server no context option

     Definition Classes
       OAuth2ClientOptions → HttpClientOptions
192.  final def synchronized[T0](arg0: ⇒ T0): T0
     Definition Classes
       AnyRef
193.  def toString(): String
     Definition Classes
       AnyRef → Any
194.  final def wait(): Unit
     Definition Classes
       AnyRef
     Annotations
       @throws( ... )
195.  final def wait(arg0: Long, arg1: Int): Unit
     Definition Classes
       AnyRef
     Annotations
       @throws( ... )
196.  final def wait(arg0: Long): Unit
     Definition Classes
       AnyRef
     Annotations
       @native() @throws( ... )

### Inherited from HttpClientOptions

### Inherited from ClientOptionsBase

### Inherited from TCPSSLOptions

### Inherited from NetworkOptions

### Inherited from AnyRef

### Inherited from Any

### Ungrouped