001/*
002 * CDDL HEADER START
003 *
004 * The contents of this file are subject to the terms of the
005 * Common Development and Distribution License, Version 1.0 only
006 * (the "License").  You may not use this file except in compliance
007 * with the License.
008 *
009 * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
010 * or http://forgerock.org/license/CDDLv1.0.html.
011 * See the License for the specific language governing permissions
012 * and limitations under the License.
013 *
014 * When distributing Covered Code, include this CDDL HEADER in each
015 * file and include the License file at legal-notices/CDDLv1_0.txt.
016 * If applicable, add the following below this CDDL HEADER, with the
017 * fields enclosed by brackets "[]" replaced with your own identifying
018 * information:
019 *      Portions Copyright [yyyy] [name of copyright owner]
020 *
021 * CDDL HEADER END
022 *
023 *
024 *      Copyright 2008 Sun Microsystems, Inc.
025 *      Portions Copyright 2014 ForgeRock AS
026 */
027package org.opends.server.admin.condition;
028
029
030
031import org.opends.server.admin.AbstractManagedObjectDefinition;
032import org.opends.server.admin.client.AuthorizationException;
033import org.opends.server.admin.client.CommunicationException;
034import org.opends.server.admin.client.ManagedObject;
035import org.opends.server.admin.client.ManagementContext;
036import org.opends.server.admin.server.ServerManagedObject;
037import org.forgerock.opendj.config.server.ConfigException;
038
039
040
041/**
042 * An interface for evaluating conditions.
043 */
044public interface Condition {
045
046  /**
047   * Initializes this condition.
048   *
049   * @param d
050   *          The abstract managed object definition associated with
051   *          this condition.
052   * @throws Exception
053   *           If this condition could not be initialized.
054   */
055  void initialize(AbstractManagedObjectDefinition<?, ?> d) throws Exception;
056
057
058
059  /**
060   * Evaluates this condition against the provided client managed
061   * object.
062   *
063   * @param context
064   *          The client management context.
065   * @param managedObject
066   *          The client managed object.
067   * @return Returns <code>true</code> if this condition is
068   *         satisfied.
069   * @throws AuthorizationException
070   *           If the condition could not be evaluated due to an
071   *           authorization problem.
072   * @throws CommunicationException
073   *           If the condition could not be evaluated due to an
074   *           communication problem.
075   */
076  boolean evaluate(ManagementContext context, ManagedObject<?> managedObject)
077      throws AuthorizationException, CommunicationException;
078
079
080
081  /**
082   * Evaluates this condition against the provided server managed
083   * object.
084   *
085   * @param managedObject
086   *          The server managed object.
087   * @return Returns <code>true</code> if this condition is
088   *         satisfied.
089   * @throws ConfigException
090   *           If the condition could not be evaluated due to an
091   *           unexpected configuration exception.
092   */
093  boolean evaluate(ServerManagedObject<?> managedObject) throws ConfigException;
094}