Class: VertxWeb::OAuth2AuthHandler

Inherits:
Object
  • Object
show all
Includes:
AuthHandler
Defined in:
/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/o_auth2_auth_handler.rb

Overview

An auth handler that provides OAuth2 Authentication support. This handler is suitable for AuthCode flows.

Constant Summary

@@j_api_type =
Object.new

Class Method Summary (collapse)

Instance Method Summary (collapse)

Class Method Details

+ (Boolean) accept?(obj)

Returns:

  • (Boolean)


22
23
24
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/o_auth2_auth_handler.rb', line 22

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

+ (::VertxWeb::OAuth2AuthHandler) create(authProvider = nil, callbackURL = nil)

Create a OAuth2 auth handler with host pinning

Parameters:

  • authProvider (::VertxAuthOauth2::OAuth2Auth) (defaults to: nil)
    the auth provider to use
  • callbackURL (String) (defaults to: nil)
    the callback URL you entered in your provider admin console, usually it should be something like: `https://myserver:8888/callback`

Returns:

Raises:

  • (ArgumentError)


69
70
71
72
73
74
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/o_auth2_auth_handler.rb', line 69

def self.create(authProvider=nil,callbackURL=nil)
  if authProvider.class.method_defined?(:j_del) && callbackURL.class == String && !block_given?
    return ::Vertx::Util::Utils.safe_create(Java::IoVertxExtWebHandler::OAuth2AuthHandler.java_method(:create, [Java::IoVertxExtAuthOauth2::OAuth2Auth.java_class,Java::java.lang.String.java_class]).call(authProvider.j_del,callbackURL),::VertxWeb::OAuth2AuthHandler)
  end
  raise ArgumentError, "Invalid arguments when calling create(#{authProvider},#{callbackURL})"
end

+ (Object) j_api_type



31
32
33
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/o_auth2_auth_handler.rb', line 31

def self.j_api_type
  @@j_api_type
end

+ (Object) j_class



34
35
36
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/o_auth2_auth_handler.rb', line 34

def self.j_class
  Java::IoVertxExtWebHandler::OAuth2AuthHandler.java_class
end

+ (Object) unwrap(obj)



28
29
30
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/o_auth2_auth_handler.rb', line 28

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

+ (Object) wrap(obj)



25
26
27
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/o_auth2_auth_handler.rb', line 25

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

Instance Method Details

- (self) add_authorities(authorities = nil)

Add a set of required authorities for this auth handler

Parameters:

  • authorities (Set<String>) (defaults to: nil)
    the set of authorities

Returns:

  • (self)

Raises:

  • (ArgumentError)


58
59
60
61
62
63
64
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/o_auth2_auth_handler.rb', line 58

def add_authorities(authorities=nil)
  if authorities.class == Set && !block_given?
    @j_del.java_method(:addAuthorities, [Java::JavaUtil::Set.java_class]).call(Java::JavaUtil::LinkedHashSet.new(authorities.map { |element| element }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling add_authorities(#{authorities})"
end

- (self) add_authority(authority = nil)

Add a required authority for this auth handler

Parameters:

  • authority (String) (defaults to: nil)
    the authority

Returns:

  • (self)

Raises:

  • (ArgumentError)


48
49
50
51
52
53
54
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/o_auth2_auth_handler.rb', line 48

def add_authority(authority=nil)
  if authority.class == String && !block_given?
    @j_del.java_method(:addAuthority, [Java::java.lang.String.java_class]).call(authority)
    return self
  end
  raise ArgumentError, "Invalid arguments when calling add_authority(#{authority})"
end

- (self) extra_params(extraParams = nil)

Extra parameters needed to be passed while requesting a token.

Parameters:

  • extraParams (Hash{String => Object}) (defaults to: nil)
    extra optional parameters.

Returns:

  • (self)

Raises:

  • (ArgumentError)


78
79
80
81
82
83
84
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/o_auth2_auth_handler.rb', line 78

def extra_params(extraParams=nil)
  if extraParams.class == Hash && !block_given?
    @j_del.java_method(:extraParams, [Java::IoVertxCoreJson::JsonObject.java_class]).call(::Vertx::Util::Utils.to_json_object(extraParams))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling extra_params(#{extraParams})"
end

- (void) handle(arg0 = nil)

This method returns an undefined value.

Parameters:

Raises:

  • (ArgumentError)


39
40
41
42
43
44
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/o_auth2_auth_handler.rb', line 39

def handle(arg0=nil)
  if arg0.class.method_defined?(:j_del) && !block_given?
    return @j_del.java_method(:handle, [Java::IoVertxExtWeb::RoutingContext.java_class]).call(arg0.j_del)
  end
  raise ArgumentError, "Invalid arguments when calling handle(#{arg0})"
end

- (self) setup_callback(route = nil)

add the callback handler to a given route.

Parameters:

Returns:

  • (self)

Raises:

  • (ArgumentError)


88
89
90
91
92
93
94
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/o_auth2_auth_handler.rb', line 88

def setup_callback(route=nil)
  if route.class.method_defined?(:j_del) && !block_given?
    @j_del.java_method(:setupCallback, [Java::IoVertxExtWeb::Route.java_class]).call(route.j_del)
    return self
  end
  raise ArgumentError, "Invalid arguments when calling setup_callback(#{route})"
end