/**
 * Licensed to Apereo under one or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information regarding copyright ownership. Apereo
 * licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use
 * this file except in compliance with the License. You may obtain a copy of the License at the
 * following location:
 *
 * <p>http://www.apache.org/licenses/LICENSE-2.0
 *
 * <p>Unless required by applicable law or agreed to in writing, software distributed under the
 * License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apereo.portal.layout.dlm.providers;

import org.apereo.portal.layout.dlm.Evaluator;

/**
 * Creates a group membership evaluator. This class inherits from IPersonEvaluatorFactory.
 * Subclassing IPersonEvaluatorFactory gives us all benefits of its configuration language
 * structure. The side affect of course is then that our group evaluator must be configured with
 * that language structure. The definitions of the specific, non-element-containing evaluators must
 * conform to the following element structure:
 *
 * <pre>
 *
 *   < attribute mode="required"
 *     name="required"
 *     value="optional"/ >
 *
 * </pre>
 *
 * Therefore, the form selected for our group membership evaluator configurations is:
 *
 * <pre>
 *
 *   < attribute mode="memberOf" name="Students"/ >
 *
 * </pre>
 *
 * Case is important for both mode and name. The value attribute is not used in configuration of
 * these group membership evaluators.
 *
 * @see
 *     org.apereo.portal.layout.dlm.providers.PersonEvaluatorFactory#getAttributeEvaluator(java.lang.String,
 *     java.lang.String, java.lang.String)
 * @since 2.5
 */
public class GroupMembershipEvaluatorFactory extends PersonEvaluatorFactory {
    /**
     * Returns an instance of an evaluator specific to this factory and the passed in values. Name
     * should be a well known group name. Case is important. The mode should be "memberOf" for now.
     * Other modes may be added in the future like, "deepMemberOf".
     */
    public Evaluator getAttributeEvaluator(String name, String mode, String value) {
        return new GroupMembershipEvaluator(mode, name);
    }
}