root/trunk/components/common/src/ome/system/Principal.java

/*
 * ome.system.Principal
 *
 *   Copyright 2006 University of Dundee. All rights reserved.
 *   Use is subject to license terms supplied in LICENSE.txt
 */

package ome.system;

// Java imports
import java.io.Serializable;

import ome.model.enums.EventType;
import ome.model.internal.Permissions;
import ome.model.meta.ExperimenterGroup;

/**
 * implementation of {@link java.security.Principal}. Specialized for Omero to
 * carry a {@link ExperimenterGroup group}, an {@link EventType event type} and
 * a {@link Permissions umask}.
 * 
 * @author Josh Moore, josh.moore at gmx.de
 * @version $Revision$, $Date$
 * @see EventType
 * @see ExperimenterGroup
 * @see Permissions
 * @since 3.0
 */
public class Principal implements java.security.Principal, Serializable {

    private static final long serialVersionUID = 3761954018296933086L;

    protected String name;

    protected String group;

    protected String type;

    protected Permissions umask;

    /**
     * Creates a Principal with null group and event type. These must be taken
     * from the session.
     * 
     * @param name
     */
    public Principal(String name) {
        this(name, null, null);
    }

    public Principal(String name, String group, String eventType) {
        this.name = name;
        this.group = group;
        this.type = eventType;
    }

    // IMMUTABLE

    public String getName() {
        return this.name;
    }

    public String getGroup() {
        return this.group;
    }

    public String getEventType() {
        return this.type;
    }

    // MUTABLE

    public boolean hasUmask() {
        return this.umask != null;
    }

    public Permissions getUmask() {
        return this.umask;
    }

    public void setUmask(Permissions mask) {
        this.umask = mask;
    }

    /**
     * returns only the name of the instance because that is the expected
     * behavior of {@link java.security.Principal} implementations
     * 
     * @return value of {@link #name}
     */
    @Override
    public String toString() {
        return this.name;
    }

}