package org.collectionspace.services.collectionobject.client.sample;
+import java.io.StringWriter;
import java.util.ArrayList;
-import java.util.Arrays;
import java.util.List;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.MultivaluedMap;
import javax.ws.rs.core.Response;
+import javax.xml.bind.JAXBContext;
+import javax.xml.bind.Marshaller;
-import org.apache.log4j.BasicConfigurator;
import org.collectionspace.services.client.CollectionObjectClient;
-import org.collectionspace.services.client.test.ServiceRequestType;
+import org.collectionspace.services.collectionobject.CollectionobjectsCommon;
+import org.collectionspace.services.collectionobject.OtherNumberList;
+import org.collectionspace.services.collectionobject.domain.naturalhistory.CollectionobjectsNaturalhistory;
+
import org.jboss.resteasy.client.ClientResponse;
import org.jboss.resteasy.plugins.providers.multipart.MultipartInput;
import org.jboss.resteasy.plugins.providers.multipart.MultipartOutput;
import org.jboss.resteasy.plugins.providers.multipart.InputPart;
import org.jboss.resteasy.plugins.providers.multipart.OutputPart;
+
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
* $LastChangedDate: $
*/
public class Sample {
+
private static final Logger logger =
LoggerFactory.getLogger(Sample.class);
// Create
// ---------------------------------------------------------------
+ public String createCollectionObject() {
+
+ // Create a CollectionObject record to submit to the service.
+ MultipartOutput multipart = createCollectionObjectInstance();
+
+ // Submit a 'create' request to the service, sending the new
+ // CollectionObject record to be created, and store the response.
+ ClientResponse<Response> res = client.create(multipart);
+
+ // Get the status code from the response and check it against
+ // the expected status code.
+ if (res.getStatus() != Response.Status.CREATED.getStatusCode()) {
+ logger.error("Error creating new CollectionObject. Status code = " +
+ res.getStatus());
+ return "";
+ } else {
+ logger.info("CollectionObject created successfully.");
+ }
+
+ // Return the new record number for the newly-created record.
+ return extractId(res);
+
+ }
// ---------------------------------------------------------------
// Read
// ---------------------------------------------------------------
- // ---------------------------------------------------------------
- // Delete
- // ---------------------------------------------------------------
+ public void readCollectionObject(String resourceIdentifier) throws Exception {
- // ---------------------------------------------------------------
- // Utility methods
- // ---------------------------------------------------------------
+ // Submit the read ("get") request to the service and store the response.
+ // The resourceIdentifier is a unique identifier for the CollectionObject
+ // record we're reading.
+ ClientResponse<MultipartInput> res = client.read(resourceIdentifier);
+
+ // Get the status code from the response and check it against
+ // the expected status code.
+
+ // If there was an
+ if (res.getStatus() != Response.Status.OK.getStatusCode()) {
+ logger.error("Error creating new CollectionObject. Status code = " +
+ res.getStatus());
+ return;
+ }
+
+ // Get the entity body of the response from the service.
+ MultipartInput input = (MultipartInput) res.getEntity();
+
+ // Extract each part of the record, and convert it from
+ // its XML representation to its associated Java object.
+
+ // Read the Common part of the record.
+ CollectionobjectsCommon collectionObject =
+ (CollectionobjectsCommon) extractPart(input,
+ client.getCommonPartName(), CollectionobjectsCommon.class);
+
+ if (logger.isInfoEnabled()) {
+ logger.info("CollectionObject Common part read:");
+ logger.info(objectAsXmlString(collectionObject,
+ CollectionobjectsCommon.class));
+ }
+
+ // Read the Natural History part of the record.
+ CollectionobjectsNaturalhistory conh =
+ (CollectionobjectsNaturalhistory) extractPart(input,
+ getNHPartName(), CollectionobjectsNaturalhistory.class);
+
+ if (logger.isInfoEnabled()) {
+ logger.info("CollectionObject Natural History part read:");
+ logger.info(objectAsXmlString(conh,
+ CollectionobjectsNaturalhistory.class));
+ }
+
+ }
+
+ // ---------------------------------------------------------------
+ // Delete
+ // ---------------------------------------------------------------
+
+ // ---------------------------------------------------------------
+ // Utility methods
+ // ---------------------------------------------------------------
+
+ private String getCommonPartName() {
+ return client.getCommonPartName();
+ }
+
+ private String getNHPartName() {
+ return "collectionobjects_naturalhistory";
+ }
- private Object extractPart(MultipartInput input, String label,
+ private MultipartOutput createCollectionObjectInstance() {
+
+ // Create the Common part of a CollectionObject and add data to its fields.
+
+ CollectionobjectsCommon collectionObject = new CollectionobjectsCommon();
+ collectionObject.setObjectNumber("some object number here");
+ collectionObject.setObjectName("some object name here");
+ // The 'other number' field in the common part of a CollectionObject record
+ // is multi-valued.
+ OtherNumberList onList = new OtherNumberList();
+ List<String> ons = onList.getOtherNumber();
+ // Note: the structured (URN) format of the values below is for
+ // illustrative purposes only.
+ ons.add("urn:org.collectionspace.id:24082390");
+ ons.add("urn:org.walkerart.id:123");
+ collectionObject.setOtherNumbers(onList);
+ collectionObject.setAge(""); // Test using an empty String.
+ collectionObject.setBriefDescription("Papier mache bird mask with horns, " +
+ "painted red with black and yellow spots. " +
+ "Puerto Rico. ca. 8" high, 6" wide, projects 10" (with horns).");
+
+ MultipartOutput multipart = new MultipartOutput();
+ OutputPart commonPart = multipart.addPart(collectionObject,
+ MediaType.APPLICATION_XML_TYPE);
+ commonPart.getHeaders().add("label", getCommonPartName());
+
+ if (logger.isInfoEnabled()) {
+ logger.info("CollectionObject Common part to be created:");
+ logger.info(objectAsXmlString(collectionObject,
+ CollectionobjectsCommon.class));
+ }
+
+ // Create a "domain" part of a CollectionObject and add data to its fields.
+ // This part might come from a community or consortia in a particular domain.
+ // There could potentially be multiple "domain" parts in a CollectionObject record.
+
+ // This example adds data to fields for a hypothetical Natural History domain,
+ // as in the case of the test fields below ...
+
+ CollectionobjectsNaturalhistory conh = new CollectionobjectsNaturalhistory();
+ conh.setNhString("test-string");
+ conh.setNhInt(999);
+ conh.setNhLong(9999);
+
+ OutputPart nhPart = multipart.addPart(conh, MediaType.APPLICATION_XML_TYPE);
+ nhPart.getHeaders().add("label", getNHPartName());
+
+ if (logger.isInfoEnabled()) {
+ logger.info("CollectionObject Natural History part to be created:");
+ logger.info(objectAsXmlString(conh,
+ CollectionobjectsNaturalhistory.class));
+ }
+
+ // Return the multipart entity body that will be submitted in the
+ // 'create' request, above.
+ return multipart;
+ }
+
+ protected Object extractPart(MultipartInput input, String label,
Class clazz) throws Exception {
Object obj = null;
- for(InputPart part : input.getParts()){
- String partLabel = part.getHeaders().getFirst("label");
+ String partLabel = "";
+ List<InputPart> parts = input.getParts();
+ if (parts.size() == 0) {
+ logger.warn("No parts found in multipart body.");
+ }
+ if(logger.isInfoEnabled()){
+ logger.info("Parts:");
+ for(InputPart part : parts){
+ partLabel = part.getHeaders().getFirst("label");
+ logger.info("part = " + partLabel);
+ }
+ }
+ boolean partLabelMatched = false;
+ for(InputPart part : parts){
+ partLabel = part.getHeaders().getFirst("label");
if(label.equalsIgnoreCase(partLabel)){
- String partStr = part.getBodyAsString();
- if(logger.isDebugEnabled()){
- logger.debug("extracted part str=\n" + partStr);
+ partLabelMatched = true;
+ if(logger.isInfoEnabled()){
+ logger.info("found part" + partLabel);
}
- obj = part.getBody(clazz, null);
- if(logger.isDebugEnabled()){
- logger.debug("extracted part obj=\n", obj, clazz);
+ String partStr = part.getBodyAsString();
+ if (partStr == null || partStr.trim().isEmpty()) {
+ logger.warn("Part '" + label + "' in multipart body is empty.");
+ } else {
+ if (logger.isInfoEnabled()){
+ logger.info("extracted part as str=\n" + partStr);
+ }
+ obj = part.getBody(clazz, null);
+ if(logger.isInfoEnabled()){
+ logger.info("extracted part as obj=\n",
+ objectAsXmlString(obj, clazz));
+ }
}
break;
}
}
+ if (! partLabelMatched) {
+ logger.warn("Could not find part '" + label + "' in multipart body.");
+ // In the event that getBodyAsString() or getBody(), above, do *not*
+ // throw an IOException, but getBody() nonetheless retrieves a null object.
+ // This *may* be unreachable.
+ } else if (obj == null) {
+ logger.warn("Could not extract part '" + label +
+ "' in multipart body as an object.");
+ }
return obj;
}
- /**
- * Returns an error message indicating that the status code returned by a
- * specific call to a service does not fall within a set of valid status
- * codes for that service.
- *
- * @param serviceRequestType A type of service request (e.g. CREATE, DELETE).
- *
- * @param statusCode The invalid status code that was returned in the response,
- * from submitting that type of request to the service.
- *
- * @return An error message.
- */
- protected String invalidStatusCodeMessage(ServiceRequestType requestType, int statusCode) {
- return "Status code '" + statusCode + "' in response is NOT within the expected set: " +
- requestType.validStatusCodesAsString();
- }
-
protected String extractId(ClientResponse<Response> res) {
MultivaluedMap<String, Object> mvm = res.getMetadata();
String uri = (String) ((ArrayList<Object>) mvm.get("Location")).get(0);
- if(logger.isDebugEnabled()){
+ if(logger.isInfoEnabled()){
logger.info("extractId:uri=" + uri);
}
String[] segments = uri.split("/");
String id = segments[segments.length - 1];
- if(logger.isDebugEnabled()){
- logger.debug("id=" + id);
+ if(logger.isInfoEnabled()){
+ logger.info("id=" + id);
}
return id;
}
+
+ protected String objectAsXmlString(Object o, Class clazz) {
+ StringWriter sw = new StringWriter();
+ try{
+ JAXBContext jc = JAXBContext.newInstance(clazz);
+ Marshaller m = jc.createMarshaller();
+ m.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT,
+ Boolean.TRUE);
+ m.marshal(o, sw);
+ }catch(Exception e){
+ e.printStackTrace();
+ }
+ return sw.toString();
+ }
- public static void main(String[] args) {
+ public static void main(String[] args) throws Exception {
+
+ Sample sample = new Sample();
+
+ // Create a new CollectionObject record.
+ String newRecordId = sample.createCollectionObject();
+
+ if (newRecordId == null || newRecordId.trim().isEmpty()) {
+ logger.error("Could not create new record.");
+ } else {
+ // Read the newly-created record.
+ sample.readCollectionObject(newRecordId);
+ }
}
projects / tmp / jakarta-migration.git / commitdiff