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 Unique Attribute Plugin 040 * settings. 041 * <p> 042 * The Unique Attribute Plugin enforces constraints on the value of an 043 * attribute within a portion of the directory. 044 */ 045public interface UniqueAttributePluginCfg extends PluginCfg { 046 047 /** 048 * Gets the configuration class associated with this Unique Attribute Plugin. 049 * 050 * @return Returns the configuration class associated with this Unique Attribute Plugin. 051 */ 052 Class<? extends UniqueAttributePluginCfg> configurationClass(); 053 054 055 056 /** 057 * Register to be notified when this Unique Attribute Plugin is changed. 058 * 059 * @param listener 060 * The Unique Attribute Plugin configuration change listener. 061 */ 062 void addUniqueAttributeChangeListener(ConfigurationChangeListener<UniqueAttributePluginCfg> listener); 063 064 065 066 /** 067 * Deregister an existing Unique Attribute Plugin configuration change listener. 068 * 069 * @param listener 070 * The Unique Attribute Plugin configuration change listener. 071 */ 072 void removeUniqueAttributeChangeListener(ConfigurationChangeListener<UniqueAttributePluginCfg> listener); 073 074 075 076 /** 077 * Gets the "base-dn" property. 078 * <p> 079 * Specifies a base DN within which the attribute must be unique. 080 * 081 * @return Returns an unmodifiable set containing the values of the "base-dn" property. 082 */ 083 SortedSet<DN> getBaseDN(); 084 085 086 087 /** 088 * Gets the "java-class" property. 089 * <p> 090 * Specifies the fully-qualified name of the Java class that 091 * provides the plug-in implementation. 092 * 093 * @return Returns the value of the "java-class" property. 094 */ 095 String getJavaClass(); 096 097 098 099 /** 100 * Gets the "plugin-type" property. 101 * <p> 102 * Specifies the set of plug-in types for the plug-in, which 103 * specifies the times at which the plug-in is invoked. 104 * 105 * @return Returns an unmodifiable set containing the values of the "plugin-type" property. 106 */ 107 SortedSet<PluginType> getPluginType(); 108 109 110 111 /** 112 * Gets the "type" property. 113 * <p> 114 * Specifies the type of attributes to check for value uniqueness. 115 * 116 * @return Returns an unmodifiable set containing the values of the "type" property. 117 */ 118 SortedSet<AttributeType> getType(); 119 120}