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 package org.apache.directory.server.core.annotations; 020 021 import java.lang.annotation.ElementType; 022 import java.lang.annotation.Retention; 023 import java.lang.annotation.RetentionPolicy; 024 import java.lang.annotation.Target; 025 026 import org.apache.directory.server.core.partition.Partition; 027 028 /** 029 * An annotation for the Partition creation. A partition is defined by 030 * a name and a suffix, plus some other characteristics. Here is an example : 031 * <pre> 032 * @CreatePartition( 033 * name = "example", 034 * suffix = "dc=example, dc=com", 035 * @ContextEntry( 036 * { 037 * "dn: dc=example, dc=com", 038 * "objectclass: top", 039 * "objectclass: domain", 040 * "dc: example", 041 * }), 042 * @Indexes( { 043 * @CreateIndex( attribute = "cn" ), 044 * @CreateIndex( attribute = "sn', cacheSize = "100" ) 045 * }) 046 * ) 047 * </pre> 048 * 049 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 050 * @version $Rev$, $Date$ 051 */ 052 @Retention(RetentionPolicy.RUNTIME) 053 @Target( {ElementType.METHOD, ElementType.TYPE } ) 054 public @interface CreatePartition 055 { 056 /** The partition implementation class */ 057 Class<? extends Partition> type() default Partition.class; 058 059 /** The partition name */ 060 String name(); 061 062 /** The partition suffix */ 063 String suffix(); 064 065 /** The context entry */ 066 ContextEntry contextEntry() default @ContextEntry( entryLdif = "" ); 067 068 /** The associated indexes */ 069 CreateIndex[] indexes() default {}; 070 071 /** The cache size */ 072 int cacheSize() default 1000; 073 }