identity/entitlement/AndCondition.java

	AndCondition.java revision 8af80418ba1ec431c8027fa9668e5678658d3611
/**
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2009 Sun Microsystems Inc. All Rights Reserved
 *
 * The contents of this file are subject to the terms
 * of the Common Development and Distribution License
 * (the License). You may not use this file except in
 * compliance with the License.
 *
 * You can obtain a copy of the License at
 * https://opensso.dev.java.net/public/CDDLv1.0.html or
 * opensso/legal/CDDLv1.0.txt
 * See the License for the specific language governing
 * permission and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL
 * Header Notice in each file and include the License file
 * at opensso/legal/CDDLv1.0.txt.
 * If applicable, add the following below the CDDL Header,
 * with the fields enclosed by brackets [] replaced by
 * your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * $Id: AndCondition.java,v 1.3 2010/01/12 21:29:58 veiming Exp $
 */
package com.sun.identity.entitlement;

import java.util.Collections;
import java.util.Map;
import java.util.Set;
import javax.security.auth.Subject;

/**
 * <code>EntitlementCondition</code> wrapper on a set of
 * <code>EntitlementCondition</code>(s) to provide
 * boolean OR logic Membership is of <code>AndCondition</code> is satisfied
 * if the user is a member of any of the wrapped
 * <code>EntitlementCondition</code>.
  */
public class AndCondition extends LogicalCondition {
    /**
     * Constructs <code>AndCondition</code>
     */
    public AndCondition() {
        super();
    }

    /**
     * Constructs AndCondition
     *
     * @param eConditions wrapped <code>EntitlementCondition</code>(s)
     */
    public AndCondition(Set<EntitlementCondition> eConditions) {
        super(eConditions);
    }

    /**
     * Constructs <code>AndCondition</code>.
     *
     * @param eConditions wrapped <code>EntitlementCondition</code>(s)
     * @param pConditionName subject name as used in OpenSSO policy,
     * this is releavant only when UserECondition was created from
     * OpenSSO policy Condition
     */
    public AndCondition(
        Set<EntitlementCondition> eConditions,
        String pConditionName
    ) {
        super(eConditions, pConditionName);
    }

    /**
     * Returns <code>ConditionDecision</code> of
     * <code>EntitlementCondition</code> evaluation
     *
     * @param realm Realm name.
     * @param subject EntitlementCondition who is under evaluation.
     * @param resourceName Resource name.
     * @param environment Environment parameters.
     * @return <code>ConditionDecision</code> of
     * <code>EntitlementCondition</code> evaluation
     * @throws EntitlementException if error occurs.
     */
    public ConditionDecision evaluate(
        String realm,
        Subject subject,
        String resourceName,
        Map<String, Set<String>> environment
    ) throws EntitlementException {
        ConditionDecision decision = new ConditionDecision(
            true, Collections.EMPTY_MAP);
        Set<EntitlementCondition> eConditions = getEConditions();
        boolean satisfied = true;

        if ((eConditions != null) && !eConditions.isEmpty()) {
            for (EntitlementCondition ec : eConditions) {
                ConditionDecision d = ec.evaluate(realm, subject, resourceName,
                    environment);
                decision.addAdvices(d);
                satisfied &= d.isSatisfied();
            }
        }
        decision.setSatisfied(satisfied);
        return decision;
    }
}