Class: VertxWeb::OAuth2AuthHandler
- Inherits:
-
Object
- Object
- VertxWeb::OAuth2AuthHandler
- 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.
Class Method Summary (collapse)
-
+ (::VertxWeb::OAuth2AuthHandler) create(authProvider = nil, uri = nil)
Create a OAuth2 auth handler.
Instance Method Summary (collapse)
-
- (self) add_authorities(authorities = nil)
Add a set of required authorities for this auth handler.
-
- (self) add_authority(authority = nil)
Add a required authority for this auth handler.
-
- (String) auth_uri(redirectURL = nil, state = nil)
Build the authorization URL.
- - (void) handle(arg0 = nil)
-
- (self) setup_callback(route = nil)
add the callback handler to a given route.
Class Method Details
+ (::VertxWeb::OAuth2AuthHandler) create(authProvider = nil, uri = nil)
Create a OAuth2 auth handler
53 54 55 56 57 58 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/o_auth2_auth_handler.rb', line 53 def self.create(authProvider=nil,uri=nil) if authProvider.class.method_defined?(:j_del) && uri.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,uri),::VertxWeb::OAuth2AuthHandler) end raise ArgumentError, "Invalid arguments when calling create(authProvider,uri)" end |
Instance Method Details
- (self) add_authorities(authorities = nil)
Add a set of required authorities for this auth handler
42 43 44 45 46 47 48 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/o_auth2_auth_handler.rb', line 42 def (=nil) if .class == Set && !block_given? @j_del.java_method(:addAuthorities, [Java::JavaUtil::Set.java_class]).call(Java::JavaUtil::LinkedHashSet.new(.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
32 33 34 35 36 37 38 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/o_auth2_auth_handler.rb', line 32 def (=nil) if .class == String && !block_given? @j_del.java_method(:addAuthority, [Java::java.lang.String.java_class]).call() return self end raise ArgumentError, "Invalid arguments when calling add_authority(authority)" end |
- (String) auth_uri(redirectURL = nil, state = nil)
Build the authorization URL.
63 64 65 66 67 68 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/o_auth2_auth_handler.rb', line 63 def auth_uri(redirectURL=nil,state=nil) if redirectURL.class == String && state.class == String && !block_given? return @j_del.java_method(:authURI, [Java::java.lang.String.java_class,Java::java.lang.String.java_class]).call(redirectURL,state) end raise ArgumentError, "Invalid arguments when calling auth_uri(redirectURL,state)" end |
- (void) handle(arg0 = nil)
This method returns an undefined value.
23 24 25 26 27 28 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/o_auth2_auth_handler.rb', line 23 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.
72 73 74 75 76 77 78 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/o_auth2_auth_handler.rb', line 72 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 |