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 */ 016package org.forgerock.opendj.server.config.client; 017 018 019 020import java.util.Collection; 021import java.util.SortedSet; 022import org.forgerock.opendj.config.ManagedObjectDefinition; 023import org.forgerock.opendj.config.PropertyException; 024import org.forgerock.opendj.ldap.DN; 025import org.forgerock.opendj.ldap.schema.AttributeType; 026import org.forgerock.opendj.server.config.meta.PluginCfgDefn.PluginType; 027import org.forgerock.opendj.server.config.server.SevenBitCleanPluginCfg; 028 029 030 031/** 032 * A client-side interface for reading and modifying Seven Bit Clean 033 * Plugin settings. 034 * <p> 035 * The Seven Bit Clean Plugin ensures that values for a specified set 036 * of attributes are 7-bit clean. 037 */ 038public interface SevenBitCleanPluginCfgClient extends PluginCfgClient { 039 040 /** 041 * Get the configuration definition associated with this Seven Bit Clean Plugin. 042 * 043 * @return Returns the configuration definition associated with this Seven Bit Clean Plugin. 044 */ 045 ManagedObjectDefinition<? extends SevenBitCleanPluginCfgClient, ? extends SevenBitCleanPluginCfg> definition(); 046 047 048 049 /** 050 * Gets the "attribute-type" property. 051 * <p> 052 * Specifies the name or OID of an attribute type for which values 053 * should be checked to ensure that they are 7-bit clean. 054 * 055 * @return Returns the values of the "attribute-type" property. 056 */ 057 SortedSet<AttributeType> getAttributeType(); 058 059 060 061 /** 062 * Sets the "attribute-type" property. 063 * <p> 064 * Specifies the name or OID of an attribute type for which values 065 * should be checked to ensure that they are 7-bit clean. 066 * 067 * @param values The values of the "attribute-type" property. 068 * @throws PropertyException 069 * If one or more of the new values are invalid. 070 */ 071 void setAttributeType(Collection<AttributeType> values) throws PropertyException; 072 073 074 075 /** 076 * Gets the "base-dn" property. 077 * <p> 078 * Specifies the base DN below which the checking is performed. 079 * <p> 080 * Any attempt to update a value for one of the configured 081 * attributes below this base DN must be 7-bit clean for the 082 * operation to be allowed. 083 * 084 * @return Returns the values of the "base-dn" property. 085 */ 086 SortedSet<DN> getBaseDN(); 087 088 089 090 /** 091 * Sets the "base-dn" property. 092 * <p> 093 * Specifies the base DN below which the checking is performed. 094 * <p> 095 * Any attempt to update a value for one of the configured 096 * attributes below this base DN must be 7-bit clean for the 097 * operation to be allowed. 098 * 099 * @param values The values of the "base-dn" property. 100 * @throws PropertyException 101 * If one or more of the new values are invalid. 102 */ 103 void setBaseDN(Collection<DN> values) throws PropertyException; 104 105 106 107 /** 108 * Gets the "java-class" property. 109 * <p> 110 * Specifies the fully-qualified name of the Java class that 111 * provides the plug-in implementation. 112 * 113 * @return Returns the value of the "java-class" property. 114 */ 115 String getJavaClass(); 116 117 118 119 /** 120 * Sets the "java-class" property. 121 * <p> 122 * Specifies the fully-qualified name of the Java class that 123 * provides the plug-in implementation. 124 * 125 * @param value The value of the "java-class" property. 126 * @throws PropertyException 127 * If the new value is invalid. 128 */ 129 void setJavaClass(String value) throws PropertyException; 130 131 132 133 /** 134 * Gets the "plugin-type" property. 135 * <p> 136 * Specifies the set of plug-in types for the plug-in, which 137 * specifies the times at which the plug-in is invoked. 138 * 139 * @return Returns the values of the "plugin-type" property. 140 */ 141 SortedSet<PluginType> getPluginType(); 142 143 144 145 /** 146 * Sets the "plugin-type" property. 147 * <p> 148 * Specifies the set of plug-in types for the plug-in, which 149 * specifies the times at which the plug-in is invoked. 150 * 151 * @param values The values of the "plugin-type" property. 152 * @throws PropertyException 153 * If one or more of the new values are invalid. 154 */ 155 void setPluginType(Collection<PluginType> values) throws PropertyException; 156 157}