Class: VertxAuthOauth2::OpenIDConnectAuth

Inherits:
Object
  • Object
show all
Defined in:
/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-auth-oauth2/open_id_connect_auth.rb

Overview

Simplified factory to create an OAuth2Auth for OpenID Connect.

Direct Known Subclasses

AzureADAuth, GoogleAuth, KeycloakAuth, SalesforceAuth

Constant Summary

@@j_api_type =
Object.new

Class Method Summary (collapse)

Class Method Details

+ (Boolean) accept?(obj)

Returns:

  • (Boolean)

19
20
21
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-auth-oauth2/open_id_connect_auth.rb', line 19

def @@j_api_type.accept?(obj)
  obj.class == OpenIDConnectAuth
end

+ (void) discover(vertx = nil, config = nil) { ... }

This method returns an undefined value.

Create a OAuth2Auth provider for OpenID Connect Discovery. The discovery will use the given site in the configuration options and attempt to load the well known descriptor. If the discovered config includes a json web key url, it will be also fetched and the JWKs will be loaded into the OAuth provider so tokens can be decoded.

Parameters:

  • vertx (::Vertx::Vertx) (defaults to: nil)
    the vertx instance
  • config (Hash) (defaults to: nil)
    the initial config, it should contain a site url

Yields:

  • the instantiated Oauth2 provider instance handler

Raises:

  • (ArgumentError)

43
44
45
46
47
48
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-auth-oauth2/open_id_connect_auth.rb', line 43

def self.discover(vertx=nil,config=nil)
  if vertx.class.method_defined?(:j_del) && config.class == Hash && block_given?
    return Java::IoVertxExtAuthOauth2Providers::OpenIDConnectAuth.java_method(:discover, [Java::IoVertxCore::Vertx.java_class,Java::IoVertxExtAuthOauth2::OAuth2ClientOptions.java_class,Java::IoVertxCore::Handler.java_class]).call(vertx.j_del,Java::IoVertxExtAuthOauth2::OAuth2ClientOptions.new(::Vertx::Util::Utils.to_json_object(config)),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ::Vertx::Util::Utils.safe_create(ar.result,::VertxAuthOauth2::OAuth2Auth) : nil) }))
  end
  raise ArgumentError, "Invalid arguments when calling discover(#{vertx},#{config})"
end

+ (Object) j_api_type


28
29
30
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-auth-oauth2/open_id_connect_auth.rb', line 28

def self.j_api_type
  @@j_api_type
end

+ (Object) j_class


31
32
33
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-auth-oauth2/open_id_connect_auth.rb', line 31

def self.j_class
  Java::IoVertxExtAuthOauth2Providers::OpenIDConnectAuth.java_class
end

+ (Object) unwrap(obj)


25
26
27
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-auth-oauth2/open_id_connect_auth.rb', line 25

def @@j_api_type.unwrap(obj)
  obj.j_del
end

+ (Object) wrap(obj)


22
23
24
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-auth-oauth2/open_id_connect_auth.rb', line 22

def @@j_api_type.wrap(obj)
  OpenIDConnectAuth.new(obj)
end