2 * This document is a part of the source code and related artifacts
\r
3 * for CollectionSpace, an open source collections management system
\r
4 * for museums and related institutions:
\r
6 * http://www.collectionspace.org
\r
7 * http://wiki.collectionspace.org
\r
9 * Copyright (c)) 2009 Regents of the University of California
\r
11 * Licensed under the Educational Community License (ECL), Version 2.0.
\r
12 * You may not use this file except in compliance with this License.
\r
14 * You may obtain a copy of the ECL 2.0 License at
\r
15 * https://source.collectionspace.org/collection-space/LICENSE.txt
\r
17 * Unless required by applicable law or agreed to in writing, software
\r
18 * distributed under the License is distributed on an "AS IS" BASIS,
\r
19 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
\r
20 * See the License for the specific language governing permissions and
\r
21 * limitations under the License.
\r
24 package org.collectionspace.services.vocabulary.client.sample;
\r
26 import java.util.ArrayList;
\r
27 import java.util.Arrays;
\r
28 import java.util.List;
\r
30 import javax.ws.rs.core.MediaType;
\r
31 import javax.ws.rs.core.MultivaluedMap;
\r
32 import javax.ws.rs.core.Response;
\r
34 import org.apache.log4j.BasicConfigurator;
\r
35 import org.collectionspace.services.client.VocabularyClient;
\r
36 import org.collectionspace.services.client.test.ServiceRequestType;
\r
37 import org.collectionspace.services.vocabulary.VocabulariesCommon;
\r
38 import org.collectionspace.services.vocabulary.VocabulariesCommonList;
\r
39 import org.collectionspace.services.vocabulary.VocabularyitemsCommon;
\r
40 import org.collectionspace.services.vocabulary.VocabularyitemsCommonList;
\r
41 import org.jboss.resteasy.client.ClientResponse;
\r
42 import org.jboss.resteasy.plugins.providers.multipart.MultipartInput;
\r
43 import org.jboss.resteasy.plugins.providers.multipart.MultipartOutput;
\r
44 import org.jboss.resteasy.plugins.providers.multipart.InputPart;
\r
45 import org.jboss.resteasy.plugins.providers.multipart.OutputPart;
\r
46 import org.slf4j.Logger;
\r
47 import org.slf4j.LoggerFactory;
\r
50 * VocabularyServiceTest, carries out tests against a
\r
51 * deployed and running Vocabulary Service.
\r
53 * $LastChangedRevision: 753 $
\r
54 * $LastChangedDate: 2009-09-23 11:03:36 -0700 (Wed, 23 Sep 2009) $
\r
56 public class Sample {
\r
57 private static final Logger logger =
\r
58 LoggerFactory.getLogger(Sample.class);
\r
60 // Instance variables specific to this test.
\r
61 private VocabularyClient client = new VocabularyClient();
\r
62 final String SERVICE_PATH_COMPONENT = "vocabularies";
\r
63 final String ITEM_SERVICE_PATH_COMPONENT = "items";
\r
66 // ---------------------------------------------------------------
\r
68 // ---------------------------------------------------------------
\r
70 public void createEnumeration(String vocabName, List<String> enumValues ) {
\r
72 // Expected status code: 201 Created
\r
73 int EXPECTED_STATUS_CODE = Response.Status.CREATED.getStatusCode();
\r
74 // Type of service request being tested
\r
75 ServiceRequestType REQUEST_TYPE = ServiceRequestType.CREATE;
\r
77 logger.info("Import: Create vocabulary: \"" + vocabName +"\"");
\r
78 MultipartOutput multipart = createVocabularyInstance(vocabName,
\r
79 createRefName(vocabName), "enum");
\r
80 ClientResponse<Response> res = client.create(multipart);
\r
82 int statusCode = res.getStatus();
\r
84 if(!REQUEST_TYPE.isValidStatusCode(statusCode)) {
\r
85 throw new RuntimeException("Could not create enumeration: \""+vocabName
\r
86 +"\" "+ invalidStatusCodeMessage(REQUEST_TYPE, statusCode));
\r
88 if(statusCode != EXPECTED_STATUS_CODE) {
\r
89 throw new RuntimeException("Unexpected Status when creating enumeration: \""
\r
90 +vocabName +"\", Status:"+ statusCode);
\r
93 // Store the ID returned from this create operation
\r
94 // for additional tests below.
\r
95 String newVocabId = extractId(res);
\r
96 logger.info("Import: Created vocabulary: \"" + vocabName +"\" ID:"
\r
99 // Add items to the vocabulary
\r
100 for(String itemName : enumValues){
\r
101 createItemInVocab(newVocabId, vocabName, itemName, createRefName(itemName));
\r
106 private String createItemInVocab(String vcsid, String vocabName, String itemName, String refName) {
\r
107 // Expected status code: 201 Created
\r
108 int EXPECTED_STATUS_CODE = Response.Status.CREATED.getStatusCode();
\r
109 // Type of service request being tested
\r
110 ServiceRequestType REQUEST_TYPE = ServiceRequestType.CREATE;
\r
112 logger.info("Import: Create Item: \""+itemName+"\" in vocabulary: \"" + vocabName +"\"");
\r
113 MultipartOutput multipart = createVocabularyItemInstance(vcsid, itemName, refName);
\r
114 ClientResponse<Response> res = client.createItem(vcsid, multipart);
\r
116 int statusCode = res.getStatus();
\r
118 if(!REQUEST_TYPE.isValidStatusCode(statusCode)) {
\r
119 throw new RuntimeException("Could not create Item: \""+itemName
\r
120 +"\" in vocabulary: \"" + vocabName
\r
121 +"\" "+ invalidStatusCodeMessage(REQUEST_TYPE, statusCode));
\r
123 if(statusCode != EXPECTED_STATUS_CODE) {
\r
124 throw new RuntimeException("Unexpected Status when creating Item: \""+itemName
\r
125 +"\" in vocabulary: \"" + vocabName +"\", Status:"+ statusCode);
\r
128 return extractId(res);
\r
132 // ---------------------------------------------------------------
\r
134 // ---------------------------------------------------------------
\r
136 private VocabulariesCommonList readVocabularies() {
\r
138 // Expected status code: 200 OK
\r
139 int EXPECTED_STATUS_CODE = Response.Status.OK.getStatusCode();
\r
140 // Type of service request being tested
\r
141 ServiceRequestType REQUEST_TYPE = ServiceRequestType.READ;
\r
143 // Submit the request to the service and store the response.
\r
144 ClientResponse<VocabulariesCommonList> res = client.readList();
\r
145 VocabulariesCommonList list = res.getEntity();
\r
147 int statusCode = res.getStatus();
\r
148 if(!REQUEST_TYPE.isValidStatusCode(statusCode)) {
\r
149 throw new RuntimeException("Could not read list of vocabularies: "
\r
150 + invalidStatusCodeMessage(REQUEST_TYPE, statusCode));
\r
152 if(statusCode != EXPECTED_STATUS_CODE) {
\r
153 throw new RuntimeException("Unexpected Status when reading " +
\r
154 "list of vocabularies, Status:"+ statusCode);
\r
160 private List<String> readVocabularyIds(VocabulariesCommonList list) {
\r
162 List<String> ids = new ArrayList<String>();
\r
163 List<VocabulariesCommonList.VocabularyListItem> vocabularies =
\r
164 list.getVocabularyListItem();
\r
165 for (VocabulariesCommonList.VocabularyListItem vocabulary : vocabularies) {
\r
166 ids.add(vocabulary.getCsid());
\r
171 private VocabulariesCommon readVocabulary(String vocabId) {
\r
173 // Expected status code: 200 OK
\r
174 int EXPECTED_STATUS_CODE = Response.Status.OK.getStatusCode();
\r
175 // Type of service request being tested
\r
176 ServiceRequestType REQUEST_TYPE = ServiceRequestType.READ;
\r
178 // Submit the request to the service and store the response.
\r
179 VocabulariesCommon vocabulary = null;
\r
181 ClientResponse<MultipartInput> res = client.read(vocabId);
\r
182 int statusCode = res.getStatus();
\r
183 if(!REQUEST_TYPE.isValidStatusCode(statusCode)) {
\r
184 throw new RuntimeException("Could not read vocabulary"
\r
185 + invalidStatusCodeMessage(REQUEST_TYPE, statusCode));
\r
187 if(statusCode != EXPECTED_STATUS_CODE) {
\r
188 throw new RuntimeException("Unexpected Status when reading " +
\r
189 "vocabulary, Status:"+ statusCode);
\r
191 MultipartInput input = (MultipartInput) res.getEntity();
\r
192 vocabulary = (VocabulariesCommon) extractPart(input,
\r
193 client.getCommonPartName(), VocabulariesCommon.class);
\r
194 } catch (Exception e) {
\r
195 throw new RuntimeException("Could not read vocabulary: ", e);
\r
201 private VocabularyitemsCommonList readItemsInVocab(String vocabId) {
\r
203 // Expected status code: 200 OK
\r
204 int EXPECTED_STATUS_CODE = Response.Status.OK.getStatusCode();
\r
205 // Type of service request being tested
\r
206 ServiceRequestType REQUEST_TYPE = ServiceRequestType.READ;
\r
208 // Submit the request to the service and store the response.
\r
209 ClientResponse<VocabularyitemsCommonList> res =
\r
210 client.readItemList(vocabId);
\r
211 VocabularyitemsCommonList list = res.getEntity();
\r
213 int statusCode = res.getStatus();
\r
215 if(!REQUEST_TYPE.isValidStatusCode(statusCode)) {
\r
216 throw new RuntimeException("Could not read items in vocabulary: "
\r
217 + invalidStatusCodeMessage(REQUEST_TYPE, statusCode));
\r
219 if(statusCode != EXPECTED_STATUS_CODE) {
\r
220 throw new RuntimeException("Unexpected Status when reading " +
\r
221 "items in vocabulary, Status:"+ statusCode);
\r
227 private List<String> readVocabularyItemIds(VocabularyitemsCommonList list) {
\r
229 List<String> ids = new ArrayList<String>();
\r
230 List<VocabularyitemsCommonList.VocabularyitemListItem> items =
\r
231 list.getVocabularyitemListItem();
\r
232 for (VocabularyitemsCommonList.VocabularyitemListItem item : items) {
\r
233 ids.add(item.getCsid());
\r
238 // ---------------------------------------------------------------
\r
240 // ---------------------------------------------------------------
\r
242 private void deleteVocabulary(String vcsid) {
\r
243 // Expected status code: 200 OK
\r
244 int EXPECTED_STATUS_CODE = Response.Status.OK.getStatusCode();
\r
245 // Type of service request being tested
\r
246 ServiceRequestType REQUEST_TYPE = ServiceRequestType.DELETE;
\r
248 ClientResponse<Response> res = client.delete(vcsid);
\r
249 int statusCode = res.getStatus();
\r
251 if(!REQUEST_TYPE.isValidStatusCode(statusCode)) {
\r
252 throw new RuntimeException("Could not delete vocabulary: "
\r
253 + invalidStatusCodeMessage(REQUEST_TYPE, statusCode));
\r
255 if(statusCode != EXPECTED_STATUS_CODE) {
\r
256 throw new RuntimeException("Unexpected Status when deleting " +
\r
257 "vocabulary, Status:"+ statusCode);
\r
261 private void deleteAllVocabularies() {
\r
262 List<String> ids = readVocabularyIds(readVocabularies());
\r
263 for (String id : ids) {
\r
264 deleteVocabulary(id);
\r
268 private void deleteVocabularyItem(String vcsid, String itemcsid) {
\r
269 // Expected status code: 200 OK
\r
270 int EXPECTED_STATUS_CODE = Response.Status.OK.getStatusCode();
\r
271 // Type of service request being tested
\r
272 ServiceRequestType REQUEST_TYPE = ServiceRequestType.DELETE;
\r
274 ClientResponse<Response> res = client.deleteItem(vcsid, itemcsid);
\r
275 int statusCode = res.getStatus();
\r
277 if(!REQUEST_TYPE.isValidStatusCode(statusCode)) {
\r
278 throw new RuntimeException("Could not delete vocabulary item: "
\r
279 + invalidStatusCodeMessage(REQUEST_TYPE, statusCode));
\r
281 if(statusCode != EXPECTED_STATUS_CODE) {
\r
282 throw new RuntimeException("Unexpected Status when deleting " +
\r
283 "vocabulary item, Status:"+ statusCode);
\r
287 private void deleteAllItemsForVocab(String vocabId) {
\r
288 List<String> itemIds = readVocabularyItemIds(readItemsInVocab(vocabId));
\r
289 for (String itemId : itemIds) {
\r
290 deleteVocabularyItem(vocabId, itemId);
\r
294 // ---------------------------------------------------------------
\r
295 // Utility methods used by tests above
\r
296 // ---------------------------------------------------------------
\r
298 private MultipartOutput createVocabularyInstance(
\r
299 String displayName, String refName, String vocabType) {
\r
300 VocabulariesCommon vocabulary = new VocabulariesCommon();
\r
301 vocabulary.setDisplayName(displayName);
\r
302 vocabulary.setRefName(refName);
\r
303 vocabulary.setVocabType(vocabType);
\r
304 MultipartOutput multipart = new MultipartOutput();
\r
305 OutputPart commonPart = multipart.addPart(vocabulary, MediaType.APPLICATION_XML_TYPE);
\r
306 commonPart.getHeaders().add("label", client.getCommonPartName());
\r
308 if(logger.isDebugEnabled()){
\r
309 logger.debug("to be created, vocabulary common ",
\r
310 vocabulary, VocabulariesCommon.class);
\r
316 private MultipartOutput createVocabularyItemInstance(
\r
317 String inVocabulary, String displayName, String refName) {
\r
318 VocabularyitemsCommon vocabularyItem = new VocabularyitemsCommon();
\r
319 vocabularyItem.setInVocabulary(inVocabulary);
\r
320 vocabularyItem.setDisplayName(displayName);
\r
321 vocabularyItem.setRefName(refName);
\r
322 MultipartOutput multipart = new MultipartOutput();
\r
323 OutputPart commonPart = multipart.addPart(vocabularyItem, MediaType.APPLICATION_XML_TYPE);
\r
324 commonPart.getHeaders().add("label", client.getItemCommonPartName());
\r
326 if(logger.isDebugEnabled()){
\r
327 logger.debug("to be created, vocabularyitem common ", vocabularyItem, VocabularyitemsCommon.class);
\r
333 // Retrieve individual fields of vocabulary records.
\r
335 private String displayAllVocabularies(VocabulariesCommonList list) {
\r
336 StringBuffer sb = new StringBuffer();
\r
337 List<VocabulariesCommonList.VocabularyListItem> vocabularies =
\r
338 list.getVocabularyListItem();
\r
340 for (VocabulariesCommonList.VocabularyListItem vocabulary : vocabularies) {
\r
341 sb.append("vocabulary [" + i + "]" + "\n");
\r
342 sb.append(displayVocabularyDetails(vocabulary));
\r
345 return sb.toString();
\r
348 private String displayVocabularyDetails(
\r
349 VocabulariesCommonList.VocabularyListItem vocabulary) {
\r
350 StringBuffer sb = new StringBuffer();
\r
351 sb.append("displayName=" + vocabulary.getDisplayName() + "\n");
\r
352 sb.append("vocabType=" + vocabulary.getVocabType() + "\n");
\r
353 // sb.append("csid=" + vocabulary.getCsid() + "\n");
\r
354 sb.append("URI=" + vocabulary.getUri() + "\n");
\r
355 return sb.toString();
\r
358 // Retrieve individual fields of vocabulary item records.
\r
360 private String displayAllVocabularyItems(VocabularyitemsCommonList list) {
\r
361 StringBuffer sb = new StringBuffer();
\r
362 List<VocabularyitemsCommonList.VocabularyitemListItem> items =
\r
363 list.getVocabularyitemListItem();
\r
365 for (VocabularyitemsCommonList.VocabularyitemListItem item : items) {
\r
366 sb.append("vocabulary item [" + i + "]" + "\n");
\r
367 sb.append(displayVocabularyItemDetails(item));
\r
370 return sb.toString();
\r
373 private String displayVocabularyItemDetails(
\r
374 VocabularyitemsCommonList.VocabularyitemListItem item) {
\r
375 StringBuffer sb = new StringBuffer();
\r
376 sb.append("csid=" + item.getCsid() + "\n");
\r
377 sb.append("displayName=" + item.getDisplayName() + "\n");
\r
378 // sb.append("URI=" + item.getUri() + "\n");
\r
379 return sb.toString();
\r
382 private Object extractPart(MultipartInput input, String label,
\r
383 Class clazz) throws Exception {
\r
385 for(InputPart part : input.getParts()){
\r
386 String partLabel = part.getHeaders().getFirst("label");
\r
387 if(label.equalsIgnoreCase(partLabel)){
\r
388 String partStr = part.getBodyAsString();
\r
389 if(logger.isDebugEnabled()){
\r
390 logger.debug("extracted part str=\n" + partStr);
\r
392 obj = part.getBody(clazz, null);
\r
393 if(logger.isDebugEnabled()){
\r
394 logger.debug("extracted part obj=\n", obj, clazz);
\r
403 * Returns an error message indicating that the status code returned by a
\r
404 * specific call to a service does not fall within a set of valid status
\r
405 * codes for that service.
\r
407 * @param serviceRequestType A type of service request (e.g. CREATE, DELETE).
\r
409 * @param statusCode The invalid status code that was returned in the response,
\r
410 * from submitting that type of request to the service.
\r
412 * @return An error message.
\r
414 protected String invalidStatusCodeMessage(ServiceRequestType requestType, int statusCode) {
\r
415 return "Status code '" + statusCode + "' in response is NOT within the expected set: " +
\r
416 requestType.validStatusCodesAsString();
\r
419 protected String extractId(ClientResponse<Response> res) {
\r
420 MultivaluedMap<String, Object> mvm = res.getMetadata();
\r
421 String uri = (String) ((ArrayList<Object>) mvm.get("Location")).get(0);
\r
422 if(logger.isDebugEnabled()){
\r
423 logger.info("extractId:uri=" + uri);
\r
425 String[] segments = uri.split("/");
\r
426 String id = segments[segments.length - 1];
\r
427 if(logger.isDebugEnabled()){
\r
428 logger.debug("id=" + id);
\r
433 protected String createRefName(String displayName) {
\r
434 return displayName.replaceAll("\\W", "");
\r
437 public static void main(String[] args) {
\r
439 BasicConfigurator.configure();
\r
440 logger.info("VocabularyBaseImport starting...");
\r
442 Sample vbi = new Sample();
\r
444 logger.info("Deleting all vocabulary items and vocabularies ...");
\r
446 // For each vocabulary ...
\r
448 VocabulariesCommonList vocabularies = vbi.readVocabularies();
\r
449 List<String> vocabIds = vbi.readVocabularyIds(vocabularies);
\r
450 for (String vocabId : vocabIds) {
\r
451 // Delete vocabulary items for this vocabulary.
\r
452 logger.info("Deleting vocabulary items ...");
\r
453 vbi.deleteAllItemsForVocab(vocabId);
\r
454 // Delete vocabularies.
\r
455 logger.info("Deleting vocabulary ...");
\r
456 vbi.deleteVocabulary(vocabId);
\r
459 // Read vocabularies after deletion.
\r
460 logger.info("Reading vocabularies after deletion ...");
\r
462 String details = "";
\r
464 vocabularies = vbi.readVocabularies();
\r
465 details = vbi.displayAllVocabularies(vocabularies);
\r
466 logger.info(details);
\r
468 logger.info("Reading items in each vocabulary after deletion ...");
\r
470 // Read items in each vocabulary.
\r
471 vocabIds = vbi.readVocabularyIds(vocabularies);
\r
472 for (String vocabId : vocabIds) {
\r
473 VocabularyitemsCommonList items = vbi.readItemsInVocab(vocabId);
\r
474 details = vbi.displayAllVocabularyItems(items);
\r
475 logger.info(details);
\r
479 // Create new vocabularies, each populated with vocabulary items.
\r
481 final String acquisitionMethodsVocabName = "Acquisition Methods";
\r
482 final String entryMethodsVocabName = "Entry Methods";
\r
483 final String entryReasonsVocabName = "Entry Reasons";
\r
484 final String responsibleDeptsVocabName = "Responsible Departments";
\r
486 List<String> acquisitionMethodsEnumValues =
\r
487 Arrays.asList("Gift","Purchase","Exchange","Transfer","Treasure");
\r
488 List<String> entryMethodsEnumValues =
\r
489 Arrays.asList("In person","Post","Found on doorstep");
\r
490 List<String> entryReasonsEnumValues =
\r
491 Arrays.asList("Enquiry","Commission","Loan");
\r
492 List<String> respDeptNamesEnumValues =
\r
493 Arrays.asList("Antiquities","Architecture and Design","Decorative Arts",
\r
494 "Ethnography","Herpetology","Media and Performance Art",
\r
495 "Paintings and Sculpture","Paleobotany","Photographs",
\r
496 "Prints and Drawings");
\r
498 vbi.createEnumeration(acquisitionMethodsVocabName, acquisitionMethodsEnumValues);
\r
499 vbi.createEnumeration(entryMethodsVocabName, entryMethodsEnumValues);
\r
500 vbi.createEnumeration(entryReasonsVocabName, entryReasonsEnumValues);
\r
501 vbi.createEnumeration(responsibleDeptsVocabName, respDeptNamesEnumValues);
\r
503 logger.info("VocabularyBaseImport complete.");
\r
505 logger.info("Reading newly-created vocabularies ...");
\r
507 // Read vocabularies after import.
\r
508 vocabularies = vbi.readVocabularies();
\r
509 details = vbi.displayAllVocabularies(vocabularies);
\r
510 logger.info(details);
\r
512 logger.info("Reading items in each vocabulary ...");
\r
514 // Read items in each vocabulary after import.
\r
515 vocabIds = vbi.readVocabularyIds(vocabularies);
\r
516 for (String vocabId : vocabIds) {
\r
517 VocabularyitemsCommonList items = vbi.readItemsInVocab(vocabId);
\r
518 details = vbi.displayAllVocabularyItems(items);
\r
519 logger.info(details);
\r