/*
* 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/user */
var utils = require('vertx-js/util/utils');
var AuthProvider = require('vertx-auth-common-js/auth_provider');
var io = Packages.io;
var JsonObject = io.vertx.core.json.JsonObject;
var JUser = io.vertx.ext.auth.User;
/**
Represents an authenticates User and contains operations to authorise the user.
<p>
Please consult the documentation for a detailed explanation.
@class
*/
var User = function(j_val) {
var j_user = j_val;
var that = this;
/**
Is the user authorised to
@public
@param authority {string} the authority - what this really means is determined by the specific implementation. It might represent a permission to access a resource e.g. `printers:printer34` or it might represent authority to a role in a roles based model, e.g. `role:admin`.
@param resultHandler {function} handler that will be called with an {@link AsyncResult} containing the value `true` if the they has the authority or `false` otherwise.
@return {User} the User to enable fluent use
*/
this.isAuthorised = function(authority, resultHandler) {
var __args = arguments;
if (__args.length === 2 && typeof __args[0] === 'string' && typeof __args[1] === 'function') {
j_user["isAuthorised(java.lang.String,io.vertx.core.Handler)"](authority, function(ar) {
if (ar.succeeded()) {
resultHandler(ar.result(), null);
} else {
resultHandler(null, ar.cause());
}
});
return that;
} else throw new TypeError('function invoked with invalid arguments');
};
/**
The User object will cache any authorities that it knows it has to avoid hitting the
underlying auth provider each time. Use this method if you want to clear this cache.
@public
@return {User} the User to enable fluent use
*/
this.clearCache = function() {
var __args = arguments;
if (__args.length === 0) {
j_user["clearCache()"]();
return that;
} else throw new TypeError('function invoked with invalid arguments');
};
/**
Get the underlying principal for the User. What this actually returns depends on the implementation.
For a simple user/password based auth, it's likely to contain a JSON object with the following structure:
<pre>
{
"username", "tim"
}
</pre>
@public
@return {Object} JSON representation of the Principal
*/
this.principal = function() {
var __args = arguments;
if (__args.length === 0) {
return utils.convReturnJson(j_user["principal()"]());
} else throw new TypeError('function invoked with invalid arguments');
};
/**
Set the auth provider for the User. This is typically used to reattach a detached User with an AuthProvider, e.g.
after it has been deserialized.
@public
@param authProvider {AuthProvider} the AuthProvider - this must be the same type of AuthProvider that originally created the User
*/
this.setAuthProvider = function(authProvider) {
var __args = arguments;
if (__args.length === 1 && typeof __args[0] === 'object' && __args[0]._jdel) {
j_user["setAuthProvider(io.vertx.ext.auth.AuthProvider)"](authProvider._jdel);
} 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_user;
};
// We export the Constructor function
module.exports = User;