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 legal-notices/CDDLv1_0.txt
010 * or http://forgerock.org/license/CDDLv1.0.html.
011 * See the License for the specific language governing permissions
012 * and limitations under the License.
013 *
014 * When distributing Covered Code, include this CDDL HEADER in each
015 * file and include the License file at legal-notices/CDDLv1_0.txt.
016 * If applicable, add the following below this CDDL HEADER, with the
017 * fields enclosed by brackets "[]" replaced with your own identifying
018 * information:
019 *      Portions Copyright [yyyy] [name of copyright owner]
020 *
021 * CDDL HEADER END
022 *
023 *
024 *      Copyright 2008 Sun Microsystems, Inc.
025 */
026package org.opends.server.admin.std.client;
027
028
029
030import org.opends.server.admin.ManagedObjectDefinition;
031import org.opends.server.admin.PropertyException;
032import org.opends.server.admin.std.meta.VirtualAttributeCfgDefn.ConflictBehavior;
033import org.opends.server.admin.std.server.PasswordPolicySubentryVirtualAttributeCfg;
034import org.opends.server.types.AttributeType;
035
036
037
038/**
039 * A client-side interface for reading and modifying Password Policy
040 * Subentry Virtual Attribute settings.
041 * <p>
042 * The Password Policy Subentry Virtual Attribute generates a virtual
043 * attribute that points to the Password Policy subentry in effect for
044 * the entry.
045 */
046public interface PasswordPolicySubentryVirtualAttributeCfgClient extends VirtualAttributeCfgClient {
047
048  /**
049   * Get the configuration definition associated with this Password Policy Subentry Virtual Attribute.
050   *
051   * @return Returns the configuration definition associated with this Password Policy Subentry Virtual Attribute.
052   */
053  ManagedObjectDefinition<? extends PasswordPolicySubentryVirtualAttributeCfgClient, ? extends PasswordPolicySubentryVirtualAttributeCfg> definition();
054
055
056
057  /**
058   * Gets the "attribute-type" property.
059   * <p>
060   * Specifies the attribute type for the attribute whose values are
061   * to be dynamically assigned by the virtual attribute.
062   *
063   * @return Returns the value of the "attribute-type" property.
064   */
065  AttributeType getAttributeType();
066
067
068
069  /**
070   * Sets the "attribute-type" property.
071   * <p>
072   * Specifies the attribute type for the attribute whose values are
073   * to be dynamically assigned by the virtual attribute.
074   *
075   * @param value The value of the "attribute-type" property.
076   * @throws PropertyException
077   *           If the new value is invalid.
078   */
079  void setAttributeType(AttributeType value) throws PropertyException;
080
081
082
083  /**
084   * Gets the "conflict-behavior" property.
085   * <p>
086   * Specifies the behavior that the server is to exhibit for entries
087   * that already contain one or more real values for the associated
088   * attribute.
089   *
090   * @return Returns the value of the "conflict-behavior" property.
091   */
092  ConflictBehavior getConflictBehavior();
093
094
095
096  /**
097   * Sets the "conflict-behavior" property.
098   * <p>
099   * Specifies the behavior that the server is to exhibit for entries
100   * that already contain one or more real values for the associated
101   * attribute.
102   *
103   * @param value The value of the "conflict-behavior" property.
104   * @throws PropertyException
105   *           If the new value is invalid.
106   */
107  void setConflictBehavior(ConflictBehavior value) throws PropertyException;
108
109
110
111  /**
112   * Gets the "java-class" property.
113   * <p>
114   * Specifies the fully-qualified name of the virtual attribute
115   * provider class that generates the attribute values.
116   *
117   * @return Returns the value of the "java-class" property.
118   */
119  String getJavaClass();
120
121
122
123  /**
124   * Sets the "java-class" property.
125   * <p>
126   * Specifies the fully-qualified name of the virtual attribute
127   * provider class that generates the attribute values.
128   *
129   * @param value The value of the "java-class" property.
130   * @throws PropertyException
131   *           If the new value is invalid.
132   */
133  void setJavaClass(String value) throws PropertyException;
134
135}