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 io.vertx.lang.rx.TypeArg<OAuth2Auth> |
__TYPE_ARG |
| Constructor and Description |
|---|
OAuth2Auth(OAuth2Auth delegate) |
| Modifier and Type | Method and Description |
|---|---|
String |
authorizeURL(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,
OAuth2ClientOptions config)
Create a OAuth2 auth provider
|
OAuth2Auth |
decodeToken(String token)
Decode a token to a
AccessToken object. |
OAuth2Auth |
decodeToken(String token,
Handler<AsyncResult<AccessToken>> handler)
Decode a token to a
AccessToken object. |
boolean |
equals(Object o) |
OAuth2Auth |
getDelegate() |
OAuth2FlowType |
getFlowType()
Returns the configured flow type for the Oauth2 provider.
|
int |
hashCode() |
OAuth2Auth |
introspectToken(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.
|
OAuth2Auth |
introspectToken(String token,
Handler<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)
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,
Handler<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 |
loadJWK()
Loads a JWK Set from the remote provider.
|
OAuth2Auth |
loadJWK(Handler<AsyncResult<Void>> handler)
Loads a JWK Set from the remote provider.
|
static OAuth2Auth |
newInstance(OAuth2Auth arg) |
OAuth2Auth |
rbacHandler(OAuth2RBAC rbac) |
Single<AccessToken> |
rxDecodeToken(String token)
Decode a token to a
AccessToken object. |
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.
|
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.
|
Completable |
rxLoadJWK()
Loads a JWK Set from the remote provider.
|
String |
toString() |
authenticate, authenticate, newInstance, rxAuthenticatepublic static final io.vertx.lang.rx.TypeArg<OAuth2Auth> __TYPE_ARG
public OAuth2Auth(OAuth2Auth delegate)
public String toString()
toString in class AuthProviderpublic boolean equals(Object o)
equals in class AuthProviderpublic int hashCode()
hashCode in class AuthProviderpublic OAuth2Auth getDelegate()
getDelegate in class AuthProviderpublic static OAuth2Auth create(Vertx vertx)
vertx - the Vertx instancepublic static OAuth2Auth create(Vertx vertx, OAuth2ClientOptions config)
vertx - the Vertx instanceconfig - the configpublic String authorizeURL(JsonObject params)
params - public OAuth2Auth decodeToken(String token, Handler<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 eventpublic OAuth2Auth decodeToken(String token)
AccessToken object. This is useful to handle bearer JWT tokens.token - the access token (base64 string)public 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, Handler<AsyncResult<AccessToken>> handler)
token - the access token (base64 string)handler - A handler to receive the eventpublic OAuth2Auth introspectToken(String token)
token - the access token (base64 string)public Single<AccessToken> rxIntrospectToken(String token)
token - the access token (base64 string)public OAuth2Auth introspectToken(String token, String tokenType, Handler<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 eventpublic OAuth2Auth introspectToken(String token, String tokenType)
token - the access token (base64 string)tokenType - hint to the token type e.g.: `access_token`public Single<AccessToken> rxIntrospectToken(String token, String tokenType)
token - the access token (base64 string)tokenType - hint to the token type e.g.: `access_token`public OAuth2FlowType getFlowType()
public OAuth2Auth loadJWK(Handler<AsyncResult<Void>> handler)
handler - public OAuth2Auth loadJWK()
public Completable rxLoadJWK()
public OAuth2Auth rbacHandler(OAuth2RBAC rbac)
public static OAuth2Auth newInstance(OAuth2Auth arg)
Copyright © 2019 Eclipse. All rights reserved.