From 6e50e069cb4d8c2b2662fb479a14ea4fe9c73f79 Mon Sep 17 00:00:00 2001 From: Michael Ritter Date: Fri, 15 Nov 2024 14:01:57 -0700 Subject: [PATCH] DRYD-1356: New ObjectExit Service (#431) --- services/JaxRsServiceProvider/pom.xml | 5 + .../CollectionSpaceJaxRsApplication.java | 2 + services/exit/build.xml | 119 +++++ services/exit/client/pom.xml | 61 +++ .../services/client/ExitClient.java | 51 ++ .../services/client/ExitProxy.java | 27 + .../services/client/ExitServiceTest.java | 489 ++++++++++++++++++ services/exit/jaxb/pom.xml | 33 ++ .../jaxb/src/main/resources/exits_common.xsd | 91 ++++ services/exit/pom.xml | 58 +++ services/exit/service/pom.xml | 89 ++++ .../services/exit/ExitResource.java | 49 ++ .../exit/nuxeo/ExitDocumentModelHandler.java | 30 ++ .../exit/nuxeo/ExitValidatorHandler.java | 68 +++ services/pom.xml | 2 + 15 files changed, 1174 insertions(+) create mode 100644 services/exit/build.xml create mode 100644 services/exit/client/pom.xml create mode 100644 services/exit/client/src/main/java/org/collectionspace/services/client/ExitClient.java create mode 100644 services/exit/client/src/main/java/org/collectionspace/services/client/ExitProxy.java create mode 100644 services/exit/client/src/test/java/org/collectionspace/services/client/ExitServiceTest.java create mode 100644 services/exit/jaxb/pom.xml create mode 100644 services/exit/jaxb/src/main/resources/exits_common.xsd create mode 100644 services/exit/pom.xml create mode 100644 services/exit/service/pom.xml create mode 100644 services/exit/service/src/main/java/org/collectionspace/services/exit/ExitResource.java create mode 100644 services/exit/service/src/main/java/org/collectionspace/services/exit/nuxeo/ExitDocumentModelHandler.java create mode 100644 services/exit/service/src/main/java/org/collectionspace/services/exit/nuxeo/ExitValidatorHandler.java diff --git a/services/JaxRsServiceProvider/pom.xml b/services/JaxRsServiceProvider/pom.xml index f093852e8..6c9de17cc 100644 --- a/services/JaxRsServiceProvider/pom.xml +++ b/services/JaxRsServiceProvider/pom.xml @@ -456,6 +456,11 @@ org.collectionspace.services.deaccession.service ${project.version} + + org.collectionspace.services + org.collectionspace.services.exit.service + ${project.version} + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/services/exit/client/pom.xml b/services/exit/client/pom.xml new file mode 100644 index 000000000..d9ed912c9 --- /dev/null +++ b/services/exit/client/pom.xml @@ -0,0 +1,61 @@ + + + + org.collectionspace.services + org.collectionspace.services.exit + ${revision} + + + 4.0.0 + org.collectionspace.services.exit.client + services.exit.client + + + + + org.collectionspace.services + org.collectionspace.services.client + ${project.version} + + + org.collectionspace.services + org.collectionspace.services.exit.jaxb + ${project.version} + + + + + org.testng + testng + + + org.jboss.resteasy + resteasy-jaxrs + + + + tjws + webserver + + + + + org.jboss.resteasy + resteasy-jaxb-provider + + + org.jboss.resteasy + resteasy-multipart-provider + + + commons-httpclient + commons-httpclient + + + + + collectionspace-services-exit-client + + diff --git a/services/exit/client/src/main/java/org/collectionspace/services/client/ExitClient.java b/services/exit/client/src/main/java/org/collectionspace/services/client/ExitClient.java new file mode 100644 index 000000000..789ca39bb --- /dev/null +++ b/services/exit/client/src/main/java/org/collectionspace/services/client/ExitClient.java @@ -0,0 +1,51 @@ +/* + * This document is a part of the source code and related artifacts + * for CollectionSpace, an open source collections management system + * for museums and related institutions: + * + * http://www.collectionspace.org + * http://wiki.collectionspace.org + * + * Licensed under the Educational Community License (ECL), Version 2.0. + * You may not use this file except in compliance with this License. + * + * You may obtain a copy of the ECL 2.0 License at + * https://source.collectionspace.org/collection-space/LICENSE.txt + */ +package org.collectionspace.services.client; + +import org.collectionspace.services.exit.ExitsCommon; + +/** + * ExitClient.java + */ +public class ExitClient extends AbstractCommonListPoxServiceClientImpl { + + public static final String SERVICE_NAME = "exits"; + public static final String SERVICE_PATH_COMPONENT = SERVICE_NAME; + public static final String SERVICE_PATH = "/" + SERVICE_PATH_COMPONENT; + public static final String SERVICE_PATH_PROXY = SERVICE_PATH + "/"; + + public ExitClient() throws Exception { + super(); + } + + public ExitClient(String clientPropertiesFilename) throws Exception { + super(clientPropertiesFilename); + } + + @Override + public String getServicePathComponent() { + return SERVICE_PATH_COMPONENT; + } + + @Override + public String getServiceName() { + return SERVICE_NAME; + } + + @Override + public Class getProxyClass() { + return ExitProxy.class; + } +} diff --git a/services/exit/client/src/main/java/org/collectionspace/services/client/ExitProxy.java b/services/exit/client/src/main/java/org/collectionspace/services/client/ExitProxy.java new file mode 100644 index 000000000..6b7f95ddf --- /dev/null +++ b/services/exit/client/src/main/java/org/collectionspace/services/client/ExitProxy.java @@ -0,0 +1,27 @@ +/* + * This document is a part of the source code and related artifacts + * for CollectionSpace, an open source collections management system + * for museums and related institutions: + * + * http://www.collectionspace.org + * http://wiki.collectionspace.org + * + * Licensed under the Educational Community License (ECL), Version 2.0. + * You may not use this file except in compliance with this License. + * + * You may obtain a copy of the ECL 2.0 License at + * https://source.collectionspace.org/collection-space/LICENSE.txt + */ +package org.collectionspace.services.client; + +import javax.ws.rs.Consumes; +import javax.ws.rs.Path; +import javax.ws.rs.Produces; + +/** + * ExitProxy.java + */ +@Path(ExitClient.SERVICE_PATH_PROXY) +@Produces({"application/xml"}) +@Consumes({"application/xml"}) +public interface ExitProxy extends CollectionSpaceCommonListPoxProxy {} diff --git a/services/exit/client/src/test/java/org/collectionspace/services/client/ExitServiceTest.java b/services/exit/client/src/test/java/org/collectionspace/services/client/ExitServiceTest.java new file mode 100644 index 000000000..3117878e1 --- /dev/null +++ b/services/exit/client/src/test/java/org/collectionspace/services/client/ExitServiceTest.java @@ -0,0 +1,489 @@ +/* + * This document is a part of the source code and related artifacts + * for CollectionSpace, an open source collections management system + * for museums and related institutions: + * + * http://www.collectionspace.org + * http://wiki.collectionspace.org + * + * Copyright © 2009 Regents of the University of California + * + * Licensed under the Educational Community License (ECL), Version 2.0. + * You may not use this file except in compliance with this License. + * + * You may obtain a copy of the ECL 2.0 License at + * https://source.collectionspace.org/collection-space/LICENSE.txt + * + * 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 org.collectionspace.services.client; + +import javax.ws.rs.core.Response; +import org.collectionspace.services.client.test.AbstractPoxServiceTestImpl; +import org.collectionspace.services.client.test.ServiceRequestType; +import org.collectionspace.services.exit.ExitsCommon; +import org.collectionspace.services.jaxb.AbstractCommonList; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.testng.Assert; + +public class ExitServiceTest extends AbstractPoxServiceTestImpl { + + private final Logger logger = LoggerFactory.getLogger(ExitServiceTest.class); + + /** The service path component. */ + final String SERVICE_NAME = "exits"; + + final String SERVICE_PATH_COMPONENT = "exits"; + + /* (non-Javadoc) + * @see org.collectionspace.services.client.test.BaseServiceTest#getClientInstance() + */ + @Override + protected CollectionSpaceClient getClientInstance() throws Exception { + return new ExitClient(); + } + + @Override + protected CollectionSpaceClient getClientInstance(String clientPropertiesFilename) throws Exception { + return new ExitClient(clientPropertiesFilename); + } + + /* (non-Javadoc) + * @see org.collectionspace.services.client.test.BaseServiceTest#getAbstractCommonList(org.jboss.resteasy.client.ClientResponse) + */ + @Override + protected AbstractCommonList getCommonList(Response response) { + return response.readEntity(AbstractCommonList.class); + } + + // --------------------------------------------------------------- + // CRUD tests : CREATE tests + // --------------------------------------------------------------- + + // Success outcomes + + /* (non-Javadoc) + * @see org.collectionspace.services.client.test.ServiceTest#create(java.lang.String) + */ + @Override + public void create(String testName) throws Exception { + // Perform setup, such as initializing the type of service request + // (e.g. CREATE, DELETE), its valid and expected status codes, and + // its associated HTTP method name (e.g. POST, DELETE). + setupCreate(); + + // Submit the request to the service and store the response. + ExitClient client = new ExitClient(); + String identifier = createIdentifier(); + PoxPayloadOut multipart = createExitInstance(identifier); + String newID; + Response res = client.create(multipart); + try { + int statusCode = res.getStatus(); + + // Check the status code of the response: does it match + // the expected response(s)? + // + // Specifically: + // Does it fall within the set of valid status codes? + // Does it exactly match the expected status code? + logger.debug("{}: status = {}", testName, statusCode); + Assert.assertTrue( + testRequestType.isValidStatusCode(statusCode), + invalidStatusCodeMessage(testRequestType, statusCode)); + Assert.assertEquals(statusCode, testExpectedStatusCode); + + newID = extractId(res); + } finally { + if (res != null) { + res.close(); + } + } + + // Store the ID returned from the first resource created + // for additional tests below. + if (knownResourceId == null) { + knownResourceId = newID; + logger.debug("{}: knownResourceId={}", testName, knownResourceId); + } + + // Store the IDs from every resource created by tests, + // so they can be deleted after tests have been run. + allResourceIdsCreated.add(newID); + } + + /* (non-Javadoc) + * @see org.collectionspace.services.client.test.AbstractServiceTestImpl#createList(java.lang.String) + */ + @Override + public void createList(String testName) throws Exception { + for (int i = 0; i < 3; i++) { + create(testName); + } + } + + // --------------------------------------------------------------- + // CRUD tests : READ tests + // --------------------------------------------------------------- + + // Success outcomes + + /* (non-Javadoc) + * @see org.collectionspace.services.client.test.AbstractServiceTestImpl#read(java.lang.String) + */ + @Override + public void read(String testName) throws Exception { + // Perform setup. + setupRead(); + + // Submit the request to the service and store the response. + ExitClient client = new ExitClient(); + Response res = client.read(knownResourceId); + PoxPayloadIn input; + try { + assertStatusCode(res, testName); + input = new PoxPayloadIn(res.readEntity(String.class)); + } finally { + if (res != null) { + res.close(); + } + } + + // Get the common part of the response and verify that it is not null. + PayloadInputPart payloadInputPart = input.getPart(client.getCommonPartName()); + ExitsCommon exitCommon = null; + if (payloadInputPart != null) { + exitCommon = (ExitsCommon) payloadInputPart.getBody(); + } + Assert.assertNotNull(exitCommon); + } + + // Failure outcomes + + /* (non-Javadoc) + * @see org.collectionspace.services.client.test.AbstractServiceTestImpl#readNonExistent(java.lang.String) + */ + @Override + public void readNonExistent(String testName) throws Exception { + // Perform setup. + setupReadNonExistent(); + + // Submit the request to the service and store the response. + ExitClient client = new ExitClient(); + Response res = client.read(NON_EXISTENT_ID); + try { + int statusCode = res.getStatus(); + + // Check the status code of the response: does it match + // the expected response(s)? + logger.debug("{}: status = {}", testName, statusCode); + Assert.assertTrue( + testRequestType.isValidStatusCode(statusCode), + invalidStatusCodeMessage(testRequestType, statusCode)); + Assert.assertEquals(statusCode, testExpectedStatusCode); + } finally { + if (res != null) { + res.close(); + } + } + } + + // --------------------------------------------------------------- + // CRUD tests : READ_LIST tests + // --------------------------------------------------------------- + + // Success outcomes + + /* (non-Javadoc) + * @see org.collectionspace.services.client.test.AbstractServiceTestImpl#readList(java.lang.String) + */ + @Override + public void readList(String testName) throws Exception { + // Perform setup. + setupReadList(); + + // Submit the request to the service and store the response. + AbstractCommonList list; + ExitClient client = new ExitClient(); + Response res = client.readList(); + assertStatusCode(res, testName); + try { + int statusCode = res.getStatus(); + + // Check the status code of the response: does it match + // the expected response(s)? + logger.debug("{}: status = {}", testName, statusCode); + Assert.assertTrue( + testRequestType.isValidStatusCode(statusCode), + invalidStatusCodeMessage(testRequestType, statusCode)); + Assert.assertEquals(statusCode, testExpectedStatusCode); + + list = res.readEntity(getCommonListType()); + } finally { + res.close(); + } + + // Optionally output additional data about list members for debugging. + AbstractCommonListUtils.ListItemsInAbstractCommonList(list, logger, testName); + } + + // Failure outcomes + // None at present. + + // --------------------------------------------------------------- + // CRUD tests : UPDATE tests + // --------------------------------------------------------------- + + // Success outcomes + + /* (non-Javadoc) + * @see org.collectionspace.services.client.test.AbstractServiceTestImpl#update(java.lang.String) + */ + @Override + public void update(String testName) throws Exception { + setupRead(); + + // Retrieve the contents of a resource to update. + ExitClient client = new ExitClient(); + Response res = client.read(knownResourceId); + PoxPayloadIn input; + try { + assertStatusCode(res, testName); + input = new PoxPayloadIn(res.readEntity(String.class)); + logger.debug("got object to update with ID: {}", knownResourceId); + } finally { + if (res != null) { + res.close(); + } + } + + // Extract the common part from the response. + PayloadInputPart payloadInputPart = input.getPart(client.getCommonPartName()); + ExitsCommon exitCommon = null; + if (payloadInputPart != null) { + exitCommon = (ExitsCommon) payloadInputPart.getBody(); + } + Assert.assertNotNull(exitCommon); + + // Update the content of this resource. + exitCommon.setExitNumber("updated-" + exitCommon.getExitNumber()); + + logger.debug("to be updated object"); + logger.debug(objectAsXmlString(exitCommon, ExitsCommon.class)); + + setupUpdate(); + + // Submit the updated common part in an update request to the service + // and store the response. + PoxPayloadOut output = new PoxPayloadOut(this.getServicePathComponent()); + output.addPart(client.getCommonPartName(), exitCommon); + res = client.update(knownResourceId, output); + try { + assertStatusCode(res, testName); + int statusCode = res.getStatus(); + // Check the status code of the response: does it match the expected response(s)? + logger.debug("{}: status = {}", testName, statusCode); + Assert.assertTrue( + testRequestType.isValidStatusCode(statusCode), + invalidStatusCodeMessage(testRequestType, statusCode)); + Assert.assertEquals(statusCode, testExpectedStatusCode); + input = new PoxPayloadIn(res.readEntity(String.class)); + } finally { + if (res != null) { + res.close(); + } + } + + // Extract the updated common part from the response. + payloadInputPart = input.getPart(client.getCommonPartName()); + ExitsCommon updatedExitCommon = null; + if (payloadInputPart != null) { + updatedExitCommon = (ExitsCommon) payloadInputPart.getBody(); + } + Assert.assertNotNull(updatedExitCommon); + + // Check selected fields in the updated common part. + Assert.assertEquals( + updatedExitCommon.getExitNumber(), + exitCommon.getExitNumber(), + "Data in updated object did not match submitted data."); + } + + @Override + public void updateNonExistent(String testName) throws Exception { + // Perform setup. + setupUpdateNonExistent(); + + // Submit the request to the service and store the response. + // Note: The ID used in this 'create' call may be arbitrary. + // The only relevant ID may be the one used in update(), below. + ExitClient client = new ExitClient(); + PoxPayloadOut multipart = createExitInstance(NON_EXISTENT_ID); + Response res = client.update(NON_EXISTENT_ID, multipart); + try { + int statusCode = res.getStatus(); + + // Check the status code of the response: does it match + // the expected response(s)? + logger.debug("{}: status = {}", testName, statusCode); + Assert.assertTrue( + testRequestType.isValidStatusCode(statusCode), + invalidStatusCodeMessage(testRequestType, statusCode)); + Assert.assertEquals(statusCode, testExpectedStatusCode); + } finally { + if (res != null) { + res.close(); + } + } + } + + // --------------------------------------------------------------- + // CRUD tests : DELETE tests + // --------------------------------------------------------------- + + // Success outcomes + + /* (non-Javadoc) + * @see org.collectionspace.services.client.test.AbstractServiceTestImpl#delete(java.lang.String) + */ + @Override + public void delete(String testName) throws Exception { + // Perform setup. + setupDelete(); + + // Submit the request to the service and store the response. + ExitClient client = new ExitClient(); + Response res = client.delete(knownResourceId); + try { + int statusCode = res.getStatus(); + + // Check the status code of the response: does it match + // the expected response(s)? + logger.debug("{}: status = {}", testName, statusCode); + Assert.assertTrue( + testRequestType.isValidStatusCode(statusCode), + invalidStatusCodeMessage(testRequestType, statusCode)); + Assert.assertEquals(statusCode, testExpectedStatusCode); + } finally { + if (res != null) { + res.close(); + } + } + } + + // Failure outcomes + + /* (non-Javadoc) + * @see org.collectionspace.services.client.test.AbstractServiceTestImpl#deleteNonExistent(java.lang.String) + */ + @Override + public void deleteNonExistent(String testName) throws Exception { + // Perform setup. + setupDeleteNonExistent(); + + // Submit the request to the service and store the response. + ExitClient client = new ExitClient(); + Response res = client.delete(NON_EXISTENT_ID); + try { + int statusCode = res.getStatus(); + + // Check the status code of the response: does it match + // the expected response(s)? + logger.debug("{}: status = {}", testName, statusCode); + Assert.assertTrue( + testRequestType.isValidStatusCode(statusCode), + invalidStatusCodeMessage(testRequestType, statusCode)); + Assert.assertEquals(statusCode, testExpectedStatusCode); + } finally { + if (res != null) { + res.close(); + } + } + } + + // --------------------------------------------------------------- + // Utility tests : tests of code used in tests above + // --------------------------------------------------------------- + + /** + * Tests the code for manually submitting data that is used by several + * of the methods above. + */ + public void testSubmitRequest() { + // Expected status code: 200 OK + final int EXPECTED_STATUS = Response.Status.OK.getStatusCode(); + + // Submit the request to the service and store the response. + String method = ServiceRequestType.READ.httpMethodName(); + String url = getResourceURL(knownResourceId); + int statusCode = submitRequest(method, url); + + // Check the status code of the response: does it match + // the expected response(s)? + logger.debug("testSubmitRequest: url={} status={}", url, statusCode); + Assert.assertEquals(statusCode, EXPECTED_STATUS); + } + + // --------------------------------------------------------------- + // Utility methods used by tests above + // --------------------------------------------------------------- + + @Override + public String getServiceName() { + return SERVICE_NAME; + } + + /* (non-Javadoc) + * @see org.collectionspace.services.client.test.BaseServiceTest#getServicePathComponent() + */ + @Override + public String getServicePathComponent() { + return SERVICE_PATH_COMPONENT; + } + + @Override + protected PoxPayloadOut createInstance(String identifier) throws Exception { + return createExitInstance(identifier); + } + + /** + * Creates the exit instance. + * + * @param exitNumber the exhibition number + * @return the multipart output + * @throws Exception + */ + private PoxPayloadOut createExitInstance(String exitNumber) throws Exception { + ExitsCommon exitCommon = new ExitsCommon(); + exitCommon.setExitNumber(exitNumber); + + PoxPayloadOut multipart = new PoxPayloadOut(this.getServicePathComponent()); + multipart.addPart(new ExitClient().getCommonPartName(), exitCommon); + + logger.debug("to be created, exit common"); + logger.debug(objectAsXmlString(exitCommon, ExitsCommon.class)); + + return multipart; + } + + @Override + public void CRUDTests(String testName) {} + + @Override + protected PoxPayloadOut createInstance(String commonPartName, String identifier) throws Exception { + return createExitInstance(identifier); + } + + @Override + protected ExitsCommon updateInstance(ExitsCommon commonPartObject) { + return null; + } + + @Override + protected void compareUpdatedInstances(ExitsCommon original, ExitsCommon updated) {} +} diff --git a/services/exit/jaxb/pom.xml b/services/exit/jaxb/pom.xml new file mode 100644 index 000000000..e61c84337 --- /dev/null +++ b/services/exit/jaxb/pom.xml @@ -0,0 +1,33 @@ + + + + org.collectionspace.services.exit + org.collectionspace.services + ${revision} + + + 4.0.0 + org.collectionspace.services.exit.jaxb + services.exit.jaxb + + + + org.collectionspace.services + org.collectionspace.services.jaxb + ${project.version} + + + + + collectionspace-services-exit-jaxb + install + + + org.jvnet.jaxb2.maven2 + maven-jaxb2-plugin + + + + diff --git a/services/exit/jaxb/src/main/resources/exits_common.xsd b/services/exit/jaxb/src/main/resources/exits_common.xsd new file mode 100644 index 000000000..3dd9096e0 --- /dev/null +++ b/services/exit/jaxb/src/main/resources/exits_common.xsd @@ -0,0 +1,91 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/services/exit/pom.xml b/services/exit/pom.xml new file mode 100644 index 000000000..7f7a343f8 --- /dev/null +++ b/services/exit/pom.xml @@ -0,0 +1,58 @@ + + + + org.collectionspace.services + org.collectionspace.services.main + ${revision} + + + 4.0.0 + org.collectionspace.services.exit + services.exit + pom + + + + 2.30.0 + + + + + + com.diffplug.spotless + spotless-maven-plugin + ${spotless.version} + + + + + + src/main/java/**/*.java + src/test/java/**/*.java + + + + + true + 4 + + + + + + + + + + + + + + jaxb + service + client + + + diff --git a/services/exit/service/pom.xml b/services/exit/service/pom.xml new file mode 100644 index 000000000..6524f2513 --- /dev/null +++ b/services/exit/service/pom.xml @@ -0,0 +1,89 @@ + + + + + org.collectionspace.services + org.collectionspace.services.exit + ${revision} + + + 4.0.0 + org.collectionspace.services.exit.service + services.exit.service + jar + + + + org.collectionspace.services + org.collectionspace.services.common + + + org.collectionspace.services + org.collectionspace.services.exit.jaxb + ${project.version} + + + org.collectionspace.services + org.collectionspace.services.exit.client + ${project.version} + + + + + junit + junit + test + + + org.testng + testng + test + + + + + javax.security + jaas + 1.0.01 + provided + + + + + org.jboss.resteasy + resteasy-jaxrs + + + tjws + webserver + + + + + org.jboss.resteasy + resteasy-jaxb-provider + + + org.jboss.resteasy + resteasy-multipart-provider + + + + + org.nuxeo.ecm.core + nuxeo-core-api + + + jboss-remoting + jboss + + + + + + + collectionspace-services-exit + + diff --git a/services/exit/service/src/main/java/org/collectionspace/services/exit/ExitResource.java b/services/exit/service/src/main/java/org/collectionspace/services/exit/ExitResource.java new file mode 100644 index 000000000..8bc60e0c5 --- /dev/null +++ b/services/exit/service/src/main/java/org/collectionspace/services/exit/ExitResource.java @@ -0,0 +1,49 @@ +/* + * This document is a part of the source code and related artifacts + * for CollectionSpace, an open source collections management system + * for museums and related institutions: + * + * http://www.collectionspace.org + * http://wiki.collectionspace.org + * + * Licensed under the Educational Community License (ECL), Version 2.0. + * You may not use this file except in compliance with this License. + * + * You may obtain a copy of the ECL 2.0 License at + * + * https://source.collectionspace.org/collection-space/LICENSE.txt + * + * 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 org.collectionspace.services.exit; + +import javax.ws.rs.Consumes; +import javax.ws.rs.Path; +import javax.ws.rs.Produces; +import org.collectionspace.services.client.ExitClient; +import org.collectionspace.services.common.NuxeoBasedResource; + +@Path(ExitClient.SERVICE_PATH) +@Consumes("application/xml") +@Produces("application/xml") +public class ExitResource extends NuxeoBasedResource { + + @Override + protected String getVersionString() { + return "$LastChangedRevision$"; + } + + @Override + public String getServiceName() { + return ExitClient.SERVICE_NAME; + } + + @Override + public Class getCommonPartClass() { + return ExitsCommon.class; + } +} diff --git a/services/exit/service/src/main/java/org/collectionspace/services/exit/nuxeo/ExitDocumentModelHandler.java b/services/exit/service/src/main/java/org/collectionspace/services/exit/nuxeo/ExitDocumentModelHandler.java new file mode 100644 index 000000000..fc31e599a --- /dev/null +++ b/services/exit/service/src/main/java/org/collectionspace/services/exit/nuxeo/ExitDocumentModelHandler.java @@ -0,0 +1,30 @@ +/* + * This document is a part of the source code and related artifacts + * for CollectionSpace, an open source collections management system + * for museums and related institutions: + * + * http://www.collectionspace.org + * http://wiki.collectionspace.org + * + * Licensed under the Educational Community License (ECL), Version 2.0. + * You may not use this file except in compliance with this License. + * + * You may obtain a copy of the ECL 2.0 License at + * + * https://source.collectionspace.org/collection-space/LICENSE.txt + * + * 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 org.collectionspace.services.exit.nuxeo; + +import org.collectionspace.services.exit.ExitsCommon; +import org.collectionspace.services.nuxeo.client.java.NuxeoDocumentModelHandler; + +/** + * ExitDocumentModelHandler + */ +public class ExitDocumentModelHandler extends NuxeoDocumentModelHandler {} diff --git a/services/exit/service/src/main/java/org/collectionspace/services/exit/nuxeo/ExitValidatorHandler.java b/services/exit/service/src/main/java/org/collectionspace/services/exit/nuxeo/ExitValidatorHandler.java new file mode 100644 index 000000000..1160ac163 --- /dev/null +++ b/services/exit/service/src/main/java/org/collectionspace/services/exit/nuxeo/ExitValidatorHandler.java @@ -0,0 +1,68 @@ +/* + * This document is a part of the source code and related artifacts + * for CollectionSpace, an open source collections management system + * for museums and related institutions: + * + * http://www.collectionspace.org + * http://wiki.collectionspace.org + * + * Licensed under the Educational Community License (ECL), Version 2.0. + * You may not use this file except in compliance with this License. + * + * You may obtain a copy of the ECL 2.0 License at + * https://source.collectionspace.org/collection-space/LICENSE.txt + */ +package org.collectionspace.services.exit.nuxeo; + +import org.collectionspace.services.client.PoxPayloadIn; +import org.collectionspace.services.client.PoxPayloadOut; +import org.collectionspace.services.common.document.InvalidDocumentException; +import org.collectionspace.services.common.document.ValidatorHandlerImpl; +import org.collectionspace.services.exit.ExitsCommon; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * Validator Handler for the new Object Exit procedure. Only handles CREATE operations, checking that the common part + * exists and the exitNumber is set. + */ +public class ExitValidatorHandler extends ValidatorHandlerImpl { + + private static final String COMMON_PART_MISSING = "Validation exception: exits_common part is missing"; + private static final String REFERENCE_NUMBER_MISSING = + "Validation exception: The exit field \"exitNumber\" cannot be empty or missing"; + + private final Logger logger = LoggerFactory.getLogger(ExitValidatorHandler.class); + + @Override + protected Class getCommonPartClass() { + return ExitsCommon.class; + } + + @Override + protected void handleCreate() throws InvalidDocumentException { + final ExitsCommon common = (ExitsCommon) getCommonPart(); + if (common == null) { + logger.error(COMMON_PART_MISSING); + throw new InvalidDocumentException(COMMON_PART_MISSING); + } + + final String exitNumber = common.getExitNumber(); + if (exitNumber == null || exitNumber.isEmpty()) { + logger.error(REFERENCE_NUMBER_MISSING); + throw new InvalidDocumentException(REFERENCE_NUMBER_MISSING); + } + } + + @Override + protected void handleGet() {} + + @Override + protected void handleGetAll() {} + + @Override + protected void handleUpdate() {} + + @Override + protected void handleDelete() {} +} diff --git a/services/pom.xml b/services/pom.xml index 3bfb864c3..2caa2eb67 100644 --- a/services/pom.xml +++ b/services/pom.xml @@ -77,6 +77,8 @@ dutyofcare valuationcontrol objectexit + + exit propagation pottag batch -- 2.47.3