Class: VertxAuthOauth2::AccessToken
- Inherits:
-
VertxAuthCommon::User
- Object
- VertxAuthCommon::User
- VertxAuthOauth2::AccessToken
- Defined in:
- /Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-auth-oauth2/access_token.rb
Overview
AccessToken extension to the User interface
Constant Summary
- @@j_api_type =
Object.new
Class Method Summary (collapse)
- + (Boolean) accept?(obj)
- + (Object) j_api_type
- + (Object) j_class
- + (Object) unwrap(obj)
- + (Object) wrap(obj)
Instance Method Summary (collapse)
-
- (Hash{String => Object}) access_token
The Access Token if present parsed as a JsonObject.
-
- (self) clear_cache
The User object will cache any authorities that it knows it has to avoid hitting the underlying auth provider each time.
-
- (true, false) expired?
Check if the access token is expired or not.
-
- (self) fetch(param_1 = nil, param_2 = nil, param_3 = nil, param_4 = nil)
Fetches a JSON resource using this Access Token.
-
- (Hash{String => Object}) id_token
The Id Token if present parsed as a JsonObject.
-
- (self) introspect(tokenType = nil) { ... }
Introspect access token.
- - (self) is_authorised(authority = nil) { ... }
-
- (self) is_authorized(authority = nil) { ... }
Is the user authorised to.
-
- (self) logout { ... }
Revoke refresh token and calls the logout endpoint.
-
- (String) opaque_access_token
The RAW String if available for the Access Token.
-
- (String) opaque_id_token
The RAW String if available for the Id Token.
-
- (String) opaque_refresh_token
The RAW String if available for the Refresh Token.
-
- (Hash{String => Object}) principal
Get the underlying principal for the User.
-
- (self) refresh { ... }
Refresh the access token.
-
- (self) revoke(token_type = nil) { ... }
Revoke access or refresh token.
-
- (void) set_auth_provider(authProvider = nil)
Set the auth provider for the User.
- - (self) set_trust_jwt(trust = nil)
- - (String) token_type
-
- (self) user_info { ... }
Load the user info as per OIDC spec.
Class Method Details
+ (Boolean) accept?(obj)
21 22 23 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-auth-oauth2/access_token.rb', line 21 def @@j_api_type.accept?(obj) obj.class == AccessToken end |
+ (Object) j_api_type
30 31 32 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-auth-oauth2/access_token.rb', line 30 def self.j_api_type @@j_api_type end |
+ (Object) j_class
33 34 35 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-auth-oauth2/access_token.rb', line 33 def self.j_class Java::IoVertxExtAuthOauth2::AccessToken.java_class end |
+ (Object) unwrap(obj)
27 28 29 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-auth-oauth2/access_token.rb', line 27 def @@j_api_type.unwrap(obj) obj.j_del end |
+ (Object) wrap(obj)
24 25 26 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-auth-oauth2/access_token.rb', line 24 def @@j_api_type.wrap(obj) AccessToken.new(obj) end |
Instance Method Details
- (Hash{String => Object}) access_token
The Access Token if present parsed as a JsonObject
101 102 103 104 105 106 107 108 109 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-auth-oauth2/access_token.rb', line 101 def access_token if !block_given? if @cached_access_token != nil return @cached_access_token end return @cached_access_token = @j_del.java_method(:accessToken, []).call() != nil ? JSON.parse(@j_del.java_method(:accessToken, []).call().encode) : nil end raise ArgumentError, "Invalid arguments when calling access_token()" end |
- (self) clear_cache
The User object will cache any authorities that it knows it has to avoid hitting the
underlying auth provider each time. Use this method if you want to clear this cache.
60 61 62 63 64 65 66 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-auth-oauth2/access_token.rb', line 60 def clear_cache if !block_given? @j_del.java_method(:clearCache, []).call() return self end raise ArgumentError, "Invalid arguments when calling clear_cache()" end |
- (true, false) expired?
Check if the access token is expired or not.
93 94 95 96 97 98 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-auth-oauth2/access_token.rb', line 93 def expired? if !block_given? return @j_del.java_method(:expired, []).call() end raise ArgumentError, "Invalid arguments when calling expired?()" end |
- (self) fetch(resource, callback) { ... } - (self) fetch(method, resource, headers, payload, callback) { ... }
Fetches a JSON resource using this Access Token.
228 229 230 231 232 233 234 235 236 237 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-auth-oauth2/access_token.rb', line 228 def fetch(param_1=nil,param_2=nil,param_3=nil,param_4=nil) if param_1.class == String && true && param_2 == nil && param_3 == nil && param_4 == nil @j_del.java_method(:fetch, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ::Vertx::Util::Utils.safe_create(ar.result,::VertxAuthOauth2::OAuth2Response) : nil) } unless !block_given?)) return self elsif param_1.class == Symbol && param_2.class == String && param_3.class == Hash && param_4.class.method_defined?(:j_del) && true @j_del.java_method(:fetch, [Java::IoVertxCoreHttp::HttpMethod.java_class,Java::java.lang.String.java_class,Java::IoVertxCoreJson::JsonObject.java_class,Java::IoVertxCoreBuffer::Buffer.java_class,Java::IoVertxCore::Handler.java_class]).call(Java::IoVertxCoreHttp::HttpMethod.valueOf(param_1.to_s),param_2,::Vertx::Util::Utils.to_json_object(param_3),param_4.j_del,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ::Vertx::Util::Utils.safe_create(ar.result,::VertxAuthOauth2::OAuth2Response) : nil) } unless !block_given?)) return self end raise ArgumentError, "Invalid arguments when calling fetch(#{param_1},#{param_2},#{param_3},#{param_4})" end |
- (Hash{String => Object}) id_token
The Id Token if present parsed as a JsonObject
112 113 114 115 116 117 118 119 120 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-auth-oauth2/access_token.rb', line 112 def id_token if !block_given? if @cached_id_token != nil return @cached_id_token end return @cached_id_token = @j_del.java_method(:idToken, []).call() != nil ? JSON.parse(@j_del.java_method(:idToken, []).call().encode) : nil end raise ArgumentError, "Invalid arguments when calling id_token()" end |
- (self) introspect(tokenType = nil) { ... }
Introspect access token. This is an OAuth2 extension that allow to verify if an access token is still valid.
197 198 199 200 201 202 203 204 205 206 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-auth-oauth2/access_token.rb', line 197 def introspect(tokenType=nil) if true && tokenType == nil @j_del.java_method(:introspect, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |ar| yield(ar.failed ? ar.cause : nil) } unless !block_given?)) return self elsif tokenType.class == String && true @j_del.java_method(:introspect, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(tokenType,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil) } unless !block_given?)) return self end raise ArgumentError, "Invalid arguments when calling introspect(#{tokenType})" end |
- (self) is_authorised(authority = nil) { ... }
50 51 52 53 54 55 56 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-auth-oauth2/access_token.rb', line 50 def (=nil) if .class == String && true @j_del.java_method(:isAuthorised, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) } unless !block_given?)) return self end raise ArgumentError, "Invalid arguments when calling is_authorised(#{})" end |
- (self) is_authorized(authority = nil) { ... }
Is the user authorised to
40 41 42 43 44 45 46 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-auth-oauth2/access_token.rb', line 40 def (=nil) if .class == String && true @j_del.java_method(:isAuthorized, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) } unless !block_given?)) return self end raise ArgumentError, "Invalid arguments when calling is_authorized(#{})" end |
- (self) logout { ... }
Revoke refresh token and calls the logout endpoint. This is a openid-connect extension and might not be
available on all providers.
186 187 188 189 190 191 192 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-auth-oauth2/access_token.rb', line 186 def logout if true @j_del.java_method(:logout, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |ar| yield(ar.failed ? ar.cause : nil) } unless !block_given?)) return self end raise ArgumentError, "Invalid arguments when calling logout()" end |
- (String) opaque_access_token
The RAW String if available for the Access Token
123 124 125 126 127 128 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-auth-oauth2/access_token.rb', line 123 def opaque_access_token if !block_given? return @j_del.java_method(:opaqueAccessToken, []).call() end raise ArgumentError, "Invalid arguments when calling opaque_access_token()" end |
- (String) opaque_id_token
The RAW String if available for the Id Token
139 140 141 142 143 144 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-auth-oauth2/access_token.rb', line 139 def opaque_id_token if !block_given? return @j_del.java_method(:opaqueIdToken, []).call() end raise ArgumentError, "Invalid arguments when calling opaque_id_token()" end |
- (String) opaque_refresh_token
The RAW String if available for the Refresh Token
131 132 133 134 135 136 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-auth-oauth2/access_token.rb', line 131 def opaque_refresh_token if !block_given? return @j_del.java_method(:opaqueRefreshToken, []).call() end raise ArgumentError, "Invalid arguments when calling opaque_refresh_token()" end |
- (Hash{String => Object}) principal
Get the underlying principal for the User. What this actually returns depends on the implementation.
For a simple user/password based auth, it's likely to contain a JSON object with the following structure:
{
"username", "tim"
}
75 76 77 78 79 80 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-auth-oauth2/access_token.rb', line 75 def principal if !block_given? return @j_del.java_method(:principal, []).call() != nil ? JSON.parse(@j_del.java_method(:principal, []).call().encode) : nil end raise ArgumentError, "Invalid arguments when calling principal()" end |
- (self) refresh { ... }
Refresh the access token
164 165 166 167 168 169 170 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-auth-oauth2/access_token.rb', line 164 def refresh if true @j_del.java_method(:refresh, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |ar| yield(ar.failed ? ar.cause : nil) } unless !block_given?)) return self end raise ArgumentError, "Invalid arguments when calling refresh()" end |
- (self) revoke(token_type = nil) { ... }
Revoke access or refresh token
175 176 177 178 179 180 181 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-auth-oauth2/access_token.rb', line 175 def revoke(token_type=nil) if token_type.class == String && true @j_del.java_method(:revoke, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(token_type,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil) } unless !block_given?)) return self end raise ArgumentError, "Invalid arguments when calling revoke(#{token_type})" end |
- (void) set_auth_provider(authProvider = nil)
This method returns an undefined value.
Set the auth provider for the User. This is typically used to reattach a detached User with an AuthProvider, e.g. after it has been deserialized.
85 86 87 88 89 90 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-auth-oauth2/access_token.rb', line 85 def set_auth_provider(authProvider=nil) if authProvider.class.method_defined?(:j_del) && !block_given? return @j_del.java_method(:setAuthProvider, [Java::IoVertxExtAuth::AuthProvider.java_class]).call(authProvider.j_del) end raise ArgumentError, "Invalid arguments when calling set_auth_provider(#{authProvider})" end |
- (self) set_trust_jwt(trust = nil)
154 155 156 157 158 159 160 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-auth-oauth2/access_token.rb', line 154 def set_trust_jwt(trust=nil) if (trust.class == TrueClass || trust.class == FalseClass) && !block_given? @j_del.java_method(:setTrustJWT, [Java::boolean.java_class]).call(trust) return self end raise ArgumentError, "Invalid arguments when calling set_trust_jwt(#{trust})" end |
- (String) token_type
146 147 148 149 150 151 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-auth-oauth2/access_token.rb', line 146 def token_type if !block_given? return @j_del.java_method(:tokenType, []).call() end raise ArgumentError, "Invalid arguments when calling token_type()" end |
- (self) user_info { ... }
Load the user info as per OIDC spec.
210 211 212 213 214 215 216 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-auth-oauth2/access_token.rb', line 210 def user_info if true @j_del.java_method(:userInfo, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.encode) : nil : nil) } unless !block_given?)) return self end raise ArgumentError, "Invalid arguments when calling user_info()" end |