001/* 002 * Licensed to the Apache Software Foundation (ASF) under one 003 * or more contributor license agreements. See the NOTICE file 004 * distributed with this work for additional information 005 * regarding copyright ownership. The ASF licenses this file 006 * to you under the Apache License, Version 2.0 (the 007 * "License"); you may not use this file except in compliance 008 * with the License. You may obtain a copy of the License at 009 * 010 * http://www.apache.org/licenses/LICENSE-2.0 011 * 012 * Unless required by applicable law or agreed to in writing, 013 * software distributed under the License is distributed on an 014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 015 * KIND, either express or implied. See the License for the 016 * specific language governing permissions and limitations 017 * under the License. 018 * 019 */ 020package org.apache.directory.server.config; 021 022 023import java.lang.annotation.Documented; 024import java.lang.annotation.ElementType; 025import java.lang.annotation.Inherited; 026import java.lang.annotation.Retention; 027import java.lang.annotation.RetentionPolicy; 028import java.lang.annotation.Target; 029 030 031/** 032 * An annotation used to specify that the qualified field is configuration element. 033 * 034 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 035 */ 036@Documented 037@Inherited 038@Retention(RetentionPolicy.RUNTIME) 039@Target(ElementType.FIELD) 040public @interface ConfigurationElement 041{ 042 /** 043 * Returns the attribute type. 044 * 045 * @return the attribute type 046 */ 047 String attributeType() default ""; 048 049 050 /** 051 * Returns the object class. 052 * 053 * @return the object class 054 */ 055 String objectClass() default ""; 056 057 058 /** 059 * Returns true if of the qualified field (attribute type and value) 060 * is the Rdn of the entry. 061 * 062 * @return <code>true</code> if of the qualified field (attribute type and value) 063 * is the Rdn of the entry, 064 * <code>false</code> if not. 065 */ 066 boolean isRdn() default false; 067 068 069 /** 070 * Returns the string value of the Dn of the container. 071 * 072 * @return the string value of the Dn of the container. 073 */ 074 String container() default ""; 075 076 077 /** 078 * Returns true if the qualified field is optional. 079 * 080 * @return <code>true</code> if the qualified field is optional, 081 * <code>false</code> if not. 082 */ 083 boolean isOptional() default false; 084 085 086 /** 087 * Returns the string value of the default value. 088 * 089 * @return the string value of the default value 090 */ 091 String defaultValue() default ""; 092 093 /** 094 * Returns the list of string values that are the 095 * default values when the element is multi-valued. 096 * 097 * @return The default values 098 */ 099 String[] defaultValues() default {}; 100}