moduleio.vertx.ceylon.auth.oauth23.3.1 (jvm)
io.vertx.ceylon.auth.oauth2
classOAuth2ClientOptions
extends HttpClientOptions
satisfies BaseDataObject
OverviewPackageInitializerAttributesMethods

Options describing how an OAuth2 will make connections.

  • OAuth2ClientOptions
    • BaseDataObject
    • HttpClientOptions
      • BaseDataObject
      • ClientOptionsBase
        • BaseDataObject
        • TCPSSLOptions
          • BaseDataObject
          • NetworkOptions
            • BaseDataObject
            • Basic
              • Identifiable
              • Object
                • Anything

no subtypes hierarchy

Initializer
OAuth2ClientOptions({HttpVersion*}? alpnVersions = null, String? authorizationPath = null, String? clientID = null, String? clientSecret = null, String? clientSecretParameterName = null, Integer? connectTimeout = null, {String*}? crlPaths = null, String? defaultHost = null, Integer? defaultPort = null, {String*}? enabledCipherSuites = null, {String*}? enabledSecureTransportProtocols = null, JsonObject? headers = null, Boolean? http2ClearTextUpgrade = null, Integer? http2ConnectionWindowSize = null, Integer? http2MaxPoolSize = null, Integer? http2MultiplexingLimit = null, Integer? idleTimeout = null, Http2Settings? initialSettings = null, JdkSSLEngineOptions? jdkSslEngineOptions = null, Boolean? jwtToken = null, Boolean? keepAlive = null, JksOptions? keyStoreOptions = null, Boolean? logActivity = null, String? logoutPath = null, Integer? maxChunkSize = null, Integer? maxPoolSize = null, Integer? maxWaitQueueSize = null, Integer? maxWebsocketFrameSize = null, String? metricsName = null, OpenSSLEngineOptions? openSslEngineOptions = null, PemKeyCertOptions? pemKeyCertOptions = null, PemTrustOptions? pemTrustOptions = null, PfxOptions? pfxKeyCertOptions = null, PfxOptions? pfxTrustOptions = null, Boolean? pipelining = null, Integer? pipeliningLimit = null, HttpVersion? protocolVersion = null, ProxyOptions? proxyOptions = null, String? publicKey = null, Integer? receiveBufferSize = null, Boolean? reuseAddress = null, String? revocationPath = null, Integer? sendBufferSize = null, String? site = null, Integer? soLinger = null, Boolean? ssl = null, Boolean? tcpKeepAlive = null, Boolean? tcpNoDelay = null, String? tokenPath = null, Integer? trafficClass = null, Boolean? trustAll = null, JksOptions? trustStoreOptions = null, Boolean? tryUseCompression = null, Boolean? useAlpn = null, Boolean? useBasicAuthorizationHeader = null, Boolean? usePooledBuffers = null, String? userAgent = null, String? userInfoPath = null, Boolean? verifyHost = null)
Parameters:
  • alpnVersions = null
  • authorizationPath = null
  • clientID = null
  • clientSecret = null
  • clientSecretParameterName = null
  • connectTimeout = null
  • crlPaths = null
  • defaultHost = null
  • defaultPort = null
  • enabledCipherSuites = null
  • enabledSecureTransportProtocols = null
  • headers = null
  • http2ClearTextUpgrade = null
  • http2ConnectionWindowSize = null
  • http2MaxPoolSize = null
  • http2MultiplexingLimit = null
  • idleTimeout = null
  • initialSettings = null
  • jdkSslEngineOptions = null
  • jwtToken = null
  • keepAlive = null
  • keyStoreOptions = null
  • logActivity = null
  • logoutPath = null
  • maxChunkSize = null
  • maxPoolSize = null
  • maxWaitQueueSize = null
  • maxWebsocketFrameSize = null
  • metricsName = null
  • openSslEngineOptions = null
  • pemKeyCertOptions = null
  • pemTrustOptions = null
  • pfxKeyCertOptions = null
  • pfxTrustOptions = null
  • pipelining = null
  • pipeliningLimit = null
  • protocolVersion = null
  • proxyOptions = null
  • publicKey = null
  • receiveBufferSize = null
  • reuseAddress = null
  • revocationPath = null
  • sendBufferSize = null
  • site = null
  • soLinger = null
  • ssl = null
  • tcpKeepAlive = null
  • tcpNoDelay = null
  • tokenPath = null
  • trafficClass = null
  • trustAll = null
  • trustStoreOptions = null
  • tryUseCompression = null
  • useAlpn = null
  • useBasicAuthorizationHeader = null
  • usePooledBuffers = null
  • userAgent = null
  • userInfoPath = null
  • verifyHost = null
Attributes
authorizationPathshared String? authorizationPath
clientIDshared String? clientID
clientSecretshared String? clientSecret
clientSecretParameterNameshared String? clientSecretParameterName
headersshared JsonObject? headers
jwtTokenshared Boolean? jwtToken
logoutPathshared String? logoutPath
publicKeyshared String? publicKey
revocationPathshared String? revocationPath
siteshared String? site
tokenPathshared String? tokenPath
useBasicAuthorizationHeadershared Boolean? useBasicAuthorizationHeader
userAgentshared String? userAgent
userInfoPathshared String? userInfoPath
Inherited Attributes
Attributes inherited from: ClientOptionsBase
connectTimeout, metricsName, proxyOptions, trustAll
Attributes inherited from: HttpClientOptions
alpnVersions, defaultHost, defaultPort, http2ClearTextUpgrade, http2ConnectionWindowSize, http2MaxPoolSize, http2MultiplexingLimit, initialSettings, keepAlive, maxChunkSize, maxPoolSize, maxWaitQueueSize, maxWebsocketFrameSize, pipelining, pipeliningLimit, protocolVersion, tryUseCompression, verifyHost
Attributes inherited from: NetworkOptions
logActivity, receiveBufferSize, reuseAddress, sendBufferSize, trafficClass
Attributes inherited from: Object
hash, string
Attributes inherited from: TCPSSLOptions
crlPaths, enabledCipherSuites, enabledSecureTransportProtocols, idleTimeout, jdkSslEngineOptions, keyStoreOptions, openSslEngineOptions, pemKeyCertOptions, pemTrustOptions, pfxKeyCertOptions, pfxTrustOptions, soLinger, ssl, tcpKeepAlive, tcpNoDelay, trustStoreOptions, useAlpn, usePooledBuffers
Methods
toJsonshared actual default JsonObject toJson()
Refines HttpClientOptions.toJson ultimately refines BaseDataObject.toJson
Inherited Methods
Methods inherited from: ClientOptionsBase
toJson
Methods inherited from: HttpClientOptions
toJson
Methods inherited from: NetworkOptions
toJson
Methods inherited from: Object
equals
Methods inherited from: TCPSSLOptions
toJson
Methods inherited from: BaseDataObject
toJson