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-2016 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/** An interface for evaluating conditions. */
027public interface Condition {
028
029    /**
030     * Initializes this condition.
031     *
032     * @param d
033     *            The abstract managed object definition associated with this
034     *            condition.
035     * @throws Exception
036     *             If this condition could not be initialized.
037     */
038    void initialize(AbstractManagedObjectDefinition<?, ?> d) throws Exception;
039
040    /**
041     * Evaluates this condition against the provided client managed object.
042     *
043     * @param context
044     *            The client management context.
045     * @param managedObject
046     *            The client managed object.
047     * @return Returns <code>true</code> if this condition is satisfied.
048     * @throws LdapException
049     *             If the condition could not be evaluated.
050     */
051    boolean evaluate(ManagementContext context, ManagedObject<?> managedObject) throws LdapException;
052
053    /**
054     * Evaluates this condition against the provided server managed object.
055     *
056     * @param managedObject
057     *            The server managed object.
058     * @return Returns <code>true</code> if this condition is satisfied.
059     * @throws ConfigException
060     *             If the condition could not be evaluated due to an unexpected
061     *             configuration exception.
062     */
063    boolean evaluate(ServerManagedObject<?> managedObject) throws ConfigException;
064}