Skip to content

Commit b664aa0

Browse files
bnasslahsenbnasslahsen
committed
Renaming some classes
1 parent 3c870c3 commit b664aa0

34 files changed

+324
-324
lines changed

‎springdoc-openapi-common/src/main/java/org/springdoc/api/AbstractOpenApiResource.java

+35-35
Original file line numberDiff line numberDiff line change
@@ -66,13 +66,13 @@
6666
import org.apache.commons.lang3.StringUtils;
6767
import org.slf4j.Logger;
6868
import org.slf4j.LoggerFactory;
69-
import org.springdoc.core.AbstractRequestBuilder;
69+
import org.springdoc.core.AbstractRequestService;
7070
import org.springdoc.core.ActuatorProvider;
71-
import org.springdoc.core.GenericParameterBuilder;
72-
import org.springdoc.core.GenericResponseBuilder;
71+
import org.springdoc.core.GenericParameterService;
72+
import org.springdoc.core.GenericResponseService;
7373
import org.springdoc.core.MethodAttributes;
74-
import org.springdoc.core.OpenAPIBuilder;
75-
import org.springdoc.core.OperationBuilder;
74+
import org.springdoc.core.OpenAPIService;
75+
import org.springdoc.core.OperationService;
7676
import org.springdoc.core.SpringDocConfigProperties;
7777
import org.springdoc.core.SpringDocConfigProperties.GroupConfig;
7878
import org.springdoc.core.annotations.RouterOperations;
@@ -119,12 +119,12 @@ public abstract class AbstractOpenApiResource extends SpecFilter {
119119
/**
120120
* The Open api builder.
121121
*/
122-
protected OpenAPIBuilder openAPIBuilder;
122+
protected OpenAPIService openAPIService;
123123

124124
/**
125125
* The open api builder object factory.
126126
*/
127-
private final ObjectFactory<OpenAPIBuilder> openAPIBuilderObjectFactory;
127+
private final ObjectFactory<OpenAPIService> openAPIBuilderObjectFactory;
128128

129129
/**
130130
* The Spring doc config properties.
@@ -139,17 +139,17 @@ public abstract class AbstractOpenApiResource extends SpecFilter {
139139
/**
140140
* The Request builder.
141141
*/
142-
private final AbstractRequestBuilder requestBuilder;
142+
private final AbstractRequestService requestBuilder;
143143

144144
/**
145145
* The Response builder.
146146
*/
147-
private final GenericResponseBuilder responseBuilder;
147+
private final GenericResponseService responseBuilder;
148148

149149
/**
150150
* The Operation parser.
151151
*/
152-
private final OperationBuilder operationParser;
152+
private final OperationService operationParser;
153153

154154
/**
155155
* The Open api customisers.
@@ -184,17 +184,17 @@ public abstract class AbstractOpenApiResource extends SpecFilter {
184184
* @param springDocConfigProperties the spring doc config properties
185185
* @param actuatorProvider the actuator provider
186186
*/
187-
protected AbstractOpenApiResource(String groupName, ObjectFactory<OpenAPIBuilder> openAPIBuilderObjectFactory,
188-
AbstractRequestBuilder requestBuilder,
189-
GenericResponseBuilder responseBuilder, OperationBuilder operationParser,
187+
protected AbstractOpenApiResource(String groupName, ObjectFactory<OpenAPIService> openAPIBuilderObjectFactory,
188+
AbstractRequestService requestBuilder,
189+
GenericResponseService responseBuilder, OperationService operationParser,
190190
Optional<List<OperationCustomizer>> operationCustomizers,
191191
Optional<List<OpenApiCustomiser>> openApiCustomisers,
192192
SpringDocConfigProperties springDocConfigProperties,
193193
Optional<ActuatorProvider> actuatorProvider) {
194194
super();
195195
this.groupName = Objects.requireNonNull(groupName, "groupName");
196196
this.openAPIBuilderObjectFactory = openAPIBuilderObjectFactory;
197-
this.openAPIBuilder = openAPIBuilderObjectFactory.getObject();
197+
this.openAPIService = openAPIBuilderObjectFactory.getObject();
198198
this.requestBuilder = requestBuilder;
199199
this.responseBuilder = responseBuilder;
200200
this.operationParser = operationParser;
@@ -251,44 +251,44 @@ public static void addHiddenRestControllers(String... classes) {
251251
*/
252252
protected synchronized OpenAPI getOpenApi() {
253253
OpenAPI openApi;
254-
if (openAPIBuilder.getCachedOpenAPI() == null || springDocConfigProperties.isCacheDisabled()) {
254+
if (openAPIService.getCachedOpenAPI() == null || springDocConfigProperties.isCacheDisabled()) {
255255
Instant start = Instant.now();
256-
openAPIBuilder.build();
257-
Map<String, Object> mappingsMap = openAPIBuilder.getMappingsMap().entrySet().stream()
256+
openAPIService.build();
257+
Map<String, Object> mappingsMap = openAPIService.getMappingsMap().entrySet().stream()
258258
.filter(controller -> (AnnotationUtils.findAnnotation(controller.getValue().getClass(),
259259
Hidden.class) == null))
260260
.filter(controller -> !AbstractOpenApiResource.isHiddenRestControllers(controller.getValue().getClass()))
261261
.collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue, (a1, a2) -> a1));
262262

263-
Map<String, Object> findControllerAdvice = openAPIBuilder.getControllerAdviceMap();
263+
Map<String, Object> findControllerAdvice = openAPIService.getControllerAdviceMap();
264264
// calculate generic responses
265-
openApi = openAPIBuilder.getCalculatedOpenAPI();
265+
openApi = openAPIService.getCalculatedOpenAPI();
266266
if (springDocConfigProperties.isOverrideWithGenericResponse() && !CollectionUtils.isEmpty(findControllerAdvice)) {
267267
if (!CollectionUtils.isEmpty(mappingsMap))
268268
findControllerAdvice.putAll(mappingsMap);
269269
responseBuilder.buildGenericResponse(openApi.getComponents(), findControllerAdvice);
270270
}
271271
getPaths(mappingsMap);
272272
if (!CollectionUtils.isEmpty(openApi.getServers()))
273-
openAPIBuilder.setServersPresent(true);
274-
openAPIBuilder.updateServers(openApi);
273+
openAPIService.setServersPresent(true);
274+
openAPIService.updateServers(openApi);
275275

276276
if (springDocConfigProperties.isRemoveBrokenReferenceDefinitions())
277277
this.removeBrokenReferenceDefinitions(openApi);
278278

279279
// run the optional customisers
280280
openApiCustomisers.ifPresent(apiCustomisers -> apiCustomisers.forEach(openApiCustomiser -> openApiCustomiser.customise(openApi)));
281281

282-
openAPIBuilder.setCachedOpenAPI(openApi);
283-
openAPIBuilder.resetCalculatedOpenAPI();
282+
openAPIService.setCachedOpenAPI(openApi);
283+
openAPIService.resetCalculatedOpenAPI();
284284

285285
LOGGER.info("Init duration for springdoc-openapi is: {} ms",
286286
Duration.between(start, Instant.now()).toMillis());
287287
}
288288
else {
289-
if (!CollectionUtils.isEmpty(openAPIBuilder.getCachedOpenAPI().getServers()))
290-
openAPIBuilder.setServersPresent(true);
291-
openApi = openAPIBuilder.updateServers(openAPIBuilder.getCachedOpenAPI());
289+
if (!CollectionUtils.isEmpty(openAPIService.getCachedOpenAPI().getServers()))
290+
openAPIService.setServersPresent(true);
291+
openApi = openAPIService.updateServers(openAPIService.getCachedOpenAPI());
292292
}
293293
return openApi;
294294
}
@@ -315,7 +315,7 @@ protected void calculatePath(HandlerMethod handlerMethod, RouterOperation router
315315
String[] headers = routerOperation.getHeaders();
316316
Map<String, String> queryParams = routerOperation.getQueryParams();
317317

318-
OpenAPI openAPI = openAPIBuilder.getCalculatedOpenAPI();
318+
OpenAPI openAPI = openAPIService.getCalculatedOpenAPI();
319319
Components components = openAPI.getComponents();
320320
Paths paths = openAPI.getPaths();
321321

@@ -361,7 +361,7 @@ protected void calculatePath(HandlerMethod handlerMethod, RouterOperation router
361361
fillParametersList(operation, queryParams, methodAttributes);
362362

363363
// compute tags
364-
operation = openAPIBuilder.buildTags(handlerMethod, operation, openAPI);
364+
operation = openAPIService.buildTags(handlerMethod, operation, openAPI);
365365

366366
io.swagger.v3.oas.annotations.parameters.RequestBody requestBodyDoc = AnnotatedElementUtils.findMergedAnnotation(method,
367367
io.swagger.v3.oas.annotations.parameters.RequestBody.class);
@@ -411,7 +411,7 @@ private void buildCallbacks(OpenAPI openAPI, MethodAttributes methodAttributes,
411411
* @param routerOperationList the router operation list
412412
*/
413413
protected void calculatePath(List<RouterOperation> routerOperationList) {
414-
ApplicationContext applicationContext = openAPIBuilder.getContext();
414+
ApplicationContext applicationContext = openAPIService.getContext();
415415
if (!CollectionUtils.isEmpty(routerOperationList)) {
416416
Collections.sort(routerOperationList);
417417
for (RouterOperation routerOperation : routerOperationList) {
@@ -464,7 +464,7 @@ protected void calculatePath(RouterOperation routerOperation) {
464464
String[] headers = routerOperation.getHeaders();
465465
Map<String, String> queryParams = routerOperation.getQueryParams();
466466

467-
OpenAPI openAPI = openAPIBuilder.getCalculatedOpenAPI();
467+
OpenAPI openAPI = openAPIService.getCalculatedOpenAPI();
468468
Paths paths = openAPI.getPaths();
469469
Map<HttpMethod, Operation> operationMap = null;
470470
if (paths.containsKey(operationPath)) {
@@ -516,7 +516,7 @@ protected void calculatePath(HandlerMethod handlerMethod, String operationPath,
516516
*/
517517
protected void getRouterFunctionPaths(String beanName, AbstractRouterFunctionVisitor routerFunctionVisitor) {
518518
List<org.springdoc.core.annotations.RouterOperation> routerOperationList = new ArrayList<>();
519-
ApplicationContext applicationContext = openAPIBuilder.getContext();
519+
ApplicationContext applicationContext = openAPIService.getContext();
520520
RouterOperations routerOperations = applicationContext.findAnnotationOnBean(beanName, RouterOperations.class);
521521
if (routerOperations == null) {
522522
org.springdoc.core.annotations.RouterOperation routerOperation = applicationContext.findAnnotationOnBean(beanName, org.springdoc.core.annotations.RouterOperation.class);
@@ -839,7 +839,7 @@ private void fillParametersList(Operation operation, Map<String, String> queryPa
839839
List<Parameter> parametersList = operation.getParameters();
840840
if (parametersList == null)
841841
parametersList = new ArrayList<>();
842-
Collection<Parameter> headersMap = AbstractRequestBuilder.getHeaders(methodAttributes, new LinkedHashMap<>());
842+
Collection<Parameter> headersMap = AbstractRequestService.getHeaders(methodAttributes, new LinkedHashMap<>());
843843
parametersList.addAll(headersMap);
844844
if (!CollectionUtils.isEmpty(queryParams)) {
845845
for (Map.Entry<String, String> entry : queryParams.entrySet()) {
@@ -848,7 +848,7 @@ private void fillParametersList(Operation operation, Map<String, String> queryPa
848848
parameter.setSchema(new StringSchema()._default(entry.getValue()));
849849
parameter.setRequired(true);
850850
parameter.setIn(ParameterIn.QUERY.toString());
851-
GenericParameterBuilder.mergeParameter(parametersList, parameter);
851+
GenericParameterService.mergeParameter(parametersList, parameter);
852852
}
853853
operation.setParameters(parametersList);
854854
}
@@ -992,8 +992,8 @@ else if (existingOperation != null) {
992992
* Init open api builder.
993993
*/
994994
protected void initOpenAPIBuilder() {
995-
if (openAPIBuilder.getCachedOpenAPI() != null && springDocConfigProperties.isCacheDisabled()) {
996-
openAPIBuilder = openAPIBuilderObjectFactory.getObject();
995+
if (openAPIService.getCachedOpenAPI() != null && springDocConfigProperties.isCacheDisabled()) {
996+
openAPIService = openAPIBuilderObjectFactory.getObject();
997997
}
998998
}
999999

‎springdoc-openapi-common/src/main/java/org/springdoc/core/AbstractRequestBuilder.java renamed to ‎springdoc-openapi-common/src/main/java/org/springdoc/core/AbstractRequestService.java

+15-15
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@
8585
* The type Abstract request builder.
8686
* @author bnasslahsen
8787
*/
88-
public abstract class AbstractRequestBuilder {
88+
public abstract class AbstractRequestService {
8989

9090
/**
9191
* The constant PARAM_TYPES_TO_IGNORE.
@@ -133,17 +133,17 @@ public abstract class AbstractRequestBuilder {
133133
/**
134134
* The Parameter builder.
135135
*/
136-
private final GenericParameterBuilder parameterBuilder;
136+
private final GenericParameterService parameterBuilder;
137137

138138
/**
139139
* The Request body builder.
140140
*/
141-
private final RequestBodyBuilder requestBodyBuilder;
141+
private final RequestBodyService requestBodyService;
142142

143143
/**
144144
* The Operation builder.
145145
*/
146-
private final OperationBuilder operationBuilder;
146+
private final OperationService operationService;
147147

148148
/**
149149
* The Local spring doc parameter name discoverer.
@@ -159,18 +159,18 @@ public abstract class AbstractRequestBuilder {
159159
* Instantiates a new Abstract request builder.
160160
*
161161
* @param parameterBuilder the parameter builder
162-
* @param requestBodyBuilder the request body builder
163-
* @param operationBuilder the operation builder
162+
* @param requestBodyService the request body builder
163+
* @param operationService the operation builder
164164
* @param parameterCustomizers the parameter customizers
165165
* @param localSpringDocParameterNameDiscoverer the local spring doc parameter name discoverer
166166
*/
167-
protected AbstractRequestBuilder(GenericParameterBuilder parameterBuilder, RequestBodyBuilder requestBodyBuilder,
168-
OperationBuilder operationBuilder, Optional<List<ParameterCustomizer>> parameterCustomizers,
167+
protected AbstractRequestService(GenericParameterService parameterBuilder, RequestBodyService requestBodyService,
168+
OperationService operationService, Optional<List<ParameterCustomizer>> parameterCustomizers,
169169
LocalVariableTableParameterNameDiscoverer localSpringDocParameterNameDiscoverer) {
170170
super();
171171
this.parameterBuilder = parameterBuilder;
172-
this.requestBodyBuilder = requestBodyBuilder;
173-
this.operationBuilder = operationBuilder;
172+
this.requestBodyService = requestBodyService;
173+
this.operationService = operationService;
174174
if (parameterCustomizers.isPresent())
175175
parameterCustomizers.get().removeIf(Objects::isNull);
176176
this.parameterCustomizers = parameterCustomizers;
@@ -220,7 +220,7 @@ public static boolean isRequestTypeToIgnore(Class<?> rawClass) {
220220
public Operation build(HandlerMethod handlerMethod, RequestMethod requestMethod,
221221
Operation operation, MethodAttributes methodAttributes, OpenAPI openAPI) {
222222
// Documentation
223-
String operationId = operationBuilder.getOperationId(handlerMethod.getMethod().getName(),
223+
String operationId = operationService.getOperationId(handlerMethod.getMethod().getName(),
224224
operation.getOperationId(), openAPI);
225225
operation.setOperationId(operationId);
226226
// requests
@@ -258,14 +258,14 @@ public Operation build(HandlerMethod handlerMethod, RequestMethod requestMethod,
258258
if (!isParamToIgnore(methodParameter)) {
259259
parameter = buildParams(parameterInfo, components, requestMethod, methodAttributes.getJsonViewAnnotation());
260260
// Merge with the operation parameters
261-
parameter = GenericParameterBuilder.mergeParameter(operationParameters, parameter);
261+
parameter = GenericParameterService.mergeParameter(operationParameters, parameter);
262262
List<Annotation> parameterAnnotations = Arrays.asList(methodParameter.getParameterAnnotations());
263263
if (isValidParameter(parameter))
264264
applyBeanValidatorAnnotations(parameter, parameterAnnotations);
265265
else if (!RequestMethod.GET.equals(requestMethod)) {
266266
if (operation.getRequestBody() != null)
267267
requestBodyInfo.setRequestBody(operation.getRequestBody());
268-
requestBodyBuilder.calculateRequestBodyInfo(components, methodAttributes,
268+
requestBodyService.calculateRequestBodyInfo(components, methodAttributes,
269269
parameterInfo, requestBodyInfo);
270270
applyBeanValidatorAnnotations(requestBodyInfo.getRequestBody(), parameterAnnotations, methodParameter.isOptional());
271271
}
@@ -538,8 +538,8 @@ else if (OPENAPI_STRING_TYPE.equals(schema.getType())) {
538538
*
539539
* @return the request body builder
540540
*/
541-
public RequestBodyBuilder getRequestBodyBuilder() {
542-
return requestBodyBuilder;
541+
public RequestBodyService getRequestBodyBuilder() {
542+
return requestBodyService;
543543
}
544544

545545
/**

‎springdoc-openapi-common/src/main/java/org/springdoc/core/GenericParameterBuilder.java renamed to ‎springdoc-openapi-common/src/main/java/org/springdoc/core/GenericParameterService.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@
5959
* @author bnasslahsen
6060
*/
6161
@SuppressWarnings("rawtypes")
62-
public class GenericParameterBuilder {
62+
public class GenericParameterService {
6363

6464
/**
6565
* The constant FILE_TYPES.
@@ -74,7 +74,7 @@ public class GenericParameterBuilder {
7474
/**
7575
* The constant LOGGER.
7676
*/
77-
private static final Logger LOGGER = LoggerFactory.getLogger(GenericParameterBuilder.class);
77+
private static final Logger LOGGER = LoggerFactory.getLogger(GenericParameterService.class);
7878

7979
static {
8080
FILE_TYPES.add(MultipartFile.class);
@@ -92,7 +92,7 @@ public class GenericParameterBuilder {
9292
* @param propertyResolverUtils the property resolver utils
9393
* @param optionalDelegatingMethodParameterCustomizer the optional delegating method parameter customizer
9494
*/
95-
public GenericParameterBuilder(PropertyResolverUtils propertyResolverUtils, Optional<DelegatingMethodParameterCustomizer> optionalDelegatingMethodParameterCustomizer) {
95+
public GenericParameterService(PropertyResolverUtils propertyResolverUtils, Optional<DelegatingMethodParameterCustomizer> optionalDelegatingMethodParameterCustomizer) {
9696
this.propertyResolverUtils = propertyResolverUtils;
9797
this.optionalDelegatingMethodParameterCustomizer=optionalDelegatingMethodParameterCustomizer;
9898
}

‎springdoc-openapi-common/src/main/java/org/springdoc/core/GenericResponseBuilder.java renamed to ‎springdoc-openapi-common/src/main/java/org/springdoc/core/GenericResponseService.java

+6-6
Original file line numberDiff line numberDiff line change
@@ -68,12 +68,12 @@
6868
* The type Generic response builder.
6969
* @author bnasslahsen
7070
*/
71-
public class GenericResponseBuilder {
71+
public class GenericResponseService {
7272

7373
/**
7474
* The Operation builder.
7575
*/
76-
private final OperationBuilder operationBuilder;
76+
private final OperationService operationService;
7777

7878
/**
7979
* The Return type parsers.
@@ -98,16 +98,16 @@ public class GenericResponseBuilder {
9898
/**
9999
* Instantiates a new Generic response builder.
100100
*
101-
* @param operationBuilder the operation builder
101+
* @param operationService the operation builder
102102
* @param returnTypeParsers the return type parsers
103103
* @param springDocConfigProperties the spring doc config properties
104104
* @param propertyResolverUtils the property resolver utils
105105
*/
106-
public GenericResponseBuilder(OperationBuilder operationBuilder, List<ReturnTypeParser> returnTypeParsers,
106+
public GenericResponseService(OperationService operationService, List<ReturnTypeParser> returnTypeParsers,
107107
SpringDocConfigProperties springDocConfigProperties,
108108
PropertyResolverUtils propertyResolverUtils) {
109109
super();
110-
this.operationBuilder = operationBuilder;
110+
this.operationService = operationService;
111111
this.returnTypeParsers = returnTypeParsers;
112112
this.springDocConfigProperties = springDocConfigProperties;
113113
this.propertyResolverUtils = propertyResolverUtils;
@@ -155,7 +155,7 @@ public void buildGenericResponse(Components components, Map<String, Object> find
155155
Arrays.stream(objClz.getDeclaredMethods()).filter(m -> m.isAnnotationPresent(ExceptionHandler.class)).forEach(methods::add);
156156
// for each one build ApiResponse and add it to existing responses
157157
for (Method method : methods) {
158-
if (!operationBuilder.isHidden(method)) {
158+
if (!operationService.isHidden(method)) {
159159
RequestMapping reqMappringMethod = AnnotatedElementUtils.findMergedAnnotation(method, RequestMapping.class);
160160
String[] methodProduces = { springDocConfigProperties.getDefaultProducesMediaType() };
161161
if (reqMappringMethod != null)

0 commit comments

Comments
 (0)