Packages

class OAuth2ClientOptions extends HttpClientOptions

Options describing how an OAuth2 will make connections.

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
    OAuth2ClientOptionsHttpClientOptionsClientOptionsBaseTCPSSLOptions
  5. def addCrlValue(value: Buffer): OAuth2ClientOptions

    Add a CRL value

    Add a CRL value

    Definition Classes
    OAuth2ClientOptionsHttpClientOptionsClientOptionsBaseTCPSSLOptions
  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
    OAuth2ClientOptionsHttpClientOptionsClientOptionsBaseTCPSSLOptions
  7. def addEnabledSecureTransportProtocol(value: String): OAuth2ClientOptions

    Add an enabled SSL/TLS protocols, appended to the ordered protocols.

    Add an enabled SSL/TLS protocols, appended to the ordered protocols.

    Definition Classes
    OAuth2ClientOptionsHttpClientOptionsClientOptionsBaseTCPSSLOptions
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def asJava: ext.auth.oauth2.OAuth2ClientOptions
    Definition Classes
    OAuth2ClientOptionsHttpClientOptions
  10. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  13. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. def getAlpnVersions: Buffer[HttpVersion]
    Definition Classes
    OAuth2ClientOptionsHttpClientOptions
  15. def getAuthorizationPath: String
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  17. def getClientID: String
  18. def getClientSecret: String
  19. def getClientSecretParameterName: String
  20. def getConnectTimeout: Int
  21. def getCrlPaths: Buffer[String]
  22. def getCrlValues: Buffer[Buffer]
  23. def getDefaultHost: String
    Definition Classes
    OAuth2ClientOptionsHttpClientOptions
  24. def getDefaultPort: Int
    Definition Classes
    OAuth2ClientOptionsHttpClientOptions
  25. def getEnabledCipherSuites: Set[String]
  26. def getEnabledSecureTransportProtocols: Set[String]
  27. def getExtraParameters: JsonObject
  28. def getHeaders: JsonObject
  29. def getHttp2ConnectionWindowSize: Int
    Definition Classes
    OAuth2ClientOptionsHttpClientOptions
  30. def getHttp2MaxPoolSize: Int
    Definition Classes
    OAuth2ClientOptionsHttpClientOptions
  31. def getHttp2MultiplexingLimit: Int
    Definition Classes
    OAuth2ClientOptionsHttpClientOptions
  32. def getIdleTimeout: Int
  33. def getInitialSettings: Http2Settings
    Definition Classes
    OAuth2ClientOptionsHttpClientOptions
  34. def getIntrospectionPath: String
  35. def getJdkSslEngineOptions: JdkSSLEngineOptions
  36. def getKeyStoreOptions: JksOptions
  37. def getLocalAddress: String
  38. def getLogActivity: Boolean
  39. def getLogoutPath: String
  40. def getMaxChunkSize: Int
    Definition Classes
    OAuth2ClientOptionsHttpClientOptions
  41. def getMaxHeaderSize: Int
    Definition Classes
    OAuth2ClientOptionsHttpClientOptions
  42. def getMaxInitialLineLength: Int
    Definition Classes
    OAuth2ClientOptionsHttpClientOptions
  43. def getMaxPoolSize: Int
    Definition Classes
    OAuth2ClientOptionsHttpClientOptions
  44. def getMaxRedirects: Int
    Definition Classes
    OAuth2ClientOptionsHttpClientOptions
  45. def getMaxWaitQueueSize: Int
    Definition Classes
    OAuth2ClientOptionsHttpClientOptions
  46. def getMaxWebsocketFrameSize: Int
    Definition Classes
    OAuth2ClientOptionsHttpClientOptions
  47. def getMaxWebsocketMessageSize: Int
    Definition Classes
    OAuth2ClientOptionsHttpClientOptions
  48. def getMetricsName: String
  49. def getOpenSslEngineOptions: OpenSSLEngineOptions
  50. def getPemKeyCertOptions: PemKeyCertOptions
  51. def getPemTrustOptions: PemTrustOptions
  52. def getPfxKeyCertOptions: PfxOptions
  53. def getPfxTrustOptions: PfxOptions
  54. def getPipeliningLimit: Int
    Definition Classes
    OAuth2ClientOptionsHttpClientOptions
  55. def getPrivateKey: String
  56. def getProtocolVersion: HttpVersion
    Definition Classes
    OAuth2ClientOptionsHttpClientOptions
  57. def getProxyOptions: ProxyOptions
  58. def getPublicKey: String
  59. def getReceiveBufferSize: Int
  60. def getRevocationPath: String
  61. def getScopeSeparator: String
  62. def getSendBufferSize: Int
  63. def getSite: String
  64. def getSoLinger: Int
  65. def getTokenPath: String
  66. def getTrafficClass: Int
  67. def getTrustStoreOptions: JksOptions
  68. def getUserAgent: String
  69. def getUserInfoPath: String
  70. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  71. def isHttp2ClearTextUpgrade: Boolean
    Definition Classes
    OAuth2ClientOptionsHttpClientOptions
  72. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  73. def isJwtToken: Boolean
  74. def isKeepAlive: Boolean
    Definition Classes
    OAuth2ClientOptionsHttpClientOptions
  75. def isPipelining: Boolean
    Definition Classes
    OAuth2ClientOptionsHttpClientOptions
  76. def isReuseAddress: Boolean
  77. def isSendUnmaskedFrames: Boolean
    Definition Classes
    OAuth2ClientOptionsHttpClientOptions
  78. def isSsl: Boolean
  79. def isTcpKeepAlive: Boolean
  80. def isTcpNoDelay: Boolean
  81. def isTrustAll: Boolean
  82. def isTryUseCompression: Boolean
    Definition Classes
    OAuth2ClientOptionsHttpClientOptions
  83. def isUseAlpn: Boolean
  84. def isUseBasicAuthorizationHeader: Boolean
  85. def isUsePooledBuffers: Boolean
  86. def isVerifyHost: Boolean
    Definition Classes
    OAuth2ClientOptionsHttpClientOptions
  87. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  88. final def notify(): Unit
    Definition Classes
    AnyRef
  89. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  90. 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:

    Definition Classes
    OAuth2ClientOptionsHttpClientOptions
  91. def setAuthorizationPath(value: String): OAuth2ClientOptions
  92. def setClientID(value: String): OAuth2ClientOptions
  93. def setClientSecret(value: String): OAuth2ClientOptions
  94. def setClientSecretParameterName(value: String): OAuth2ClientOptions
  95. def setConnectTimeout(value: Int): OAuth2ClientOptions

    Set the connect timeout

    Set the connect timeout

    Definition Classes
    OAuth2ClientOptionsHttpClientOptionsClientOptionsBase
  96. 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
    OAuth2ClientOptionsHttpClientOptions
  97. 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
    OAuth2ClientOptionsHttpClientOptions
  98. def setExtraParameters(value: JsonObject): OAuth2ClientOptions
  99. def setHeaders(value: JsonObject): OAuth2ClientOptions
  100. 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
    OAuth2ClientOptionsHttpClientOptions
  101. 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
    OAuth2ClientOptionsHttpClientOptions
  102. 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
    OAuth2ClientOptionsHttpClientOptions
  103. 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
    OAuth2ClientOptionsHttpClientOptions
  104. def setIdleTimeout(value: Int): OAuth2ClientOptions

    Set the idle timeout, in seconds.

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

    Definition Classes
    OAuth2ClientOptionsHttpClientOptionsClientOptionsBaseTCPSSLOptions
  105. 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
    OAuth2ClientOptionsHttpClientOptions
  106. def setIntrospectionPath(value: String): OAuth2ClientOptions
  107. def setJdkSslEngineOptions(value: JdkSSLEngineOptions): OAuth2ClientOptions
  108. def setJwtToken(value: Boolean): OAuth2ClientOptions
  109. 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
    OAuth2ClientOptionsHttpClientOptions
  110. 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
    OAuth2ClientOptionsHttpClientOptionsClientOptionsBaseTCPSSLOptions
  111. 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
    OAuth2ClientOptionsHttpClientOptionsClientOptionsBase
  112. 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
    OAuth2ClientOptionsHttpClientOptionsClientOptionsBaseTCPSSLOptionsNetworkOptions
  113. def setLogoutPath(value: String): OAuth2ClientOptions
  114. def setMaxChunkSize(value: Int): OAuth2ClientOptions

    Set the maximum HTTP chunk size

    Set the maximum HTTP chunk size

    Definition Classes
    OAuth2ClientOptionsHttpClientOptions
  115. 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
    OAuth2ClientOptionsHttpClientOptions
  116. 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
    OAuth2ClientOptionsHttpClientOptions
  117. def setMaxPoolSize(value: Int): OAuth2ClientOptions

    Set the maximum pool size for connections

    Set the maximum pool size for connections

    Definition Classes
    OAuth2ClientOptionsHttpClientOptions
  118. 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
    OAuth2ClientOptionsHttpClientOptions
  119. 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
    OAuth2ClientOptionsHttpClientOptions
  120. def setMaxWebsocketFrameSize(value: Int): OAuth2ClientOptions

    Set the max websocket frame size

    Set the max websocket frame size

    Definition Classes
    OAuth2ClientOptionsHttpClientOptions
  121. def setMaxWebsocketMessageSize(value: Int): OAuth2ClientOptions

    Set the max websocket message size

    Set the max websocket message size

    Definition Classes
    OAuth2ClientOptionsHttpClientOptions
  122. 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
    OAuth2ClientOptionsHttpClientOptionsClientOptionsBase
  123. def setOpenSslEngineOptions(value: OpenSSLEngineOptions): OAuth2ClientOptions
  124. 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
    OAuth2ClientOptionsHttpClientOptionsClientOptionsBaseTCPSSLOptions
  125. def setPemTrustOptions(value: PemTrustOptions): OAuth2ClientOptions

    Set the trust options in pem format

    Set the trust options in pem format

    Definition Classes
    OAuth2ClientOptionsHttpClientOptionsClientOptionsBaseTCPSSLOptions
  126. def setPfxKeyCertOptions(value: PfxOptions): OAuth2ClientOptions

    Set the key/cert options in pfx format.

    Set the key/cert options in pfx format.

    Definition Classes
    OAuth2ClientOptionsHttpClientOptionsClientOptionsBaseTCPSSLOptions
  127. def setPfxTrustOptions(value: PfxOptions): OAuth2ClientOptions

    Set the trust options in pfx format

    Set the trust options in pfx format

    Definition Classes
    OAuth2ClientOptionsHttpClientOptionsClientOptionsBaseTCPSSLOptions
  128. 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
    OAuth2ClientOptionsHttpClientOptions
  129. 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
    OAuth2ClientOptionsHttpClientOptions
  130. def setPrivateKey(value: String): OAuth2ClientOptions
  131. def setProtocolVersion(value: HttpVersion): OAuth2ClientOptions

    Set the protocol version.

    Set the protocol version.

    Definition Classes
    OAuth2ClientOptionsHttpClientOptions
  132. 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
    OAuth2ClientOptionsHttpClientOptionsClientOptionsBase
  133. def setPublicKey(value: String): OAuth2ClientOptions
  134. def setReceiveBufferSize(value: Int): OAuth2ClientOptions

    Set the TCP receive buffer size

    Set the TCP receive buffer size

    Definition Classes
    OAuth2ClientOptionsHttpClientOptionsClientOptionsBaseTCPSSLOptionsNetworkOptions
  135. def setReuseAddress(value: Boolean): OAuth2ClientOptions

    Set the value of reuse address

    Set the value of reuse address

    Definition Classes
    OAuth2ClientOptionsHttpClientOptionsClientOptionsBaseTCPSSLOptionsNetworkOptions
  136. def setRevocationPath(value: String): OAuth2ClientOptions
  137. def setScopeSeparator(value: String): OAuth2ClientOptions
  138. def setSendBufferSize(value: Int): OAuth2ClientOptions

    Set the TCP send buffer size

    Set the TCP send buffer size

    Definition Classes
    OAuth2ClientOptionsHttpClientOptionsClientOptionsBaseTCPSSLOptionsNetworkOptions
  139. 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
    OAuth2ClientOptionsHttpClientOptions
  140. def setSite(value: String): OAuth2ClientOptions
  141. def setSoLinger(value: Int): OAuth2ClientOptions

    Set whether SO_linger keep alive is enabled

    Set whether SO_linger keep alive is enabled

    Definition Classes
    OAuth2ClientOptionsHttpClientOptionsClientOptionsBaseTCPSSLOptions
  142. def setSsl(value: Boolean): OAuth2ClientOptions

    Set whether SSL/TLS is enabled

    Set whether SSL/TLS is enabled

    Definition Classes
    OAuth2ClientOptionsHttpClientOptionsClientOptionsBaseTCPSSLOptions
  143. def setTcpKeepAlive(value: Boolean): OAuth2ClientOptions

    Set whether TCP keep alive is enabled

    Set whether TCP keep alive is enabled

    Definition Classes
    OAuth2ClientOptionsHttpClientOptionsClientOptionsBaseTCPSSLOptions
  144. def setTcpNoDelay(value: Boolean): OAuth2ClientOptions

    Set whether TCP no delay is enabled

    Set whether TCP no delay is enabled

    Definition Classes
    OAuth2ClientOptionsHttpClientOptionsClientOptionsBaseTCPSSLOptions
  145. def setTokenPath(value: String): OAuth2ClientOptions
  146. def setTrafficClass(value: Int): OAuth2ClientOptions

    Set the value of traffic class

    Set the value of traffic class

    Definition Classes
    OAuth2ClientOptionsHttpClientOptionsClientOptionsBaseTCPSSLOptionsNetworkOptions
  147. def setTrustAll(value: Boolean): OAuth2ClientOptions

    Set whether all server certificates should be trusted

    Set whether all server certificates should be trusted

    Definition Classes
    OAuth2ClientOptionsHttpClientOptionsClientOptionsBase
  148. 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
    OAuth2ClientOptionsHttpClientOptionsClientOptionsBaseTCPSSLOptions
  149. def setTryUseCompression(value: Boolean): OAuth2ClientOptions

    Set whether compression is enabled

    Set whether compression is enabled

    Definition Classes
    OAuth2ClientOptionsHttpClientOptions
  150. def setUseAlpn(value: Boolean): OAuth2ClientOptions

    Set the ALPN usage.

    Set the ALPN usage.

    Definition Classes
    OAuth2ClientOptionsHttpClientOptionsClientOptionsBaseTCPSSLOptions
  151. def setUseBasicAuthorizationHeader(value: Boolean): OAuth2ClientOptions
  152. def setUsePooledBuffers(value: Boolean): OAuth2ClientOptions

    Set whether Netty pooled buffers are enabled

    Set whether Netty pooled buffers are enabled

    Definition Classes
    OAuth2ClientOptionsHttpClientOptionsClientOptionsBaseTCPSSLOptions
  153. def setUserAgent(value: String): OAuth2ClientOptions
  154. def setUserInfoPath(value: String): OAuth2ClientOptions
  155. def setVerifyHost(value: Boolean): OAuth2ClientOptions

    Set whether hostname verification is enabled

    Set whether hostname verification is enabled

    Definition Classes
    OAuth2ClientOptionsHttpClientOptions
  156. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  157. def toString(): String
    Definition Classes
    AnyRef → Any
  158. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  159. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  160. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from HttpClientOptions

Inherited from ClientOptionsBase

Inherited from TCPSSLOptions

Inherited from NetworkOptions

Inherited from AnyRef

Inherited from Any

Ungrouped