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 010 * trunk/opends/resource/legal-notices/OpenDS.LICENSE 011 * or https://OpenDS.dev.java.net/OpenDS.LICENSE. 012 * See the License for the specific language governing permissions 013 * and limitations under the License. 014 * 015 * When distributing Covered Code, include this CDDL HEADER in each 016 * file and include the License file at 017 * trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable, 018 * add the following below this CDDL HEADER, with the fields enclosed 019 * by brackets "[]" replaced with your own identifying information: 020 * Portions Copyright [yyyy] [name of copyright owner] 021 * 022 * CDDL HEADER END 023 * 024 * 025 * Copyright 2008 Sun Microsystems, Inc. 026 */ 027 package org.opends.server.admin.condition; 028 029 030 031 import org.opends.server.admin.AbstractManagedObjectDefinition; 032 import org.opends.server.admin.client.AuthorizationException; 033 import org.opends.server.admin.client.CommunicationException; 034 import org.opends.server.admin.client.ManagedObject; 035 import org.opends.server.admin.client.ManagementContext; 036 import org.opends.server.admin.server.ServerManagedObject; 037 import org.opends.server.config.ConfigException; 038 039 040 041 /** 042 * An interface for evaluating conditions. 043 */ 044 public 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 }