core-annotations/src/main/java/org/apache/directory/server/core/annotations/CreatePartition.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.directory.server.core.annotations;


import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.apache.directory.server.core.api.partition.Partition;


/**
 * An annotation for the Partition creation. A partition is defined by
 * a name and a suffix, plus some other characteristics. Here is an example :
 * <pre>
 * &#64;CreatePartition(
 *     name = "example",
 *     suffix = "dc=example, dc=com",
 *     &#64;ContextEntry( 
 *         {
 *             "dn: dc=example, dc=com",
 *             "objectclass: top",
 *             "objectclass: domain",
 *             "dc: example", 
 *         }),
 *     &#64;Indexes( {
 *         &#64;CreateIndex( attribute = "cn" ),
 *         &#64;CreateIndex( attribute = "sn' )
 *     })
 * )
 * </pre>
 *
 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(
    { ElementType.METHOD, ElementType.TYPE })
public @interface CreatePartition
{
    /** @return The partition implementation class */
    Class<? extends Partition> type() default Partition.class;


    /** @return The partition name */
    String name();


    /** @return The partition suffix */
    String suffix();


    /** @return The context entry */
    ContextEntry contextEntry() default @ContextEntry(entryLdif = "");


    /** @return The associated indexes */
    CreateIndex[] indexes() default
        {};


    /** @return The cache size */
    int cacheSize() default 1000;
}