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.server; 017 018 019 020import java.util.SortedSet; 021import org.forgerock.opendj.config.server.ConfigurationChangeListener; 022import org.forgerock.opendj.ldap.DN; 023import org.forgerock.opendj.ldap.schema.AttributeType; 024import org.forgerock.opendj.server.config.meta.PluginCfgDefn.PluginType; 025 026 027 028/** 029 * A server-side interface for querying Unique Attribute Plugin 030 * settings. 031 * <p> 032 * The Unique Attribute Plugin enforces constraints on the value of an 033 * attribute within a portion of the directory. 034 */ 035public interface UniqueAttributePluginCfg extends PluginCfg { 036 037 /** 038 * Gets the configuration class associated with this Unique Attribute Plugin. 039 * 040 * @return Returns the configuration class associated with this Unique Attribute Plugin. 041 */ 042 Class<? extends UniqueAttributePluginCfg> configurationClass(); 043 044 045 046 /** 047 * Register to be notified when this Unique Attribute Plugin is changed. 048 * 049 * @param listener 050 * The Unique Attribute Plugin configuration change listener. 051 */ 052 void addUniqueAttributeChangeListener(ConfigurationChangeListener<UniqueAttributePluginCfg> listener); 053 054 055 056 /** 057 * Deregister an existing Unique Attribute Plugin configuration change listener. 058 * 059 * @param listener 060 * The Unique Attribute Plugin configuration change listener. 061 */ 062 void removeUniqueAttributeChangeListener(ConfigurationChangeListener<UniqueAttributePluginCfg> listener); 063 064 065 066 /** 067 * Gets the "base-dn" property. 068 * <p> 069 * Specifies a base DN within which the attribute must be unique. 070 * 071 * @return Returns an unmodifiable set containing the values of the "base-dn" property. 072 */ 073 SortedSet<DN> getBaseDN(); 074 075 076 077 /** 078 * Gets the "java-class" property. 079 * <p> 080 * Specifies the fully-qualified name of the Java class that 081 * provides the plug-in implementation. 082 * 083 * @return Returns the value of the "java-class" property. 084 */ 085 String getJavaClass(); 086 087 088 089 /** 090 * Gets the "plugin-type" property. 091 * <p> 092 * Specifies the set of plug-in types for the plug-in, which 093 * specifies the times at which the plug-in is invoked. 094 * 095 * @return Returns an unmodifiable set containing the values of the "plugin-type" property. 096 */ 097 SortedSet<PluginType> getPluginType(); 098 099 100 101 /** 102 * Gets the "type" property. 103 * <p> 104 * Specifies the type of attributes to check for value uniqueness. 105 * 106 * @return Returns an unmodifiable set containing the values of the "type" property. 107 */ 108 SortedSet<AttributeType> getType(); 109 110}