Skip to content

Commit 5b50ece

Browse files
4lejandritobrianchandotcom
authored andcommitted
LPD-64047 Extracting all methods to a single descriptor
This way they are not scattered throught the resourceImpl class and the whole integration with export-import can be understood in one single place.
1 parent fad4d83 commit 5b50ece

File tree

11 files changed

+204
-133
lines changed

11 files changed

+204
-133
lines changed

modules/apps/export-import/export-import-api/src/main/java/com/liferay/exportimport/vulcan/batch/engine/ExportImportVulcanBatchEngineTaskItemDelegate.java

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,23 @@
1818
public interface ExportImportVulcanBatchEngineTaskItemDelegate<T>
1919
extends VulcanBatchEngineTaskItemDelegate<T> {
2020

21-
public default List<String> getNestedFields() {
22-
return null;
23-
}
21+
public ExportImportDescriptor getExportImportDescriptor();
2422

25-
public default Map<String, Serializable> getParameters() {
26-
return null;
27-
}
23+
public interface ExportImportDescriptor {
24+
25+
public default List<String> getNestedFields() {
26+
return null;
27+
}
2828

29-
public String getPortletId();
29+
public default Map<String, Serializable> getParameters() {
30+
return null;
31+
}
3032

31-
public Scope getScope();
33+
public String getPortletId();
34+
35+
public Scope getScope();
36+
37+
}
3238

3339
public enum Scope {
3440

modules/apps/export-import/export-import-report-service/src/main/java/com/liferay/exportimport/report/internal/exception/handler/ExportImportBatchEngineImportTaskExceptionHandler.java

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,12 @@ public void handle(
5555
(ExportImportVulcanBatchEngineTaskItemDelegate)
5656
batchEngineImportTask;
5757

58-
if (exportImportVulcanBatchEngineTaskItemDelegate.getScope() ==
58+
ExportImportVulcanBatchEngineTaskItemDelegate.ExportImportDescriptor
59+
exportImportDescriptor =
60+
exportImportVulcanBatchEngineTaskItemDelegate.
61+
getExportImportDescriptor();
62+
63+
if (exportImportDescriptor.getScope() ==
5964
ExportImportVulcanBatchEngineTaskItemDelegate.Scope.SITE) {
6065

6166
groupId = GetterUtil.getLong(

modules/apps/export-import/export-import-service/src/main/java/com/liferay/exportimport/internal/data/handler/BatchEnginePortletDataHandler.java

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -102,8 +102,13 @@ public BatchEnginePortletDataHandler(
102102

103103
_fileName = fileNamePrefix + ".json";
104104

105+
ExportImportVulcanBatchEngineTaskItemDelegate.ExportImportDescriptor
106+
exportImportDescriptor =
107+
exportImportVulcanBatchEngineTaskItemDelegate.
108+
getExportImportDescriptor();
109+
105110
if (ExportImportVulcanBatchEngineTaskItemDelegate.Scope.COMPANY.equals(
106-
exportImportVulcanBatchEngineTaskItemDelegate.getScope())) {
111+
exportImportDescriptor.getScope())) {
107112

108113
setDataLevel(DataLevel.PORTAL);
109114
}
@@ -211,6 +216,11 @@ protected String doExportData(
211216
setPortletDataContextWithSafeCloseable(
212217
portletDataContext)) {
213218

219+
ExportImportVulcanBatchEngineTaskItemDelegate.ExportImportDescriptor
220+
exportImportDescriptor =
221+
_exportImportVulcanBatchEngineTaskItemDelegate.
222+
getExportImportDescriptor();
223+
214224
BatchEngineExportTaskExecutor.Result result =
215225
_batchEngineExportTaskExecutor.execute(
216226
_batchEngineExportTaskService.addBatchEngineExportTask(
@@ -219,10 +229,8 @@ protected String doExportData(
219229
BatchEngineTaskExecuteStatus.INITIAL.name(),
220230
Collections.emptyList(),
221231
BatchEnginePortletDataHandlerUtil.buildExportParameters(
222-
_exportImportVulcanBatchEngineTaskItemDelegate.
223-
getNestedFields(),
224-
_exportImportVulcanBatchEngineTaskItemDelegate.
225-
getParameters(),
232+
exportImportDescriptor.getNestedFields(),
233+
exportImportDescriptor.getParameters(),
226234
portletDataContext),
227235
_taskItemDelegateName),
228236
new BatchEngineExportTaskExecutor.Settings() {

modules/apps/export-import/export-import-service/src/main/java/com/liferay/exportimport/internal/data/handler/BatchEnginePortletDataHandlerRegistry.java

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,8 +118,12 @@ public ServiceRegistration<PortletDataHandler> addingService(
118118
return null;
119119
}
120120

121-
String portletId =
122-
exportImportVulcanBatchEngineTaskItemDelegate.getPortletId();
121+
ExportImportVulcanBatchEngineTaskItemDelegate.ExportImportDescriptor
122+
exportImportDescriptor =
123+
exportImportVulcanBatchEngineTaskItemDelegate.
124+
getExportImportDescriptor();
125+
126+
String portletId = exportImportDescriptor.getPortletId();
123127

124128
if (Validator.isNull(portletId)) {
125129
return null;

modules/apps/export-import/export-import-test/src/testIntegration/java/com/liferay/exportimport/internal/data/handler/test/BatchEnginePortletDataHandlerRegistryTest.java

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -188,13 +188,20 @@ public EntityModel getEntityModel(
188188
}
189189

190190
@Override
191-
public String getPortletId() {
192-
return _portletId;
193-
}
191+
public ExportImportDescriptor getExportImportDescriptor() {
192+
return new ExportImportDescriptor() {
194193

195-
@Override
196-
public Scope getScope() {
197-
return Scope.COMPANY;
194+
@Override
195+
public String getPortletId() {
196+
return _portletId;
197+
}
198+
199+
@Override
200+
public Scope getScope() {
201+
return Scope.COMPANY;
202+
}
203+
204+
};
198205
}
199206

200207
@Override

modules/apps/headless/headless-admin-user/headless-admin-user-impl/src/main/java/com/liferay/headless/admin/user/internal/resource/v1_0/AccountGroupResourceImpl.java

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -203,24 +203,31 @@ public EntityModel getEntityModel(MultivaluedMap multivaluedMap)
203203
}
204204

205205
@Override
206-
public List<String> getNestedFields() {
207-
return List.of("accountBriefs");
208-
}
206+
public ExportImportDescriptor getExportImportDescriptor() {
207+
return new ExportImportDescriptor() {
209208

210-
@Override
211-
public String getPortletId() {
212-
if (FeatureFlagManagerUtil.isEnabled(
213-
CompanyConstants.SYSTEM, "LPD-35914")) {
209+
@Override
210+
public List<String> getNestedFields() {
211+
return List.of("accountBriefs");
212+
}
214213

215-
return AccountPortletKeys.ACCOUNT_GROUPS_ADMIN;
216-
}
214+
@Override
215+
public String getPortletId() {
216+
if (FeatureFlagManagerUtil.isEnabled(
217+
CompanyConstants.SYSTEM, "LPD-35914")) {
217218

218-
return null;
219-
}
219+
return AccountPortletKeys.ACCOUNT_GROUPS_ADMIN;
220+
}
220221

221-
@Override
222-
public Scope getScope() {
223-
return Scope.COMPANY;
222+
return null;
223+
}
224+
225+
@Override
226+
public Scope getScope() {
227+
return Scope.COMPANY;
228+
}
229+
230+
};
224231
}
225232

226233
@Override

modules/apps/headless/headless-admin-user/headless-admin-user-impl/src/main/java/com/liferay/headless/admin/user/internal/resource/v1_0/AccountResourceImpl.java

Lines changed: 27 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -316,10 +316,33 @@ public EntityModel getEntityModel(MultivaluedMap multivaluedMap)
316316
}
317317

318318
@Override
319-
public List<String> getNestedFields() {
320-
return List.of(
321-
"accountGroupBriefs", "accountRoles", "keywords", "logoBase64",
322-
"postalAddresses", "taxonomyCategoryBriefs");
319+
public ExportImportDescriptor getExportImportDescriptor() {
320+
return new ExportImportDescriptor() {
321+
322+
@Override
323+
public List<String> getNestedFields() {
324+
return List.of(
325+
"accountGroupBriefs", "accountRoles", "keywords",
326+
"logoBase64", "postalAddresses", "taxonomyCategoryBriefs");
327+
}
328+
329+
@Override
330+
public String getPortletId() {
331+
if (FeatureFlagManagerUtil.isEnabled(
332+
CompanyConstants.SYSTEM, "LPD-35914")) {
333+
334+
return AccountPortletKeys.ACCOUNT_ENTRIES_ADMIN;
335+
}
336+
337+
return null;
338+
}
339+
340+
@Override
341+
public Scope getScope() {
342+
return Scope.COMPANY;
343+
}
344+
345+
};
323346
}
324347

325348
@NestedField(
@@ -381,22 +404,6 @@ public Page<Account> getOrganizationByExternalReferenceCodeAccountsPage(
381404
pagination, sorts);
382405
}
383406

384-
@Override
385-
public String getPortletId() {
386-
if (FeatureFlagManagerUtil.isEnabled(
387-
CompanyConstants.SYSTEM, "LPD-35914")) {
388-
389-
return AccountPortletKeys.ACCOUNT_ENTRIES_ADMIN;
390-
}
391-
392-
return null;
393-
}
394-
395-
@Override
396-
public Scope getScope() {
397-
return Scope.COMPANY;
398-
}
399-
400407
@Override
401408
public Account patchAccount(Long accountId, Account account)
402409
throws Exception {

modules/apps/headless/headless-admin-user/headless-admin-user-impl/src/main/java/com/liferay/headless/admin/user/internal/resource/v1_0/OrganizationResourceImpl.java

Lines changed: 33 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -298,10 +298,39 @@ public EntityModel getEntityModel(MultivaluedMap multivaluedMap) {
298298
}
299299

300300
@Override
301-
public List<String> getNestedFields() {
302-
return List.of(
303-
"accountBriefs", "imageBase64", "roleBriefs",
304-
"taxonomyCategoryBriefs", "userAccountBriefs");
301+
public ExportImportDescriptor getExportImportDescriptor() {
302+
return new ExportImportDescriptor() {
303+
304+
@Override
305+
public List<String> getNestedFields() {
306+
return List.of(
307+
"accountBriefs", "imageBase64", "roleBriefs",
308+
"taxonomyCategoryBriefs", "userAccountBriefs");
309+
}
310+
311+
public Map<String, Serializable> getParameters() {
312+
return HashMapBuilder.<String, Serializable>put(
313+
"flatten", "true"
314+
).build();
315+
}
316+
317+
@Override
318+
public String getPortletId() {
319+
if (FeatureFlagManagerUtil.isEnabled(
320+
CompanyConstants.SYSTEM, "LPD-35914")) {
321+
322+
return UsersAdminPortletKeys.ORGANIZATIONS_ADMIN;
323+
}
324+
325+
return null;
326+
}
327+
328+
@Override
329+
public Scope getScope() {
330+
return Scope.COMPANY;
331+
}
332+
333+
};
305334
}
306335

307336
@Override
@@ -405,29 +434,6 @@ public Page<Organization> getOrganizationsPage(
405434
null, flatten, filter, search, pagination, sorts);
406435
}
407436

408-
@Override
409-
public Map<String, Serializable> getParameters() {
410-
return HashMapBuilder.<String, Serializable>put(
411-
"flatten", "true"
412-
).build();
413-
}
414-
415-
@Override
416-
public String getPortletId() {
417-
if (FeatureFlagManagerUtil.isEnabled(
418-
CompanyConstants.SYSTEM, "LPD-35914")) {
419-
420-
return UsersAdminPortletKeys.ORGANIZATIONS_ADMIN;
421-
}
422-
423-
return null;
424-
}
425-
426-
@Override
427-
public Scope getScope() {
428-
return Scope.COMPANY;
429-
}
430-
431437
@Override
432438
public Organization patchOrganization(
433439
String organizationId, Organization organization)

modules/apps/headless/headless-admin-user/headless-admin-user-impl/src/main/java/com/liferay/headless/admin/user/internal/resource/v1_0/RoleResourceImpl.java

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -169,14 +169,26 @@ public EntityModel getEntityModel(MultivaluedMap multivaluedMap)
169169
}
170170

171171
@Override
172-
public String getPortletId() {
173-
if (FeatureFlagManagerUtil.isEnabled(
174-
CompanyConstants.SYSTEM, "LPD-35914")) {
172+
public ExportImportDescriptor getExportImportDescriptor() {
173+
return new ExportImportDescriptor() {
175174

176-
return RolesAdminPortletKeys.ROLES_ADMIN;
177-
}
175+
@Override
176+
public String getPortletId() {
177+
if (FeatureFlagManagerUtil.isEnabled(
178+
CompanyConstants.SYSTEM, "LPD-35914")) {
179+
180+
return RolesAdminPortletKeys.ROLES_ADMIN;
181+
}
182+
183+
return null;
184+
}
178185

179-
return null;
186+
@Override
187+
public Scope getScope() {
188+
return Scope.COMPANY;
189+
}
190+
191+
};
180192
}
181193

182194
@Override
@@ -250,11 +262,6 @@ true, _getActions(role.getRoleId()),
250262
});
251263
}
252264

253-
@Override
254-
public Scope getScope() {
255-
return Scope.COMPANY;
256-
}
257-
258265
@Override
259266
public Role patchRole(Long roleId, Role role) throws Exception {
260267
com.liferay.portal.kernel.model.Role serviceBuilderRole =

0 commit comments

Comments
 (0)