public class OAuth2Auth extends AuthProvider
AuthProvider
instances.
NOTE: This class has been automatically generated from the original
non RX-ified interface using Vert.x codegen.Modifier and Type | Field and Description |
---|---|
static TypeArg<OAuth2Auth> |
__TYPE_ARG |
Constructor and Description |
---|
OAuth2Auth(io.vertx.ext.auth.oauth2.OAuth2Auth delegate) |
Modifier and Type | Method and Description |
---|---|
String |
authorizeURL(io.vertx.core.json.JsonObject params)
Generate a redirect URL to the authN/Z backend.
|
static OAuth2Auth |
create(Vertx vertx)
Create a OAuth2 auth provider
|
static OAuth2Auth |
create(Vertx vertx,
io.vertx.ext.auth.oauth2.OAuth2ClientOptions config)
Create a OAuth2 auth provider
|
static OAuth2Auth |
create(Vertx vertx,
io.vertx.ext.auth.oauth2.OAuth2FlowType flow)
Deprecated.
|
static OAuth2Auth |
create(Vertx vertx,
io.vertx.ext.auth.oauth2.OAuth2FlowType flow,
io.vertx.ext.auth.oauth2.OAuth2ClientOptions config)
Deprecated.
|
static OAuth2Auth |
createKeycloak(Vertx vertx,
io.vertx.ext.auth.oauth2.OAuth2FlowType flow,
io.vertx.core.json.JsonObject config)
Deprecated.
|
OAuth2Auth |
decodeToken(String token,
io.vertx.core.Handler<io.vertx.core.AsyncResult<AccessToken>> handler)
Deprecated.
|
rx.Observable<AccessToken> |
decodeTokenObservable(String token)
Deprecated.
use
rxDecodeToken(java.lang.String) instead |
boolean |
equals(Object o) |
io.vertx.ext.auth.oauth2.OAuth2Auth |
getDelegate() |
io.vertx.ext.auth.oauth2.OAuth2FlowType |
getFlowType()
Returns the configured flow type for the Oauth2 provider.
|
String |
getScopeSeparator()
Deprecated.
|
void |
getToken(io.vertx.core.json.JsonObject params,
io.vertx.core.Handler<io.vertx.core.AsyncResult<AccessToken>> handler)
Deprecated.
|
rx.Observable<AccessToken> |
getTokenObservable(io.vertx.core.json.JsonObject params)
Deprecated.
use
rxGetToken(io.vertx.core.json.JsonObject) instead |
int |
hashCode() |
OAuth2Auth |
introspectToken(String token,
io.vertx.core.Handler<io.vertx.core.AsyncResult<AccessToken>> handler)
Query an OAuth 2.0 authorization server to determine the active state of an OAuth 2.0 token and to determine
meta-information about this token.
|
OAuth2Auth |
introspectToken(String token,
String tokenType,
io.vertx.core.Handler<io.vertx.core.AsyncResult<AccessToken>> handler)
Query an OAuth 2.0 authorization server to determine the active state of an OAuth 2.0 token and to determine
meta-information about this token.
|
rx.Observable<AccessToken> |
introspectTokenObservable(String token)
Deprecated.
use
rxIntrospectToken(java.lang.String) instead |
rx.Observable<AccessToken> |
introspectTokenObservable(String token,
String tokenType)
Deprecated.
use
rxIntrospectToken(java.lang.String) instead |
OAuth2Auth |
loadJWK(io.vertx.core.Handler<io.vertx.core.AsyncResult<Void>> handler)
Loads a JWK Set from the remote provider.
|
rx.Observable<Void> |
loadJWKObservable()
Deprecated.
use
rxLoadJWK() instead |
static OAuth2Auth |
newInstance(io.vertx.ext.auth.oauth2.OAuth2Auth arg) |
OAuth2Auth |
rbacHandler(OAuth2RBAC rbac) |
rx.Single<AccessToken> |
rxDecodeToken(String token)
Deprecated.
|
rx.Single<AccessToken> |
rxGetToken(io.vertx.core.json.JsonObject params)
Deprecated.
|
rx.Single<AccessToken> |
rxIntrospectToken(String token)
Query an OAuth 2.0 authorization server to determine the active state of an OAuth 2.0 token and to determine
meta-information about this token.
|
rx.Single<AccessToken> |
rxIntrospectToken(String token,
String tokenType)
Query an OAuth 2.0 authorization server to determine the active state of an OAuth 2.0 token and to determine
meta-information about this token.
|
rx.Single<Void> |
rxLoadJWK()
Loads a JWK Set from the remote provider.
|
String |
toString() |
authenticate, authenticateObservable, newInstance, rxAuthenticate
public static final TypeArg<OAuth2Auth> __TYPE_ARG
public String toString()
toString
in class AuthProvider
public boolean equals(Object o)
equals
in class AuthProvider
public int hashCode()
hashCode
in class AuthProvider
public io.vertx.ext.auth.oauth2.OAuth2Auth getDelegate()
getDelegate
in class AuthProvider
@Deprecated public static OAuth2Auth createKeycloak(Vertx vertx, io.vertx.ext.auth.oauth2.OAuth2FlowType flow, io.vertx.core.json.JsonObject config)
vertx
- the Vertx instanceflow
- config
- the config as exported from the admin console@Deprecated public static OAuth2Auth create(Vertx vertx, io.vertx.ext.auth.oauth2.OAuth2FlowType flow, io.vertx.ext.auth.oauth2.OAuth2ClientOptions config)
vertx
- the Vertx instanceflow
- config
- the config@Deprecated public static OAuth2Auth create(Vertx vertx, io.vertx.ext.auth.oauth2.OAuth2FlowType flow)
vertx
- the Vertx instanceflow
- public static OAuth2Auth create(Vertx vertx)
vertx
- the Vertx instancepublic static OAuth2Auth create(Vertx vertx, io.vertx.ext.auth.oauth2.OAuth2ClientOptions config)
vertx
- the Vertx instanceconfig
- the configpublic String authorizeURL(io.vertx.core.json.JsonObject params)
params
- @Deprecated public void getToken(io.vertx.core.json.JsonObject params, io.vertx.core.Handler<io.vertx.core.AsyncResult<AccessToken>> handler)
params
- - JSON with the options, each flow requires different options.handler
- - The handler returning the results.@Deprecated public rx.Observable<AccessToken> getTokenObservable(io.vertx.core.json.JsonObject params)
rxGetToken(io.vertx.core.json.JsonObject)
insteadparams
- - JSON with the options, each flow requires different options.@Deprecated public rx.Single<AccessToken> rxGetToken(io.vertx.core.json.JsonObject params)
params
- - JSON with the options, each flow requires different options.@Deprecated public OAuth2Auth decodeToken(String token, io.vertx.core.Handler<io.vertx.core.AsyncResult<AccessToken>> handler)
AccessToken
object. This is useful to handle bearer JWT tokens.token
- the access token (base64 string)handler
- A handler to receive the event@Deprecated public rx.Observable<AccessToken> decodeTokenObservable(String token)
rxDecodeToken(java.lang.String)
insteadAccessToken
object. This is useful to handle bearer JWT tokens.token
- the access token (base64 string)@Deprecated public rx.Single<AccessToken> rxDecodeToken(String token)
AccessToken
object. This is useful to handle bearer JWT tokens.token
- the access token (base64 string)public OAuth2Auth introspectToken(String token, io.vertx.core.Handler<io.vertx.core.AsyncResult<AccessToken>> handler)
token
- the access token (base64 string)handler
- A handler to receive the event@Deprecated public rx.Observable<AccessToken> introspectTokenObservable(String token)
rxIntrospectToken(java.lang.String)
insteadtoken
- the access token (base64 string)public rx.Single<AccessToken> rxIntrospectToken(String token)
token
- the access token (base64 string)public OAuth2Auth introspectToken(String token, String tokenType, io.vertx.core.Handler<io.vertx.core.AsyncResult<AccessToken>> handler)
token
- the access token (base64 string)tokenType
- hint to the token type e.g.: `access_token`handler
- A handler to receive the event@Deprecated public rx.Observable<AccessToken> introspectTokenObservable(String token, String tokenType)
rxIntrospectToken(java.lang.String)
insteadtoken
- the access token (base64 string)tokenType
- hint to the token type e.g.: `access_token`public rx.Single<AccessToken> rxIntrospectToken(String token, String tokenType)
token
- the access token (base64 string)tokenType
- hint to the token type e.g.: `access_token`@Deprecated public String getScopeSeparator()
public io.vertx.ext.auth.oauth2.OAuth2FlowType getFlowType()
public OAuth2Auth loadJWK(io.vertx.core.Handler<io.vertx.core.AsyncResult<Void>> handler)
handler
- @Deprecated public rx.Observable<Void> loadJWKObservable()
rxLoadJWK()
insteadpublic rx.Single<Void> rxLoadJWK()
public OAuth2Auth rbacHandler(OAuth2RBAC rbac)
public static OAuth2Auth newInstance(io.vertx.ext.auth.oauth2.OAuth2Auth arg)
Copyright © 2019 Eclipse. All rights reserved.