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 Governing Structure Rule 028 * Virtual Attribute settings. 029 * <p> 030 * The Governing Structure Rule Virtual Attribute generates a virtual 031 * attribute that specifies the DIT structure rule with the schema 032 * definitions in effect for the entry. This attribute is defined in 033 * RFC 4512. 034 */ 035public interface GoverningStructureRuleVirtualAttributeCfg extends VirtualAttributeCfg { 036 037 /** 038 * Gets the configuration class associated with this Governing Structure Rule Virtual Attribute. 039 * 040 * @return Returns the configuration class associated with this Governing Structure Rule Virtual Attribute. 041 */ 042 Class<? extends GoverningStructureRuleVirtualAttributeCfg> configurationClass(); 043 044 045 046 /** 047 * Register to be notified when this Governing Structure Rule Virtual Attribute is changed. 048 * 049 * @param listener 050 * The Governing Structure Rule Virtual Attribute configuration change listener. 051 */ 052 void addGoverningStructureRuleChangeListener(ConfigurationChangeListener<GoverningStructureRuleVirtualAttributeCfg> listener); 053 054 055 056 /** 057 * Deregister an existing Governing Structure Rule Virtual Attribute configuration change listener. 058 * 059 * @param listener 060 * The Governing Structure Rule Virtual Attribute configuration change listener. 061 */ 062 void removeGoverningStructureRuleChangeListener(ConfigurationChangeListener<GoverningStructureRuleVirtualAttributeCfg> listener); 063 064 065 066 /** 067 * Gets the "attribute-type" property. 068 * <p> 069 * Specifies the attribute type for the attribute whose values are 070 * to be dynamically assigned by the virtual attribute. 071 * 072 * @return Returns the value of the "attribute-type" property. 073 */ 074 AttributeType getAttributeType(); 075 076 077 078 /** 079 * Gets the "conflict-behavior" property. 080 * <p> 081 * Specifies the behavior that the server is to exhibit for entries 082 * that already contain one or more real values for the associated 083 * attribute. 084 * 085 * @return Returns the value of the "conflict-behavior" property. 086 */ 087 ConflictBehavior getConflictBehavior(); 088 089 090 091 /** 092 * Gets the "java-class" property. 093 * <p> 094 * Specifies the fully-qualified name of the virtual attribute 095 * provider class that generates the attribute values. 096 * 097 * @return Returns the value of the "java-class" property. 098 */ 099 String getJavaClass(); 100 101}