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 */
019package org.apache.directory.server.core.annotations;
020
021
022import java.lang.annotation.ElementType;
023import java.lang.annotation.Retention;
024import java.lang.annotation.RetentionPolicy;
025import java.lang.annotation.Target;
026
027import org.apache.directory.server.core.factory.DefaultDirectoryServiceFactory;
028
029
030/**
031 * An annotation for the DirectoryService builder
032 *
033 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
034 */
035@Retention(RetentionPolicy.RUNTIME)
036@Target(
037    { ElementType.METHOD, ElementType.TYPE })
038public @interface CreateDS
039{
040    /** @return The Factory to use to create a DirectoryService */
041    Class<?> factory() default DefaultDirectoryServiceFactory.class;
042
043    
044    /** @return The DS name */
045    String name() default "defaultDS";
046
047
048    /** @return flag to enable/disable access control, default is false */
049    boolean enableAccessControl() default false;
050    
051
052    /** @return flag to enable/disable anonymous access, default is false */
053    boolean allowAnonAccess() default false;
054
055
056    /** @return flag to enable/disable changelog, default is true */
057    boolean enableChangeLog() default true;
058
059
060    /** @return The list of partitions to create */
061    CreatePartition[] partitions() default
062        {};
063
064
065    /** @return additional interceptors */
066    Class<?>[] additionalInterceptors() default
067        {};
068
069
070    /** @return authenticators, when empty the default authenticators are used, else this must contain the complete list */
071    CreateAuthenticator[] authenticators() default
072        {};
073
074
075    /** @return The loaded schemas */
076    LoadSchema[] loadedSchemas() default
077        {};
078}