public class OAuth2ClientOptions extends HttpClientOptions
HttpClient will make connections.DEFAULT_ALPN_VERSIONS, DEFAULT_DECODER_INITIAL_BUFFER_SIZE, DEFAULT_DEFAULT_HOST, DEFAULT_DEFAULT_PORT, DEFAULT_FORCE_SNI, DEFAULT_HTTP2_CLEAR_TEXT_UPGRADE, DEFAULT_HTTP2_CONNECTION_WINDOW_SIZE, DEFAULT_HTTP2_MAX_POOL_SIZE, DEFAULT_HTTP2_MULTIPLEXING_LIMIT, DEFAULT_KEEP_ALIVE, DEFAULT_MAX_CHUNK_SIZE, DEFAULT_MAX_HEADER_SIZE, DEFAULT_MAX_INITIAL_LINE_LENGTH, DEFAULT_MAX_POOL_SIZE, DEFAULT_MAX_REDIRECTS, DEFAULT_MAX_WAIT_QUEUE_SIZE, DEFAULT_MAX_WEBSOCKET_FRAME_SIZE, DEFAULT_MAX_WEBSOCKET_MESSAGE_SIZE, DEFAULT_PIPELINING, DEFAULT_PIPELINING_LIMIT, DEFAULT_PROTOCOL_VERSION, DEFAULT_SEND_UNMASKED_FRAMES, DEFAULT_TRY_USE_COMPRESSION, DEFAULT_VERIFY_HOSTDEFAULT_CONNECT_TIMEOUT, DEFAULT_METRICS_NAME, DEFAULT_TRUST_ALLDEFAULT_IDLE_TIMEOUT, DEFAULT_SO_LINGER, DEFAULT_SSL, DEFAULT_SSL_ENGINE, DEFAULT_TCP_CORK, DEFAULT_TCP_FAST_OPEN, DEFAULT_TCP_KEEP_ALIVE, DEFAULT_TCP_NO_DELAY, DEFAULT_TCP_QUICKACK, DEFAULT_USE_ALPN, DEFAULT_USE_POOLED_BUFFERSDEFAULT_LOG_ENABLED, DEFAULT_RECEIVE_BUFFER_SIZE, DEFAULT_REUSE_ADDRESS, DEFAULT_REUSE_PORT, DEFAULT_SEND_BUFFER_SIZE, DEFAULT_TRAFFIC_CLASS| Constructor and Description |
|---|
OAuth2ClientOptions()
Default constructor
|
OAuth2ClientOptions(HttpClientOptions other)
Copy constructor
|
OAuth2ClientOptions(JsonObject json)
Constructor to create an options from JSON
|
OAuth2ClientOptions(OAuth2ClientOptions other)
Copy constructor
|
| Modifier and Type | Method and Description |
|---|---|
String |
getAuthorizationPath()
Get the Oauth2 authorization resource path.
|
String |
getClientID()
Get the provider client id
|
String |
getClientSecret()
Get the provider client secret
|
String |
getClientSecretParameterName()
When a provider uses a non standard HTTP form field name, the client secret can be overriden here.
|
JsonObject |
getExtraParameters()
Extra parameters to send to the provider
|
JsonObject |
getHeaders()
Custom headers to send along with every request.
|
String |
getIntrospectionPath()
The provider token introspection resource path
|
String |
getLogoutPath()
The provider logout path
|
PubSecKeyOptions |
getPubSecKey()
The provider PubSec key options
|
String |
getRevocationPath()
Get the Oauth2 revocation resource path.
|
String |
getScopeSeparator()
Set the provider scope separator
|
String |
getSite() |
String |
getTokenPath()
Get the Oauth2 token resource path.
|
String |
getUserAgent()
The User-Agent header to use when communicating with a provider
|
JsonObject |
getUserInfoParameters()
Set the provider custom userInfo parameters to send when requesting them.
|
String |
getUserInfoPath()
The provider userInfo resource path
|
boolean |
isJwtToken()
Flag if this provider returns tokens in JWT format
|
boolean |
isUseBasicAuthorizationHeader()
Flag to use HTTP basic auth header with client id, client secret.
|
OAuth2ClientOptions |
setAuthorizationPath(String authorizationPath) |
OAuth2ClientOptions |
setClientID(String clientID)
Set the provider client id
|
OAuth2ClientOptions |
setClientSecret(String clientSecret)
Set the provider client secret
|
OAuth2ClientOptions |
setClientSecretParameterName(String clientSecretParameterName)
Override the HTTP form field name for client secret
|
OAuth2ClientOptions |
setExtraParameters(JsonObject extraParams)
Set extra parameters to be sent to the provider on each request
|
OAuth2ClientOptions |
setHeaders(JsonObject headers)
Set custom headers to be sent with every request to the provider
|
OAuth2ClientOptions |
setIntrospectionPath(String introspectionPath)
Set the provider token introspection resource path
|
OAuth2ClientOptions |
setJwtToken(boolean jwtToken)
Signal that this provider tokens are in JWT format
|
OAuth2ClientOptions |
setLogoutPath(String logoutPath)
Set the provider logout path
|
OAuth2ClientOptions |
setPubSecKeyOptions(PubSecKeyOptions pubSecKey) |
OAuth2ClientOptions |
setRevocationPath(String revocationPath)
Set the Oauth2 revocation resource path.
|
OAuth2ClientOptions |
setScopeSeparator(String scopeSeparator)
Set the provider scope separator
|
OAuth2ClientOptions |
setSite(String site)
Root URL for the provider
|
OAuth2ClientOptions |
setTokenPath(String tokenPath) |
OAuth2ClientOptions |
setUseBasicAuthorizationHeader(boolean useBasicAuthorizationHeader)
Flag to use HTTP basic auth header with client id, client secret.
|
OAuth2ClientOptions |
setUserAgent(String userAgent)
Set a custom user agent to use when communicating to a provider
|
OAuth2ClientOptions |
setUserInfoParameters(JsonObject userInfoParams)
Set custom parameters to be sent during the userInfo resource request
|
OAuth2ClientOptions |
setUserInfoPath(String userInfoPath)
Set the provider userInfo resource path
|
addCrlPath, addCrlValue, addEnabledCipherSuite, addEnabledSecureTransportProtocol, equals, getAlpnVersions, getDecoderInitialBufferSize, getDefaultHost, getDefaultPort, getHttp2ConnectionWindowSize, getHttp2MaxPoolSize, getHttp2MultiplexingLimit, getInitialSettings, getMaxChunkSize, getMaxHeaderSize, getMaxInitialLineLength, getMaxPoolSize, getMaxRedirects, getMaxWaitQueueSize, getMaxWebsocketFrameSize, getMaxWebsocketMessageSize, getPipeliningLimit, getProtocolVersion, hashCode, isForceSni, isHttp2ClearTextUpgrade, isKeepAlive, isPipelining, isSendUnmaskedFrames, isTryUseCompression, isVerifyHost, setAlpnVersions, setConnectTimeout, setDecoderInitialBufferSize, setDefaultHost, setDefaultPort, setForceSni, setHttp2ClearTextUpgrade, setHttp2ConnectionWindowSize, setHttp2MaxPoolSize, setHttp2MultiplexingLimit, setIdleTimeout, setInitialSettings, setJdkSslEngineOptions, setKeepAlive, setKeyCertOptions, setKeyStoreOptions, setLocalAddress, setLogActivity, setMaxChunkSize, setMaxHeaderSize, setMaxInitialLineLength, setMaxPoolSize, setMaxRedirects, setMaxWaitQueueSize, setMaxWebsocketFrameSize, setMaxWebsocketMessageSize, setMetricsName, setOpenSslEngineOptions, setPemKeyCertOptions, setPemTrustOptions, setPfxKeyCertOptions, setPfxTrustOptions, setPipelining, setPipeliningLimit, setProtocolVersion, setProxyOptions, setReceiveBufferSize, setReuseAddress, setReusePort, setSendBufferSize, setSendUnmaskedFrames, setSoLinger, setSsl, setSslEngineOptions, setTcpCork, setTcpFastOpen, setTcpKeepAlive, setTcpNoDelay, setTcpQuickAck, setTrafficClass, setTrustAll, setTrustOptions, setTrustStoreOptions, setTryUseCompression, setUseAlpn, setUsePooledBuffers, setVerifyHost, toJsongetConnectTimeout, getLocalAddress, getMetricsName, getProxyOptions, isTrustAllgetCrlPaths, getCrlValues, getEnabledCipherSuites, getEnabledSecureTransportProtocols, getIdleTimeout, getJdkSslEngineOptions, getKeyCertOptions, getKeyStoreOptions, getOpenSslEngineOptions, getPemKeyCertOptions, getPemTrustOptions, getPfxKeyCertOptions, getPfxTrustOptions, getSoLinger, getSslEngineOptions, getTrustOptions, getTrustStoreOptions, isSsl, isTcpCork, isTcpFastOpen, isTcpKeepAlive, isTcpNoDelay, isTcpQuickAck, isUseAlpn, isUsePooledBuffersgetLogActivity, getReceiveBufferSize, getSendBufferSize, getTrafficClass, isReuseAddress, isReusePortpublic OAuth2ClientOptions()
public OAuth2ClientOptions(HttpClientOptions other)
other - the options to copypublic OAuth2ClientOptions(OAuth2ClientOptions other)
other - the options to copypublic OAuth2ClientOptions(JsonObject json)
json - the JSONpublic String getSite()
public String getAuthorizationPath()
public OAuth2ClientOptions setAuthorizationPath(String authorizationPath)
public String getTokenPath()
public OAuth2ClientOptions setTokenPath(String tokenPath)
public String getRevocationPath()
public OAuth2ClientOptions setRevocationPath(String revocationPath)
public boolean isUseBasicAuthorizationHeader()
public OAuth2ClientOptions setUseBasicAuthorizationHeader(boolean useBasicAuthorizationHeader)
public String getClientSecretParameterName()
public OAuth2ClientOptions setClientSecretParameterName(String clientSecretParameterName)
clientSecretParameterName - the new nmepublic OAuth2ClientOptions setSite(String site)
site - a urlpublic String getClientID()
public OAuth2ClientOptions setClientID(String clientID)
clientID - client idpublic String getClientSecret()
public OAuth2ClientOptions setClientSecret(String clientSecret)
clientSecret - client secretpublic String getUserAgent()
public OAuth2ClientOptions setUserAgent(String userAgent)
userAgent - the user agentpublic JsonObject getHeaders()
public OAuth2ClientOptions setHeaders(JsonObject headers)
headers - the headerspublic PubSecKeyOptions getPubSecKey()
public OAuth2ClientOptions setPubSecKeyOptions(PubSecKeyOptions pubSecKey)
public boolean isJwtToken()
public OAuth2ClientOptions setJwtToken(boolean jwtToken)
jwtToken - true or falsepublic String getLogoutPath()
public OAuth2ClientOptions setLogoutPath(String logoutPath)
logoutPath - a logout resource pathpublic String getUserInfoPath()
public OAuth2ClientOptions setUserInfoPath(String userInfoPath)
userInfoPath - a resource pathpublic String getScopeSeparator()
public OAuth2ClientOptions setScopeSeparator(String scopeSeparator)
scopeSeparator - a separator e.g.: ' ', '+', ','public JsonObject getExtraParameters()
public OAuth2ClientOptions setExtraParameters(JsonObject extraParams)
extraParams - a json representation of the parameterspublic String getIntrospectionPath()
public OAuth2ClientOptions setIntrospectionPath(String introspectionPath)
introspectionPath - a resource pathpublic JsonObject getUserInfoParameters()
public OAuth2ClientOptions setUserInfoParameters(JsonObject userInfoParams)
userInfoParams - json representation of the parametersCopyright © 2017. All rights reserved.