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.PasswordExpirationTimeVirtualAttributeCfg;
034import org.opends.server.types.AttributeType;
035
036
037
038/**
039 * A client-side interface for reading and modifying Password
040 * Expiration Time Virtual Attribute settings.
041 * <p>
042 * The Password Expiration Time Virtual Attribute generates a virtual
043 * attribute which shows the password expiration date.
044 */
045public interface PasswordExpirationTimeVirtualAttributeCfgClient extends VirtualAttributeCfgClient {
046
047  /**
048   * Get the configuration definition associated with this Password Expiration Time Virtual Attribute.
049   *
050   * @return Returns the configuration definition associated with this Password Expiration Time Virtual Attribute.
051   */
052  ManagedObjectDefinition<? extends PasswordExpirationTimeVirtualAttributeCfgClient, ? extends PasswordExpirationTimeVirtualAttributeCfg> definition();
053
054
055
056  /**
057   * Gets the "attribute-type" property.
058   * <p>
059   * Specifies the attribute type for the attribute whose values are
060   * to be dynamically assigned by the virtual attribute.
061   *
062   * @return Returns the value of the "attribute-type" property.
063   */
064  AttributeType getAttributeType();
065
066
067
068  /**
069   * Sets the "attribute-type" property.
070   * <p>
071   * Specifies the attribute type for the attribute whose values are
072   * to be dynamically assigned by the virtual attribute.
073   *
074   * @param value The value of the "attribute-type" property.
075   * @throws PropertyException
076   *           If the new value is invalid.
077   */
078  void setAttributeType(AttributeType value) throws PropertyException;
079
080
081
082  /**
083   * Gets the "conflict-behavior" property.
084   * <p>
085   * Specifies the behavior that the server is to exhibit for entries
086   * that already contain one or more real values for the associated
087   * attribute.
088   *
089   * @return Returns the value of the "conflict-behavior" property.
090   */
091  ConflictBehavior getConflictBehavior();
092
093
094
095  /**
096   * Sets the "conflict-behavior" property.
097   * <p>
098   * Specifies the behavior that the server is to exhibit for entries
099   * that already contain one or more real values for the associated
100   * attribute.
101   *
102   * @param value The value of the "conflict-behavior" property.
103   * @throws PropertyException
104   *           If the new value is invalid.
105   */
106  void setConflictBehavior(ConflictBehavior value) throws PropertyException;
107
108
109
110  /**
111   * Gets the "java-class" property.
112   * <p>
113   * Specifies the fully-qualified name of the virtual attribute
114   * provider class that generates the attribute values.
115   *
116   * @return Returns the value of the "java-class" property.
117   */
118  String getJavaClass();
119
120
121
122  /**
123   * Sets the "java-class" property.
124   * <p>
125   * Specifies the fully-qualified name of the virtual attribute
126   * provider class that generates the attribute values.
127   *
128   * @param value The value of the "java-class" property.
129   * @throws PropertyException
130   *           If the new value is invalid.
131   */
132  void setJavaClass(String value) throws PropertyException;
133
134}