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

package org.gvsig.tools.identitymanagement;

import java.util.List;

public interface SimpleIdentity {

    public static final String READ_AUTHORIZATION = "access--read";

    public static final String WRITE_AUTHORIZATION = "access--write";

    /**

     * Return the identifier of this user

     *

     * @return the id of the user

     */

    public String getID();

    public String getName();

    public String getFullName();

    public List getAttributeNames();

    public String getAttribute(String name);

    /**

     * Checks is the identity is authorized to perform the action.

     * If the identity is authorized to execute the accion return true, 

     * otherwise false.

     *

     * "actionName", can be a single name or a list of coma separated names.

     *

     * If actionName is a list of actions, fails when not authorized to one of 

     * the actions.

     * 

     * @param actionName 

     * @return true if the identity is authorized

     */

    public boolean isAuthorized(String actionName);

    /**

     * Checks is the identity is authorized to perform the action on the 

     * indicated resource. 

     * If the identity is authorized to execute the accion return true, 

     * otherwise false.

     *

     * "actionName", can be a single name or a list of coma sepaated

     * names.

     *

     * @param actionName

     * @param resource

     * @param resourceName

     * @return true if the identity is authorized

     */

    public boolean isAuthorized(String actionName, Object resource, String resourceName);

    /**

     * Checks if the identity has read access on the indicated resource.

     * This method is a utility method for:

     * 

     * {@link #isAuthorized(READ_AUTHORIZATION, resource, resourceName) 

     * 

     * @param resource

     * @param resourceName

     * @return  true if the identity has read access

     */

    public boolean canRead(Object resource, String resourceName);

    /**

     * Checks if the identity has read access on the indicated resource.

     * This method is a utility method for:

     * 

     * {@link #isAuthorized(WRITE_AUTHORIZATION, resource, resourceName) 

     * 

     * @param resource

     * @param resourceName

     * @return  true if the identity has write access

     */

    public boolean canWrite(Object resource, String resourceName);

}