org.testifyproject.annotation.Application Maven / Gradle / Ivy
/*
* Copyright 2016-2017 Testify Project.
*
* 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.testifyproject.annotation;
import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import org.testifyproject.ClientProvider;
import org.testifyproject.ServerProvider;
/**
* An annotation that can be placed on system test to specify an application that should be
* loaded, configured, started, and stopped before and after each test run (i.e. Jersey 2,
* Spring Boot, Spring MVC, etc).
*
* @author saden
*/
@Documented
@Retention(RUNTIME)
@Target({ANNOTATION_TYPE, TYPE})
public @interface Application {
/**
* The class of the application under test that will be configured, started and stopped
* before and after each test run.
*
* @return the application class.
*/
Class value();
/**
* Specifies the class that provides {@link ClientProvider client provider implementation}.
* If a provider is not specified one will be discovered in the class path.
*
* @return client provider implementation class.
*/
Class clientProvider() default ClientProvider.class;
/**
*
* Specifies the client name. This useful for giving the client instance a unique name that
* can be used to qualify and distinguish it from other similar services.
*
*
* Note that the default client name is "applicationClient".
*
*
* @return a the client name.
*/
String clientName() default "";
/**
*
* Specifies the contract implemented by the client. This useful for getting the client
* instance by its contract.
*
*
* Note that if the client contract class is not specified the client instance will be
* injectable by its implementation class only.
*
*
* @return the client contract class
*/
Class clientContract() default void.class;
/**
*
* Specifies the client provider name. This useful for giving the client provider instance a
* unique name that can be used to qualify and distinguish it from other similar services.
*
*
* Note that the default client name is "applicationClientProvider".
*
*
* @return a the client provider name.
*/
String clientProviderName() default "";
/**
*
* Specifies the contract implemented by the client provider. This useful for getting the
* client provider instance by its contract.
*
*
* Note that if the client provider contract class is not specified the client provider
* instance will be injectable by its implementation class only.
*
*
* @return the client provider contract class
*/
Class clientProviderContract() default void.class;
/**
* Specifies the class that provides {@link ServerProvider server provider implementation}.
* If a provider is not specified one will be discovered in the class path.
*
* @return server provider implementation class.
*/
Class serverProvider() default ServerProvider.class;
/**
*
* Specifies the server name. This useful for giving the server instance a unique name that
* can be used to qualify and distinguish it from other similar services.
*
*
* Note that the default server name is "applicationServer".
*
*
* @return a the server name.
*/
String serverName() default "";
/**
*
* Specifies the contract implemented by the server. This useful for getting the server
* instance by its contract.
*
*
* Note that if the server contract class is not specified the server instance will be
* injectable by its implementation class only.
*
*
* @return the server contract class
*/
Class serverContract() default void.class;
}