<artifactId>org.collectionspace.services.summarydocumentation.service</artifactId>
<version>${project.version}</version>
</dependency>
+ <dependency>
+ <groupId>org.collectionspace.services</groupId>
+ <artifactId>org.collectionspace.services.heldintrust.service</artifactId>
+ <version>${project.version}</version>
+ </dependency>
<!--dependency>
<groupId>org.collectionspace.services</groupId>
import org.collectionspace.services.chronology.ChronologyAuthorityResource;
import org.collectionspace.services.collectionobject.CollectionObjectResource;
import org.collectionspace.services.dutyofcare.DutyofcareResource;
+import org.collectionspace.services.heldintrust.HeldInTrustResource;
import org.collectionspace.services.id.IDResource;
import org.collectionspace.services.insurance.InsuranceResource;
import org.collectionspace.services.iterationreport.IterationreportResource;
addResourceToMapAndSingletons(new ChronologyAuthorityResource());
addResourceToMapAndSingletons(new NagpraInventoryResource());
addResourceToMapAndSingletons(new SummaryDocumentationResource());
+ addResourceToMapAndSingletons(new HeldInTrustResource());
singletons.add(new IDResource());
SELECT csid
FROM id_generators
);
+
+-- HELD_IN_TRUST_NUMBER
+
+INSERT INTO id_generators
+ (csid, displayname, description, priority, last_generated_id, id_generator_state)
+ SELECT
+ '6b5bc008-34f9-40be-bd49-0440ee9f262d',
+ 'Held-in-Trust Number',
+ 'Identifies a held-in-trust document.',
+ '9',
+ '',
+'<org.collectionspace.services.id.SettableIDGenerator>
+ <parts>
+ <org.collectionspace.services.id.StringIDGeneratorPart>
+ <initialValue>HIT</initialValue>
+ <currentValue>HIT</currentValue>
+ </org.collectionspace.services.id.StringIDGeneratorPart>
+ <org.collectionspace.services.id.YearIDGeneratorPart>
+ <currentValue></currentValue>
+ </org.collectionspace.services.id.YearIDGeneratorPart>
+ <org.collectionspace.services.id.StringIDGeneratorPart>
+ <initialValue>.</initialValue>
+ <currentValue>.</currentValue>
+ </org.collectionspace.services.id.StringIDGeneratorPart>
+ <org.collectionspace.services.id.NumericIDGeneratorPart>
+ <maxLength>6</maxLength>
+ <initialValue>1</initialValue>
+ <currentValue>-1</currentValue>
+ </org.collectionspace.services.id.NumericIDGeneratorPart>
+ </parts>
+</org.collectionspace.services.id.SettableIDGenerator>'
+ WHERE '6b5bc008-34f9-40be-bd49-0440ee9f262d' NOT IN
+ (
+ SELECT csid
+ FROM id_generators
+ );
--- /dev/null
+<project name="heldintrust" default="package" basedir=".">
+ <description>
+ heldintrust service
+ </description>
+ <!-- set global properties for this build -->
+ <property name="services.trunk" value="../.." />
+ <!-- environment should be declared before reading build.properties -->
+ <property environment="env" />
+ <property file="${services.trunk}/build.properties" />
+ <property name="mvn.opts" value="-V" />
+ <property name="src" location="src" />
+
+ <condition property="osfamily-unix">
+ <os family="unix" />
+ </condition>
+ <condition property="osfamily-windows">
+ <os family="windows" />
+ </condition>
+
+ <target name="package" depends="package-unix,package-windows"
+ description="Package CollectionSpace Services" />
+
+ <target name="package-unix" if="osfamily-unix">
+ <exec executable="mvn" failonerror="true">
+ <arg value="package" />
+ <arg value="-Dmaven.test.skip=true" />
+ <arg value="-f" />
+ <arg value="${basedir}/pom.xml" />
+ <arg value="-N" />
+ <arg value="${mvn.opts}" />
+ </exec>
+ </target>
+
+ <target name="package-windows" if="osfamily-windows">
+ <exec executable="cmd" failonerror="true">
+ <arg value="/c" />
+ <arg value="mvn" />
+ <arg value="package" />
+ <arg value="-Dmaven.test.skip=true" />
+ <arg value="-f" />
+ <arg value="${basedir}/pom.xml" />
+ <arg value="-N" />
+ <arg value="${mvn.opts}" />
+ </exec>
+ </target>
+
+ <target name="install" depends="install-unix,install-windows"
+ description="Install" />
+ <target name="install-unix" if="osfamily-unix">
+ <exec executable="mvn" failonerror="true">
+ <arg value="install" />
+ <arg value="-Dmaven.test.skip=true" />
+ <arg value="-f" />
+ <arg value="${basedir}/pom.xml" />
+ <arg value="-N" />
+ <arg value="${mvn.opts}" />
+ </exec>
+ </target>
+ <target name="install-windows" if="osfamily-windows">
+ <exec executable="cmd" failonerror="true">
+ <arg value="/c" />
+ <arg value="mvn" />
+ <arg value="install" />
+ <arg value="-Dmaven.test.skip=true" />
+ <arg value="-f" />
+ <arg value="${basedir}/pom.xml" />
+ <arg value="-N" />
+ <arg value="${mvn.opts}" />
+ </exec>
+ </target>
+
+ <target name="clean" depends="clean-unix,clean-windows"
+ description="Delete target directories">
+ <delete dir="${build}" />
+ </target>
+ <target name="clean-unix" if="osfamily-unix">
+ <exec executable="mvn" failonerror="true">
+ <arg value="clean" />
+ <arg value="${mvn.opts}" />
+ </exec>
+ </target>
+ <target name="clean-windows" if="osfamily-windows">
+ <exec executable="cmd" failonerror="true">
+ <arg value="/c" />
+ <arg value="mvn" />
+ <arg value="clean" />
+ <arg value="${mvn.opts}" />
+ </exec>
+ </target>
+
+ <target name="test" depends="test-unix,test-windows" description="Run tests" />
+ <target name="test-unix" if="osfamily-unix">
+ <exec executable="mvn" failonerror="true">
+ <arg value="test" />
+ <arg value="${mvn.opts}" />
+ </exec>
+ </target>
+ <target name="test-windows" if="osfamily-windows">
+ <exec executable="cmd" failonerror="true">
+ <arg value="/c" />
+ <arg value="mvn" />
+ <arg value="test" />
+ <arg value="${mvn.opts}" />
+ </exec>
+ </target>
+</project>
\ No newline at end of file
--- /dev/null
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+ <parent>
+ <groupId>org.collectionspace.services</groupId>
+ <artifactId>org.collectionspace.services.heldintrust</artifactId>
+ <version>${revision}</version>
+ </parent>
+
+ <modelVersion>4.0.0</modelVersion>
+ <artifactId>org.collectionspace.services.heldintrust.client</artifactId>
+ <name>services.heldintrust.client</name>
+
+ <dependencies>
+ <!-- CollectionSpace dependencies -->
+ <dependency>
+ <groupId>org.collectionspace.services</groupId>
+ <artifactId>org.collectionspace.services.client</artifactId>
+ <version>${project.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.collectionspace.services</groupId>
+ <artifactId>org.collectionspace.services.heldintrust.jaxb</artifactId>
+ <version>${project.version}</version>
+ </dependency>
+
+ <!-- External dependencies -->
+ <dependency>
+ <groupId>org.testng</groupId>
+ <artifactId>testng</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>org.jboss.resteasy</groupId>
+ <artifactId>resteasy-jaxrs</artifactId>
+ <!-- filter out unwanted jars -->
+ <exclusions>
+ <exclusion>
+ <groupId>tjws</groupId>
+ <artifactId>webserver</artifactId>
+ </exclusion>
+ </exclusions>
+ </dependency>
+ <dependency>
+ <groupId>org.jboss.resteasy</groupId>
+ <artifactId>resteasy-jaxb-provider</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>org.jboss.resteasy</groupId>
+ <artifactId>resteasy-multipart-provider</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>commons-httpclient</groupId>
+ <artifactId>commons-httpclient</artifactId>
+ </dependency>
+ </dependencies>
+
+ <build>
+ <finalName>collectionspace-services-heldintrust-client</finalName>
+ </build>
+</project>
\ No newline at end of file
--- /dev/null
+/*
+ * 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.heldintrust.HeldInTrustsCommon;
+
+/**
+ * HeldInTrustClient.java
+ */
+public class HeldInTrustClient extends AbstractCommonListPoxServiceClientImpl<HeldInTrustProxy, HeldInTrustsCommon> {
+
+ public static final String SERVICE_NAME = "heldintrusts";
+ 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 HeldInTrustClient() throws Exception {
+ super();
+ }
+
+ public HeldInTrustClient(String clientPropertiesFilename) throws Exception {
+ super(clientPropertiesFilename);
+ }
+
+ @Override
+ public String getServicePathComponent() {
+ return SERVICE_PATH_COMPONENT;
+ }
+
+ @Override
+ public String getServiceName() {
+ return SERVICE_NAME;
+ }
+
+ @Override
+ public Class<HeldInTrustProxy> getProxyClass() {
+ return HeldInTrustProxy.class;
+ }
+}
--- /dev/null
+/*
+ * 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;
+
+/**
+ * HeldInTrustProxy.java
+ */
+@Path(HeldInTrustClient.SERVICE_PATH_PROXY)
+@Produces({"application/xml"})
+@Consumes({"application/xml"})
+public interface HeldInTrustProxy extends CollectionSpaceCommonListPoxProxy {}
--- /dev/null
+/*
+ * 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.test;
+
+import javax.ws.rs.core.Response;
+import org.collectionspace.services.client.AbstractCommonListUtils;
+import org.collectionspace.services.client.CollectionSpaceClient;
+import org.collectionspace.services.client.HeldInTrustClient;
+import org.collectionspace.services.client.PayloadInputPart;
+import org.collectionspace.services.client.PayloadOutputPart;
+import org.collectionspace.services.client.PoxPayloadIn;
+import org.collectionspace.services.client.PoxPayloadOut;
+import org.collectionspace.services.heldintrust.HeldInTrustsCommon;
+import org.collectionspace.services.jaxb.AbstractCommonList;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.testng.Assert;
+
+public class HeldInTrustServiceTest extends AbstractPoxServiceTestImpl<AbstractCommonList, HeldInTrustsCommon> {
+
+ private final Logger logger = LoggerFactory.getLogger(HeldInTrustServiceTest.class);
+
+ /** The service path component. */
+ final String SERVICE_NAME = "heldintrusts";
+
+ final String SERVICE_PATH_COMPONENT = "heldintrusts";
+
+ /* (non-Javadoc)
+ * @see org.collectionspace.services.client.test.BaseServiceTest#getClientInstance()
+ */
+ @Override
+ protected CollectionSpaceClient getClientInstance() throws Exception {
+ return new HeldInTrustClient();
+ }
+
+ @Override
+ protected CollectionSpaceClient getClientInstance(String clientPropertiesFilename) throws Exception {
+ return new HeldInTrustClient(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.
+ HeldInTrustClient client = new HeldInTrustClient();
+ String identifier = createIdentifier();
+ PoxPayloadOut multipart = createHeldInTrustInstance(identifier);
+ String newID = null;
+ 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(testName + ": status = " + 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(testName + ": knownResourceId=" + 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.
+ HeldInTrustClient client = new HeldInTrustClient();
+ 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());
+ HeldInTrustsCommon heldInTrustCommon = null;
+ if (payloadInputPart != null) {
+ heldInTrustCommon = (HeldInTrustsCommon) payloadInputPart.getBody();
+ }
+ Assert.assertNotNull(heldInTrustCommon);
+ }
+
+ // 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.
+ HeldInTrustClient client = new HeldInTrustClient();
+ 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(testName + ": status = " + 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;
+ HeldInTrustClient client = new HeldInTrustClient();
+ 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(testName + ": status = " + 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 {
+ // Perform setup.
+ setupRead();
+
+ // Retrieve the contents of a resource to update.
+ HeldInTrustClient client = new HeldInTrustClient();
+ 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());
+ HeldInTrustsCommon heldInTrustCommon = null;
+ if (payloadInputPart != null) {
+ heldInTrustCommon = (HeldInTrustsCommon) payloadInputPart.getBody();
+ }
+ Assert.assertNotNull(heldInTrustCommon);
+
+ // Update the content of this resource.
+ heldInTrustCommon.setHeldInTrustNumber("updated-" + heldInTrustCommon.getHeldInTrustNumber());
+
+ logger.debug("to be updated object");
+ logger.debug(objectAsXmlString(heldInTrustCommon, HeldInTrustsCommon.class));
+
+ setupUpdate();
+
+ // Submit the updated common part in an update request to the service
+ // and store the response.
+ PoxPayloadOut output = new PoxPayloadOut(this.getServicePathComponent());
+ PayloadOutputPart commonPart = output.addPart(client.getCommonPartName(), heldInTrustCommon);
+ 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(testName + ": status = " + 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());
+ HeldInTrustsCommon updatedHeldInTrustCommon = null;
+ if (payloadInputPart != null) {
+ updatedHeldInTrustCommon = (HeldInTrustsCommon) payloadInputPart.getBody();
+ }
+ Assert.assertNotNull(updatedHeldInTrustCommon);
+
+ // Check selected fields in the updated common part.
+ Assert.assertEquals(
+ updatedHeldInTrustCommon.getHeldInTrustNumber(),
+ heldInTrustCommon.getHeldInTrustNumber(),
+ "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.
+ HeldInTrustClient client = new HeldInTrustClient();
+ PoxPayloadOut multipart = createHeldInTrustInstance(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(testName + ": status = " + 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.
+ HeldInTrustClient client = new HeldInTrustClient();
+ 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(testName + ": status = " + 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.
+ HeldInTrustClient client = new HeldInTrustClient();
+ 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(testName + ": status = " + 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=" + url + " status=" + 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 createHeldInTrustInstance(identifier);
+ }
+
+ /**
+ * Creates the heldInTrust instance.
+ *
+ * @param heldInTrustNumber the held in trust number
+ * @return the multipart output
+ * @throws Exception
+ */
+ private PoxPayloadOut createHeldInTrustInstance(String heldInTrustNumber) throws Exception {
+ HeldInTrustsCommon heldInTrustCommon = new HeldInTrustsCommon();
+ heldInTrustCommon.setHeldInTrustNumber(heldInTrustNumber);
+
+ PoxPayloadOut multipart = new PoxPayloadOut(this.getServicePathComponent());
+ PayloadOutputPart commonPart =
+ multipart.addPart(new HeldInTrustClient().getCommonPartName(), heldInTrustCommon);
+
+ logger.debug("to be created, heldInTrust common");
+ logger.debug(objectAsXmlString(heldInTrustCommon, HeldInTrustsCommon.class));
+
+ return multipart;
+ }
+
+ @Override
+ public void CRUDTests(String testName) {
+ // TODO Auto-generated method stub
+
+ }
+
+ @Override
+ protected PoxPayloadOut createInstance(String commonPartName, String identifier) throws Exception {
+ return createHeldInTrustInstance(identifier);
+ }
+
+ @Override
+ protected HeldInTrustsCommon updateInstance(HeldInTrustsCommon commonPartObject) {
+ // TODO Auto-generated method stub
+ return null;
+ }
+
+ @Override
+ protected void compareUpdatedInstances(HeldInTrustsCommon original, HeldInTrustsCommon updated) {
+ // TODO Auto-generated method stub
+ }
+}
--- /dev/null
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+ <parent>
+ <artifactId>org.collectionspace.services.heldintrust</artifactId>
+ <groupId>org.collectionspace.services</groupId>
+ <version>${revision}</version>
+ </parent>
+
+ <modelVersion>4.0.0</modelVersion>
+ <artifactId>org.collectionspace.services.heldintrust.jaxb</artifactId>
+ <name>services.heldintrust.jaxb</name>
+
+ <dependencies>
+ <dependency>
+ <groupId>org.collectionspace.services</groupId>
+ <artifactId>org.collectionspace.services.jaxb</artifactId>
+ <version>${project.version}</version>
+ </dependency>
+ </dependencies>
+
+ <build>
+ <finalName>collectionspace-services-heldintrust-jaxb</finalName>
+ <defaultGoal>install</defaultGoal>
+ <plugins>
+ <plugin>
+ <groupId>org.jvnet.jaxb2.maven2</groupId>
+ <artifactId>maven-jaxb2-plugin</artifactId>
+ </plugin>
+ </plugins>
+ </build>
+</project>
\ No newline at end of file
--- /dev/null
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+
+<!--
+ HeldInTrust schema (XSD)
+
+ Entity : HeldInTrust
+ Part : Common
+ Used for: JAXB binding between XML and Java objects
+-->
+<xs:schema
+ xmlns:xs="http://www.w3.org/2001/XMLSchema"
+ xmlns:jaxb="http://java.sun.com/xml/ns/jaxb"
+ jaxb:version="1.0" elementFormDefault="unqualified"
+ xmlns="http://collectionspace.org/services/heldintrust"
+ targetNamespace="http://collectionspace.org/services/heldintrust"
+ version="0.1"
+>
+
+ <!-- HeldInTrust Information Group -->
+ <xs:element name="heldintrusts_common">
+ <xs:annotation>
+ <xs:appinfo>
+ <jaxb:class name="HeldInTrustsCommon" />
+ </xs:appinfo>
+ </xs:annotation>
+
+ <xs:complexType>
+ <xs:sequence>
+ <xs:element name="heldInTrustNumber" type="xs:string" />
+ <xs:element name="typeOfAgreement" type="xs:string" />
+ <xs:element name="owners" type="owners" />
+ <xs:element name="plannedReturnGroupList" type="plannedReturnGroupList" />
+ <xs:element name="agreementDescriptions" type="agreementDescriptions" />
+ <xs:element name="agreementRenewalDates" type="agreementRenewalDates" />
+ <xs:element name="agreementApprovalGroupList" type="agreementApprovalGroupList" />
+ <xs:element name="correspondenceGroupList" type="correspondenceGroupList" />
+ </xs:sequence>
+ </xs:complexType>
+ </xs:element>
+
+ <xs:complexType name="owners">
+ <xs:sequence>
+ <xs:element name="owner" type="xs:string" minOccurs="0" maxOccurs="unbounded" />
+ </xs:sequence>
+ </xs:complexType>
+
+ <xs:complexType name="plannedReturnGroupList">
+ <xs:sequence>
+ <xs:element name="plannedReturnGroup" type="plannedReturnGroup" minOccurs="0" maxOccurs="unbounded" />
+ </xs:sequence>
+ </xs:complexType>
+
+ <xs:complexType name="plannedReturnGroup">
+ <xs:sequence>
+ <xs:element name="plannedReturnDate" type="xs:date" />
+ <xs:element name="plannedReturnNote" type="xs:string" />
+ </xs:sequence>
+ </xs:complexType>
+
+ <xs:complexType name="agreementDescriptions">
+ <xs:sequence>
+ <xs:element name="agreementDescription" type="xs:string" minOccurs="0" maxOccurs="unbounded" />
+ </xs:sequence>
+ </xs:complexType>
+
+ <xs:complexType name="agreementRenewalDates">
+ <xs:sequence>
+ <xs:element name="agreementRenewalDate" type="xs:date" minOccurs="0" maxOccurs="unbounded" />
+ </xs:sequence>
+ </xs:complexType>
+
+ <xs:complexType name="agreementApprovalGroupList">
+ <xs:sequence>
+ <xs:element name="agreementApprovalGroup" type="agreementApprovalGroup" minOccurs="0" maxOccurs="unbounded" />
+ </xs:sequence>
+ </xs:complexType>
+
+ <xs:complexType name="agreementApprovalGroup">
+ <xs:sequence>
+ <xs:element name="agreementGroup" type="xs:string" />
+ <xs:element name="agreementIndividual" type="xs:string" />
+ <xs:element name="agreementStatus" type="xs:string" />
+ <xs:element name="agreementDate" type="xs:date" />
+ <xs:element name="agreementNote" type="xs:string" />
+ </xs:sequence>
+ </xs:complexType>
+
+ <xs:complexType name="correspondenceGroupList">
+ <xs:sequence>
+ <xs:element name="correspondenceGroup" type="correspondenceGroup" minOccurs="0" maxOccurs="unbounded" />
+ </xs:sequence>
+ </xs:complexType>
+
+ <xs:complexType name="correspondenceGroup">
+ <xs:sequence>
+ <xs:element name="correspondenceSender" type="xs:string" />
+ <xs:element name="correspondenceRecipient" type="xs:string" />
+ <xs:element name="correspondenceType" type="xs:string" />
+ <xs:element name="correspondenceDate" type="xs:date" />
+ <xs:element name="correspondenceSummary" type="xs:string" />
+ </xs:sequence>
+ </xs:complexType>
+</xs:schema>
\ No newline at end of file
--- /dev/null
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+ <parent>
+ <groupId>org.collectionspace.services</groupId>
+ <artifactId>org.collectionspace.services.main</artifactId>
+ <version>${revision}</version>
+ </parent>
+
+ <modelVersion>4.0.0</modelVersion>
+ <artifactId>org.collectionspace.services.heldintrust</artifactId>
+ <name>services.heldintrust</name>
+ <packaging>pom</packaging>
+
+ <properties>
+ <!-- spotless 2.30.0 is the last version that supports java 8 -->
+ <spotless.version>2.30.0</spotless.version>
+ </properties>
+
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>com.diffplug.spotless</groupId>
+ <artifactId>spotless-maven-plugin</artifactId>
+ <version>${spotless.version}</version>
+ <configuration>
+ <formats>
+ <!-- you can define as many formats as you want, each is independent -->
+ <format>
+ <includes>
+ <include>src/main/java/**/*.java</include>
+ <include>src/test/java/**/*.java</include>
+ </includes>
+ <trimTrailingWhitespace />
+ <endWithNewline />
+ <indent>
+ <spaces>true</spaces>
+ <spacesPerTab>4</spacesPerTab>
+ </indent>
+ </format>
+ </formats>
+ <!-- define a language-specific format -->
+ <java>
+ <palantirJavaFormat />
+ </java>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+
+ <modules>
+ <module>jaxb</module>
+ <module>service</module>
+ <module>client</module>
+ </modules>
+
+</project>
\ No newline at end of file
--- /dev/null
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+
+ <parent>
+ <groupId>org.collectionspace.services</groupId>
+ <artifactId>org.collectionspace.services.heldintrust</artifactId>
+ <version>${revision}</version>
+ </parent>
+
+ <modelVersion>4.0.0</modelVersion>
+ <artifactId>org.collectionspace.services.heldintrust.service</artifactId>
+ <name>services.heldintrust.service</name>
+ <packaging>jar</packaging>
+
+ <dependencies>
+ <dependency>
+ <groupId>org.collectionspace.services</groupId>
+ <artifactId>org.collectionspace.services.common</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>org.collectionspace.services</groupId>
+ <artifactId>org.collectionspace.services.heldintrust.jaxb</artifactId>
+ <version>${project.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.collectionspace.services</groupId>
+ <artifactId>org.collectionspace.services.heldintrust.client</artifactId>
+ <version>${project.version}</version>
+ </dependency>
+
+ <!-- External dependencies -->
+ <dependency>
+ <groupId>junit</groupId>
+ <artifactId>junit</artifactId>
+ <scope>test</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.testng</groupId>
+ <artifactId>testng</artifactId>
+ <scope>test</scope>
+ </dependency>
+
+ <!-- javax -->
+ <dependency>
+ <groupId>javax.security</groupId>
+ <artifactId>jaas</artifactId>
+ <version>1.0.01</version>
+ <scope>provided</scope>
+ </dependency>
+
+ <!-- jboss -->
+ <dependency>
+ <groupId>org.jboss.resteasy</groupId>
+ <artifactId>resteasy-jaxrs</artifactId>
+ <exclusions>
+ <exclusion>
+ <groupId>tjws</groupId>
+ <artifactId>webserver</artifactId>
+ </exclusion>
+ </exclusions>
+ </dependency>
+ <dependency>
+ <groupId>org.jboss.resteasy</groupId>
+ <artifactId>resteasy-jaxb-provider</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>org.jboss.resteasy</groupId>
+ <artifactId>resteasy-multipart-provider</artifactId>
+ </dependency>
+
+ <!-- nuxeo -->
+ <dependency>
+ <groupId>org.nuxeo.ecm.core</groupId>
+ <artifactId>nuxeo-core-api</artifactId>
+ <exclusions>
+ <exclusion>
+ <artifactId>jboss-remoting</artifactId>
+ <groupId>jboss</groupId>
+ </exclusion>
+ </exclusions>
+ </dependency>
+ </dependencies>
+
+ <build>
+ <finalName>collectionspace-services-heldintrust</finalName>
+ </build>
+</project>
--- /dev/null
+/*
+ * 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.heldintrust;
+
+import javax.ws.rs.Consumes;
+import javax.ws.rs.Path;
+import javax.ws.rs.Produces;
+import org.collectionspace.services.client.HeldInTrustClient;
+import org.collectionspace.services.common.NuxeoBasedResource;
+
+@Path(HeldInTrustClient.SERVICE_PATH)
+@Consumes("application/xml")
+@Produces("application/xml")
+public class HeldInTrustResource extends NuxeoBasedResource {
+
+ @Override
+ protected String getVersionString() {
+ return "$LastChangedRevision$";
+ }
+
+ @Override
+ public String getServiceName() {
+ return HeldInTrustClient.SERVICE_NAME;
+ }
+
+ @Override
+ public Class<HeldInTrustsCommon> getCommonPartClass() {
+ return HeldInTrustsCommon.class;
+ }
+}
--- /dev/null
+/*
+ * 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.heldintrust.nuxeo;
+
+/**
+ * HeldInTrustConstants specifies constants for the HeldInTrust service
+ *
+ */
+public class HeldInTrustConstants {
+
+ public static final String NUXEO_DOCTYPE = "Heldintrust";
+ public static final String NUXEO_SCHEMA_NAME = "heldintrust";
+ public static final String NUXEO_DC_TITLE = "CollectionSpace-Heldintrust";
+}
--- /dev/null
+/*
+ * 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.heldintrust.nuxeo;
+
+import org.collectionspace.services.heldintrust.HeldInTrustsCommon;
+import org.collectionspace.services.nuxeo.client.java.NuxeoDocumentModelHandler;
+
+/** HeldInTrustDocumentModelHandler
+ */
+public class HeldInTrustDocumentModelHandler extends NuxeoDocumentModelHandler<HeldInTrustsCommon> {}
--- /dev/null
+/*
+ * 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.heldintrust.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.heldintrust.HeldInTrustsCommon;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class HeldInTrustValidatorHandler extends ValidatorHandlerImpl<PoxPayloadIn, PoxPayloadOut> {
+
+ private static final String COMMON_PART_MISSING = "Validation exception: heldintrusts_common part is missing";
+ private static final String HELDINTRUST_NUMBER_MISSING =
+ "Validation exception: The heldintrust field \"heldInTrustNumber\" cannot be empty or missing";
+
+ private final Logger logger = LoggerFactory.getLogger(HeldInTrustValidatorHandler.class);
+
+ @Override
+ protected Class<?> getCommonPartClass() {
+ return HeldInTrustsCommon.class;
+ }
+
+ @Override
+ protected void handleCreate() throws InvalidDocumentException {
+ final HeldInTrustsCommon heldInTrust = (HeldInTrustsCommon) getCommonPart();
+ if (heldInTrust == null) {
+ logger.error(COMMON_PART_MISSING);
+ throw new InvalidDocumentException(COMMON_PART_MISSING);
+ }
+
+ final String heldInTrustNumber = heldInTrust.getHeldInTrustNumber();
+ if (heldInTrustNumber == null || heldInTrustNumber.isEmpty()) {
+ logger.error(HELDINTRUST_NUMBER_MISSING);
+ throw new InvalidDocumentException(HELDINTRUST_NUMBER_MISSING);
+ }
+ }
+
+ @Override
+ protected void handleGet() {}
+
+ @Override
+ protected void handleGetAll() {}
+
+ @Override
+ protected void handleUpdate() {}
+
+ @Override
+ protected void handleDelete() {}
+}
<module>nagpraclaim</module>
<module>nagprainventory</module>
<module>summarydocumentation</module>
+ <module>heldintrust</module>
<module>IntegrationTests</module>
<module>PerformanceTests</module>
<module>security</module>
projects / tmp / jakarta-migration.git / commitdiff