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.std.client; 028 029 030 031 import org.opends.server.admin.ConfigurationClient; 032 import org.opends.server.admin.IllegalPropertyValueException; 033 import org.opends.server.admin.ManagedObjectDefinition; 034 import org.opends.server.admin.std.server.ExtendedOperationHandlerCfg; 035 036 037 038 /** 039 * A client-side interface for reading and modifying Extended 040 * Operation Handler settings. 041 * <p> 042 * Extended Operation Handlers processes the different types of 043 * extended operations in the server. 044 */ 045 public interface ExtendedOperationHandlerCfgClient extends ConfigurationClient { 046 047 /** 048 * Get the configuration definition associated with this Extended Operation Handler. 049 * 050 * @return Returns the configuration definition associated with this Extended Operation Handler. 051 */ 052 ManagedObjectDefinition<? extends ExtendedOperationHandlerCfgClient, ? extends ExtendedOperationHandlerCfg> definition(); 053 054 055 056 /** 057 * Gets the "enabled" property. 058 * <p> 059 * Indicates whether the Extended Operation Handler is enabled (that 060 * is, whether the types of extended operations are allowed in the 061 * server). 062 * 063 * @return Returns the value of the "enabled" property. 064 */ 065 Boolean isEnabled(); 066 067 068 069 /** 070 * Sets the "enabled" property. 071 * <p> 072 * Indicates whether the Extended Operation Handler is enabled (that 073 * is, whether the types of extended operations are allowed in the 074 * server). 075 * 076 * @param value The value of the "enabled" property. 077 * @throws IllegalPropertyValueException 078 * If the new value is invalid. 079 */ 080 void setEnabled(boolean value) throws IllegalPropertyValueException; 081 082 083 084 /** 085 * Gets the "java-class" property. 086 * <p> 087 * Specifies the fully-qualified name of the Java class that 088 * provides the Extended Operation Handler implementation. 089 * 090 * @return Returns the value of the "java-class" property. 091 */ 092 String getJavaClass(); 093 094 095 096 /** 097 * Sets the "java-class" property. 098 * <p> 099 * Specifies the fully-qualified name of the Java class that 100 * provides the Extended Operation Handler implementation. 101 * 102 * @param value The value of the "java-class" property. 103 * @throws IllegalPropertyValueException 104 * If the new value is invalid. 105 */ 106 void setJavaClass(String value) throws IllegalPropertyValueException; 107 108 }