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; 021 022 023 024/** 025 * A server-side interface for querying Directory String Attribute 026 * Syntax settings. 027 * <p> 028 * The Directory String Attribute Syntax defines an attribute syntax 029 * for storing arbitrary string (and sometimes binary) data. 030 */ 031public interface DirectoryStringAttributeSyntaxCfg extends AttributeSyntaxCfg { 032 033 /** 034 * Gets the configuration class associated with this Directory String Attribute Syntax. 035 * 036 * @return Returns the configuration class associated with this Directory String Attribute Syntax. 037 */ 038 Class<? extends DirectoryStringAttributeSyntaxCfg> configurationClass(); 039 040 041 042 /** 043 * Register to be notified when this Directory String Attribute Syntax is changed. 044 * 045 * @param listener 046 * The Directory String Attribute Syntax configuration change listener. 047 */ 048 void addDirectoryStringChangeListener(ConfigurationChangeListener<DirectoryStringAttributeSyntaxCfg> listener); 049 050 051 052 /** 053 * Deregister an existing Directory String Attribute Syntax configuration change listener. 054 * 055 * @param listener 056 * The Directory String Attribute Syntax configuration change listener. 057 */ 058 void removeDirectoryStringChangeListener(ConfigurationChangeListener<DirectoryStringAttributeSyntaxCfg> listener); 059 060 061 062 /** 063 * Gets the "allow-zero-length-values" property. 064 * <p> 065 * Indicates whether zero-length (that is, an empty string) values 066 * are allowed. 067 * <p> 068 * This is technically not allowed by the revised LDAPv3 069 * specification, but some environments may require it for backward 070 * compatibility with servers that do allow it. 071 * 072 * @return Returns the value of the "allow-zero-length-values" property. 073 */ 074 boolean isAllowZeroLengthValues(); 075 076 077 078 /** 079 * Gets the "java-class" property. 080 * <p> 081 * Specifies the fully-qualified name of the Java class that 082 * provides the Directory String Attribute Syntax implementation. 083 * 084 * @return Returns the value of the "java-class" property. 085 */ 086 String getJavaClass(); 087 088}