update enunciate to version 2.9.1

2025-11-11 16:05:44 +01:00 · 2017-05-09 15:18:14 +02:00
parent de5e1084e9
commit 9ffb07acee
16 changed files with 66 additions and 68 deletions
--- a/pom.xml
+++ b/pom.xml
@@ -142,7 +142,7 @@
      <plugin>
        <groupId>org.codehaus.mojo</groupId>
        <artifactId>animal-sniffer-maven-plugin</artifactId>
-        <version>1.9</version>
+        <version>1.15</version>
        <configuration>
          <signature>
            <groupId>org.codehaus.mojo.signature</groupId>
--- a/scm-webapp/pom.xml
+++ b/scm-webapp/pom.xml
@@ -275,10 +275,9 @@
    <!-- rest documentation -->
    
    <dependency>
-      <groupId>org.codehaus.enunciate</groupId>
-      <artifactId>enunciate-jersey-rt</artifactId>
+      <groupId>com.webcohesion.enunciate</groupId>
+      <artifactId>enunciate-jaxrs</artifactId>
      <version>${enunciate.version}</version>
-      <!-- fix conflict with jersey-json -->
      <exclusions>
        <exclusion>
          <artifactId>jackson-jaxrs</artifactId>
@@ -546,7 +545,7 @@
    <scm.home>target/scm-it</scm.home>
    <environment.profile>default</environment.profile>
    <selenium.version>2.53.1</selenium.version>
-    <enunciate.version>1.31</enunciate.version>
+    <enunciate.version>2.9.1</enunciate.version>
    <aether.version>1.13.1</aether.version>
    <wagon.version>1.0</wagon.version>
    <maven.version>3.0.5</maven.version>
@@ -825,8 +824,35 @@
        <plugins>
          
          <plugin>
-            <groupId>org.codehaus.enunciate</groupId>
-            <artifactId>maven-enunciate-plugin</artifactId>
+            <groupId>org.apache.maven.plugins</groupId>
+            <artifactId>maven-resources-plugin</artifactId>
+            <version>2.6</version>
+            <executions>
+              <execution>
+                <id>copy-enunciate-configuration</id>
+                <phase>compile</phase>
+                <goals>
+                  <goal>copy-resources</goal>
+                </goals>
+                <configuration>
+                  <outputDirectory>${project.build.directory}</outputDirectory>
+                  <resources>          
+                    <resource>
+                      <directory>src/main/doc</directory>
+                      <filtering>true</filtering>
+                      <includes>
+                        <include>**/enunciate.xml</include>
+                      </includes>
+                    </resource>
+                  </resources>              
+                </configuration>            
+              </execution>
+            </executions>
+          </plugin>
+          
+          <plugin>
+            <groupId>com.webcohesion.enunciate</groupId>
+            <artifactId>enunciate-maven-plugin</artifactId>
            <version>${enunciate.version}</version>
            <executions>
              <execution>
@@ -837,14 +863,20 @@
              </execution>
            </executions>
            <configuration>
-              <configFile>src/main/doc/enunciate.xml</configFile>
+              <configFile>${project.build.directory}/enunciate.xml</configFile>
              <docsDir>${project.build.directory}/restdocs</docsDir>
            </configuration>
            <dependencies>
              <dependency>
-                <groupId>org.codehaus.enunciate</groupId>
-                <artifactId>enunciate-jersey</artifactId>
-                <version>${enunciate.version}</version>
+                <groupId>com.webcohesion.enunciate</groupId>
+                <artifactId>enunciate-top</artifactId>
+                <version>2.9.1</version>
+                <exclusions>
+                  <exclusion>
+                    <groupId>com.webcohesion.enunciate</groupId>
+                    <artifactId>enunciate-swagger</artifactId>
+                  </exclusion>
+                </exclusions>
              </dependency>
            </dependencies>
          </plugin>
--- a/scm-webapp/src/main/doc/enunciate.xml
+++ b/scm-webapp/src/main/doc/enunciate.xml
@@ -39,30 +39,33 @@
    Description: Enunciate configuration
 -->

-<enunciate label="full" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-           xsi:noNamespaceSchemaLocation="http://enunciate.codehaus.org/schemas/enunciate-1.27.xsd">
+<enunciate xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+           xsi:noNamespaceSchemaLocation="http://enunciate.webcohesion.com/schemas/enunciate-2.9.0.xsd"
+           slug="scm-manager" version="${project.version}">
+
+  <title>SCM-Manager API</title>
+  
+  <description>
+    <![CDATA[
+      <h1>SCM-Manager API</h1>
+      <p>This page describes the REST Api of <a href="https://www.scm-manager.org">SCM-Manager</a> ${project.version}.</p>
+    ]]>
+  </description>
  
  <api-classes>
-    <include pattern="sonia.scm.api.rest.resources.*" />
+    <exclude pattern="sonia.scm.debug.DebugResource" /> 
    <exclude pattern="sonia.scm.api.rest.resources.ConfigurationResource" /> 
    <exclude pattern="sonia.scm.api.rest.resources.SupportResource" />
    <exclude pattern="sonia.scm.api.rest.resources.RepositoryRootResource" />
  </api-classes>

-  <services>
-    <rest defaultRestSubcontext="/api/rest" />
-  </services>
-
  <modules>
    
-    <docs title="SCM-Manager API" />
+    <jaxrs datatype-detection="local">
+      <application path="/api/rest" />
+    </jaxrs>
    
-    <jersey resourceProviderFactory="com.sun.jersey.guice.spi.container.GuiceComponentProviderFactory">
-      <init-param name="com.sun.jersey.api.json.POJOMappingFeature" value="true" />
-      <init-param name="com.sun.jersey.config.feature.Redirect" value="true" />
-      <init-param name="com.sun.jersey.config.property.resourceConfigClass" value="sonia.scm.api.rest.UriExtensionsConfig" /> 
-      <init-param name="com.sun.jersey.config.property.packages" value="sonia.scm.api.rest" />
-    </jersey>
+    <docs disableResourceLinks="true" includeApplicationPath="true" />
  
  </modules>

--- a/scm-webapp/src/main/java/sonia/scm/api/rest/resources/AuthenticationResource.java
+++ b/scm-webapp/src/main/java/sonia/scm/api/rest/resources/AuthenticationResource.java
@@ -41,6 +41,7 @@ import com.google.common.collect.ImmutableList;
 import com.google.common.collect.ImmutableList.Builder;
 import com.google.inject.Inject;
 import com.google.inject.Singleton;
+import com.webcohesion.enunciate.metadata.rs.TypeHint;

 import org.apache.shiro.SecurityUtils;
 import org.apache.shiro.authc.AuthenticationException;
@@ -50,8 +51,6 @@ import org.apache.shiro.authz.Permission;
 import org.apache.shiro.subject.PrincipalCollection;
 import org.apache.shiro.subject.Subject;

-import org.codehaus.enunciate.jaxrs.TypeHint;
-import org.codehaus.enunciate.modules.jersey.ExternallyManagedLifecycle;

 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -106,7 +105,6 @@ import sonia.scm.security.XsrfCookies;
 */
@Singleton
@Path("authentication")
-@ExternallyManagedLifecycle
@Produces({ MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON })
 public class AuthenticationResource
 {
--- a/scm-webapp/src/main/java/sonia/scm/api/rest/resources/ChangePasswordResource.java
+++ b/scm-webapp/src/main/java/sonia/scm/api/rest/resources/ChangePasswordResource.java
@@ -36,13 +36,11 @@ package sonia.scm.api.rest.resources;
 //~--- non-JDK imports --------------------------------------------------------

 import com.google.inject.Inject;
+import com.webcohesion.enunciate.metadata.rs.TypeHint;

 import org.apache.shiro.SecurityUtils;
 import org.apache.shiro.subject.Subject;

-import org.codehaus.enunciate.jaxrs.TypeHint;
-import org.codehaus.enunciate.modules.jersey.ExternallyManagedLifecycle;
-
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;

@@ -71,7 +69,6 @@ import sonia.scm.security.Role;
 *
 * @author Sebastian Sdorra
 */
-@ExternallyManagedLifecycle
@Path("action/change-password")
 public class ChangePasswordResource
 {
--- a/scm-webapp/src/main/java/sonia/scm/api/rest/resources/ConfigurationResource.java
+++ b/scm-webapp/src/main/java/sonia/scm/api/rest/resources/ConfigurationResource.java
@@ -41,8 +41,6 @@ import com.google.inject.Singleton;
 import org.apache.shiro.SecurityUtils;
 import org.apache.shiro.subject.Subject;

-import org.codehaus.enunciate.modules.jersey.ExternallyManagedLifecycle;
-
 import sonia.scm.config.ScmConfiguration;
 import sonia.scm.security.Role;
 import sonia.scm.security.ScmSecurityException;
@@ -66,7 +64,6 @@ import javax.ws.rs.core.UriInfo;
 */
@Singleton
@Path("config")
-@ExternallyManagedLifecycle
 public class ConfigurationResource
 {

--- a/scm-webapp/src/main/java/sonia/scm/api/rest/resources/GroupResource.java
+++ b/scm-webapp/src/main/java/sonia/scm/api/rest/resources/GroupResource.java
@@ -37,12 +37,10 @@ package sonia.scm.api.rest.resources;

 import com.google.inject.Inject;
 import com.google.inject.Singleton;
+import com.webcohesion.enunciate.metadata.rs.TypeHint;

 import org.apache.shiro.SecurityUtils;

-import org.codehaus.enunciate.jaxrs.TypeHint;
-import org.codehaus.enunciate.modules.jersey.ExternallyManagedLifecycle;
-
 import sonia.scm.group.Group;
 import sonia.scm.group.GroupException;
 import sonia.scm.group.GroupManager;
@@ -75,7 +73,6 @@ import javax.ws.rs.core.UriInfo;
 */
@Path("groups")
@Singleton
-@ExternallyManagedLifecycle
 public class GroupResource
  extends AbstractManagerResource<Group, GroupException>
 {
--- a/scm-webapp/src/main/java/sonia/scm/api/rest/resources/KeyResource.java
+++ b/scm-webapp/src/main/java/sonia/scm/api/rest/resources/KeyResource.java
@@ -37,8 +37,6 @@ import com.google.inject.Inject;

 import org.apache.shiro.SecurityUtils;

-import org.codehaus.enunciate.modules.jersey.ExternallyManagedLifecycle;
-
 import sonia.scm.security.KeyGenerator;
 import sonia.scm.security.Role;

@@ -56,7 +54,6 @@ import javax.ws.rs.core.MediaType;
 * @since 1.41
 */
@Path("security/key")
-@ExternallyManagedLifecycle
 public class KeyResource
 {

--- a/scm-webapp/src/main/java/sonia/scm/api/rest/resources/PluginResource.java
+++ b/scm-webapp/src/main/java/sonia/scm/api/rest/resources/PluginResource.java
@@ -39,8 +39,6 @@ import com.google.common.collect.Lists;
 import com.google.inject.Inject;
 import com.google.inject.Singleton;

-import org.codehaus.enunciate.modules.jersey.ExternallyManagedLifecycle;
-
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;

@@ -80,7 +78,6 @@ import javax.ws.rs.core.Response.Status;
 */
@Singleton
@Path("plugins")
-@ExternallyManagedLifecycle
 public class PluginResource
 {

--- a/scm-webapp/src/main/java/sonia/scm/api/rest/resources/RepositoryImportResource.java
+++ b/scm-webapp/src/main/java/sonia/scm/api/rest/resources/RepositoryImportResource.java
@@ -43,9 +43,6 @@ import com.google.inject.Inject;

 import org.apache.shiro.SecurityUtils;

-import org.codehaus.enunciate.jaxrs.TypeHint;
-import org.codehaus.enunciate.modules.jersey.ExternallyManagedLifecycle;
-
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;

@@ -74,6 +71,7 @@ import static com.google.common.base.Preconditions.*;

 import com.sun.jersey.api.client.ClientResponse.Status;
 import com.sun.jersey.multipart.FormDataParam;
+import com.webcohesion.enunciate.metadata.rs.TypeHint;

 import java.io.File;
 import java.io.IOException;
@@ -111,7 +109,6 @@ import javax.xml.bind.annotation.XmlRootElement;
 * @author Sebastian Sdorra
 */
@Path("import/repositories")
-@ExternallyManagedLifecycle
 public class RepositoryImportResource
 {

--- a/scm-webapp/src/main/java/sonia/scm/api/rest/resources/RepositoryResource.java
+++ b/scm-webapp/src/main/java/sonia/scm/api/rest/resources/RepositoryResource.java
@@ -39,12 +39,10 @@ import com.google.common.base.Strings;
 import com.google.common.io.Closeables;
 import com.google.inject.Inject;
 import com.google.inject.Singleton;
+import com.webcohesion.enunciate.metadata.rs.TypeHint;

 import org.apache.shiro.SecurityUtils;

-import org.codehaus.enunciate.jaxrs.TypeHint;
-import org.codehaus.enunciate.modules.jersey.ExternallyManagedLifecycle;
-
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;

@@ -111,7 +109,6 @@ import javax.ws.rs.core.UriInfo;
 */
@Singleton
@Path("repositories")
-@ExternallyManagedLifecycle
 public class RepositoryResource
  extends AbstractManagerResource<Repository, RepositoryException>
 {
--- a/scm-webapp/src/main/java/sonia/scm/api/rest/resources/RepositoryRootResource.java
+++ b/scm-webapp/src/main/java/sonia/scm/api/rest/resources/RepositoryRootResource.java
@@ -41,8 +41,6 @@ import com.google.common.collect.Maps;
 import com.google.common.collect.Ordering;
 import com.google.inject.Inject;

-import org.codehaus.enunciate.modules.jersey.ExternallyManagedLifecycle;
-
 import sonia.scm.repository.Repository;
 import sonia.scm.repository.RepositoryManager;
 import sonia.scm.repository.RepositoryTypePredicate;
@@ -74,7 +72,6 @@ import javax.ws.rs.core.MediaType;
 *
 * @author Sebastian Sdorra
 */
-@ExternallyManagedLifecycle
@Path("help/repository-root/{type}.html")
 public class RepositoryRootResource
 {
--- a/scm-webapp/src/main/java/sonia/scm/api/rest/resources/SearchResource.java
+++ b/scm-webapp/src/main/java/sonia/scm/api/rest/resources/SearchResource.java
@@ -39,8 +39,6 @@ import com.google.common.base.Function;
 import com.google.inject.Inject;
 import com.google.inject.Singleton;

-import org.codehaus.enunciate.modules.jersey.ExternallyManagedLifecycle;
-
 import sonia.scm.HandlerEvent;
 import sonia.scm.cache.Cache;
 import sonia.scm.cache.CacheManager;
@@ -68,7 +66,6 @@ import javax.ws.rs.core.MediaType;
 */
@Singleton
@Path("search")
-@ExternallyManagedLifecycle
 public class SearchResource implements UserListener, GroupListener
 {

--- a/scm-webapp/src/main/java/sonia/scm/api/rest/resources/SecuritySystemResource.java
+++ b/scm-webapp/src/main/java/sonia/scm/api/rest/resources/SecuritySystemResource.java
@@ -45,14 +45,12 @@ import sonia.scm.security.SecuritySystem;

 import javax.ws.rs.Path;
 import javax.ws.rs.PathParam;
-import org.codehaus.enunciate.modules.jersey.ExternallyManagedLifecycle;

 /**
 *
 * @author Sebastian Sdorra
 */
@Path("security/permission")
-@ExternallyManagedLifecycle
 public class SecuritySystemResource
 {

--- a/scm-webapp/src/main/java/sonia/scm/api/rest/resources/SupportResource.java
+++ b/scm-webapp/src/main/java/sonia/scm/api/rest/resources/SupportResource.java
@@ -42,8 +42,6 @@ import com.google.inject.Inject;
 import org.apache.shiro.SecurityUtils;
 import org.apache.shiro.subject.Subject;

-import org.codehaus.enunciate.modules.jersey.ExternallyManagedLifecycle;
-
 import sonia.scm.SCMContextProvider;
 import sonia.scm.ServletContainerDetector;
 import sonia.scm.Type;
@@ -79,7 +77,6 @@ import javax.ws.rs.core.MediaType;
 * @author Sebastian Sdorra
 */
@Path("support")
-@ExternallyManagedLifecycle
 public class SupportResource
 {

--- a/scm-webapp/src/main/java/sonia/scm/api/rest/resources/UserResource.java
+++ b/scm-webapp/src/main/java/sonia/scm/api/rest/resources/UserResource.java
@@ -37,12 +37,10 @@ package sonia.scm.api.rest.resources;

 import com.google.inject.Inject;
 import com.google.inject.Singleton;
+import com.webcohesion.enunciate.metadata.rs.TypeHint;

 import org.apache.shiro.SecurityUtils;

-import org.codehaus.enunciate.jaxrs.TypeHint;
-import org.codehaus.enunciate.modules.jersey.ExternallyManagedLifecycle;
-
 import sonia.scm.security.EncryptionHandler;
 import sonia.scm.security.Role;
 import sonia.scm.user.User;
@@ -78,7 +76,6 @@ import javax.ws.rs.core.UriInfo;
 */
@Singleton
@Path("users")
-@ExternallyManagedLifecycle
 public class UserResource extends AbstractManagerResource<User, UserException>
 {