com.payneteasy.superfly.api.SSOUser Maven / Gradle / Ivy

Go to download
package com.payneteasy.superfly.api;

import java.io.Serializable;
import java.util.Map;

/**
 * User from SSO with roles, actions and preferences. User may have several
 * roles, each role has its own action set.
 * 
 * @author Roman Puchkovskiy
 * @since 1.0
 */
public class SSOUser implements Serializable {
    private static final long serialVersionUID = 2939559042187840631L;

    private String name;
    private String sessionId;
    private Map actionsMap;
    private Map preferences;

    /**
     * Constructs user.
     *
     * @param name            user name
     * @param actionsMap    mapping from roles to action sets
     * @param preferences    preferences of the user
     */
    public SSOUser(String name, Map actionsMap,
            Map preferences) {
        super();
        this.name = name;
        this.actionsMap = actionsMap;
        this.preferences = preferences;
    }

    /**
     * Returns user name.
     *
     * @return name
     */
    public String getName() {
        return name;
    }

    /**
     * Sets user name.
     *
     * @param name    name to set
     */
    public void setName(String name) {
        this.name = name;
    }

    /**
     * Returns a session ID.
     *
     * @return session ID
     * @since 1.1
     */
    public String getSessionId() {
        return sessionId;
    }

    /**
     * Sets a session ID.
     *
     * @param sessionId    ID to set
     * @since 1.1
     */
    public void setSessionId(String sessionId) {
        this.sessionId = sessionId;
    }

    /**
     * Returns a mapping from roles to action sets.
     *
     * @return mapping
     */
    public Map getActionsMap() {
        return actionsMap;
    }

    /**
     * Sets a mapping from roles to action sets.
     *
     * @param actionsMap
     */
    public void setActionsMap(Map actionsMap) {
        this.actionsMap = actionsMap;
    }

    /**
     * Returns preferences.
     *
     * @return preferences
     */
    public Map getPreferences() {
        return preferences;
    }

    /**
     * Sets preferences.
     *
     * @param preferences    preferences to set
     */
    public void setPreferences(Map preferences) {
        this.preferences = preferences;
    }

    @Override
    public String toString() {
        return name;
    }
}