Application: gvSIG desktop » Library: org.gvsig.tools

package org.gvsig.tools.identitymanagement;

import java.util.Collection;

public interface SimpleIdentityManager {

    //

    // http://en.wikipedia.org/wiki/Identity_management

    //

    /**

     * Authenticate the identity in the system and stablish a session with this

     * identity.

     * If the identityid don't exists or the password specified is incorrect, throw

     * a exception.

     *

     * If the domain is not required it can not be null.

     *

     * @param domain, the domain used to authenticate the user

     * @param identityid, identity id to login in the system

     * @param password

     */

    public void login(String domain, String identityid, String password) throws UnauthorizedException;

    /**

     * Closes the session stablised with the current identity.

     */

    public void logout();

    /**

     * Return the identity of the current session in the system.

     * Can't be null.

     *

     * @return the current identity

     */

    public SimpleIdentity getCurrentIdentity();

    public SimpleIdentity getAdministrator();

    /**

     * Inform if the login process require a domain name.

     *

     * @return true if a domain name is required.

     */

    public boolean needDomain();

    /**

     * Run the specified action as the specified identity.

     * 

     * @param domain

     * @param identityid

     * @param acction 

     */

    public void sudo(String domain, String identityid, Runnable acction);

    /**

     * Register the actionName as an action that require authorization.

     * 

     * @param actionName 

     */

    public void registerAction(String actionName);

    /**

     * Return a list of the actions that are registered.

     * 

     * @return list of action names that requiere authorization.

     */

    public Collection getActions();

}