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 org.forgerock.opendj.config.ManagedObjectDefinition;
021import org.forgerock.opendj.config.PropertyException;
022import org.forgerock.opendj.ldap.schema.AttributeType;
023import org.forgerock.opendj.server.config.meta.VirtualAttributeCfgDefn.ConflictBehavior;
024import org.forgerock.opendj.server.config.server.IsMemberOfVirtualAttributeCfg;
025
026
027
028/**
029 * A client-side interface for reading and modifying Is Member Of
030 * Virtual Attribute settings.
031 * <p>
032 * The Is Member Of Virtual Attribute generates the isMemberOf
033 * operational attribute, which contains the DNs of the groups in which
034 * the user is a member.
035 */
036public interface IsMemberOfVirtualAttributeCfgClient extends VirtualAttributeCfgClient {
037
038  /**
039   * Get the configuration definition associated with this Is Member Of Virtual Attribute.
040   *
041   * @return Returns the configuration definition associated with this Is Member Of Virtual Attribute.
042   */
043  ManagedObjectDefinition<? extends IsMemberOfVirtualAttributeCfgClient, ? extends IsMemberOfVirtualAttributeCfg> definition();
044
045
046
047  /**
048   * Gets the "attribute-type" property.
049   * <p>
050   * Specifies the attribute type for the attribute whose values are
051   * to be dynamically assigned by the virtual attribute.
052   *
053   * @return Returns the value of the "attribute-type" property.
054   */
055  AttributeType getAttributeType();
056
057
058
059  /**
060   * Sets the "attribute-type" property.
061   * <p>
062   * Specifies the attribute type for the attribute whose values are
063   * to be dynamically assigned by the virtual attribute.
064   *
065   * @param value The value of the "attribute-type" property.
066   * @throws PropertyException
067   *           If the new value is invalid.
068   */
069  void setAttributeType(AttributeType value) throws PropertyException;
070
071
072
073  /**
074   * Gets the "conflict-behavior" property.
075   * <p>
076   * Specifies the behavior that the server is to exhibit for entries
077   * that already contain one or more real values for the associated
078   * attribute.
079   *
080   * @return Returns the value of the "conflict-behavior" property.
081   */
082  ConflictBehavior getConflictBehavior();
083
084
085
086  /**
087   * Sets the "conflict-behavior" property.
088   * <p>
089   * Specifies the behavior that the server is to exhibit for entries
090   * that already contain one or more real values for the associated
091   * attribute.
092   *
093   * @param value The value of the "conflict-behavior" property.
094   * @throws PropertyException
095   *           If the new value is invalid.
096   */
097  void setConflictBehavior(ConflictBehavior value) throws PropertyException;
098
099
100
101  /**
102   * Gets the "java-class" property.
103   * <p>
104   * Specifies the fully-qualified name of the virtual attribute
105   * provider class that generates the attribute values.
106   *
107   * @return Returns the value of the "java-class" property.
108   */
109  String getJavaClass();
110
111
112
113  /**
114   * Sets the "java-class" property.
115   * <p>
116   * Specifies the fully-qualified name of the virtual attribute
117   * provider class that generates the attribute values.
118   *
119   * @param value The value of the "java-class" property.
120   * @throws PropertyException
121   *           If the new value is invalid.
122   */
123  void setJavaClass(String value) throws PropertyException;
124
125}