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 Attribute Type Description 026 * Attribute Syntax settings. 027 * <p> 028 * Attribute Type Description Attribute Syntaxes describe the format 029 * of the directory schema attribute type definitions. 030 */ 031public interface AttributeTypeDescriptionAttributeSyntaxCfg extends AttributeSyntaxCfg { 032 033 /** 034 * Gets the configuration class associated with this Attribute Type Description Attribute Syntax. 035 * 036 * @return Returns the configuration class associated with this Attribute Type Description Attribute Syntax. 037 */ 038 Class<? extends AttributeTypeDescriptionAttributeSyntaxCfg> configurationClass(); 039 040 041 042 /** 043 * Register to be notified when this Attribute Type Description Attribute Syntax is changed. 044 * 045 * @param listener 046 * The Attribute Type Description Attribute Syntax configuration change listener. 047 */ 048 void addAttributeTypeDescriptionChangeListener(ConfigurationChangeListener<AttributeTypeDescriptionAttributeSyntaxCfg> listener); 049 050 051 052 /** 053 * Deregister an existing Attribute Type Description Attribute Syntax configuration change listener. 054 * 055 * @param listener 056 * The Attribute Type Description Attribute Syntax configuration change listener. 057 */ 058 void removeAttributeTypeDescriptionChangeListener(ConfigurationChangeListener<AttributeTypeDescriptionAttributeSyntaxCfg> listener); 059 060 061 062 /** 063 * Gets the "java-class" property. 064 * <p> 065 * Specifies the fully-qualified name of the Java class that 066 * provides the Attribute Type Description Attribute Syntax 067 * implementation. 068 * 069 * @return Returns the value of the "java-class" property. 070 */ 071 String getJavaClass(); 072 073 074 075 /** 076 * Gets the "strip-syntax-min-upper-bound" property. 077 * <p> 078 * Indicates whether the suggested minimum upper bound appended to 079 * an attribute's syntax OID in it's schema definition Attribute Type 080 * Description is stripped off. 081 * <p> 082 * When retrieving the server's schema, some APIs (JNDI) fail in 083 * their syntax lookup methods, because they do not parse this value 084 * correctly. This configuration option allows the server to be 085 * configured to provide schema definitions these APIs can parse 086 * correctly. 087 * 088 * @return Returns the value of the "strip-syntax-min-upper-bound" property. 089 */ 090 boolean isStripSyntaxMinUpperBound(); 091 092}