org.glite.slcs.group.Group.java Source code

Introduction

Here is the source code for org.glite.slcs.group.Group.java

Source

/*
 * $Id: Group.java,v 1.4 2007/11/01 14:35:11 vtschopp Exp $
 *
 * Copyright (c) Members of the EGEE Collaboration. 2004.
 * See http://eu-egee.org/partners/ for details on the copyright holders.
 * For license conditions see the license file or http://eu-egee.org/license.html 
 */
package org.glite.slcs.group;

import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.glite.slcs.acl.AccessControlRule;
import org.glite.slcs.attribute.Attribute;

/**
 * Named group defined by a list of {@link GroupMember}s. A user is a group
 * member when all his attributes match one of the group member attributes list.
 * An optional {@link AccessControlRule} constraint, defining the mandatory
 * {@link Attribute}s list required for each rule, can be added.
 * 
 * @author Valery Tschopp <tschopp@switch.ch>
 * @version $Revision: 1.4 $
 */
public class Group {

    /** Logging */
    static private Log LOG = LogFactory.getLog(Group.class);

    /** Group name */
    private String name_ = null;

    /** Group members */
    private List members_ = null;

    /** AccessControlRule constraints */
    private List ruleAttributesConstraint_ = null;

    /**
     * Constructor of a named group without member and without rule constraint.
     * 
     * @param name
     *            The group name.
     */
    public Group(String name) {
        name_ = name;
        members_ = new ArrayList();
        ruleAttributesConstraint_ = new ArrayList();
    }

    /**
     * Constructor
     * 
     * @param name
     *            The group name.
     * @param members
     *            List of {@link GroupMember}s of the group.
     */
    public Group(String name, List members) {
        name_ = name;
        members_ = members;
        ruleAttributesConstraint_ = new ArrayList();
    }

    /**
     * @return the list of {@link GroupMember}s.
     */
    public List getGroupMembers() {
        return members_;
    }

    /**
     * @param members
     *            set the list of {@link GroupMember}s.
     */
    public void setGroupMembers(List members) {
        members_ = members;
    }

    /**
     * Adds an {@link GroupMember} to the group members list.
     * 
     * @param member
     *            The member to add.
     */
    public void addGroupMember(GroupMember member) {
        members_.add(member);
    }

    /**
     * @return the group name
     */
    public String getName() {
        return name_;
    }

    /**
     * @param name
     *            the group name to set
     */
    public void setName(String name) {
        name_ = name;
    }

    /**
     * Checks if the user, identified by his {@link Attribute}s, is member of
     * this group.
     * 
     * @param userAttributes
     *            The user {@link Attribute}s
     * @return <code>true</code> if the user is member of the group.
     */
    public boolean isMember(List userAttributes) {
        Iterator iterator = members_.iterator();
        while (iterator.hasNext()) {
            GroupMember member = (GroupMember) iterator.next();
            List memberAttributes = member.getAttributes();
            if (userAttributes.containsAll(memberAttributes)) {
                if (LOG.isDebugEnabled()) {
                    LOG.debug("Group " + name_ + " membership: " + memberAttributes);
                }
                return true;
            }
        }
        return false;
    }

    /**
     * Gets the {@link AccessControlRule} constraints defined for this group.
     * 
     * @return the list of attributes defining the rule constraints. An empty
     *         list if no constaint are defined.
     */
    public List getRuleAttributesConstraint() {
        if (LOG.isDebugEnabled()) {
            LOG.debug("ruleAttributesConstraint=" + ruleAttributesConstraint_);
        }
        return ruleAttributesConstraint_;
    }

    /**
     * Adds an {@link Attribute} to the list of AccessControlRule constraints
     * defined for this group.
     * 
     * @param attribute
     *            The attribute to add as rule constraint.
     */
    public void addRuleAttributesConstraint(Attribute attribute) {
        attribute.setConstrained(true);
        ruleAttributesConstraint_.add(attribute);
    }

    /**
     * @param ruleConstraints
     *            the ruleConstraints to set
     */
    public void setRuleAttributesConstraint(List ruleConstraints) {
        ruleAttributesConstraint_ = ruleConstraints;
        // set the attributes as constrained
        Iterator constrainedAttributes = ruleAttributesConstraint_.iterator();
        while (constrainedAttributes.hasNext()) {
            Attribute attribute = (Attribute) constrainedAttributes.next();
            attribute.setConstrained(true);
        }
    }

    /*
     * (non-Javadoc)
     * 
     * @see java.lang.Object#toString()
     */
    public String toString() {
        StringBuffer sb = new StringBuffer();
        sb.append("Group[");
        sb.append(name_).append(":");
        sb.append(members_);
        sb.append("]");
        return sb.toString();
    }

}