/*
* Copyright 2014 Red Hat, Inc.
*
* Red Hat licenses this file to you under the Apache License, version 2.0
* (the "License"); you may not use this file except in compliance with the
* License. You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*/
/** @module vertx-auth-common-js/auth_provider */
var utils = require('vertx-js/util/utils');
var User = require('vertx-auth-common-js/user');
var io = Packages.io;
var JsonObject = io.vertx.core.json.JsonObject;
var JAuthProvider = io.vertx.ext.auth.AuthProvider;
/**
User-facing interface for authenticating users.
@class
*/
var AuthProvider = function(j_val) {
var j_authProvider = j_val;
var that = this;
/**
Authenticate a user.
<p>
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:
<pre>
{
"username": "tim",
"password": "mypassword"
}
</pre>
For other types of authentication it contain different information - for example a JWT token or OAuth bearer token.
<p>
If the user is successfully authenticated a {@link User} object is passed to the handler in an {@link AsyncResult}.
The user object can then be used for authorisation.
@public
@param authInfo {Object} The auth information
@param resultHandler {function} The result handler
*/
this.authenticate = function(authInfo, resultHandler) {
var __args = arguments;
if (__args.length === 2 && typeof __args[0] === 'object' && typeof __args[1] === 'function') {
j_authProvider["authenticate(io.vertx.core.json.JsonObject,io.vertx.core.Handler)"](utils.convParamJsonObject(authInfo), function(ar) {
if (ar.succeeded()) {
resultHandler(utils.convReturnVertxGen(ar.result(), User), null);
} else {
resultHandler(null, ar.cause());
}
});
} else throw new TypeError('function invoked with invalid arguments');
};
// A reference to the underlying Java delegate
// NOTE! This is an internal API and must not be used in user code.
// If you rely on this property your code is likely to break if we change it / remove it without warning.
this._jdel = j_authProvider;
};
// We export the Constructor function
module.exports = AuthProvider;