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; 022 023 024 025/** 026 * A server-side interface for querying User Defined Virtual Attribute 027 * settings. 028 * <p> 029 * The User Defined Virtual Attribute creates virtual attributes with 030 * user-defined values in entries that match the criteria defined in 031 * the plug-in's configuration. 032 */ 033public interface UserDefinedVirtualAttributeCfg extends VirtualAttributeCfg { 034 035 /** 036 * Gets the configuration class associated with this User Defined Virtual Attribute. 037 * 038 * @return Returns the configuration class associated with this User Defined Virtual Attribute. 039 */ 040 Class<? extends UserDefinedVirtualAttributeCfg> configurationClass(); 041 042 043 044 /** 045 * Register to be notified when this User Defined Virtual Attribute is changed. 046 * 047 * @param listener 048 * The User Defined Virtual Attribute configuration change listener. 049 */ 050 void addUserDefinedChangeListener(ConfigurationChangeListener<UserDefinedVirtualAttributeCfg> listener); 051 052 053 054 /** 055 * Deregister an existing User Defined Virtual Attribute configuration change listener. 056 * 057 * @param listener 058 * The User Defined Virtual Attribute configuration change listener. 059 */ 060 void removeUserDefinedChangeListener(ConfigurationChangeListener<UserDefinedVirtualAttributeCfg> listener); 061 062 063 064 /** 065 * Gets the "java-class" property. 066 * <p> 067 * Specifies the fully-qualified name of the virtual attribute 068 * provider class that generates the attribute values. 069 * 070 * @return Returns the value of the "java-class" property. 071 */ 072 String getJavaClass(); 073 074 075 076 /** 077 * Gets the "value" property. 078 * <p> 079 * Specifies the values to be included in the virtual attribute. 080 * 081 * @return Returns an unmodifiable set containing the values of the "value" property. 082 */ 083 SortedSet<String> getValue(); 084 085}