Class: VertxWeb::DigestAuthHandler
- Inherits:
-
Object
- Object
- VertxWeb::DigestAuthHandler
- Includes:
- AuthHandler
- Defined in:
- /Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/digest_auth_handler.rb
Overview
An auth handler that provides HTTP Basic Authentication support.
Constant Summary
- @@j_api_type =
Object.new
Class Method Summary (collapse)
- + (Boolean) accept?(obj)
-
+ (::VertxWeb::DigestAuthHandler) create(vertx = nil, authProvider = nil, nonceExpireTimeout = nil)
Create a digest auth handler, specifying the expire timeout for nonces.
-
+ (Object) DEFAULT_NONCE_EXPIRE_TIMEOUT
The default nonce expire timeout to use in milliseconds.
- + (Object) j_api_type
- + (Object) j_class
- + (Object) unwrap(obj)
- + (Object) wrap(obj)
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.
-
- (void) authorize(user = nil) { ... }
Authorizes the given user against all added authorities.
-
- (void) handle(event = nil)
Something has happened, so handle it.
-
- (void) parse_credentials(context = nil) { ... }
Parses the credentials from the request into a JsonObject.
Class Method Details
+ (Boolean) accept?(obj)
23 24 25 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/digest_auth_handler.rb', line 23 def @@j_api_type.accept?(obj) obj.class == DigestAuthHandler end |
+ (::VertxWeb::DigestAuthHandler) create(vertx = nil, authProvider = nil, nonceExpireTimeout = nil)
Create a digest auth handler, specifying the expire timeout for nonces.
94 95 96 97 98 99 100 101 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/digest_auth_handler.rb', line 94 def self.create(vertx=nil,authProvider=nil,nonceExpireTimeout=nil) if vertx.class.method_defined?(:j_del) && authProvider.class.method_defined?(:j_del) && !block_given? && nonceExpireTimeout == nil return ::Vertx::Util::Utils.safe_create(Java::IoVertxExtWebHandler::DigestAuthHandler.java_method(:create, [Java::IoVertxCore::Vertx.java_class,Java::IoVertxExtAuthHtdigest::HtdigestAuth.java_class]).call(vertx.j_del,authProvider.j_del),::VertxWeb::DigestAuthHandler) elsif vertx.class.method_defined?(:j_del) && authProvider.class.method_defined?(:j_del) && nonceExpireTimeout.class == Fixnum && !block_given? return ::Vertx::Util::Utils.safe_create(Java::IoVertxExtWebHandler::DigestAuthHandler.java_method(:create, [Java::IoVertxCore::Vertx.java_class,Java::IoVertxExtAuthHtdigest::HtdigestAuth.java_class,Java::long.java_class]).call(vertx.j_del,authProvider.j_del,nonceExpireTimeout),::VertxWeb::DigestAuthHandler) end raise ArgumentError, "Invalid arguments when calling create(#{vertx},#{authProvider},#{nonceExpireTimeout})" end |
+ (Object) DEFAULT_NONCE_EXPIRE_TIMEOUT
The default nonce expire timeout to use in milliseconds.
103 104 105 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/digest_auth_handler.rb', line 103 def self.DEFAULT_NONCE_EXPIRE_TIMEOUT Java::IoVertxExtWebHandler::DigestAuthHandler.DEFAULT_NONCE_EXPIRE_TIMEOUT end |
+ (Object) j_api_type
32 33 34 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/digest_auth_handler.rb', line 32 def self.j_api_type @@j_api_type end |
+ (Object) j_class
35 36 37 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/digest_auth_handler.rb', line 35 def self.j_class Java::IoVertxExtWebHandler::DigestAuthHandler.java_class end |
+ (Object) unwrap(obj)
29 30 31 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/digest_auth_handler.rb', line 29 def @@j_api_type.unwrap(obj) obj.j_del end |
+ (Object) wrap(obj)
26 27 28 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/digest_auth_handler.rb', line 26 def @@j_api_type.wrap(obj) DigestAuthHandler.new(obj) end |
Instance Method Details
- (self) add_authorities(authorities = nil)
Add a set of required authorities for this auth handler
60 61 62 63 64 65 66 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/digest_auth_handler.rb', line 60 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(#{})" end |
- (self) add_authority(authority = nil)
Add a required authority for this auth handler
50 51 52 53 54 55 56 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/digest_auth_handler.rb', line 50 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(#{})" end |
- (void) authorize(user = nil) { ... }
This method returns an undefined value.
Authorizes the given user against all added authorities.
83 84 85 86 87 88 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/digest_auth_handler.rb', line 83 def (user=nil) if user.class.method_defined?(:j_del) && true return @j_del.java_method(:authorize, [Java::IoVertxExtAuth::User.java_class,Java::IoVertxCore::Handler.java_class]).call(user.j_del,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil) } unless !block_given?)) end raise ArgumentError, "Invalid arguments when calling authorize(#{user})" end |
- (void) handle(event = nil)
This method returns an undefined value.
Something has happened, so handle it.
41 42 43 44 45 46 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/digest_auth_handler.rb', line 41 def handle(event=nil) if event.class.method_defined?(:j_del) && !block_given? return @j_del.java_method(:handle, [Java::IoVertxExtWeb::RoutingContext.java_class]).call(event.j_del) end raise ArgumentError, "Invalid arguments when calling handle(#{event})" end |
- (void) parse_credentials(context = nil) { ... }
This method returns an undefined value.
Parses the credentials from the request into a JsonObject. The implementation should be able to extract the required info for the auth provider in the format the provider expects.
73 74 75 76 77 78 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/digest_auth_handler.rb', line 73 def parse_credentials(context=nil) if context.class.method_defined?(:j_del) && true return @j_del.java_method(:parseCredentials, [Java::IoVertxExtWeb::RoutingContext.java_class,Java::IoVertxCore::Handler.java_class]).call(context.j_del,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.encode) : nil : nil) } unless !block_given?)) end raise ArgumentError, "Invalid arguments when calling parse_credentials(#{context})" end |