001/* 002 * Copyright 2012-2017 the original author or authors. 003 * 004 * Licensed under the Apache License, Version 2.0 (the "License"); 005 * you may not use this file except in compliance with the License. 006 * You may obtain a copy of the License at 007 * 008 * http://www.apache.org/licenses/LICENSE-2.0 009 * 010 * Unless required by applicable law or agreed to in writing, software 011 * distributed under the License is distributed on an "AS IS" BASIS, 012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 013 * See the License for the specific language governing permissions and 014 * limitations under the License. 015 */ 016 017package org.springframework.boot.autoconfigure.condition; 018 019import java.lang.annotation.Documented; 020import java.lang.annotation.ElementType; 021import java.lang.annotation.Retention; 022import java.lang.annotation.RetentionPolicy; 023import java.lang.annotation.Target; 024 025import org.springframework.context.annotation.Conditional; 026 027/** 028 * {@link Conditional} that matches when the application is a web application. By default, 029 * any web application will match but it can be narrowed using the {@link #type()} 030 * attribute. 031 * 032 * @author Dave Syer 033 * @author Stephane Nicoll 034 */ 035@Target({ ElementType.TYPE, ElementType.METHOD }) 036@Retention(RetentionPolicy.RUNTIME) 037@Documented 038@Conditional(OnWebApplicationCondition.class) 039public @interface ConditionalOnWebApplication { 040 041 /** 042 * The required type of the web application. 043 * @return the required web application type 044 */ 045 Type type() default Type.ANY; 046 047 /** 048 * Available application types. 049 */ 050 enum Type { 051 052 /** 053 * Any web application will match. 054 */ 055 ANY, 056 057 /** 058 * Only servlet-based web application will match. 059 */ 060 SERVLET, 061 062 /** 063 * Only reactive-based web application will match. 064 */ 065 REACTIVE 066 067 } 068 069}