/*

  * Copyright 2009, Josh Devins, Jitr.org.

  *

  * Licensed 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.jitr.annotation;

 import java.lang.annotation.Documented;

 import java.lang.annotation.ElementType;

 import java.lang.annotation.Inherited;

 import java.lang.annotation.Retention;

 import java.lang.annotation.RetentionPolicy;

 import java.lang.annotation.Target;

 import org.jitr.core.Defaults;

 import org.jitr.core.OperationalMode;

 /**

  * Test classes that want to customize how Jitr runs will need to be annotated with this annotation.

  * If your test class is not annotated with this, it will use the Jitr defaults as defined here.

  */

 @Documented

 @Inherited

 @Retention(RetentionPolicy.RUNTIME)

 @Target(value = { ElementType.TYPE })

 public @interface JitrConfiguration {

     /**

      * Sets the type of container you want Jitr to use.

      */

     Class<?> containerClass() default Object.class;

     /**

      * Sets the relative path of the working directory for the container. The default container work

      * path will be correct for Maven projects.

      * 

      * <p>

      * Default value: <code>target</code>

      * </p>

      */

     String containerWorkPath() default Defaults.DEFAULT_CONTAINER_WORK_PATH;

     /**

      * Context path for the war.

      * 

      * <p>

      * Default value: <code>/</code>

      * </p>

      */

     String contextPath() default Defaults.DEFAULT_CONTEXT_PATH;

     /**

      * Operational mode to run in.

      * 

      * <p>

      * Default value: {@link OperationalMode#INTERNAL}

      * </p>

      */

     OperationalMode mode() default OperationalMode.INTERNAL;

     /**

      * Set the port number for the container to use. To let Jitr choose a random, unused port, do

      * not set this value.

      * 

      * <p>

      * Default value: <code>-1</code>

      * </p>

      */

     int port() default Defaults.DEFAULT_PORT;

     /**

      * The path to the unpacked war. This is relative to the running location. The default war path

      * will be correct for Maven projects.

      * 

      * <p>

      * Default value: <code>src/main/webapp</code>

      * </p>

      */

     String warPath() default Defaults.DEFAULT_WAR_PATH;

 }