io.vertx.rxjava.ext.auth.oauth2

Class AccessToken

java.lang.Object

io.vertx.rxjava.ext.auth.User

io.vertx.rxjava.ext.auth.oauth2.AccessToken

public class AccessToken
extends User

AccessToken extension to the User interface

NOTE: This class has been automatically generated from the original non RX-ified interface using Vert.x codegen.

Field Summary

Fields

Modifier and Type	Field and Description
static TypeArg<AccessToken>	__TYPE_ARG

Constructor Summary

Constructors

Constructor and Description
AccessToken(AccessToken delegate)

Method Summary

Modifier and Type	Method and Description
JsonObject	accessToken() The Access Token if present parsed as a JsonObject
boolean	equals(Object o)
boolean	expired() Check if the access token is expired or not.
AccessToken	fetch(HttpMethod method, String resource, JsonObject headers, Buffer payload, Handler<AsyncResult<OAuth2Response>> callback) Fetches a JSON resource using this Access Token.
AccessToken	fetch(String resource, Handler<AsyncResult<OAuth2Response>> callback) Fetches a JSON resource using this Access Token.
rx.Observable<OAuth2Response>	fetchObservable(HttpMethod method, String resource, JsonObject headers, Buffer payload) Deprecated. use rxFetch(java.lang.String) instead
rx.Observable<OAuth2Response>	fetchObservable(String resource) Deprecated. use rxFetch(java.lang.String) instead
AccessToken	getDelegate()
int	hashCode()
JsonObject	idToken() The Id Token if present parsed as a JsonObject
AccessToken	introspect(Handler<AsyncResult<Void>> callback) Introspect access token.
AccessToken	introspect(String tokenType, Handler<AsyncResult<Void>> callback) Introspect access token.
rx.Observable<Void>	introspectObservable() Deprecated. use rxIntrospect() instead
rx.Observable<Void>	introspectObservable(String tokenType) Deprecated. use rxIntrospect() instead
AccessToken	logout(Handler<AsyncResult<Void>> callback) Revoke refresh token and calls the logout endpoint.
rx.Observable<Void>	logoutObservable() Deprecated. use rxLogout() instead
static AccessToken	newInstance(AccessToken arg)
String	opaqueAccessToken() The RAW String if available for the Access Token
String	opaqueIdToken() The RAW String if available for the Id Token
String	opaqueRefreshToken() The RAW String if available for the Refresh Token
AccessToken	refresh(Handler<AsyncResult<Void>> callback) Refresh the access token
rx.Observable<Void>	refreshObservable() Deprecated. use rxRefresh() instead
JsonObject	refreshToken() The Refresh Token if present parsed as a JsonObject
AccessToken	revoke(String token_type, Handler<AsyncResult<Void>> callback) Revoke access or refresh token
rx.Observable<Void>	revokeObservable(String token_type) Deprecated. use rxRevoke(java.lang.String) instead
rx.Single<OAuth2Response>	rxFetch(HttpMethod method, String resource, JsonObject headers, Buffer payload) Fetches a JSON resource using this Access Token.
rx.Single<OAuth2Response>	rxFetch(String resource) Fetches a JSON resource using this Access Token.
rx.Single<Void>	rxIntrospect() Introspect access token.
rx.Single<Void>	rxIntrospect(String tokenType) Introspect access token.
rx.Single<Void>	rxLogout() Revoke refresh token and calls the logout endpoint.
rx.Single<Void>	rxRefresh() Refresh the access token
rx.Single<Void>	rxRevoke(String token_type) Revoke access or refresh token
rx.Single<JsonObject>	rxUserInfo() Load the user info as per OIDC spec.
AccessToken	setTrustJWT(boolean trust)
String	tokenType()
String	toString()
AccessToken	userInfo(Handler<AsyncResult<JsonObject>> callback) Load the user info as per OIDC spec.
rx.Observable<JsonObject>	userInfoObservable() Deprecated. use rxUserInfo() instead

Methods inherited from class io.vertx.rxjava.ext.auth.User

clearCache, isAuthorised, isAuthorisedObservable, isAuthorized, isAuthorizedObservable, newInstance, principal, rxIsAuthorised, rxIsAuthorized, setAuthProvider

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

__TYPE_ARG

public static final TypeArg<AccessToken> __TYPE_ARG

Constructor Detail

AccessToken

public AccessToken(AccessToken delegate)

Method Detail

toString

public String toString()

Overrides:

toString in class User

equals

public boolean equals(Object o)

Overrides:

equals in class User

hashCode

public int hashCode()

Overrides:

hashCode in class User

getDelegate

public AccessToken getDelegate()

Overrides:

getDelegate in class User

expired

public boolean expired()

Check if the access token is expired or not.

Returns:

accessToken

public JsonObject accessToken()

The Access Token if present parsed as a JsonObject

Returns:

JSON

refreshToken

public JsonObject refreshToken()

The Refresh Token if present parsed as a JsonObject

Returns:

JSON

idToken

public JsonObject idToken()

The Id Token if present parsed as a JsonObject

Returns:

JSON

opaqueAccessToken

public String opaqueAccessToken()

The RAW String if available for the Access Token

Returns:

String

opaqueRefreshToken

public String opaqueRefreshToken()

The RAW String if available for the Refresh Token

Returns:

String

opaqueIdToken

public String opaqueIdToken()

The RAW String if available for the Id Token

Returns:

String

tokenType

public String tokenType()

setTrustJWT

public AccessToken setTrustJWT(boolean trust)

refresh

public AccessToken refresh(Handler<AsyncResult<Void>> callback)

Refresh the access token

Parameters:

callback - - The callback function returning the results.

Returns:

refreshObservable

@Deprecated
public rx.Observable<Void> refreshObservable()

Deprecated. use rxRefresh() instead

Refresh the access token

Returns:

rxRefresh

public rx.Single<Void> rxRefresh()

Refresh the access token

Returns:

revoke

public AccessToken revoke(String token_type,
                          Handler<AsyncResult<Void>> callback)

Revoke access or refresh token

Parameters:

token_type - - A String containing the type of token to revoke. Should be either "access_token" or "refresh_token".

callback - - The callback function returning the results.

Returns:

revokeObservable

@Deprecated
public rx.Observable<Void> revokeObservable(String token_type)

Deprecated. use rxRevoke(java.lang.String) instead

Revoke access or refresh token

Parameters:

token_type - - A String containing the type of token to revoke. Should be either "access_token" or "refresh_token".

Returns:

rxRevoke

public rx.Single<Void> rxRevoke(String token_type)

Revoke access or refresh token

Parameters:

token_type - - A String containing the type of token to revoke. Should be either "access_token" or "refresh_token".

Returns:

logout

public AccessToken logout(Handler<AsyncResult<Void>> callback)

Revoke refresh token and calls the logout endpoint. This is a openid-connect extension and might not be available on all providers.

Parameters:

callback - - The callback function returning the results.

Returns:

logoutObservable

@Deprecated
public rx.Observable<Void> logoutObservable()

Deprecated. use rxLogout() instead

Revoke refresh token and calls the logout endpoint. This is a openid-connect extension and might not be available on all providers.

Returns:

rxLogout

public rx.Single<Void> rxLogout()

Revoke refresh token and calls the logout endpoint. This is a openid-connect extension and might not be available on all providers.

Returns:

introspect

public AccessToken introspect(Handler<AsyncResult<Void>> callback)

Introspect access token. This is an OAuth2 extension that allow to verify if an access token is still valid.

Parameters:

callback - - The callback function returning the results.

Returns:

introspectObservable

@Deprecated
public rx.Observable<Void> introspectObservable()

Deprecated. use rxIntrospect() instead

Introspect access token. This is an OAuth2 extension that allow to verify if an access token is still valid.

Returns:

rxIntrospect

public rx.Single<Void> rxIntrospect()

Introspect access token. This is an OAuth2 extension that allow to verify if an access token is still valid.

Returns:

introspect

public AccessToken introspect(String tokenType,
                              Handler<AsyncResult<Void>> callback)

Introspect access token. This is an OAuth2 extension that allow to verify if an access token is still valid.

Parameters:

tokenType - - A String containing the type of token to revoke. Should be either "access_token" or "refresh_token".

callback - - The callback function returning the results.

Returns:

introspectObservable

@Deprecated
public rx.Observable<Void> introspectObservable(String tokenType)

Deprecated. use rxIntrospect() instead

Introspect access token. This is an OAuth2 extension that allow to verify if an access token is still valid.

Parameters:

tokenType - - A String containing the type of token to revoke. Should be either "access_token" or "refresh_token".

Returns:

rxIntrospect

public rx.Single<Void> rxIntrospect(String tokenType)

Introspect access token. This is an OAuth2 extension that allow to verify if an access token is still valid.

Parameters:

tokenType - - A String containing the type of token to revoke. Should be either "access_token" or "refresh_token".

Returns:

userInfo

public AccessToken userInfo(Handler<AsyncResult<JsonObject>> callback)

Load the user info as per OIDC spec.

Parameters:

callback - - The callback function returning the results.

Returns:

userInfoObservable

@Deprecated
public rx.Observable<JsonObject> userInfoObservable()

Deprecated. use rxUserInfo() instead

Load the user info as per OIDC spec.

Returns:

rxUserInfo

public rx.Single<JsonObject> rxUserInfo()

Load the user info as per OIDC spec.

Returns:

fetch

public AccessToken fetch(String resource,
                         Handler<AsyncResult<OAuth2Response>> callback)

Fetches a JSON resource using this Access Token.

Parameters:

resource - - the resource to fetch.

callback - - The callback function returning the results.

Returns:

fetchObservable

@Deprecated
public rx.Observable<OAuth2Response> fetchObservable(String resource)

Deprecated. use rxFetch(java.lang.String) instead

Fetches a JSON resource using this Access Token.

Parameters:

resource - - the resource to fetch.

Returns:

rxFetch

public rx.Single<OAuth2Response> rxFetch(String resource)

Fetches a JSON resource using this Access Token.

Parameters:

resource - - the resource to fetch.

Returns:

fetch

public AccessToken fetch(HttpMethod method,
                         String resource,
                         JsonObject headers,
                         Buffer payload,
                         Handler<AsyncResult<OAuth2Response>> callback)

Fetches a JSON resource using this Access Token.

Parameters:

method - - the HTTP method to user.

resource - - the resource to fetch.

headers - - extra headers to pass to the request.

payload - - payload to send to the server.

callback - - The callback function returning the results.

Returns:

fetchObservable

@Deprecated
public rx.Observable<OAuth2Response> fetchObservable(HttpMethod method,
                                                                 String resource,
                                                                 JsonObject headers,
                                                                 Buffer payload)

Deprecated. use rxFetch(java.lang.String) instead

Fetches a JSON resource using this Access Token.

Parameters:

method - - the HTTP method to user.

resource - - the resource to fetch.

headers - - extra headers to pass to the request.

payload - - payload to send to the server.

Returns:

rxFetch

public rx.Single<OAuth2Response> rxFetch(HttpMethod method,
                                         String resource,
                                         JsonObject headers,
                                         Buffer payload)

Fetches a JSON resource using this Access Token.

Parameters:

method - - the HTTP method to user.

resource - - the resource to fetch.

headers - - extra headers to pass to the request.

payload - - payload to send to the server.

Returns:

newInstance

public static AccessToken newInstance(AccessToken arg)