Simplify core elements initialization with Spring

gravitee-apim-rest-api/gravitee-apim-rest-api-portal/gravitee-apim-rest-api-portal-rest/src/test/java/io/gravitee/rest/api/portal/rest/resource/SubscriptionResourceTest.java

@@ -211,26 +211,9 @@ public void shouldNotGetSubscription() {
         assertNotNull(errors);
     }
 
-    @Test
-    public void shouldCloseSubscription() {
-        final Response response = target(SUBSCRIPTION).path("_close").request().post(null);
-        assertEquals(HttpStatusCode.NO_CONTENT_204, response.getStatus());
-
-        assertFalse(response.hasEntity());
-    }
-
     @Test
     public void testPermissionsForClosingASubscription() {
         reset(permissionService);
-        doReturn(true)
-            .when(permissionService)
-            .hasPermission(
-                eq(GraviteeContext.getExecutionContext()),
-                eq(RolePermission.APPLICATION_SUBSCRIPTION),
-                eq(APPLICATION),
-                eq(RolePermissionAction.DELETE)
-            );
-        assertEquals(HttpStatusCode.NO_CONTENT_204, target(SUBSCRIPTION).path("_close").request().post(null).getStatus());
 
         doReturn(false)
             .when(permissionService)

gravitee-apim-rest-api/gravitee-apim-rest-api-portal/gravitee-apim-rest-api-portal-rest/src/test/java/io/gravitee/rest/api/portal/rest/spring/ResourceContextConfiguration.java

@@ -43,24 +43,82 @@
 import io.gravitee.apim.core.plan.domain_service.PlanSynchronizationService;
 import io.gravitee.apim.core.policy.domain_service.PolicyValidationDomainService;
 import io.gravitee.apim.core.subscription.domain_service.CloseSubscriptionDomainService;
-import io.gravitee.apim.core.subscription.use_case.CloseSubscriptionUseCase;
 import io.gravitee.apim.infra.domain_service.api.ApiHostValidatorDomainServiceImpl;
 import io.gravitee.apim.infra.json.jackson.JacksonSpringConfiguration;
 import io.gravitee.apim.infra.sanitizer.SanitizerSpringConfiguration;
 import io.gravitee.apim.infra.spring.UsecaseSpringConfiguration;
 import io.gravitee.definition.jackson.datatype.GraviteeMapper;
 import io.gravitee.node.api.license.LicenseManager;
-import io.gravitee.rest.api.portal.rest.mapper.*;
+import io.gravitee.rest.api.portal.rest.mapper.AnalyticsMapper;
+import io.gravitee.rest.api.portal.rest.mapper.ApiMapper;
+import io.gravitee.rest.api.portal.rest.mapper.ApplicationMapper;
+import io.gravitee.rest.api.portal.rest.mapper.CategoryMapper;
+import io.gravitee.rest.api.portal.rest.mapper.ConfigurationMapper;
+import io.gravitee.rest.api.portal.rest.mapper.IdentityProviderMapper;
+import io.gravitee.rest.api.portal.rest.mapper.KeyMapper;
+import io.gravitee.rest.api.portal.rest.mapper.LogMapper;
+import io.gravitee.rest.api.portal.rest.mapper.MemberMapper;
+import io.gravitee.rest.api.portal.rest.mapper.PageMapper;
+import io.gravitee.rest.api.portal.rest.mapper.PlanMapper;
+import io.gravitee.rest.api.portal.rest.mapper.PortalNotificationMapper;
+import io.gravitee.rest.api.portal.rest.mapper.RatingMapper;
+import io.gravitee.rest.api.portal.rest.mapper.ReferenceMetadataMapper;
+import io.gravitee.rest.api.portal.rest.mapper.SubscriptionMapper;
+import io.gravitee.rest.api.portal.rest.mapper.ThemeMapper;
+import io.gravitee.rest.api.portal.rest.mapper.TicketMapper;
+import io.gravitee.rest.api.portal.rest.mapper.UserMapper;
 import io.gravitee.rest.api.security.authentication.AuthenticationProvider;
 import io.gravitee.rest.api.security.cookies.CookieGenerator;
 import io.gravitee.rest.api.security.utils.AuthoritiesProvider;
-import io.gravitee.rest.api.service.*;
+import io.gravitee.rest.api.service.AccessControlService;
+import io.gravitee.rest.api.service.AnalyticsService;
+import io.gravitee.rest.api.service.ApiKeyService;
+import io.gravitee.rest.api.service.ApiMetadataService;
 import io.gravitee.rest.api.service.ApiService;
+import io.gravitee.rest.api.service.ApplicationMetadataService;
+import io.gravitee.rest.api.service.ApplicationService;
+import io.gravitee.rest.api.service.CategoryService;
+import io.gravitee.rest.api.service.ConfigService;
+import io.gravitee.rest.api.service.CustomUserFieldService;
+import io.gravitee.rest.api.service.EntrypointService;
+import io.gravitee.rest.api.service.EnvironmentService;
+import io.gravitee.rest.api.service.FetcherService;
+import io.gravitee.rest.api.service.GenericNotificationConfigService;
+import io.gravitee.rest.api.service.GroupService;
+import io.gravitee.rest.api.service.HealthCheckService;
+import io.gravitee.rest.api.service.IdentityService;
+import io.gravitee.rest.api.service.LogsService;
+import io.gravitee.rest.api.service.MediaService;
+import io.gravitee.rest.api.service.MembershipService;
+import io.gravitee.rest.api.service.MessageService;
+import io.gravitee.rest.api.service.NotifierService;
+import io.gravitee.rest.api.service.PageService;
+import io.gravitee.rest.api.service.ParameterService;
+import io.gravitee.rest.api.service.PermissionService;
 import io.gravitee.rest.api.service.PlanService;
+import io.gravitee.rest.api.service.PolicyService;
+import io.gravitee.rest.api.service.PortalNotificationConfigService;
+import io.gravitee.rest.api.service.PortalNotificationService;
+import io.gravitee.rest.api.service.QualityMetricsService;
+import io.gravitee.rest.api.service.RatingService;
+import io.gravitee.rest.api.service.RoleService;
+import io.gravitee.rest.api.service.SocialIdentityProviderService;
+import io.gravitee.rest.api.service.SubscriptionService;
+import io.gravitee.rest.api.service.SwaggerService;
+import io.gravitee.rest.api.service.TagService;
+import io.gravitee.rest.api.service.TaskService;
+import io.gravitee.rest.api.service.ThemeService;
+import io.gravitee.rest.api.service.TicketService;
+import io.gravitee.rest.api.service.TopApiService;
+import io.gravitee.rest.api.service.UserService;
 import io.gravitee.rest.api.service.configuration.application.ApplicationTypeService;
 import io.gravitee.rest.api.service.configuration.identity.IdentityProviderActivationService;
 import io.gravitee.rest.api.service.filtering.FilteringService;
-import io.gravitee.rest.api.service.v4.*;
+import io.gravitee.rest.api.service.v4.ApiAuthorizationService;
+import io.gravitee.rest.api.service.v4.ApiCategoryService;
+import io.gravitee.rest.api.service.v4.ApiEntrypointService;
+import io.gravitee.rest.api.service.v4.ApiSearchService;
+import io.gravitee.rest.api.service.v4.PlanSearchService;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Import;
@@ -456,11 +514,6 @@ public CloseSubscriptionDomainService closeSubscriptionDomainService() {
         return mock(CloseSubscriptionDomainService.class);
     }
 
-    @Bean
-    CloseSubscriptionUseCase closeSubscriptionUsecase() {
-        return mock(CloseSubscriptionUseCase.class);
-    }
-
     @Bean
     public LicenseManager licenseManager() {
         return mock(LicenseManager.class);

gravitee-apim-rest-api/gravitee-apim-rest-api-service/src/main/java/io/gravitee/apim/core/DomainService.java

@@ -0,0 +1,51 @@
+/*
+ * Copyright © 2015 The Gravitee team (http://gravitee.io)
+ *
+ * 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 io.gravitee.apim.core;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * This annotation is used to mark a class as a Domain Service
+ *
+ * <p>
+ *     A Domain Service is a class that will perform business logic that can be both targeted by Use Cases, or other
+ *     Domain Services.
+ * </p>
+ *
+ * <p>
+ *      Most of the time, we can't have different implementation and therefore defining an Interface can be skipped. <br />
+ *      However, an interface can be useful in APIM context when existing code (Legacy) already define the logic and we don't want to spend time to extract in regular Domain Service yet.
+ * </p>
+ *
+ * <p>
+ *     An example: revoking an API key can be done in a Use Case (action performed on an API call), or it can be done
+ *     when performing another use case (for instance when closing a subscription). We can create a
+ *     <code>RevokeApiKeyDomainService</code> that will be called by the <code>RevokeApiKeyUseCase</code>, and <code>CloseSubscriptionUseCase</code>
+ * </p>
+ *
+ * <p>NOTE: In Craft literature, we can also see Application Services. We choose to not introduce the term (yet?). <br />
+ * Our main focus for now is to split business code from infrastructure code.</p>
+ *
+ * @see <a href="https://gravitee.slab.com/posts/%E2%9A%92%EF%B8%8F-better-software-architecture-of-the-management-api-yxtcvazk">https://gravitee.slab.com/posts/%E2%9A%92%EF%B8%8F-better-software-architecture-of-the-management-api-yxtcvazk</a>
+ * @see <a href="https://enterprisecraftsmanship.com/posts/domain-vs-application-services/">https://enterprisecraftsmanship.com/posts/domain-vs-application-services/</a>
+ */
+@Target({ ElementType.TYPE })
+@Retention(RetentionPolicy.RUNTIME)
+public @interface DomainService {
+}

gravitee-apim-rest-api/gravitee-apim-rest-api-service/src/main/java/io/gravitee/apim/core/UseCase.java

@@ -0,0 +1,54 @@
+/*
+ * Copyright © 2015 The Gravitee team (http://gravitee.io)
+ *
+ * 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 io.gravitee.apim.core;
+
+import io.gravitee.rest.api.service.exceptions.AbstractManagementException;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+import org.springframework.transaction.annotation.Transactional;
+
+/**
+ * This annotation is used to mark a class as a Use Case.
+ *
+ * <p>
+ * A Use Case is a class that describes a list of actions that a system should perform in order to achieve a particular goal.
+ * </p>
+ * <p>
+ * Rules that applies to Use Cases, in APIM context, are the following:
+ *     <ul>
+ *         <li>Use Case can't reference another Use Case</li>
+ *         <li>Use Case matches to an action that can be done by a user (or System)</li>
+ *        <li>Other rules are enforced by ArchUnit {@link architecture.UseCaseRulesTest}</li>
+ *      <ul>
+ * </p>
+ * <p>
+ *      ⚠️ This annotation relies on Spring annotation which is an exception to the rule of not using Framework in core.
+ * </p>
+ * <p>
+ *      ⚠️ Transactions only supported when using JDBC repositories.
+ * </p>
+ *
+ * @see <a href="https://gravitee.slab.com/posts/%E2%9A%92%EF%B8%8F-better-software-architecture-of-the-management-api-yxtcvazk">https://gravitee.slab.com/posts/%E2%9A%92%EF%B8%8F-better-software-architecture-of-the-management-api-yxtcvazk</a>
+ * @see <a href="https://blog.cleancoder.com/uncle-bob/2012/08/13/the-clean-architecture.html">https://blog.cleancoder.com/uncle-bob/2012/08/13/the-clean-architecture.html</a>
+ * @see <a href="https://nanosoft.co.za/blog/post/clean-architecture-use-cases">https://nanosoft.co.za/blog/post/clean-architecture-use-cases</a>
+ */
+@Target({ ElementType.TYPE })
+@Retention(RetentionPolicy.RUNTIME)
+@Transactional(value = "graviteeTransactionManager", noRollbackFor = AbstractManagementException.class)
+public @interface UseCase {
+}

gravitee-apim-rest-api/gravitee-apim-rest-api-service/src/main/java/io/gravitee/apim/core/api/domain_service/ApiIndexerDomainService.java

@@ -15,6 +15,7 @@
  */
 package io.gravitee.apim.core.api.domain_service;
 
+import io.gravitee.apim.core.DomainService;
 import io.gravitee.apim.core.api.domain_service.ApiMetadataDecoderDomainService.ApiMetadataDecodeContext;
 import io.gravitee.apim.core.api.domain_service.ApiMetadataDecoderDomainService.PrimaryOwnerMetadataDecodeContext;
 import io.gravitee.apim.core.api.model.Api;
@@ -23,6 +24,7 @@
 import io.gravitee.apim.core.search.model.IndexableApi;
 import java.util.Date;
 
+@DomainService
 public class ApiIndexerDomainService {
 
     private final ApiMetadataDecoderDomainService apiMetadataDecoderDomainService;

gravitee-apim-rest-api/gravitee-apim-rest-api-service/src/main/java/io/gravitee/apim/core/api/domain_service/ApiMetadataDecoderDomainService.java

@@ -15,6 +15,7 @@
  */
 package io.gravitee.apim.core.api.domain_service;
 
+import io.gravitee.apim.core.DomainService;
 import io.gravitee.apim.core.api.query_service.ApiMetadataQueryService;
 import io.gravitee.apim.core.exception.TechnicalDomainException;
 import io.gravitee.apim.core.template.TemplateProcessor;
@@ -30,6 +31,7 @@
 import lombok.extern.slf4j.Slf4j;
 
 @Slf4j
+@DomainService
 public class ApiMetadataDecoderDomainService {
 
     private final ApiMetadataQueryService metadataQueryService;

gravitee-apim-rest-api/gravitee-apim-rest-api-service/src/main/java/io/gravitee/apim/core/api/domain_service/ApiMetadataDomainService.java

@@ -15,6 +15,7 @@
  */
 package io.gravitee.apim.core.api.domain_service;
 
+import io.gravitee.apim.core.DomainService;
 import io.gravitee.apim.core.api.model.ApiMetadata;
 import io.gravitee.apim.core.audit.domain_service.AuditDomainService;
 import io.gravitee.apim.core.audit.model.ApiAuditLogEntity;
@@ -33,6 +34,7 @@
  * @author Antoine CORDIER (antoine.cordier at graviteesource.com)
  * @author GraviteeSource Team
  */
+@DomainService
 public class ApiMetadataDomainService {
 
     private final MetadataCrudService metadataCrudService;

gravitee-apim-rest-api/gravitee-apim-rest-api-service/src/main/java/io/gravitee/apim/core/api/domain_service/ApiPolicyValidatorDomainService.java

@@ -15,6 +15,7 @@
  */
 package io.gravitee.apim.core.api.domain_service;
 
+import io.gravitee.apim.core.DomainService;
 import io.gravitee.apim.core.policy.domain_service.PolicyValidationDomainService;
 import io.gravitee.definition.model.Api;
 import io.gravitee.definition.model.Plan;
@@ -27,6 +28,7 @@
 import lombok.RequiredArgsConstructor;
 
 @RequiredArgsConstructor
+@DomainService
 public class ApiPolicyValidatorDomainService {
 
     private final PolicyValidationDomainService policyValidationDomainService;

gravitee-apim-rest-api/gravitee-apim-rest-api-service/src/main/java/io/gravitee/apim/core/api/domain_service/CreateApiDomainService.java

@@ -17,6 +17,7 @@
 
 import static io.gravitee.apim.core.workflow.model.Workflow.newApiReviewWorkflow;
 
+import io.gravitee.apim.core.DomainService;
 import io.gravitee.apim.core.api.crud_service.ApiCrudService;
 import io.gravitee.apim.core.api.model.Api;
 import io.gravitee.apim.core.api.model.ApiWithFlows;
@@ -37,6 +38,7 @@
 import io.gravitee.rest.api.model.parameters.ParameterReferenceType;
 import java.util.Collections;
 
+@DomainService
 public class CreateApiDomainService {
 
     private final ValidateApiDomainService validateApiDomainService;

gravitee-apim-rest-api/gravitee-apim-rest-api-service/src/main/java/io/gravitee/apim/core/api/domain_service/VerifyApiHostsDomainService.java

@@ -15,6 +15,7 @@
  */
 package io.gravitee.apim.core.api.domain_service;
 
+import io.gravitee.apim.core.DomainService;
 import io.gravitee.apim.core.api.exception.DuplicatedHostException;
 import io.gravitee.apim.core.api.exception.HostAlreadyExistsException;
 import io.gravitee.apim.core.api.exception.InvalidHostException;
@@ -34,6 +35,7 @@
 
 @Slf4j
 @RequiredArgsConstructor
+@DomainService
 public class VerifyApiHostsDomainService {
 
     /**

gravitee-apim-rest-api/gravitee-apim-rest-api-service/src/main/java/io/gravitee/apim/core/api/domain_service/VerifyApiPathDomainService.java

@@ -15,6 +15,7 @@
  */
 package io.gravitee.apim.core.api.domain_service;
 
+import io.gravitee.apim.core.DomainService;
 import io.gravitee.apim.core.api.exception.InvalidHostException;
 import io.gravitee.apim.core.api.exception.InvalidPathsException;
 import io.gravitee.apim.core.api.model.Api;
@@ -34,6 +35,7 @@
 import lombok.extern.slf4j.Slf4j;
 
 @Slf4j
+@DomainService
 public class VerifyApiPathDomainService {
 
     private final ApiQueryService apiSearchService;
@@ -249,11 +251,11 @@ private static String extractPort(final String hostAndPort) {
         }
         return null;
     }
-}
 
-class PathAlreadyExistsException extends RuntimeException {
+    static class PathAlreadyExistsException extends RuntimeException {
 
-    public PathAlreadyExistsException(String path) {
-        super("Path [" + path + "] already exists");
+        public PathAlreadyExistsException(String path) {
+            super("Path [" + path + "] already exists");
+        }
     }
 }