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 org.forgerock.opendj.config.server.ConfigurationChangeListener; 021import org.forgerock.opendj.ldap.schema.AttributeType; 022import org.forgerock.opendj.server.config.meta.VirtualAttributeCfgDefn.ConflictBehavior; 023 024 025 026/** 027 * A server-side interface for querying Entry DN Virtual Attribute 028 * settings. 029 * <p> 030 * The Entry DN Virtual Attribute generates the entryDN operational 031 * attribute in directory entries, which contains a normalized form of 032 * the entry's DN. 033 */ 034public interface EntryDNVirtualAttributeCfg extends VirtualAttributeCfg { 035 036 /** 037 * Gets the configuration class associated with this Entry DN Virtual Attribute. 038 * 039 * @return Returns the configuration class associated with this Entry DN Virtual Attribute. 040 */ 041 Class<? extends EntryDNVirtualAttributeCfg> configurationClass(); 042 043 044 045 /** 046 * Register to be notified when this Entry DN Virtual Attribute is changed. 047 * 048 * @param listener 049 * The Entry DN Virtual Attribute configuration change listener. 050 */ 051 void addEntryDNChangeListener(ConfigurationChangeListener<EntryDNVirtualAttributeCfg> listener); 052 053 054 055 /** 056 * Deregister an existing Entry DN Virtual Attribute configuration change listener. 057 * 058 * @param listener 059 * The Entry DN Virtual Attribute configuration change listener. 060 */ 061 void removeEntryDNChangeListener(ConfigurationChangeListener<EntryDNVirtualAttributeCfg> listener); 062 063 064 065 /** 066 * Gets the "attribute-type" property. 067 * <p> 068 * Specifies the attribute type for the attribute whose values are 069 * to be dynamically assigned by the virtual attribute. 070 * 071 * @return Returns the value of the "attribute-type" property. 072 */ 073 AttributeType getAttributeType(); 074 075 076 077 /** 078 * Gets the "conflict-behavior" property. 079 * <p> 080 * Specifies the behavior that the server is to exhibit for entries 081 * that already contain one or more real values for the associated 082 * attribute. 083 * 084 * @return Returns the value of the "conflict-behavior" property. 085 */ 086 ConflictBehavior getConflictBehavior(); 087 088 089 090 /** 091 * Gets the "java-class" property. 092 * <p> 093 * Specifies the fully-qualified name of the virtual attribute 094 * provider class that generates the attribute values. 095 * 096 * @return Returns the value of the "java-class" property. 097 */ 098 String getJavaClass(); 099 100}