Merge pull request #296 from apache/single-spring-1-8

Back port single spring boot module to 1.x
apache · May 27, 2021 · 1447e43 · 1447e43
2 parents 358397b + 9f8e5c6
commit 1447e43
Show file tree

Hide file tree

Showing 18 changed files with 94 additions and 128 deletions.
diff --git a/pom.xml b/pom.xml
@@ -1172,6 +1172,11 @@
                 <artifactId>spring-boot-test</artifactId>
                 <version>${spring-boot.version}</version>
             </dependency>
+            <dependency>
+                <groupId>org.springframework.boot</groupId>
+                <artifactId>spring-boot-starter-web</artifactId>
+                <version>${spring-boot.version}</version>
+            </dependency>
 
             <!-- Guice -->
             <dependency>

diff --git a/support/spring-boot/spring-boot-starter/pom.xml b/support/spring-boot/spring-boot-starter/pom.xml
@@ -44,6 +44,16 @@
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-autoconfigure</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-web</artifactId>
+            <optional>true</optional>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework</groupId>
+            <artifactId>spring-webmvc</artifactId>
+            <optional>true</optional>
+        </dependency>
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-configuration-processor</artifactId>
@@ -76,4 +86,31 @@
 
     </dependencies>
 
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>com.github.siom79.japicmp</groupId>
+                <artifactId>japicmp-maven-plugin</artifactId>
+                <executions>
+                    <execution>
+                        <id>single-boot-jar</id>
+                        <goals>
+                            <goal>cmp</goal>
+                        </goals>
+                        <configuration>
+                            <oldVersion>
+                                <dependency>
+                                    <!-- This project was moved into another jar -->
+                                    <groupId>${project.groupId}</groupId>
+                                    <artifactId>shiro-spring-boot-web-starter</artifactId>
+                                    <version>${shiro.previousVersion}</version>
+                                    <type>jar</type>
+                                </dependency>
+                            </oldVersion>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
 </project>
diff --git a/...oconfigure/ShiroWebAutoConfiguration.java → ...oconfigure/ShiroWebAutoConfiguration.java b/...oconfigure/ShiroWebAutoConfiguration.java → ...oconfigure/ShiroWebAutoConfiguration.java
@@ -41,6 +41,7 @@
 import org.springframework.boot.autoconfigure.AutoConfigureBefore;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 
@@ -50,6 +51,7 @@
 @Configuration
 @AutoConfigureBefore(ShiroAutoConfiguration.class)
 @AutoConfigureAfter(ShiroWebMvcAutoConfiguration.class)
+@ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET)
 @ConditionalOnProperty(name = "shiro.web.enabled", matchIfMissing = true)
 public class ShiroWebAutoConfiguration extends AbstractShiroWebConfiguration {
 

diff --git a/...onfigure/ShiroWebFilterConfiguration.java → ...onfigure/ShiroWebFilterConfiguration.java b/...onfigure/ShiroWebFilterConfiguration.java → ...onfigure/ShiroWebFilterConfiguration.java
@@ -24,6 +24,7 @@
 import org.apache.shiro.web.servlet.AbstractShiroFilter;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
 import org.springframework.boot.web.servlet.FilterRegistrationBean;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
@@ -34,6 +35,7 @@
  * @since 1.4.0
  */
 @Configuration
+@ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET)
 @ConditionalOnProperty(name = "shiro.web.enabled", matchIfMissing = true)
 public class ShiroWebFilterConfiguration extends AbstractShiroWebFilterConfiguration {
 

diff --git a/...nfigure/ShiroWebMvcAutoConfiguration.java → ...nfigure/ShiroWebMvcAutoConfiguration.java b/...nfigure/ShiroWebMvcAutoConfiguration.java → ...nfigure/ShiroWebMvcAutoConfiguration.java
@@ -21,12 +21,14 @@
 import org.apache.shiro.spring.web.config.ShiroRequestMappingConfig;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Import;
 import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping;
 
 @Configuration
 @ConditionalOnClass(RequestMappingHandlerMapping.class)
 @Import(ShiroRequestMappingConfig.class)
+@ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET)
 @ConditionalOnProperty(name = "shiro.web.enabled", matchIfMissing = true)
 public class ShiroWebMvcAutoConfiguration { }
diff --git a/...ng-boot-starter/src/main/resources/META-INF/additional-spring-configuration-metadata.json b/...ng-boot-starter/src/main/resources/META-INF/additional-spring-configuration-metadata.json
@@ -11,6 +11,42 @@
       "type": "java.lang.Boolean",
       "description": "A boolean flag that can disable all Shiro Spring Boot starters.  This is mostly useful during testing or debugging, or if you want to compare behavior when Shiro is enabled or disabled.",
       "defaultValue": true
+    },
+    {
+      "name": "shiro.web.enabled",
+      "type": "java.lang.Boolean",
+      "description": "A boolean flag that can disable all Shiro Spring Boot starters.  This is mostly useful during testing or debugging, or if you want to compare behavior when Shiro is enabled or disabled.",
+      "defaultValue": true
+    },
+    {
+      "name": "shiro.loginUrl",
+      "type": "java.lang.String",
+      "description": "The application's login URL to be assigned to all acquired Filters that subclass AccessControlFilter or 'null' if no value should be assigned globally.",
+      "defaultValue": "/login.jsp"
+    },
+    {
+      "name": "shiro.successUrl",
+      "type": "java.lang.String",
+      "description": "The application's after-login success URL to be assigned to all acquired Filters that subclass AuthenticationFilter or null if no value should be assigned globally.",
+      "defaultValue": "/"
+    },
+    {
+      "name": "shiro.unauthorizedUrl",
+      "type": "java.lang.String",
+      "description": "The application's 'unauthorized' URL to apply to as a convenience to all discovered AuthorizationFilter instances.",
+      "defaultValue": null
+    },
+    {
+      "name": "shiro.sessionManager.sessionIdCookieEnabled",
+      "type": "java.lang.String",
+      "description": "Enable or disable session tracking via a cookie.",
+      "defaultValue": true
+    },
+    {
+      "name": "shiro.sessionManager.sessionIdUrlRewritingEnabled",
+      "type": "java.lang.String",
+      "description": "Enable or disable session tracking via a URL parameter.  If your site requires cookies, it is recommended you disable this.",
+      "defaultValue": true
     }
   ]
 }
diff --git a/support/spring-boot/spring-boot-starter/src/main/resources/META-INF/spring.factories b/support/spring-boot/spring-boot-starter/src/main/resources/META-INF/spring.factories
@@ -1,4 +1,7 @@
 org.springframework.boot.autoconfigure.EnableAutoConfiguration = \
+  org.apache.shiro.spring.config.web.autoconfigure.ShiroWebAutoConfiguration,\
+  org.apache.shiro.spring.config.web.autoconfigure.ShiroWebFilterConfiguration,\
+  org.apache.shiro.spring.config.web.autoconfigure.ShiroWebMvcAutoConfiguration,\
   org.apache.shiro.spring.boot.autoconfigure.ShiroBeanAutoConfiguration,\
   org.apache.shiro.spring.boot.autoconfigure.ShiroAutoConfiguration,\
   org.apache.shiro.spring.boot.autoconfigure.ShiroAnnotationProcessorAutoConfiguration

diff --git a/support/spring-boot/spring-boot-starter/src/main/resources/META-INF/spring.provides b/support/spring-boot/spring-boot-starter/src/main/resources/META-INF/spring.provides
@@ -1 +1 @@
-provides: shiro
+provides: shiro,shiro-web
diff --git a/...re/web/ConfiguredGlobalFiltersTest.groovy → ...re/web/ConfiguredGlobalFiltersTest.groovy b/...re/web/ConfiguredGlobalFiltersTest.groovy → ...re/web/ConfiguredGlobalFiltersTest.groovy
diff --git a/...gure/web/DisabledGlobalFiltersTest.groovy → ...gure/web/DisabledGlobalFiltersTest.groovy b/...gure/web/DisabledGlobalFiltersTest.groovy → ...gure/web/DisabledGlobalFiltersTest.groovy
diff --git a/...hiroWebSpringAutoConfigurationTest.groovy → ...hiroWebSpringAutoConfigurationTest.groovy b/...hiroWebSpringAutoConfigurationTest.groovy → ...hiroWebSpringAutoConfigurationTest.groovy
diff --git a/...oWebAutoConfigurationTestApplication.java → ...oWebAutoConfigurationTestApplication.java b/...oWebAutoConfigurationTestApplication.java → ...oWebAutoConfigurationTestApplication.java
diff --git a/support/spring-boot/spring-boot-web-starter/pom.xml b/support/spring-boot/spring-boot-web-starter/pom.xml
@@ -31,6 +31,12 @@
 
     <artifactId>shiro-spring-boot-web-starter</artifactId>
     <name>Apache Shiro :: Support :: Spring Boot Web</name>
+    <description>Deprecated, these classes were moved to shiro-spring-boot-starter</description>
+
+    <properties>
+        <!-- japicmp config was moved into the combine 'shiro-spring-boot-starter' module -->
+        <japicmp.skip>true</japicmp.skip>
+    </properties>
 
     <dependencies>
 
@@ -60,29 +66,10 @@
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter</artifactId>
-            <version>${spring-boot.version}</version>
         </dependency>
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-web</artifactId>
-            <version>${spring-boot.version}</version>
-        </dependency>
-
-        <dependency>
-            <groupId>org.springframework.boot</groupId>
-            <artifactId>spring-boot-test</artifactId>
-            <scope>test</scope>
-        </dependency>
-        <dependency>
-            <groupId>org.springframework</groupId>
-            <artifactId>spring-test</artifactId>
-            <scope>test</scope>
-        </dependency>
-
-        <dependency>
-            <groupId>org.mockito</groupId>
-            <artifactId>mockito-core</artifactId>
-            <scope>test</scope>
         </dependency>
 
     </dependencies>

diff --git a/support/spring-boot/spring-boot-web-starter/src/main/resources/META-INF/NOTICE b/support/spring-boot/spring-boot-web-starter/src/main/resources/META-INF/NOTICE
diff --git a/...oot-web-starter/src/main/resources/META-INF/additional-spring-configuration-metadata.json b/...oot-web-starter/src/main/resources/META-INF/additional-spring-configuration-metadata.json
diff --git a/support/spring-boot/spring-boot-web-starter/src/main/resources/META-INF/spring.factories b/support/spring-boot/spring-boot-web-starter/src/main/resources/META-INF/spring.factories
diff --git a/support/spring-boot/spring-boot-web-starter/src/main/resources/META-INF/spring.provides b/support/spring-boot/spring-boot-web-starter/src/main/resources/META-INF/spring.provides
diff --git a/.../test/groovy/org/apache/shiro/spring/boot/autoconfigure/web/WebSpringFactoriesTest.groovy b/.../test/groovy/org/apache/shiro/spring/boot/autoconfigure/web/WebSpringFactoriesTest.groovy