renaming SubmissionConfigReaderService

This commit is contained in:
Paulo Graça
2023-08-23 17:24:54 +01:00
parent e343d51519
commit 9ea7c321c3
16 changed files with 66 additions and 53 deletions

View File

@@ -159,7 +159,7 @@ public class DCInputsReader {
throws DCInputsReaderException {
SubmissionConfig config;
try {
config = SubmissionServiceFactory.getInstance().getSubmissionConfigReaderService()
config = SubmissionServiceFactory.getInstance().getSubmissionConfigService()
.getSubmissionConfigByCollection(collectionHandle);
String formName = config.getSubmissionName();
if (formName == null) {
@@ -182,7 +182,7 @@ public class DCInputsReader {
throws DCInputsReaderException {
SubmissionConfig config;
try {
config = SubmissionServiceFactory.getInstance().getSubmissionConfigReaderService()
config = SubmissionServiceFactory.getInstance().getSubmissionConfigService()
.getSubmissionConfigByName(name);
String formName = config.getSubmissionName();
if (formName == null) {

View File

@@ -35,7 +35,7 @@ import org.dspace.discovery.configuration.DiscoveryConfigurationService;
import org.dspace.discovery.configuration.DiscoverySearchFilterFacet;
import org.dspace.services.ConfigurationService;
import org.dspace.submit.factory.SubmissionServiceFactory;
import org.dspace.submit.service.SubmissionConfigReaderService;
import org.dspace.submit.service.SubmissionConfigService;
import org.springframework.beans.factory.annotation.Autowired;
/**
@@ -89,7 +89,7 @@ public final class ChoiceAuthorityServiceImpl implements ChoiceAuthorityService
protected Map<String, DSpaceControlledVocabularyIndex> vocabularyIndexMap = new HashMap<>();
// the item submission reader
private SubmissionConfigReaderService itemSubmissionConfigReaderService;
private SubmissionConfigService itemSubmissionConfigReaderService;
@Autowired(required = true)
protected ConfigurationService configurationService;
@@ -136,7 +136,7 @@ public final class ChoiceAuthorityServiceImpl implements ChoiceAuthorityService
private synchronized void init() {
if (!initialized) {
try {
itemSubmissionConfigReaderService = SubmissionServiceFactory.getInstance().getSubmissionConfigReaderService();
itemSubmissionConfigReaderService = SubmissionServiceFactory.getInstance().getSubmissionConfigService();
} catch (SubmissionConfigReaderException e) {
// the system is in an illegal state as the submission definition is not valid
throw new IllegalStateException("Error reading the item submission configuration: " + e.getMessage(),
@@ -491,9 +491,9 @@ public final class ChoiceAuthorityServiceImpl implements ChoiceAuthorityService
init();
ChoiceAuthority ma = controller.get(fieldKey);
if (ma == null && collection != null) {
SubmissionConfigReaderService configReaderService;
SubmissionConfigService configReaderService;
try {
configReaderService = SubmissionServiceFactory.getInstance().getSubmissionConfigReaderService();
configReaderService = SubmissionServiceFactory.getInstance().getSubmissionConfigService();
SubmissionConfig submissionName = configReaderService.getSubmissionConfigByCollection(collection.getHandle());
ma = controllerFormDefinitions.get(fieldKey).get(submissionName.getSubmissionName());
} catch (SubmissionConfigReaderException e) {

View File

@@ -47,7 +47,7 @@ public class SubmissionConfigConsumer implements Consumer {
case Event.MODIFY:
case Event.MODIFY_METADATA:
// reload submission configurations
SubmissionServiceFactory.getInstance().getSubmissionConfigReaderService().reload();
SubmissionServiceFactory.getInstance().getSubmissionConfigService().reload();
break;
}

View File

@@ -9,7 +9,7 @@ package org.dspace.submit.factory;
import org.dspace.app.util.SubmissionConfigReaderException;
import org.dspace.services.factory.DSpaceServicesFactory;
import org.dspace.submit.service.SubmissionConfigReaderService;
import org.dspace.submit.service.SubmissionConfigService;
/**
* Abstract factory to get services for submission, use SubmissionServiceFactory.getInstance() to retrieve an
@@ -19,7 +19,7 @@ import org.dspace.submit.service.SubmissionConfigReaderService;
*/
public abstract class SubmissionServiceFactory {
public abstract SubmissionConfigReaderService getSubmissionConfigReaderService() throws SubmissionConfigReaderException;
public abstract SubmissionConfigService getSubmissionConfigService() throws SubmissionConfigReaderException;
public static SubmissionServiceFactory getInstance() {
return DSpaceServicesFactory.getInstance().getServiceManager()

View File

@@ -8,7 +8,7 @@
package org.dspace.submit.factory;
import org.dspace.app.util.SubmissionConfigReaderException;
import org.dspace.submit.service.SubmissionConfigReaderService;
import org.dspace.submit.service.SubmissionConfigService;
import org.springframework.beans.factory.annotation.Autowired;
/**
@@ -19,10 +19,10 @@ import org.springframework.beans.factory.annotation.Autowired;
*/
public class SubmissionServiceFactoryImpl extends SubmissionServiceFactory {
@Autowired(required = true)
private SubmissionConfigReaderService submissionConfigReaderService;
private SubmissionConfigService submissionConfigService;
@Override
public SubmissionConfigReaderService getSubmissionConfigReaderService() throws SubmissionConfigReaderException {
return submissionConfigReaderService;
public SubmissionConfigService getSubmissionConfigService() throws SubmissionConfigReaderException {
return submissionConfigService;
}
}

View File

@@ -15,23 +15,31 @@ import org.dspace.app.util.SubmissionStepConfig;
import org.dspace.content.Collection;
import org.dspace.core.Context;
public interface SubmissionConfigReaderService {
/**
* Item Submission Configuration Service
* enables interaction with a submission config like
* getting a config by a collection name or handle
* as also retrieving submission configuration steps
*
* @author paulo.graca at fccn.pt
*/
public interface SubmissionConfigService {
public void reload() throws SubmissionConfigReaderException;
public String getDefaultSubmissionConfigName();
public List<SubmissionConfig> getAllSubmissionConfigs(Integer limit, Integer offset);
public int countSubmissionConfigs();
public SubmissionConfig getSubmissionConfigByCollection(String collectionHandle);
public SubmissionConfig getSubmissionConfigByName(String submitName);
public SubmissionStepConfig getStepConfig(String stepID)
throws SubmissionConfigReaderException;
public List<Collection> getCollectionsBySubmissionConfig(Context context, String submitName)
throws IllegalStateException, SQLException, SubmissionConfigReaderException;

View File

@@ -17,11 +17,16 @@ import org.dspace.content.Collection;
import org.dspace.core.Context;
import org.springframework.beans.factory.InitializingBean;
public class SubmissionConfigReaderServiceImpl implements SubmissionConfigReaderService, InitializingBean {
/**
* An implementation for Submission Config service
*
* @author paulo.graca at fccn.pt
*/
public class SubmissionConfigServiceImpl implements SubmissionConfigService, InitializingBean {
protected SubmissionConfigReader submissionConfigReader;
public SubmissionConfigReaderServiceImpl () throws SubmissionConfigReaderException {
public SubmissionConfigServiceImpl () throws SubmissionConfigReaderException {
submissionConfigReader = new SubmissionConfigReader();
}

View File

@@ -66,7 +66,7 @@ public class SubmissionConfigTest extends AbstractUnitTest {
// Get submission configuration
SubmissionConfig submissionConfig =
SubmissionServiceFactory.getInstance().getSubmissionConfigReaderService()
SubmissionServiceFactory.getInstance().getSubmissionConfigService()
.getSubmissionConfigByCollection(typeBindHandle);
// Submission name should match name defined in item-submission.xml
assertEquals(typeBindSubmissionName, submissionConfig.getSubmissionName());

View File

@@ -53,7 +53,7 @@ import org.dspace.scripts.factory.ScriptServiceFactory;
import org.dspace.scripts.service.ProcessService;
import org.dspace.services.factory.DSpaceServicesFactory;
import org.dspace.submit.factory.SubmissionServiceFactory;
import org.dspace.submit.service.SubmissionConfigReaderService;
import org.dspace.submit.service.SubmissionConfigService;
import org.dspace.supervision.factory.SupervisionOrderServiceFactory;
import org.dspace.supervision.service.SupervisionOrderService;
import org.dspace.versioning.factory.VersionServiceFactory;
@@ -110,7 +110,7 @@ public abstract class AbstractBuilder<T, S> {
static OrcidQueueService orcidQueueService;
static OrcidTokenService orcidTokenService;
static SystemWideAlertService systemWideAlertService;
static SubmissionConfigReaderService submissionConfigReaderService;
static SubmissionConfigService submissionConfigReaderService;
static SubscribeService subscribeService;
static SupervisionOrderService supervisionOrderService;
@@ -177,7 +177,7 @@ public abstract class AbstractBuilder<T, S> {
systemWideAlertService = DSpaceServicesFactory.getInstance().getServiceManager()
.getServicesByType(SystemWideAlertService.class).get(0);
try {
submissionConfigReaderService = SubmissionServiceFactory.getInstance().getSubmissionConfigReaderService();
submissionConfigReaderService = SubmissionServiceFactory.getInstance().getSubmissionConfigService();
} catch (SubmissionConfigReaderException e) {
log.error(e.getMessage(), e);
}

View File

@@ -26,7 +26,7 @@ import org.dspace.content.InProgressSubmission;
import org.dspace.content.Item;
import org.dspace.eperson.EPerson;
import org.dspace.submit.factory.SubmissionServiceFactory;
import org.dspace.submit.service.SubmissionConfigReaderService;
import org.dspace.submit.service.SubmissionConfigService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Lazy;
@@ -54,13 +54,13 @@ public abstract class AInprogressItemConverter<T extends InProgressSubmission,
@Autowired
private SubmissionSectionConverter submissionSectionConverter;
protected SubmissionConfigReaderService submissionConfigReaderService;
protected SubmissionConfigService submissionConfigReaderService;
@Autowired
SubmissionService submissionService;
public AInprogressItemConverter() throws SubmissionConfigReaderException {
submissionConfigReaderService = SubmissionServiceFactory.getInstance().getSubmissionConfigReaderService();
submissionConfigReaderService = SubmissionServiceFactory.getInstance().getSubmissionConfigService();
}
protected void fillFromModel(T obj, R witem, Projection projection) {

View File

@@ -16,7 +16,7 @@ import org.dspace.app.rest.projection.Projection;
import org.dspace.app.util.SubmissionConfigReaderException;
import org.dspace.app.util.SubmissionStepConfig;
import org.dspace.submit.factory.SubmissionServiceFactory;
import org.dspace.submit.service.SubmissionConfigReaderService;
import org.dspace.submit.service.SubmissionConfigService;
import org.springframework.stereotype.Component;
/**
@@ -30,7 +30,7 @@ public class SubmissionSectionConverter implements DSpaceConverter<SubmissionSte
private static final Logger log = org.apache.logging.log4j.LogManager.getLogger(SubmissionSectionConverter.class);
private SubmissionConfigReaderService submissionConfigReaderService;
private SubmissionConfigService submissionConfigReaderService;
@Override
public SubmissionSectionRest convert(SubmissionStepConfig step, Projection projection) {
@@ -61,10 +61,10 @@ public class SubmissionSectionConverter implements DSpaceConverter<SubmissionSte
return SubmissionStepConfig.class;
}
public SubmissionConfigReaderService getSubmissionConfigReaderService()
public SubmissionConfigService getSubmissionConfigReaderService()
throws SubmissionConfigReaderException, SQLException, IllegalStateException {
if (submissionConfigReaderService == null) {
submissionConfigReaderService = SubmissionServiceFactory.getInstance().getSubmissionConfigReaderService();
submissionConfigReaderService = SubmissionServiceFactory.getInstance().getSubmissionConfigService();
}
return submissionConfigReaderService;
}

View File

@@ -21,7 +21,7 @@ import org.dspace.content.factory.ContentServiceFactory;
import org.dspace.content.service.CollectionService;
import org.dspace.core.Context;
import org.dspace.submit.factory.SubmissionServiceFactory;
import org.dspace.submit.service.SubmissionConfigReaderService;
import org.dspace.submit.service.SubmissionConfigService;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.security.access.prepost.PreAuthorize;
@@ -34,12 +34,12 @@ import org.springframework.stereotype.Component;
*/
@Component(SubmissionDefinitionRest.CATEGORY + "." + SubmissionDefinitionRest.NAME)
public class SubmissionDefinitionRestRepository extends DSpaceRestRepository<SubmissionDefinitionRest, String> {
private SubmissionConfigReaderService submissionConfigReaderService;
private SubmissionConfigService submissionConfigReaderService;
private CollectionService collectionService = ContentServiceFactory.getInstance().getCollectionService();
public SubmissionDefinitionRestRepository() throws SubmissionConfigReaderException {
submissionConfigReaderService = SubmissionServiceFactory.getInstance().getSubmissionConfigReaderService();
submissionConfigReaderService = SubmissionServiceFactory.getInstance().getSubmissionConfigService();
}
@PreAuthorize("hasAuthority('AUTHENTICATED')")

View File

@@ -17,7 +17,7 @@ import org.dspace.app.util.SubmissionConfigReaderException;
import org.dspace.app.util.SubmissionStepConfig;
import org.dspace.core.Context;
import org.dspace.submit.factory.SubmissionServiceFactory;
import org.dspace.submit.service.SubmissionConfigReaderService;
import org.dspace.submit.service.SubmissionConfigService;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.security.access.prepost.PreAuthorize;
@@ -31,10 +31,10 @@ import org.springframework.stereotype.Component;
@Component(SubmissionDefinitionRest.CATEGORY + "." + SubmissionSectionRest.NAME)
public class SubmissionPanelRestRepository extends DSpaceRestRepository<SubmissionSectionRest, String> {
private SubmissionConfigReaderService submissionConfigReaderService;
private SubmissionConfigService submissionConfigReaderService;
public SubmissionPanelRestRepository() throws SubmissionConfigReaderException {
submissionConfigReaderService = SubmissionServiceFactory.getInstance().getSubmissionConfigReaderService();
submissionConfigReaderService = SubmissionServiceFactory.getInstance().getSubmissionConfigService();
}
@PreAuthorize("hasAuthority('AUTHENTICATED')")

View File

@@ -41,7 +41,7 @@ import org.dspace.eperson.EPerson;
import org.dspace.eperson.EPersonServiceImpl;
import org.dspace.services.ConfigurationService;
import org.dspace.submit.factory.SubmissionServiceFactory;
import org.dspace.submit.service.SubmissionConfigReaderService;
import org.dspace.submit.service.SubmissionConfigService;
import org.dspace.workflow.WorkflowException;
import org.dspace.workflow.WorkflowService;
import org.dspace.xmlworkflow.WorkflowConfigurationException;
@@ -111,10 +111,10 @@ public class WorkflowItemRestRepository extends DSpaceRestRepository<WorkflowIte
@Autowired
protected XmlWorkflowFactory workflowFactory;
private SubmissionConfigReaderService submissionConfigReaderService;
private SubmissionConfigService submissionConfigReaderService;
public WorkflowItemRestRepository() throws SubmissionConfigReaderException {
submissionConfigReaderService = SubmissionServiceFactory.getInstance().getSubmissionConfigReaderService();
submissionConfigReaderService = SubmissionServiceFactory.getInstance().getSubmissionConfigService();
}
@Override

View File

@@ -58,7 +58,7 @@ import org.dspace.importer.external.metadatamapping.MetadatumDTO;
import org.dspace.importer.external.service.ImportService;
import org.dspace.services.ConfigurationService;
import org.dspace.submit.factory.SubmissionServiceFactory;
import org.dspace.submit.service.SubmissionConfigReaderService;
import org.dspace.submit.service.SubmissionConfigService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
@@ -118,10 +118,10 @@ public class WorkspaceItemRestRepository extends DSpaceRestRepository<WorkspaceI
@Autowired
private UriListHandlerService uriListHandlerService;
private SubmissionConfigReaderService submissionConfigReaderService;
private SubmissionConfigService submissionConfigReaderService;
public WorkspaceItemRestRepository() throws SubmissionConfigReaderException {
submissionConfigReaderService = SubmissionServiceFactory.getInstance().getSubmissionConfigReaderService();
submissionConfigReaderService = SubmissionServiceFactory.getInstance().getSubmissionConfigService();
}
@PreAuthorize("hasPermission(#id, 'WORKSPACEITEM', 'READ')")

View File

@@ -59,7 +59,7 @@ import org.dspace.services.ConfigurationService;
import org.dspace.services.RequestService;
import org.dspace.services.model.Request;
import org.dspace.submit.factory.SubmissionServiceFactory;
import org.dspace.submit.service.SubmissionConfigReaderService;
import org.dspace.submit.service.SubmissionConfigService;
import org.dspace.workflow.WorkflowException;
import org.dspace.workflow.WorkflowItemService;
import org.dspace.workflow.WorkflowService;
@@ -102,10 +102,10 @@ public class SubmissionService {
private ConverterService converter;
@Autowired
private org.dspace.app.rest.utils.Utils utils;
private SubmissionConfigReaderService submissionConfigReaderService;
private SubmissionConfigService submissionConfigReaderService;
public SubmissionService() throws SubmissionConfigReaderException {
submissionConfigReaderService = SubmissionServiceFactory.getInstance().getSubmissionConfigReaderService();
submissionConfigReaderService = SubmissionServiceFactory.getInstance().getSubmissionConfigService();
}
/**