--- /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 (c)) 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.importer;
+
+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 org.collectionspace.services.client.VocabularyClient;
+import org.collectionspace.services.client.test.ServiceRequestType;
+import org.collectionspace.services.vocabulary.VocabulariesCommon;
+import org.collectionspace.services.vocabulary.VocabularyitemsCommon;
+import org.jboss.resteasy.client.ClientResponse;
+import org.jboss.resteasy.plugins.providers.multipart.MultipartOutput;
+import org.jboss.resteasy.plugins.providers.multipart.OutputPart;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * VocabularyServiceTest, carries out tests against a
+ * deployed and running Vocabulary Service.
+ *
+ * $LastChangedRevision: 753 $
+ * $LastChangedDate: 2009-09-23 11:03:36 -0700 (Wed, 23 Sep 2009) $
+ */
+public class VocabularyBaseImport {
+ private final Logger logger =
+ LoggerFactory.getLogger(VocabularyBaseImport.class);
+
+ // Instance variables specific to this test.
+ private VocabularyClient client = new VocabularyClient();
+ final String SERVICE_PATH_COMPONENT = "vocabularies";
+ final String ITEM_SERVICE_PATH_COMPONENT = "items";
+
+ public void createEnumeration(String vocabName, List<String> enumValues ) {
+
+ // Expected status code: 201 Created
+ int EXPECTED_STATUS_CODE = Response.Status.CREATED.getStatusCode();
+ // Type of service request being tested
+ ServiceRequestType REQUEST_TYPE = ServiceRequestType.CREATE;
+
+ if(logger.isDebugEnabled()){
+ logger.debug("Import: Create vocabulary: \"" + vocabName +"\"");
+ }
+ MultipartOutput multipart = createVocabularyInstance(vocabName, "enum");
+ ClientResponse<Response> res = client.create(multipart);
+
+ int statusCode = res.getStatus();
+
+ if(!REQUEST_TYPE.isValidStatusCode(statusCode)) {
+ throw new RuntimeException("Could not create enumeration: \""+vocabName
+ +"\" "+ invalidStatusCodeMessage(REQUEST_TYPE, statusCode));
+ }
+ if(statusCode != EXPECTED_STATUS_CODE) {
+ throw new RuntimeException("Unexpected Status when creating enumeration: \""
+ +vocabName +"\", Status:"+ statusCode);
+ }
+
+ // Store the ID returned from this create operation
+ // for additional tests below.
+ String newVocabId = extractId(res);
+ if(logger.isDebugEnabled()){
+ logger.debug("Import: Created vocabulary: \"" + vocabName +"\" ID:"
+ +newVocabId );
+ }
+ for(String itemName : enumValues){
+ createItemInVocab(newVocabId, vocabName, itemName);
+ }
+ }
+
+ private String createItemInVocab(String vcsid, String vocabName, String itemName) {
+ // Expected status code: 201 Created
+ int EXPECTED_STATUS_CODE = Response.Status.CREATED.getStatusCode();
+ // Type of service request being tested
+ ServiceRequestType REQUEST_TYPE = ServiceRequestType.CREATE;
+
+ if(logger.isDebugEnabled()){
+ logger.debug("Import: Create Item: \""+itemName+"\" in vocabulary: \"" + vocabName +"\"");
+ }
+ MultipartOutput multipart = createVocabularyItemInstance(vcsid, itemName);
+ ClientResponse<Response> res = client.createItem(vcsid, multipart);
+
+ int statusCode = res.getStatus();
+
+ if(!REQUEST_TYPE.isValidStatusCode(statusCode)) {
+ throw new RuntimeException("Could not create Item: \""+itemName
+ +"\" in vocabulary: \"" + vocabName
+ +"\" "+ invalidStatusCodeMessage(REQUEST_TYPE, statusCode));
+ }
+ if(statusCode != EXPECTED_STATUS_CODE) {
+ throw new RuntimeException("Unexpected Status when creating Item: \""+itemName
+ +"\" in vocabulary: \"" + vocabName +"\", Status:"+ statusCode);
+ }
+
+ return extractId(res);
+ }
+
+ // ---------------------------------------------------------------
+ // Utility methods used by tests above
+ // ---------------------------------------------------------------
+
+ private MultipartOutput createVocabularyInstance(String displayName, String vocabType) {
+ VocabulariesCommon vocabulary = new VocabulariesCommon();
+ vocabulary.setDisplayName(displayName);
+ vocabulary.setVocabType(vocabType);
+ MultipartOutput multipart = new MultipartOutput();
+ OutputPart commonPart = multipart.addPart(vocabulary, MediaType.APPLICATION_XML_TYPE);
+ commonPart.getHeaders().add("label", client.getCommonPartName());
+
+ if(logger.isDebugEnabled()){
+ logger.debug("to be created, vocabulary common ",
+ vocabulary, VocabulariesCommon.class);
+ }
+
+ return multipart;
+ }
+
+ private MultipartOutput createVocabularyItemInstance(String inVocabulary, String displayName) {
+ VocabularyitemsCommon vocabularyItem = new VocabularyitemsCommon();
+ vocabularyItem.setInVocabulary(inVocabulary);
+ vocabularyItem.setDisplayName(displayName);
+ MultipartOutput multipart = new MultipartOutput();
+ OutputPart commonPart = multipart.addPart(vocabularyItem, MediaType.APPLICATION_XML_TYPE);
+ commonPart.getHeaders().add("label", client.getItemCommonPartName());
+
+ if(logger.isDebugEnabled()){
+ logger.debug("to be created, vocabularyitem common ", vocabularyItem, VocabularyitemsCommon.class);
+ }
+
+ return multipart;
+ }
+
+
+ /**
+ * 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()){
+ logger.debug("extractId:uri=" + uri);
+ }
+ String[] segments = uri.split("/");
+ String id = segments[segments.length - 1];
+ if(logger.isDebugEnabled()){
+ logger.debug("id=" + id);
+ }
+ return id;
+ }
+
+ public static void main(String[] args) {
+ VocabularyBaseImport vbi = new VocabularyBaseImport();
+ final String acquisitionMethodsVocabName = "Acquisition Methods";
+ final String entryMethodsVocabName = "Entry Methods";
+ final String entryReasonsVocabName = "Entry Reasons";
+ final String responsibleDeptsVocabName = "Responsible Departments";
+
+ List<String> acquisitionMethodsEnumValues =
+ Arrays.asList("Gift","Purchase","Exchange","Transfer","Treasure");
+ List<String> entryMethodsEnumValues =
+ Arrays.asList("In person","Post","Found on doorstep");
+ List<String> entryReasonsEnumValues =
+ Arrays.asList("Enquiry","Commission","Loan");
+ List<String> respDeptNamesEnumValues =
+ Arrays.asList("Antiquities","Architecture and Design","Decorative Arts",
+ "Ethnography","Herpetology","Media and Performance Art",
+ "Paintings and Sculpture","Paleobotany","Photographs",
+ "Prints and Drawings");
+
+ vbi.createEnumeration(acquisitionMethodsVocabName, acquisitionMethodsEnumValues);
+ vbi.createEnumeration(entryMethodsVocabName, entryMethodsEnumValues);
+ vbi.createEnumeration(entryReasonsVocabName, entryReasonsEnumValues);
+ vbi.createEnumeration(responsibleDeptsVocabName, respDeptNamesEnumValues);
+ }
+}
projects / tmp / jakarta-migration.git / commitdiff