001 /* 002 * CDDL HEADER START 003 * 004 * The contents of this file are subject to the terms of the 005 * Common Development and Distribution License, Version 1.0 only 006 * (the "License"). You may not use this file except in compliance 007 * with the License. 008 * 009 * You can obtain a copy of the license at 010 * trunk/opends/resource/legal-notices/OpenDS.LICENSE 011 * or https://OpenDS.dev.java.net/OpenDS.LICENSE. 012 * See the License for the specific language governing permissions 013 * and limitations under the License. 014 * 015 * When distributing Covered Code, include this CDDL HEADER in each 016 * file and include the License file at 017 * trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable, 018 * add the following below this CDDL HEADER, with the fields enclosed 019 * by brackets "[]" replaced with your own identifying information: 020 * Portions Copyright [yyyy] [name of copyright owner] 021 * 022 * CDDL HEADER END 023 * 024 * 025 * Copyright 2008 Sun Microsystems, Inc. 026 */ 027 package org.opends.server.admin.std.client; 028 029 030 031 import org.opends.server.admin.IllegalPropertyValueException; 032 import org.opends.server.admin.ManagedObjectDefinition; 033 import org.opends.server.admin.std.meta.VirtualAttributeCfgDefn.ConflictBehavior; 034 import org.opends.server.admin.std.server.MemberVirtualAttributeCfg; 035 036 037 038 /** 039 * A client-side interface for reading and modifying Member Virtual 040 * Attribute settings. 041 * <p> 042 * The Member Virtual Attribute generates a member or uniqueMember 043 * attribute whose values are the DNs of the members of a specified 044 * virtual static group. 045 */ 046 public interface MemberVirtualAttributeCfgClient extends VirtualAttributeCfgClient { 047 048 /** 049 * Get the configuration definition associated with this Member Virtual Attribute. 050 * 051 * @return Returns the configuration definition associated with this Member Virtual Attribute. 052 */ 053 ManagedObjectDefinition<? extends MemberVirtualAttributeCfgClient, ? extends MemberVirtualAttributeCfg> definition(); 054 055 056 057 /** 058 * Gets the "allow-retrieving-membership" property. 059 * <p> 060 * Indicates whether to handle requests that request all values for 061 * the virtual attribute. 062 * <p> 063 * This operation can be very expensive in some cases and is not 064 * consistent with the primary function of virtual static groups, 065 * which is to make it possible to use static group idioms to 066 * determine whether a given user is a member. If this attribute is 067 * set to false, attempts to retrieve the entire set of values 068 * receive an empty set, and only attempts to determine whether the 069 * attribute has a specific value or set of values (which is the 070 * primary anticipated use for virtual static groups) are handled 071 * properly. 072 * 073 * @return Returns the value of the "allow-retrieving-membership" property. 074 */ 075 boolean isAllowRetrievingMembership(); 076 077 078 079 /** 080 * Sets the "allow-retrieving-membership" property. 081 * <p> 082 * Indicates whether to handle requests that request all values for 083 * the virtual attribute. 084 * <p> 085 * This operation can be very expensive in some cases and is not 086 * consistent with the primary function of virtual static groups, 087 * which is to make it possible to use static group idioms to 088 * determine whether a given user is a member. If this attribute is 089 * set to false, attempts to retrieve the entire set of values 090 * receive an empty set, and only attempts to determine whether the 091 * attribute has a specific value or set of values (which is the 092 * primary anticipated use for virtual static groups) are handled 093 * properly. 094 * 095 * @param value The value of the "allow-retrieving-membership" property. 096 * @throws IllegalPropertyValueException 097 * If the new value is invalid. 098 */ 099 void setAllowRetrievingMembership(boolean value) throws IllegalPropertyValueException; 100 101 102 103 /** 104 * Gets the "conflict-behavior" property. 105 * <p> 106 * Specifies the behavior that the server is to exhibit for entries 107 * that already contain one or more real values for the associated 108 * attribute. 109 * 110 * @return Returns the value of the "conflict-behavior" property. 111 */ 112 ConflictBehavior getConflictBehavior(); 113 114 115 116 /** 117 * Sets the "conflict-behavior" property. 118 * <p> 119 * Specifies the behavior that the server is to exhibit for entries 120 * that already contain one or more real values for the associated 121 * attribute. 122 * 123 * @param value The value of the "conflict-behavior" property. 124 * @throws IllegalPropertyValueException 125 * If the new value is invalid. 126 */ 127 void setConflictBehavior(ConflictBehavior value) throws IllegalPropertyValueException; 128 129 130 131 /** 132 * Gets the "java-class" property. 133 * <p> 134 * Specifies the fully-qualified name of the virtual attribute 135 * provider class that generates the attribute values. 136 * 137 * @return Returns the value of the "java-class" property. 138 */ 139 String getJavaClass(); 140 141 142 143 /** 144 * Sets the "java-class" property. 145 * <p> 146 * Specifies the fully-qualified name of the virtual attribute 147 * provider class that generates the attribute values. 148 * 149 * @param value The value of the "java-class" property. 150 * @throws IllegalPropertyValueException 151 * If the new value is invalid. 152 */ 153 void setJavaClass(String value) throws IllegalPropertyValueException; 154 155 }