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 */ 026package org.opends.server.admin.std.server; 027 028 029 030import java.util.SortedSet; 031import org.opends.server.admin.server.ConfigurationChangeListener; 032import org.opends.server.admin.std.meta.PluginCfgDefn.PluginType; 033import org.opends.server.types.AttributeType; 034import org.opends.server.types.DN; 035 036 037 038/** 039 * A server-side interface for querying Seven Bit Clean Plugin 040 * settings. 041 * <p> 042 * The Seven Bit Clean Plugin ensures that values for a specified set 043 * of attributes are 7-bit clean. 044 */ 045public interface SevenBitCleanPluginCfg extends PluginCfg { 046 047 /** 048 * Gets the configuration class associated with this Seven Bit Clean Plugin. 049 * 050 * @return Returns the configuration class associated with this Seven Bit Clean Plugin. 051 */ 052 Class<? extends SevenBitCleanPluginCfg> configurationClass(); 053 054 055 056 /** 057 * Register to be notified when this Seven Bit Clean Plugin is changed. 058 * 059 * @param listener 060 * The Seven Bit Clean Plugin configuration change listener. 061 */ 062 void addSevenBitCleanChangeListener(ConfigurationChangeListener<SevenBitCleanPluginCfg> listener); 063 064 065 066 /** 067 * Deregister an existing Seven Bit Clean Plugin configuration change listener. 068 * 069 * @param listener 070 * The Seven Bit Clean Plugin configuration change listener. 071 */ 072 void removeSevenBitCleanChangeListener(ConfigurationChangeListener<SevenBitCleanPluginCfg> listener); 073 074 075 076 /** 077 * Gets the "attribute-type" property. 078 * <p> 079 * Specifies the name or OID of an attribute type for which values 080 * should be checked to ensure that they are 7-bit clean. 081 * 082 * @return Returns an unmodifiable set containing the values of the "attribute-type" property. 083 */ 084 SortedSet<AttributeType> getAttributeType(); 085 086 087 088 /** 089 * Gets the "base-dn" property. 090 * <p> 091 * Specifies the base DN below which the checking is performed. 092 * <p> 093 * Any attempt to update a value for one of the configured 094 * attributes below this base DN must be 7-bit clean for the 095 * operation to be allowed. 096 * 097 * @return Returns an unmodifiable set containing the values of the "base-dn" property. 098 */ 099 SortedSet<DN> getBaseDN(); 100 101 102 103 /** 104 * Gets the "java-class" property. 105 * <p> 106 * Specifies the fully-qualified name of the Java class that 107 * provides the plug-in implementation. 108 * 109 * @return Returns the value of the "java-class" property. 110 */ 111 String getJavaClass(); 112 113 114 115 /** 116 * Gets the "plugin-type" property. 117 * <p> 118 * Specifies the set of plug-in types for the plug-in, which 119 * specifies the times at which the plug-in is invoked. 120 * 121 * @return Returns an unmodifiable set containing the values of the "plugin-type" property. 122 */ 123 SortedSet<PluginType> getPluginType(); 124 125}