git.aero2k.de Git - tmp/jakarta-migration.git/blob

   1 /**     \r
   2  * PersonAuthorityClientUtils.java\r
   3  *\r
   4  * {Purpose of This Class}\r
   5  *\r
   6  * {Other Notes Relating to This Class (Optional)}\r
   7  *\r
   8  * $LastChangedBy: $\r
   9  * $LastChangedRevision: $\r
  10  * $LastChangedDate: $\r
  11  *\r
  12  * This document is a part of the source code and related artifacts\r
  13  * for CollectionSpace, an open source collections management system\r
  14  * for museums and related institutions:\r
  15  *\r
  16  * http://www.collectionspace.org\r
  17  * http://wiki.collectionspace.org\r
  18  *\r
  19  * Copyright © 2009 {Contributing Institution}\r
  20  *\r
  21  * Licensed under the Educational Community License (ECL), Version 2.0.\r
  22  * You may not use this file except in compliance with this License.\r
  23  *\r
  24  * You may obtain a copy of the ECL 2.0 License at\r
  25  * https://source.collectionspace.org/collection-space/LICENSE.txt\r
  26  */\r
  27 package org.collectionspace.services.client;\r
  28 \r
  29 import java.util.ArrayList;\r
  30 import java.util.Arrays;\r
  31 import java.util.HashMap;\r
  32 import java.util.List;\r
  33 import java.util.Map;\r
  34 \r
  35 import javax.ws.rs.core.MediaType;\r
  36 import javax.ws.rs.core.MultivaluedMap;\r
  37 import javax.ws.rs.core.Response;\r
  38 \r
  39 import org.collectionspace.services.PersonJAXBSchema;\r
  40 import org.collectionspace.services.client.test.ServiceRequestType;\r
  41 import org.collectionspace.services.person.GroupList;\r
  42 import org.collectionspace.services.person.NationalityList;\r
  43 import org.collectionspace.services.person.OccupationList;\r
  44 import org.collectionspace.services.person.PersonTermGroup;\r
  45 import org.collectionspace.services.person.PersonTermGroupList;\r
  46 import org.collectionspace.services.person.PersonsCommon;\r
  47 import org.collectionspace.services.person.PersonauthoritiesCommon;\r
  48 import org.collectionspace.services.person.SchoolOrStyleList;\r
  49 import org.jboss.resteasy.client.ClientResponse;\r
  50 //import org.jboss.resteasy.plugins.providers.multipart.OutputPart;\r
  51 import org.slf4j.Logger;\r
  52 import org.slf4j.LoggerFactory;\r
  53 \r
  54 /**\r
  55  * The Class PersonAuthorityClientUtils.\r
  56  */\r
  57 public class PersonAuthorityClientUtils {\r
  58     \r
  59     /** The Constant logger. */\r
  60     private static final Logger logger =\r
  61         LoggerFactory.getLogger(PersonAuthorityClientUtils.class);\r
  62         private static final ServiceRequestType READ_REQ = ServiceRequestType.READ;\r
  63 \r
  64     /**\r
  65      * @param csid the id of the PersonAuthority\r
  66      * @param client if null, creates a new client\r
  67      * @return\r
  68      */\r
  69     public static String getAuthorityRefName(String csid, PersonAuthorityClient client){\r
  70         if (client == null) {\r
  71                 client = new PersonAuthorityClient();\r
  72         }\r
  73         ClientResponse<String> res = client.read(csid);\r
  74         try {\r
  75                 int statusCode = res.getStatus();\r
  76                 if(!READ_REQ.isValidStatusCode(statusCode)\r
  77                         ||(statusCode != CollectionSpaceClientUtils.STATUS_OK)) {\r
  78                         throw new RuntimeException("Invalid status code returned: "+statusCode);\r
  79                 }\r
  80                 //FIXME: remove the following try catch once Aron fixes signatures\r
  81                 try {\r
  82                     PoxPayloadIn input = new PoxPayloadIn(res.getEntity());\r
  83                     PersonauthoritiesCommon personAuthority = \r
  84                         (PersonauthoritiesCommon) CollectionSpaceClientUtils.extractPart(input,\r
  85                             client.getCommonPartName(), PersonauthoritiesCommon.class);\r
  86                         if(personAuthority == null) {\r
  87                                 throw new RuntimeException("Null personAuthority returned from service.");\r
  88                         }\r
  89                     return personAuthority.getRefName();\r
  90                 } catch (Exception e) {\r
  91                     throw new RuntimeException(e);\r
  92                 }\r
  93         } finally {\r
  94                 res.releaseConnection();\r
  95         }\r
  96     }\r
  97 \r
  98     /**\r
  99      * @param csid the id of the PersonAuthority\r
 100      * @param client if null, creates a new client\r
 101      * @return\r
 102      */\r
 103     public static String getPersonRefName(String inAuthority, String csid, PersonAuthorityClient client){\r
 104         if ( client == null) {\r
 105                 client = new PersonAuthorityClient();\r
 106         }\r
 107         ClientResponse<String> res = client.readItem(inAuthority, csid);\r
 108         try {\r
 109                 int statusCode = res.getStatus();\r
 110                 if(!READ_REQ.isValidStatusCode(statusCode)\r
 111                                 ||(statusCode != CollectionSpaceClientUtils.STATUS_OK)) {\r
 112                         throw new RuntimeException("Invalid status code returned: "+statusCode);\r
 113                 }\r
 114                 //FIXME: remove the following try catch once Aron fixes signatures\r
 115                 try {\r
 116                     PoxPayloadIn input = new PoxPayloadIn(res.getEntity());\r
 117                     PersonsCommon person = \r
 118                         (PersonsCommon) CollectionSpaceClientUtils.extractPart(input,\r
 119                             client.getItemCommonPartName(), PersonsCommon.class);\r
 120                         if (person == null) {\r
 121                                 throw new RuntimeException("Null person returned from service.");\r
 122                         }\r
 123                     return person.getRefName();\r
 124                 } catch (Exception e) {\r
 125                     throw new RuntimeException(e);\r
 126                 }\r
 127         } finally {\r
 128                 res.releaseConnection();\r
 129         }\r
 130     }\r
 131 \r
 132     /**\r
 133      * Creates the person authority instance.\r
 134      *\r
 135      * @param displayName the display name\r
 136      * @param shortIdentifier the short Id \r
 137      * @param headerLabel the header label\r
 138      * @return the multipart output\r
 139      */\r
 140     public static PoxPayloadOut createPersonAuthorityInstance(\r
 141                 String displayName, String shortIdentifier, String headerLabel ) {\r
 142         PersonauthoritiesCommon personAuthority = new PersonauthoritiesCommon();\r
 143         personAuthority.setDisplayName(displayName);\r
 144         personAuthority.setShortIdentifier(shortIdentifier);\r
 145         //String refName = createPersonAuthRefName(shortIdentifier, displayName);\r
 146         //personAuthority.setRefName(refName);\r
 147         personAuthority.setVocabType("PersonAuthority");\r
 148         PoxPayloadOut multipart = new PoxPayloadOut(PersonAuthorityClient.SERVICE_PAYLOAD_NAME);\r
 149         PayloadOutputPart commonPart = multipart.addPart(personAuthority, MediaType.APPLICATION_XML_TYPE);\r
 150         commonPart.setLabel(headerLabel);\r
 151 \r
 152         if(logger.isDebugEnabled()){\r
 153                 logger.debug("to be created, personAuthority common ", \r
 154                                         personAuthority, PersonauthoritiesCommon.class);\r
 155         }\r
 156 \r
 157         return multipart;\r
 158     }\r
 159 \r
 160     /**\r
 161      * Creates a person instance.\r
 162      *\r
 163      * @param inAuthority the owning authority\r
 164      * @param personAuthRefName the owning Authority ref name\r
 165      * @param personInfo the person info\r
 166      * @param headerLabel the header label\r
 167      * @return the multipart output\r
 168      */\r
 169     public static PoxPayloadOut createPersonInstance(String inAuthority,\r
 170                 String personAuthRefName,\r
 171                 Map<String, String> personInfo,\r
 172                 List<PersonTermGroup> terms,\r
 173                 String headerLabel){\r
 174         final Map<String, List<String>> EMPTY_PERSON_REPEATABLES_INFO =\r
 175                 new HashMap<String, List<String>>();\r
 176         return createPersonInstance(inAuthority, null /*personAuthRefName*/,\r
 177                 personInfo, terms, EMPTY_PERSON_REPEATABLES_INFO, headerLabel);\r
 178     }\r
 179 \r
 180     /**\r
 181      * Creates a person instance.\r
 182      *\r
 183      * @param inAuthority the owning authority\r
 184      * @param personAuthRefName the owning Authority ref name\r
 185      * @param personInfo the person info\r
 186      * @param terms a list of Person terms\r
 187      * @param personRepeatablesInfo names and values of repeatable scalar fields in the Person record\r
 188      * @param headerLabel the header label\r
 189      * @return the multipart output\r
 190      */\r
 191     public static PoxPayloadOut createPersonInstance(String inAuthority, \r
 192                 String personAuthRefName, Map<String, String> personInfo,\r
 193                 List<PersonTermGroup> terms,\r
 194                 Map<String, List<String>> personRepeatablesInfo, String headerLabel){\r
 195         PersonsCommon person = new PersonsCommon();\r
 196         person.setInAuthority(inAuthority);\r
 197         String shortId = personInfo.get(PersonJAXBSchema.SHORT_IDENTIFIER);\r
 198         if (shortId == null || shortId.isEmpty()) {\r
 199                 throw new IllegalArgumentException("shortIdentifier cannot be null or empty");\r
 200         }       \r
 201         person.setShortIdentifier(shortId);\r
 202         \r
 203         String value;\r
 204         List<String> values = null;\r
 205 \r
 206         if((value = (String)personInfo.get(PersonJAXBSchema.BIRTH_DATE))!=null)\r
 207                 person.setBirthDate(value);\r
 208         if((value = (String)personInfo.get(PersonJAXBSchema.DEATH_DATE))!=null)\r
 209                 person.setDeathDate(value);\r
 210         if((value = (String)personInfo.get(PersonJAXBSchema.BIRTH_PLACE))!=null)\r
 211                 person.setBirthPlace(value);\r
 212         if((value = (String)personInfo.get(PersonJAXBSchema.DEATH_PLACE))!=null)\r
 213                 person.setDeathPlace(value);\r
 214         if((value = (String)personInfo.get(PersonJAXBSchema.GENDER))!=null)\r
 215                 person.setGender(value);\r
 216          if((value = (String)personInfo.get(PersonJAXBSchema.BIO_NOTE))!=null)\r
 217                 person.setBioNote(value);\r
 218         if((value = (String)personInfo.get(PersonJAXBSchema.NAME_NOTE))!=null)\r
 219                 person.setNameNote(value);\r
 220         \r
 221         // Set values in the Term Information Group\r
 222         PersonTermGroupList termList = person.getPersonTermGroupList();\r
 223         List<PersonTermGroup> existingTerms = termList.getPersonTermGroup();\r
 224         existingTerms = terms;\r
 225         \r
 226         if (personRepeatablesInfo != null) {\r
 227             if((values = (List<String>)personRepeatablesInfo.get(PersonJAXBSchema.GROUPS))!=null) {\r
 228                     GroupList groupsList = new GroupList();\r
 229                     List<String> groups = groupsList.getGroup();\r
 230                     groups.addAll(values);\r
 231                     person.setGroups(groupsList);\r
 232             }\r
 233             if((values = (List<String>)personRepeatablesInfo.get(PersonJAXBSchema.NATIONALITIES))!=null) {\r
 234                     NationalityList nationalitiesList = new NationalityList();\r
 235                     List<String> nationalities = nationalitiesList.getNationality();\r
 236                     nationalities.addAll(values);\r
 237                     person.setNationalities(nationalitiesList);\r
 238             }\r
 239 \r
 240             if((values = (List<String>)personRepeatablesInfo.get(PersonJAXBSchema.OCCUPATIONS))!=null) {\r
 241                     OccupationList occupationsList = new OccupationList();\r
 242                     List<String> occupations = occupationsList.getOccupation();\r
 243                     occupations.addAll(values);\r
 244                     person.setOccupations(occupationsList);\r
 245             }\r
 246             if((values = (List<String>)personRepeatablesInfo.get(PersonJAXBSchema.SCHOOLS_OR_STYLES))!=null) {\r
 247                     SchoolOrStyleList schoolOrStyleList = new SchoolOrStyleList();\r
 248                     List<String> schoolsOrStyles = schoolOrStyleList.getSchoolOrStyle();\r
 249                     schoolsOrStyles.addAll(values);\r
 250                     person.setSchoolsOrStyles(schoolOrStyleList);\r
 251             }        \r
 252         }\r
 253 \r
 254         \r
 255         PoxPayloadOut multipart = new PoxPayloadOut(PersonAuthorityClient.SERVICE_ITEM_PAYLOAD_NAME);\r
 256         PayloadOutputPart commonPart = multipart.addPart(person,\r
 257             MediaType.APPLICATION_XML_TYPE);\r
 258         commonPart.setLabel(headerLabel);\r
 259 \r
 260         if(logger.isDebugEnabled()){\r
 261                 logger.debug("to be created, person common ", person, PersonsCommon.class);\r
 262         }\r
 263 \r
 264         return multipart;\r
 265     }\r
 266     \r
 267     /**\r
 268      * Creates the item in authority.\r
 269      *\r
 270      * @param vcsid the vcsid\r
 271      * @param personAuthorityRefName the person authority ref name\r
 272      * @param personMap the person map. PersonJAXBSchema.SHORT_IDENTIFIER is REQUIRED.\r
 273      * @param client the client\r
 274      * @return the string\r
 275      */\r
 276     public static String createItemInAuthority(String vcsid, \r
 277                 String personAuthorityRefName, Map<String,String> personMap,\r
 278                 List<PersonTermGroup> terms, Map<String, List<String>> personRepeatablesMap,\r
 279                 PersonAuthorityClient client ) {\r
 280         // Expected status code: 201 Created\r
 281         int EXPECTED_STATUS_CODE = Response.Status.CREATED.getStatusCode();\r
 282         // Type of service request being tested\r
 283         ServiceRequestType REQUEST_TYPE = ServiceRequestType.CREATE;\r
 284         \r
 285         String displayName = "";\r
 286         if (terms !=null && terms.size() > 0) {\r
 287             displayName = terms.get(0).getDisplayName();\r
 288         }\r
 289         \r
 290         if(logger.isDebugEnabled()){\r
 291                 logger.debug("Creating item with display name: \"" + displayName\r
 292                                 +"\" in personAuthority: \"" + vcsid +"\"");\r
 293         }\r
 294         PoxPayloadOut multipart = \r
 295                 createPersonInstance(vcsid, null /*personAuthorityRefName*/,\r
 296                         personMap, terms, personRepeatablesMap, client.getItemCommonPartName());\r
 297         \r
 298         String result = null;\r
 299         ClientResponse<Response> res = client.createItem(vcsid, multipart);\r
 300         try {\r
 301                 int statusCode = res.getStatus();\r
 302         \r
 303                 if(!REQUEST_TYPE.isValidStatusCode(statusCode)) {\r
 304                         throw new RuntimeException("Could not create Item: \""+personMap.get(PersonJAXBSchema.SHORT_IDENTIFIER)\r
 305                                         +"\" in personAuthority: \"" + vcsid //personAuthorityRefName\r
 306                                         +"\" "+ invalidStatusCodeMessage(REQUEST_TYPE, statusCode));\r
 307                 }\r
 308                 if(statusCode != EXPECTED_STATUS_CODE) {\r
 309                         throw new RuntimeException("Unexpected Status when creating Item: \""+personMap.get(PersonJAXBSchema.SHORT_IDENTIFIER)\r
 310                                         +"\" in personAuthority: \"" + vcsid /*personAuthorityRefName*/ +"\", Status:"+ statusCode);\r
 311                 }\r
 312         \r
 313                 result = extractId(res);\r
 314         } finally {\r
 315                 res.releaseConnection();\r
 316         }\r
 317         \r
 318         return result;\r
 319     }\r
 320 \r
 321     /**\r
 322      * Creates the personAuthority ref name.\r
 323      *\r
 324      * @param shortId the personAuthority shortIdentifier\r
 325      * @param displaySuffix displayName to be appended, if non-null\r
 326      * @return the string\r
 327      */\r
 328     /*\r
 329     public static String createPersonAuthRefName(String shortId, String displaySuffix) {\r
 330         String refName = "urn:cspace:org.collectionspace.demo:personauthority:name("\r
 331                         +shortId+")";\r
 332         if(displaySuffix!=null&&!displaySuffix.isEmpty())\r
 333                 refName += "'"+displaySuffix+"'";\r
 334         return refName;\r
 335     }\r
 336     */\r
 337 \r
 338     /**\r
 339      * Creates the person ref name.\r
 340      *\r
 341      * @param personAuthRefName the person auth ref name\r
 342      * @param shortId the person shortIdentifier\r
 343      * @param displaySuffix displayName to be appended, if non-null\r
 344      * @return the string\r
 345      */\r
 346     /*\r
 347     public static String createPersonRefName(\r
 348                                                 String personAuthRefName, String shortId, String displaySuffix) {\r
 349         String refName = personAuthRefName+":person:name("+shortId+")";\r
 350         if(displaySuffix!=null&&!displaySuffix.isEmpty())\r
 351                 refName += "'"+displaySuffix+"'";\r
 352         return refName;\r
 353     }\r
 354     */\r
 355 \r
 356     /**\r
 357      * Extract id.\r
 358      *\r
 359      * @param res the res\r
 360      * @return the string\r
 361      */\r
 362     public static String extractId(ClientResponse<Response> res) {\r
 363         MultivaluedMap<String, Object> mvm = res.getMetadata();\r
 364         // FIXME: This may throw an NPE if the Location: header isn't present\r
 365         String uri = (String) ((ArrayList<Object>) mvm.get("Location")).get(0);\r
 366         if(logger.isDebugEnabled()){\r
 367                 logger.debug("extractId:uri=" + uri);\r
 368         }\r
 369         String[] segments = uri.split("/");\r
 370         String id = segments[segments.length - 1];\r
 371         if(logger.isDebugEnabled()){\r
 372                 logger.debug("id=" + id);\r
 373         }\r
 374         return id;\r
 375     }\r
 376     \r
 377     /**\r
 378      * Returns an error message indicating that the status code returned by a\r
 379      * specific call to a service does not fall within a set of valid status\r
 380      * codes for that service.\r
 381      *\r
 382      * @param serviceRequestType  A type of service request (e.g. CREATE, DELETE).\r
 383      *\r
 384      * @param statusCode  The invalid status code that was returned in the response,\r
 385      *                    from submitting that type of request to the service.\r
 386      *\r
 387      * @return An error message.\r
 388      */\r
 389     public static String invalidStatusCodeMessage(ServiceRequestType requestType, int statusCode) {\r
 390         return "Status code '" + statusCode + "' in response is NOT within the expected set: " +\r
 391                 requestType.validStatusCodesAsString();\r
 392     }\r
 393 \r
 394 \r
 395     \r
 396     /**\r
 397      * Produces a default displayName from the basic name and dates fields.\r
 398      * @see PersonDocumentModelHandler.prepareDefaultDisplayName() which\r
 399      * duplicates this logic, until we define a service-general utils package\r
 400      * that is neither client nor service specific.\r
 401      * @param foreName  \r
 402      * @param middleName\r
 403      * @param surName\r
 404      * @param birthDate\r
 405      * @param deathDate\r
 406      * @return display name\r
 407      */\r
 408     public static String prepareDefaultDisplayName(\r
 409                 String foreName, String middleName, String surName,\r
 410                 String birthDate, String deathDate ) {\r
 411         StringBuilder newStr = new StringBuilder();\r
 412                 final String sep = " ";\r
 413                 final String dateSep = "-";\r
 414                 List<String> nameStrings = \r
 415                         Arrays.asList(foreName, middleName, surName);\r
 416                 boolean firstAdded = false;\r
 417         for(String partStr : nameStrings ){\r
 418                         if(null != partStr ) {\r
 419                                 if(firstAdded) {\r
 420                                         newStr.append(sep);\r
 421                                 }\r
 422                                 newStr.append(partStr);\r
 423                                 firstAdded = true;\r
 424                         }\r
 425         }\r
 426         // Now we add the dates. In theory could have dates with no name, but that is their problem.\r
 427         boolean foundBirth = false;\r
 428                 if(null != birthDate) {\r
 429                         if(firstAdded) {\r
 430                                 newStr.append(sep);\r
 431                         }\r
 432                         newStr.append(birthDate);\r
 433                 newStr.append(dateSep);         // Put this in whether there is a death date or not\r
 434                         foundBirth = true;\r
 435                 }\r
 436                 if(null != deathDate) {\r
 437                         if(!foundBirth) {\r
 438                                 if(firstAdded) {\r
 439                                         newStr.append(sep);\r
 440                                 }\r
 441                         newStr.append(dateSep);\r
 442                         }\r
 443                         newStr.append(deathDate);\r
 444                 }\r
 445                 return newStr.toString();\r
 446     }\r
 447     \r
 448 \r
 449 \r
 450 }\r