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.server;
017
018
019
020import org.forgerock.opendj.config.server.ConfigurationChangeListener;
021import org.forgerock.opendj.ldap.schema.AttributeType;
022import org.forgerock.opendj.server.config.meta.VirtualAttributeCfgDefn.ConflictBehavior;
023
024
025
026/**
027 * A server-side interface for querying Password Expiration Time
028 * Virtual Attribute settings.
029 * <p>
030 * The Password Expiration Time Virtual Attribute generates a virtual
031 * attribute which shows the password expiration date.
032 */
033public interface PasswordExpirationTimeVirtualAttributeCfg extends VirtualAttributeCfg {
034
035  /**
036   * Gets the configuration class associated with this Password Expiration Time Virtual Attribute.
037   *
038   * @return Returns the configuration class associated with this Password Expiration Time Virtual Attribute.
039   */
040  Class<? extends PasswordExpirationTimeVirtualAttributeCfg> configurationClass();
041
042
043
044  /**
045   * Register to be notified when this Password Expiration Time Virtual Attribute is changed.
046   *
047   * @param listener
048   *          The Password Expiration Time Virtual Attribute configuration change listener.
049   */
050  void addPasswordExpirationTimeChangeListener(ConfigurationChangeListener<PasswordExpirationTimeVirtualAttributeCfg> listener);
051
052
053
054  /**
055   * Deregister an existing Password Expiration Time Virtual Attribute configuration change listener.
056   *
057   * @param listener
058   *          The Password Expiration Time Virtual Attribute configuration change listener.
059   */
060  void removePasswordExpirationTimeChangeListener(ConfigurationChangeListener<PasswordExpirationTimeVirtualAttributeCfg> listener);
061
062
063
064  /**
065   * Gets the "attribute-type" property.
066   * <p>
067   * Specifies the attribute type for the attribute whose values are
068   * to be dynamically assigned by the virtual attribute.
069   *
070   * @return Returns the value of the "attribute-type" property.
071   */
072  AttributeType getAttributeType();
073
074
075
076  /**
077   * Gets the "conflict-behavior" property.
078   * <p>
079   * Specifies the behavior that the server is to exhibit for entries
080   * that already contain one or more real values for the associated
081   * attribute.
082   *
083   * @return Returns the value of the "conflict-behavior" property.
084   */
085  ConflictBehavior getConflictBehavior();
086
087
088
089  /**
090   * Gets the "java-class" property.
091   * <p>
092   * Specifies the fully-qualified name of the virtual attribute
093   * provider class that generates the attribute values.
094   *
095   * @return Returns the value of the "java-class" property.
096   */
097  String getJavaClass();
098
099}