/**
 * This file Copyright (c) 2003-2012 Magnolia International
 * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
 *
 *
 * This file is dual-licensed under both the Magnolia
 * Network Agreement and the GNU General Public License.
 * You may elect to use one or the other of these licenses.
 *
 * This file is distributed in the hope that it will be
 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
 * implied warranty of MERCHANTABILITY or FITNESS FOR A
 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
 * Redistribution, except as permitted by whichever of the GPL
 * or MNA you select, is prohibited.
 *
 * 1. For the GPL license (GPL), you can redistribute and/or
 * modify this file under the terms of the GNU General
 * Public License, Version 3, as published by the Free Software
 * Foundation.  You should have received a copy of the GNU
 * General Public License, Version 3 along with this program;
 * if not, write to the Free Software Foundation, Inc., 51
 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * 2. For the Magnolia Network Agreement (MNA), this file
 * and the accompanying materials are made available under the
 * terms of the MNA which accompanies this distribution, and
 * is available at http://www.magnolia-cms.com/mna.html
 *
 * Any modifications to this file must keep this entire header
 * intact.
 *
 */
package info.magnolia.cms.security;

import java.io.Serializable;
import java.security.Principal;
import java.util.Collection;

/**
 * Represents a magnolia user.
 *
 * @author philipp
 * @version $Revision:2558 $ ($Author:scharles $)
 */
public interface User extends Principal, Serializable {

    /**
     * Is this user in a specified role?
     * @param roleName the name of the role
     * @return true if in role
     */
    boolean hasRole(String roleName);

    /**
     * Remove a role. Implementation is optional
     * @deprecated since 4.5 - use {@link UserManager#removeRole(User, String)} instead.
     */
    @Deprecated
    void removeRole(String roleName) throws UnsupportedOperationException;

    /**
     * Adds a role to this user. Implementation is optional
     * @param roleName the name of the role
     * @deprecated since 4.5 - use {@link UserManager#addRole(User, String)} instead.
     */
    @Deprecated
    void addRole(String roleName) throws UnsupportedOperationException;

    /**
     * Is this user in a specified group?
     * @return true if in group
     */
    boolean inGroup(String groupName);

    /**
     * Remove a group. Implementation is optional
     * @deprecated since 4.5 - use {@link UserManager#removeGroup(User, String)} instead.
     */
    @Deprecated
    void removeGroup(String groupName) throws UnsupportedOperationException;

    /**
     * Adds this user to a group. Implementation is optional
     * @deprecated since 4.5 - use {@link UserManager#addGroup(User, String)} instead.
     */
    @Deprecated
    void addGroup(String groupName) throws UnsupportedOperationException;

    /**
     * Returns false if the user was explicitly disabled. Implementations should return
     * true by default if the status is unknown.
     */
    boolean isEnabled();

    /**
     * @deprecated since 4.5, use {@link UserManager#setProperty(User, String, Value)} instead
     */
    @Deprecated
    void setEnabled(boolean enabled);

    String getLanguage();

    @Override
    String getName();

    String getPassword();

    /**
     * Gets an arbitrary property from this user.
     */
    String getProperty(String propertyName);

    /**
     * Sets an arbitrary property for this user.
     * Values are currently Strings; we'd need some kind of abstract encoding mechanism to allow other types if needed.
     * @deprecated since 4.5, use {@link UserManager#setProperty(User, String, Value)} instead
     */
    @Deprecated
    void setProperty(String propertyName, String value);

    /**
     * Gets user identifier.
     */
    String getIdentifier();

    /**
     * Get groups that are directly assigned to the user.
     */
    Collection<String> getGroups();

    /**
     * Get all groups to which this user belongs to, collected recursively including.
     */
    Collection<String> getAllGroups();

    /**
     * Get roles that are directly assigned to the user.
     */
    Collection<String> getRoles();

    /**
     * Get all roles assigned to this user, collected recursively including groups/subgroups.
     */
    Collection<String> getAllRoles();

}