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