Class: VertxAuthCommon::AuthProvider
- Inherits:
-
Object
- Object
- VertxAuthCommon::AuthProvider
- Defined in:
- /Users/julien/java/vertx-aggregator/modules/vertx-auth/vertx-auth-common/src/main/resources/vertx-auth-common/auth_provider.rb
Overview
User-facing interface for authenticating users.
Instance Method Summary (collapse)
-
- (void) authenticate(authInfo = nil) { ... }
Authenticate a user.
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 User object is passed to the handler in an AsyncResult. The user object can then be used for authorisation.
36 37 38 39 40 41 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-auth/vertx-auth-common/src/main/resources/vertx-auth-common/auth_provider.rb', line 36 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 |