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.client; 017 018 019 020import java.util.Collection; 021import java.util.SortedSet; 022import org.forgerock.opendj.config.ManagedObjectDefinition; 023import org.forgerock.opendj.config.PropertyException; 024import org.forgerock.opendj.server.config.server.UserDefinedVirtualAttributeCfg; 025 026 027 028/** 029 * A client-side interface for reading and modifying User Defined 030 * Virtual Attribute settings. 031 * <p> 032 * The User Defined Virtual Attribute creates virtual attributes with 033 * user-defined values in entries that match the criteria defined in 034 * the plug-in's configuration. 035 */ 036public interface UserDefinedVirtualAttributeCfgClient extends VirtualAttributeCfgClient { 037 038 /** 039 * Get the configuration definition associated with this User Defined Virtual Attribute. 040 * 041 * @return Returns the configuration definition associated with this User Defined Virtual Attribute. 042 */ 043 ManagedObjectDefinition<? extends UserDefinedVirtualAttributeCfgClient, ? extends UserDefinedVirtualAttributeCfg> definition(); 044 045 046 047 /** 048 * Gets the "java-class" property. 049 * <p> 050 * Specifies the fully-qualified name of the virtual attribute 051 * provider class that generates the attribute values. 052 * 053 * @return Returns the value of the "java-class" property. 054 */ 055 String getJavaClass(); 056 057 058 059 /** 060 * Sets the "java-class" property. 061 * <p> 062 * Specifies the fully-qualified name of the virtual attribute 063 * provider class that generates the attribute values. 064 * 065 * @param value The value of the "java-class" property. 066 * @throws PropertyException 067 * If the new value is invalid. 068 */ 069 void setJavaClass(String value) throws PropertyException; 070 071 072 073 /** 074 * Gets the "value" property. 075 * <p> 076 * Specifies the values to be included in the virtual attribute. 077 * 078 * @return Returns the values of the "value" property. 079 */ 080 SortedSet<String> getValue(); 081 082 083 084 /** 085 * Sets the "value" property. 086 * <p> 087 * Specifies the values to be included in the virtual attribute. 088 * 089 * @param values The values of the "value" property. 090 * @throws PropertyException 091 * If one or more of the new values are invalid. 092 */ 093 void setValue(Collection<String> values) throws PropertyException; 094 095}