001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions Copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2008 Sun Microsystems, Inc.
015 * Portions Copyright 2014 ForgeRock AS.
016 */
017package org.forgerock.opendj.config.conditions;
018
019import org.forgerock.opendj.config.AbstractManagedObjectDefinition;
020import org.forgerock.opendj.config.client.ManagedObject;
021import org.forgerock.opendj.config.client.ManagementContext;
022import org.forgerock.opendj.config.server.ConfigException;
023import org.forgerock.opendj.config.server.ServerManagedObject;
024import org.forgerock.opendj.ldap.LdapException;
025
026/**
027 * An interface for evaluating conditions.
028 */
029public interface Condition {
030
031    /**
032     * Initializes this condition.
033     *
034     * @param d
035     *            The abstract managed object definition associated with this
036     *            condition.
037     * @throws Exception
038     *             If this condition could not be initialized.
039     */
040    void initialize(AbstractManagedObjectDefinition<?, ?> d) throws Exception;
041
042    /**
043     * Evaluates this condition against the provided client managed object.
044     *
045     * @param context
046     *            The client management context.
047     * @param managedObject
048     *            The client managed object.
049     * @return Returns <code>true</code> if this condition is satisfied.
050     * @throws LdapException
051     *             If the condition could not be evaluated.
052     */
053    boolean evaluate(ManagementContext context, ManagedObject<?> managedObject) throws LdapException;
054
055    /**
056     * Evaluates this condition against the provided server managed object.
057     *
058     * @param managedObject
059     *            The server managed object.
060     * @return Returns <code>true</code> if this condition is satisfied.
061     * @throws ConfigException
062     *             If the condition could not be evaluated due to an unexpected
063     *             configuration exception.
064     */
065    boolean evaluate(ServerManagedObject<?> managedObject) throws ConfigException;
066}