Class: VertxAuthHtdigest::HtdigestAuth

Inherits:
VertxAuthCommon::AuthProvider show all
Defined in:
/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-auth-htdigest/htdigest_auth.rb

Overview

An extension of AuthProvider which is using .htdigest file as store

Constant Summary

@@j_api_type =
Object.new

Class Method Summary (collapse)

Instance Method Summary (collapse)

Class Method Details

+ (Boolean) accept?(obj)

Returns:

  • (Boolean)

20
21
22
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-auth-htdigest/htdigest_auth.rb', line 20

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

+ (::VertxAuthHtdigest::HtdigestAuth) create(vertx = nil, htfile = nil)

Creates an instance of HtdigestAuth by using the given htfile file.

Parameters:

  • vertx (::Vertx::Vertx) (defaults to: nil)
  • htfile (String) (defaults to: nil)
    the existing htfile.

Returns:

Raises:

  • (ArgumentError)

63
64
65
66
67
68
69
70
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-auth-htdigest/htdigest_auth.rb', line 63

def self.create(vertx=nil,htfile=nil)
  if vertx.class.method_defined?(:j_del) && !block_given? && htfile == nil
    return ::Vertx::Util::Utils.safe_create(Java::IoVertxExtAuthHtdigest::HtdigestAuth.java_method(:create, [Java::IoVertxCore::Vertx.java_class]).call(vertx.j_del),::VertxAuthHtdigest::HtdigestAuth)
  elsif vertx.class.method_defined?(:j_del) && htfile.class == String && !block_given?
    return ::Vertx::Util::Utils.safe_create(Java::IoVertxExtAuthHtdigest::HtdigestAuth.java_method(:create, [Java::IoVertxCore::Vertx.java_class,Java::java.lang.String.java_class]).call(vertx.j_del,htfile),::VertxAuthHtdigest::HtdigestAuth)
  end
  raise ArgumentError, "Invalid arguments when calling create(#{vertx},#{htfile})"
end

+ (Object) HTDIGEST_FILE

The property name to be used to set the name of the collection inside the config

80
81
82
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-auth-htdigest/htdigest_auth.rb', line 80

def self.HTDIGEST_FILE
  Java::IoVertxExtAuthHtdigest::HtdigestAuth.HTDIGEST_FILE
end

+ (Object) j_api_type


29
30
31
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-auth-htdigest/htdigest_auth.rb', line 29

def self.j_api_type
  @@j_api_type
end

+ (Object) j_class


32
33
34
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-auth-htdigest/htdigest_auth.rb', line 32

def self.j_class
  Java::IoVertxExtAuthHtdigest::HtdigestAuth.java_class
end

+ (Object) unwrap(obj)


26
27
28
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-auth-htdigest/htdigest_auth.rb', line 26

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

+ (Object) wrap(obj)


23
24
25
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-auth-htdigest/htdigest_auth.rb', line 23

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

Instance Method Details

- (void) authenticate(authInfo = nil) { ... }

This method returns an undefined value.

Authenticate a user.

The first argument is a JSON object containing information for authenticating the user. What this actually contains depends on the specific implementation. In the case of a simple username/password based authentication it is likely to contain a JSON object with the following structure:


   {
     "username": "tim",
     "password": "mypassword"
   }
For other types of authentication it contain different information - for example a JWT token or OAuth bearer token.

If the user is successfully authenticated a object is passed to the handler in an AsyncResult. The user object can then be used for authorisation.

Parameters:

  • authInfo (Hash{String => Object}) (defaults to: nil)
    The auth information

Yields:

  • The result handler

Raises:

  • (ArgumentError)

53
54
55
56
57
58
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-auth-htdigest/htdigest_auth.rb', line 53

def authenticate(authInfo=nil)
  if authInfo.class == Hash && block_given?
    return @j_del.java_method(:authenticate, [Java::IoVertxCoreJson::JsonObject.java_class,Java::IoVertxCore::Handler.java_class]).call(::Vertx::Util::Utils.to_json_object(authInfo),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ::Vertx::Util::Utils.safe_create(ar.result,::VertxAuthCommon::User) : nil) }))
  end
  raise ArgumentError, "Invalid arguments when calling authenticate(#{authInfo})"
end

- (String) realm

Return the currently used realm

Returns:

  • (String)
    the realm

Raises:

  • (ArgumentError)

73
74
75
76
77
78
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-auth-htdigest/htdigest_auth.rb', line 73

def realm
  if !block_given?
    return @j_del.java_method(:realm, []).call()
  end
  raise ArgumentError, "Invalid arguments when calling realm()"
end