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

   1 /**
   2  *  This document is a part of the source code and related artifacts
   3  *  for CollectionSpace, an open source collections management system
   4  *  for museums and related institutions:
   5
   6  *  http://www.collectionspace.org
   7  *  http://wiki.collectionspace.org
   8
   9  *  Copyright 2009 University of California at Berkeley
  10
  11  *  Licensed under the Educational Community License (ECL), Version 2.0.
  12  *  You may not use this file except in compliance with this License.
  13
  14  *  You may obtain a copy of the ECL 2.0 License at
  15
  16  *  https://source.collectionspace.org/collection-space/LICENSE.txt
  17
  18  *  Unless required by applicable law or agreed to in writing, software
  19  *  distributed under the License is distributed on an "AS IS" BASIS,
  20  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  21  *  See the License for the specific language governing permissions and
  22  *  limitations under the License.
  23  */
  24 package org.collectionspace.services.common.vocabulary.nuxeo;
  25
  26 import org.collectionspace.services.client.AuthorityClient;
  27 import org.collectionspace.services.client.CollectionSpaceClient;
  28 import org.collectionspace.services.client.IQueryManager;
  29 import org.collectionspace.services.client.PoxPayloadIn;
  30 import org.collectionspace.services.client.PoxPayloadOut;
  31 import org.collectionspace.services.common.ResourceMap;
  32 import org.collectionspace.services.common.UriTemplateRegistry;
  33 import org.collectionspace.services.common.api.RefName;
  34 import org.collectionspace.services.common.api.RefNameUtils;
  35 import org.collectionspace.services.common.api.Tools;
  36 import org.collectionspace.services.common.api.RefNameUtils.AuthorityInfo;
  37 import org.collectionspace.services.common.authorityref.AuthorityRefDocList;
  38 import org.collectionspace.services.common.context.MultipartServiceContext;
  39 import org.collectionspace.services.common.context.ServiceContext;
  40 import org.collectionspace.services.common.document.DocumentException;
  41 import org.collectionspace.services.common.document.DocumentFilter;
  42 import org.collectionspace.services.common.document.DocumentNotFoundException;
  43 import org.collectionspace.services.common.document.DocumentWrapper;
  44 import org.collectionspace.services.common.repository.RepositoryClient;
  45 import org.collectionspace.services.common.vocabulary.AuthorityJAXBSchema;
  46 import org.collectionspace.services.common.vocabulary.AuthorityItemJAXBSchema;
  47 import org.collectionspace.services.common.vocabulary.AuthorityResource;
  48 import org.collectionspace.services.common.vocabulary.AuthorityServiceUtils;
  49 import org.collectionspace.services.common.vocabulary.RefNameServiceUtils;
  50 import org.collectionspace.services.common.vocabulary.RefNameServiceUtils.AuthorityItemSpecifier;
  51 import org.collectionspace.services.common.vocabulary.RefNameServiceUtils.Specifier;
  52 import org.collectionspace.services.common.vocabulary.RefNameServiceUtils.SpecifierForm;
  53 import org.collectionspace.services.config.service.ListResultField;
  54 import org.collectionspace.services.config.service.ObjectPartType;
  55 import org.collectionspace.services.lifecycle.TransitionDef;
  56 import org.collectionspace.services.nuxeo.client.java.NuxeoDocumentModelHandler;
  57 import org.collectionspace.services.nuxeo.client.java.CoreSessionInterface;
  58 import org.collectionspace.services.nuxeo.client.java.RepositoryClientImpl;
  59 import org.collectionspace.services.nuxeo.util.NuxeoUtils;
  60 import org.collectionspace.services.relation.RelationsCommonList;
  61 import org.collectionspace.services.vocabulary.VocabularyItemJAXBSchema;
  62 import org.nuxeo.ecm.core.api.ClientException;
  63 import org.nuxeo.ecm.core.api.DocumentModel;
  64 import org.nuxeo.ecm.core.api.model.PropertyException;
  65 import org.slf4j.Logger;
  66 import org.slf4j.LoggerFactory;
  67
  68 import javax.ws.rs.core.MultivaluedMap;
  69
  70 import java.util.ArrayList;
  71 import java.util.Collections;
  72 import java.util.HashMap;
  73 import java.util.List;
  74 import java.util.Map;
  75 import java.util.regex.Matcher;
  76 import java.util.regex.Pattern;
  77 import java.util.regex.PatternSyntaxException;
  78
  79 //import org.collectionspace.services.common.authority.AuthorityItemRelations;
  80 /**
  81  * AuthorityItemDocumentModelHandler
  82  *
  83  * $LastChangedRevision: $
  84  * $LastChangedDate: $
  85  */
  86 public abstract class AuthorityItemDocumentModelHandler<AICommon>
  87         extends NuxeoDocumentModelHandler<AICommon> {
  88
  89     private final Logger logger = LoggerFactory.getLogger(AuthorityItemDocumentModelHandler.class);
  90
  91     protected String authorityCommonSchemaName;
  92     protected String authorityItemCommonSchemaName;
  93     private String authorityItemTermGroupXPathBase;
  94     private boolean shouldUpdateRevNumber = true; // by default we should update the revision number -not true on synchronization with SAS
  95     /**
  96      * inVocabulary is the parent Authority for this context
  97      */
  98     protected String inAuthority = null;
  99     protected boolean wildcardedAuthorityRequest = false;
 100     protected String authorityRefNameBase = null;
 101     // Used to determine when the displayName changes as part of the update.
 102     protected String oldDisplayNameOnUpdate = null;
 103     private final static String LIST_SUFFIX = "List";
 104     private final static String ZERO_OR_MORE_ANY_CHAR_REGEX = ".*";
 105
 106     public AuthorityItemDocumentModelHandler(String authorityCommonSchemaName, String authorityItemCommonSchemaName) {
 107         this.authorityItemCommonSchemaName = authorityItemCommonSchemaName;
 108     }
 109
 110     abstract public String getParentCommonSchemaName();
 111
 112     public boolean getShouldUpdateRevNumber() {
 113         return this.shouldUpdateRevNumber;
 114     }
 115
 116     public void setShouldUpdateRevNumber(boolean flag) {
 117         this.shouldUpdateRevNumber = flag;
 118     }
 119
 120     @Override
 121     public void prepareSync() throws Exception {
 122         this.setShouldUpdateRevNumber(AuthorityServiceUtils.DONT_UPDATE_REV);  // Never update rev nums on sync operations
 123     }
 124
 125     @Override
 126     protected String getRefnameDisplayName(DocumentWrapper<DocumentModel> docWrapper) {
 127         String result = null;
 128
 129         DocumentModel docModel = docWrapper.getWrappedObject();
 130         ServiceContext<PoxPayloadIn, PoxPayloadOut> ctx = this.getServiceContext();
 131         RefName.AuthorityItem refname = (RefName.AuthorityItem)getRefName(ctx, docModel);
 132         result = refname.getDisplayName();
 133
 134         return result;
 135     }
 136
 137     /*
 138      * After calling this method successfully, the document model will contain an updated refname and short ID
 139      * (non-Javadoc)
 140      * @see org.collectionspace.services.nuxeo.client.java.DocumentModelHandler#getRefName(org.collectionspace.services.common.context.ServiceContext, org.nuxeo.ecm.core.api.DocumentModel)
 141      */
 142     @Override
 143     public RefName.RefNameInterface getRefName(ServiceContext ctx,
 144                 DocumentModel docModel) {
 145         RefName.RefNameInterface refname = null;
 146
 147         try {
 148                 String displayName = getPrimaryDisplayName(docModel, authorityItemCommonSchemaName,
 149                     getItemTermInfoGroupXPathBase(), AuthorityItemJAXBSchema.TERM_DISPLAY_NAME);
 150                 if (Tools.isEmpty(displayName)) {
 151                     throw new Exception("The displayName for this authority term was empty or not set.");
 152                 }
 153
 154                 String shortIdentifier = (String) docModel.getProperty(authorityItemCommonSchemaName, AuthorityItemJAXBSchema.SHORT_IDENTIFIER);
 155                 if (Tools.isEmpty(shortIdentifier)) {
 156                         // We didn't find a short ID in the payload request, so we need to synthesize one.
 157                         shortIdentifier = handleDisplayNameAsShortIdentifier(docModel); // updates the document model with the new short ID as a side-effect
 158                 }
 159
 160                 String authorityRefBaseName = getAuthorityRefNameBase();
 161                 if (Tools.isEmpty(authorityRefBaseName)) {
 162                     throw new Exception("Could not create the refName for this authority term, because the refName for its authority parent was empty.");
 163                 }
 164
 165                 // Create the items refname using the parent's as a base
 166                 RefName.Authority parentsRefName = RefName.Authority.parse(authorityRefBaseName);
 167                 refname = RefName.buildAuthorityItem(parentsRefName, shortIdentifier, displayName);
 168                 // Now update the document model with the refname value
 169                 String refNameStr = refname.toString();
 170                 docModel.setProperty(authorityItemCommonSchemaName, AuthorityItemJAXBSchema.REF_NAME, refNameStr); // REM - This field is deprecated now that the refName is part of the collection_space core schema
 171
 172         } catch (Exception e) {
 173                 logger.error(e.getMessage(), e);
 174         }
 175
 176         return refname;
 177     }
 178
 179     public void setInAuthority(String inAuthority) {
 180         this.inAuthority = inAuthority;
 181     }
 182
 183    public String getInAuthority() {
 184         return this.inAuthority;
 185     }
 186
 187     /** Subclasses may override this to customize the URI segment. */
 188     public String getAuthorityServicePath() {
 189         return getServiceContext().getServiceName().toLowerCase();    // Laramie20110510 CSPACE-3932
 190     }
 191
 192     @Override
 193     public String getUri(DocumentModel docModel) {
 194         // Laramie20110510 CSPACE-3932
 195         String authorityServicePath = getAuthorityServicePath();
 196         if(inAuthority==null) { // Only true with the first document model received, on queries to wildcarded authorities
 197             wildcardedAuthorityRequest = true;
 198         }
 199         // If this search crosses multiple authorities, get the inAuthority value
 200         // from each record, rather than using the cached value from the first record
 201         if(wildcardedAuthorityRequest) {
 202                 try {
 203                         inAuthority = (String) docModel.getProperty(authorityItemCommonSchemaName,
 204                         AuthorityItemJAXBSchema.IN_AUTHORITY);
 205                 } catch (ClientException pe) {
 206                         throw new RuntimeException("Could not get parent specifier for item!");
 207                 }
 208         }
 209         return "/" + authorityServicePath + '/' + inAuthority + '/' + AuthorityClient.ITEMS + '/' + getCsid(docModel);
 210     }
 211
 212     protected String getAuthorityRefNameBase() {
 213         return this.authorityRefNameBase;
 214     }
 215
 216     public void setAuthorityRefNameBase(String value) {
 217         this.authorityRefNameBase = value;
 218     }
 219
 220     /*
 221      * Note: the Vocabulary service's VocabularyItemDocumentModelHandler class overrides this method.
 222      */
 223     protected ListResultField getListResultsDisplayNameField() {
 224         ListResultField result = new ListResultField();
 225         // Per CSPACE-5132, the name of this element remains 'displayName'
 226         // for backwards compatibility, although its value is obtained
 227         // from the termDisplayName field.
 228         //
 229         // Update: this name is now being changed to 'termDisplayName', both
 230         // because this is the actual field name and because the app layer
 231         // work to convert over to this field is underway. Per Patrick, the
 232         // app layer treats lists, in at least some context(s), as sparse record
 233         // payloads, and thus fields in list results must all be present in
 234         // (i.e. represent a strict subset of the fields in) record schemas.
 235         // - ADR 2012-05-11
 236         //
 237         //
 238         // In CSPACE-5134, these list results will change substantially
 239         // to return display names for both the preferred term and for
 240         // each non-preferred term (if any).
 241         result.setElement(AuthorityItemJAXBSchema.TERM_DISPLAY_NAME);
 242         result.setXpath(NuxeoUtils.getPrimaryXPathPropertyName(
 243                 authorityItemCommonSchemaName, getItemTermInfoGroupXPathBase(), AuthorityItemJAXBSchema.TERM_DISPLAY_NAME));
 244
 245         return result;
 246     }
 247
 248     /*
 249      * Note: the Vocabulary service's VocabularyItemDocumentModelHandler class overrides this method.
 250      */
 251     protected ListResultField getListResultsTermStatusField() {
 252         ListResultField result = new ListResultField();
 253
 254         result.setElement(AuthorityItemJAXBSchema.TERM_STATUS);
 255         result.setXpath(NuxeoUtils.getPrimaryXPathPropertyName(
 256                 authorityItemCommonSchemaName, getItemTermInfoGroupXPathBase(), AuthorityItemJAXBSchema.TERM_STATUS));
 257
 258         return result;
 259     }
 260
 261     private boolean isTermDisplayName(String elName) {
 262         return AuthorityItemJAXBSchema.TERM_DISPLAY_NAME.equals(elName) || VocabularyItemJAXBSchema.DISPLAY_NAME.equals(elName);
 263     }
 264
 265     /*
 266      * (non-Javadoc)
 267      * @see org.collectionspace.services.nuxeo.client.java.DocHandlerBase#getListItemsArray()
 268      *
 269      * Note: We're updating the "global" service and tenant bindings instance here -the list instance here is
 270      * a reference to the tenant bindings instance in the singleton ServiceMain.
 271      */
 272     @Override
 273     public List<ListResultField> getListItemsArray() throws DocumentException {
 274         List<ListResultField> list = super.getListItemsArray();
 275
 276         // One-time initialization for each authority item service.
 277         if (isListItemArrayExtended() == false) {
 278                 synchronized(AuthorityItemDocumentModelHandler.class) {
 279                         if (isListItemArrayExtended() == false) {
 280                         int nFields = list.size();
 281                         // Ensure that each item in a list of Authority items includes
 282                         // a set of common fields, so we do not depend upon configuration
 283                         // for general logic.
 284                         List<Integer> termDisplayNamePositionsInList = new ArrayList<>();
 285                         boolean hasShortId = false;
 286                         boolean hasTermStatus = false;
 287                         for (int i = 0; i < nFields; i++) {
 288                             ListResultField field = list.get(i);
 289                             String elName = field.getElement();
 290                             if (isTermDisplayName(elName) == true) {
 291                                 termDisplayNamePositionsInList.add(i);
 292                             } else if (AuthorityItemJAXBSchema.SHORT_IDENTIFIER.equals(elName)) {
 293                                 hasShortId = true;
 294                             } else if (AuthorityItemJAXBSchema.TERM_STATUS.equals(elName)) {
 295                                 hasTermStatus = true;
 296                             }
 297                         }
 298
 299                         ListResultField field;
 300
 301                         // Certain fields in authority item list results
 302                         // are handled specially here
 303
 304                         // Term display name
 305                         //
 306                         // Ignore (throw out) any configuration entries that
 307                         // specify how the termDisplayName field should be
 308                         // emitted in authority item lists. This field will
 309                         // be handled in a standardized manner (see block below).
 310                         if (termDisplayNamePositionsInList.isEmpty() == false) {
 311                             // Remove matching items starting at the end of the list
 312                             // and moving towards the start, so that reshuffling of
 313                             // list order doesn't alter the positions of earlier items
 314                             Collections.sort(termDisplayNamePositionsInList, Collections.reverseOrder());
 315                             for (int i : termDisplayNamePositionsInList) {
 316                                 list.remove(i);
 317                             }
 318                         }
 319                         // termDisplayName values in authority item lists
 320                         // will be handled via code that emits display names
 321                         // for both the preferred term and all non-preferred
 322                         // terms (if any). The following is a placeholder
 323                         // entry that will trigger this code. See the
 324                         // getListResultValue() method in this class.
 325                         field = getListResultsDisplayNameField();
 326                         list.add(field);
 327
 328                         // Short identifier
 329                         if (!hasShortId) {
 330                             field = new ListResultField();
 331                             field.setElement(AuthorityItemJAXBSchema.SHORT_IDENTIFIER);
 332                             field.setXpath(AuthorityItemJAXBSchema.SHORT_IDENTIFIER);
 333                             list.add(field);
 334                         }
 335
 336                         // Term status
 337                         if (!hasTermStatus) {
 338                             field = getListResultsTermStatusField();
 339                             list.add(field);
 340                         }
 341
 342                         }
 343
 344                         setListItemArrayExtended(true);
 345                 } // end of synchronized block
 346         }
 347
 348         return list;
 349     }
 350
 351     /**
 352      * We consider workflow state changes as a change that should bump the revision number.
 353      */
 354     @Override
 355     public void handleWorkflowTransition(DocumentWrapper<DocumentModel> wrapDoc, TransitionDef transitionDef) throws Exception {
 356         // Update the revision number
 357         if (this.getShouldUpdateRevNumber() == true) { // We don't update the rev number of synchronization requests
 358                 updateRevNumbers(wrapDoc);
 359         }
 360     }
 361
 362     /**
 363      * This method synchronizes/updates a single authority item resource.
 364      */
 365     @Override
 366     public boolean handleSync(DocumentWrapper<Object> wrapDoc) throws Exception {
 367         boolean result = false;
 368         ServiceContext<PoxPayloadIn, PoxPayloadOut> ctx = getServiceContext();
 369
 370         //
 371         // Get information about the local authority item so we can compare with corresponding item on the shared authority server
 372         //
 373         AuthorityItemSpecifier authorityItemSpecifier = (AuthorityItemSpecifier) wrapDoc.getWrappedObject();
 374         DocumentModel itemDocModel = NuxeoUtils.getDocFromSpecifier(ctx, getRepositorySession(), getAuthorityItemCommonSchemaName(),
 375                         authorityItemSpecifier);
 376         if (itemDocModel == null) {
 377                 throw new DocumentNotFoundException(String.format("Could not find authority item resource with CSID='%s'",
 378                                 authorityItemSpecifier.getItemSpecifier().value));
 379         }
 380         Long localItemRev = (Long) NuxeoUtils.getProperyValue(itemDocModel, AuthorityItemJAXBSchema.REV);
 381         String localItemCsid = itemDocModel.getName();
 382         String localItemWorkflowState = (String) NuxeoUtils.getProperyValue(itemDocModel, CollectionSpaceClient.CORE_WORKFLOWSTATE);
 383         String itemShortId = (String) NuxeoUtils.getProperyValue(itemDocModel, AuthorityItemJAXBSchema.SHORT_IDENTIFIER);
 384
 385         //
 386         // Now get the item's Authority (the parent) information
 387         //
 388         DocumentModel authorityDocModel = NuxeoUtils.getDocFromSpecifier(ctx, getRepositorySession(), authorityCommonSchemaName,
 389                         authorityItemSpecifier.getParentSpecifier());
 390         String authorityShortId = (String) NuxeoUtils.getProperyValue(authorityDocModel, AuthorityJAXBSchema.SHORT_IDENTIFIER);
 391         String localParentCsid = authorityDocModel.getName();
 392         //
 393         // Using the short IDs of the local authority and item, create URN specifiers to retrieve the SAS authority item
 394         //
 395         Specifier sasAuthoritySpecifier = new Specifier(SpecifierForm.URN_NAME, RefNameUtils.createShortIdRefName(authorityShortId));
 396         Specifier sasItemSpecifier = new Specifier(SpecifierForm.URN_NAME, RefNameUtils.createShortIdRefName(itemShortId));
 397         AuthorityItemSpecifier sasAuthorityItemSpecifier = new AuthorityItemSpecifier(sasAuthoritySpecifier, sasItemSpecifier);
 398         // Get the shared authority server's copy
 399         PoxPayloadIn sasPayloadIn = AuthorityServiceUtils.requestPayloadIn(sasAuthorityItemSpecifier,
 400                         getAuthorityServicePath(), getEntityResponseType());
 401         Long sasRev = getRevision(sasPayloadIn);
 402         String sasWorkflowState = getWorkflowState(sasPayloadIn);
 403         //
 404         // If the shared authority item is newer, update our local copy
 405         //
 406         if (sasRev > localItemRev) {
 407                 ResourceMap resourceMap = ctx.getResourceMap();
 408                 String resourceName = this.getAuthorityServicePath();
 409                 AuthorityResource authorityResource = (AuthorityResource) resourceMap.get(resourceName);
 410                 PoxPayloadOut payloadOut = authorityResource.updateAuthorityItem(ctx,
 411                                 resourceMap,
 412                                 ctx.getUriInfo(),
 413                                 localParentCsid,                                // parent's CSID
 414                                 localItemCsid,                                  // item's CSID
 415                                 sasPayloadIn,                                   // the payload from the remote SAS
 416                                 AuthorityServiceUtils.DONT_UPDATE_REV); // don't update the parent's revision number
 417                 if (payloadOut != null) {
 418                         ctx.setOutput(payloadOut);
 419                         result = true;
 420                 }
 421         }
 422         //
 423         // If the workflow states are different, we need to update the local's to reflects the remote's
 424         //
 425         if (localItemWorkflowState.equalsIgnoreCase(sasWorkflowState) == false) {
 426                 ResourceMap resourceMap = ctx.getResourceMap();
 427                 String resourceName = this.getAuthorityServicePath();
 428                 AuthorityResource authorityResource = (AuthorityResource) resourceMap.get(resourceName);
 429                 authorityResource.updateItemWorkflowWithTransition(ctx, localParentCsid, localItemCsid, transition, AuthorityServiceUtils.DONT_UPDATE_REV)
 430         }
 431
 432         return result;
 433     }
 434
 435     /* (non-Javadoc)
 436      * @see org.collectionspace.services.nuxeo.client.java.DocumentModelHandler#handleCreate(org.collectionspace.services.common.document.DocumentWrapper)
 437      */
 438     @Override
 439     public void handleCreate(DocumentWrapper<DocumentModel> wrapDoc) throws Exception {
 440         // first fill all the parts of the document, refname and short ID get set as well
 441         super.handleCreate(wrapDoc);
 442         // Ensure we have required fields set properly
 443         handleInAuthority(wrapDoc.getWrappedObject());
 444     }
 445
 446     /*
 447      * This method gets called after the primary update to an authority item has happened.  If the authority item's refName
 448      * has changed, then we need to updated all the records that use that refname with the new/updated version
 449      *
 450      * (non-Javadoc)
 451      * @see org.collectionspace.services.nuxeo.client.java.RemoteDocumentModelHandlerImpl#completeUpdate(org.collectionspace.services.common.document.DocumentWrapper)
 452      */
 453     public void completeUpdate(DocumentWrapper<DocumentModel> wrapDoc) throws Exception {
 454         // Must call our super class' version first
 455         super.completeUpdate(wrapDoc);
 456
 457         //
 458         // Look for and update authority references with the updated refName
 459         //
 460         if (hasRefNameUpdate() == true) {
 461             // We have work to do.
 462             if (logger.isDebugEnabled()) {
 463                 final String EOL = System.getProperty("line.separator");
 464                 logger.debug("Need to find and update references to authority item." + EOL
 465                         + "   Old refName" + oldRefNameOnUpdate + EOL
 466                         + "   New refName" + newRefNameOnUpdate);
 467             }
 468             ServiceContext<PoxPayloadIn, PoxPayloadOut> ctx = getServiceContext();
 469             RepositoryClient<PoxPayloadIn, PoxPayloadOut> repoClient = getRepositoryClient(ctx);
 470             CoreSessionInterface repoSession = this.getRepositorySession();
 471
 472             // Update all the existing records that have a field with the old refName in it
 473             int nUpdated = RefNameServiceUtils.updateAuthorityRefDocs(ctx, repoClient, repoSession,
 474                     oldRefNameOnUpdate, newRefNameOnUpdate, getRefPropName());
 475
 476             // Finished so log a message.
 477             if (logger.isDebugEnabled()) {
 478                 logger.debug("Updated " + nUpdated + " instances of oldRefName to newRefName");
 479             }
 480         }
 481     }
 482
 483     /*
 484      * Note that the Vocabulary service's document-model for items overrides this method.
 485      */
 486         protected String getPrimaryDisplayName(DocumentModel docModel, String schema,
 487                         String complexPropertyName, String fieldName) {
 488                 String result = null;
 489
 490                 result = getStringValueInPrimaryRepeatingComplexProperty(docModel, schema, complexPropertyName, fieldName);
 491
 492                 return result;
 493         }
 494
 495     /* (non-Javadoc)
 496      * @see org.collectionspace.services.nuxeo.client.java.DocumentModelHandler#handleUpdate(org.collectionspace.services.common.document.DocumentWrapper)
 497      */
 498     @Override
 499     // FIXME: Once we remove the refName field from the authority item schemas, we can remove this override method since our super does everthing for us now.
 500     @Deprecated
 501     public void handleUpdate(DocumentWrapper<DocumentModel> wrapDoc) throws Exception {
 502         // Must call our super's version first, this updates the core schema and the relationship records to deal with possible refName changes/update
 503         super.handleUpdate(wrapDoc);
 504         if (this.hasRefNameUpdate() == true) {
 505                 DocumentModel docModel = wrapDoc.getWrappedObject();
 506             docModel.setProperty(authorityItemCommonSchemaName, AuthorityItemJAXBSchema.REF_NAME, this.newRefNameOnUpdate); // This field is deprecated since it is now a duplicate of what is in the collectionspace_core:refName field
 507         }
 508     }
 509
 510     public void fillAllParts(DocumentWrapper<DocumentModel> wrapDoc, Action action) throws Exception {
 511         super.fillAllParts(wrapDoc, action);
 512         //
 513         // Update the record's revision number on both CREATE and UPDATE actions
 514         //
 515         if (this.getShouldUpdateRevNumber() == true) { // We won't update rev numbers on synchronization with SAS
 516                 updateRevNumbers(wrapDoc);
 517         }
 518     }
 519
 520     /**
 521      * Update the revision number of both the item and the item's parent.
 522      * @param wrapDoc
 523      * @throws Exception
 524      */
 525     protected void updateRevNumbers(DocumentWrapper<DocumentModel> wrapDoc) throws Exception {
 526         DocumentModel documentModel = wrapDoc.getWrappedObject();
 527         Long rev = (Long)documentModel.getProperty(authorityItemCommonSchemaName, AuthorityItemJAXBSchema.REV);
 528         if (rev == null) {
 529                 rev = (long)0;
 530         } else {
 531                 rev++;
 532         }
 533         documentModel.setProperty(authorityItemCommonSchemaName, AuthorityItemJAXBSchema.REV, rev);
 534         //
 535         // Next, update the inAuthority (the parent's) rev number
 536         //
 537         DocumentModel inAuthorityDocModel = NuxeoUtils.getDocFromCsid(getServiceContext(), getRepositorySession(), getInAuthority());
 538         Long parentRev = (Long)inAuthorityDocModel.getProperty(getParentCommonSchemaName(), AuthorityJAXBSchema.REV);
 539         if (parentRev == null) {
 540                 parentRev = new Long(0);
 541         }
 542                 parentRev++;
 543                 inAuthorityDocModel.setProperty(getParentCommonSchemaName(), AuthorityJAXBSchema.REV, parentRev);
 544                 getRepositorySession().saveDocument(inAuthorityDocModel);
 545     }
 546
 547     /**
 548      * If no short identifier was provided in the input payload, generate a
 549      * short identifier from the preferred term display name or term name.
 550      */
 551         private String handleDisplayNameAsShortIdentifier(DocumentModel docModel) throws Exception {
 552                 String result = (String) docModel.getProperty(authorityItemCommonSchemaName,
 553                                 AuthorityItemJAXBSchema.SHORT_IDENTIFIER);
 554
 555                 if (Tools.isEmpty(result)) {
 556                         String termDisplayName = getPrimaryDisplayName(
 557                                         docModel, authorityItemCommonSchemaName,
 558                                         getItemTermInfoGroupXPathBase(),
 559                                         AuthorityItemJAXBSchema.TERM_DISPLAY_NAME);
 560
 561                         String termName = getPrimaryDisplayName(
 562                                         docModel, authorityItemCommonSchemaName,
 563                                         getItemTermInfoGroupXPathBase(),
 564                                         AuthorityItemJAXBSchema.TERM_NAME);
 565
 566                         String generatedShortIdentifier = AuthorityIdentifierUtils.generateShortIdentifierFromDisplayName(termDisplayName,
 567                                                         termName);
 568                         docModel.setProperty(authorityItemCommonSchemaName, AuthorityItemJAXBSchema.SHORT_IDENTIFIER,
 569                                         generatedShortIdentifier);
 570                         result = generatedShortIdentifier;
 571                 }
 572
 573                 return result;
 574         }
 575
 576     /**
 577      * Generate a refName for the authority item from the short identifier
 578      * and display name.
 579      *
 580      * All refNames for authority items are generated.  If a client supplies
 581      * a refName, it will be overwritten during create (per this method)
 582      * or discarded during update (per filterReadOnlyPropertiesForPart).
 583      *
 584      * @see #filterReadOnlyPropertiesForPart(Map<String, Object>, org.collectionspace.services.common.service.ObjectPartType)
 585      *
 586      */
 587     protected String updateRefnameForAuthorityItem(DocumentModel docModel,
 588             String schemaName) throws Exception {
 589         String result = null;
 590
 591         RefName.RefNameInterface refname = getRefName(getServiceContext(), docModel);
 592         String refNameStr = refname.toString();
 593         docModel.setProperty(schemaName, AuthorityItemJAXBSchema.REF_NAME, refNameStr);
 594         result = refNameStr;
 595
 596         return result;
 597     }
 598
 599     /**
 600      * Check the logic around the parent pointer. Note that we only need do this on
 601      * create, since we have logic to make this read-only on update.
 602      *
 603      * @param docModel
 604      *
 605      * @throws Exception the exception
 606      */
 607     private void handleInAuthority(DocumentModel docModel) throws Exception {
 608         if(inAuthority==null) { // Only happens on queries to wildcarded authorities
 609                 throw new IllegalStateException("Trying to Create an object with no inAuthority value!");
 610         }
 611         docModel.setProperty(authorityItemCommonSchemaName,
 612                 AuthorityItemJAXBSchema.IN_AUTHORITY, inAuthority);
 613     }
 614
 615     public AuthorityRefDocList getReferencingObjects(
 616                 ServiceContext<PoxPayloadIn, PoxPayloadOut> ctx,
 617                 UriTemplateRegistry uriTemplateRegistry,
 618                 List<String> serviceTypes,
 619                 String propertyName,
 620             String itemcsid) throws Exception {
 621         AuthorityRefDocList authRefDocList = null;
 622         CoreSessionInterface repoSession = null;
 623         boolean releaseRepoSession = false;
 624
 625         try {
 626                 RepositoryClientImpl repoClient = (RepositoryClientImpl)this.getRepositoryClient(ctx);
 627                 repoSession = this.getRepositorySession();
 628                 if (repoSession == null) {
 629                         repoSession = repoClient.getRepositorySession(ctx);
 630                         releaseRepoSession = true;
 631                 }
 632             DocumentFilter myFilter = getDocumentFilter();
 633
 634                 try {
 635                         DocumentWrapper<DocumentModel> wrapper = repoClient.getDoc(repoSession, ctx, itemcsid);
 636                         DocumentModel docModel = wrapper.getWrappedObject();
 637                         String refName = (String) NuxeoUtils.getProperyValue(docModel, AuthorityItemJAXBSchema.REF_NAME); //docModel.getPropertyValue(AuthorityItemJAXBSchema.REF_NAME);
 638                 authRefDocList = RefNameServiceUtils.getAuthorityRefDocs(
 639                                 repoSession, ctx, uriTemplateRegistry, repoClient,
 640                         serviceTypes,
 641                         refName,
 642                         propertyName,
 643                         myFilter, true /*computeTotal*/);
 644                 } catch (PropertyException pe) {
 645                         throw pe;
 646                 } catch (DocumentException de) {
 647                         throw de;
 648                 } catch (Exception e) {
 649                         if (logger.isDebugEnabled()) {
 650                                 logger.debug("Caught exception ", e);
 651                         }
 652                         throw new DocumentException(e);
 653                 } finally {
 654                         // If we got/aquired a new seesion then we're responsible for releasing it.
 655                         if (releaseRepoSession && repoSession != null) {
 656                                 repoClient.releaseRepositorySession(ctx, repoSession);
 657                         }
 658                 }
 659         } catch (Exception e) {
 660                 if (logger.isDebugEnabled()) {
 661                         logger.debug("Caught exception ", e);
 662                 }
 663                 throw new DocumentException(e);
 664         }
 665
 666         return authRefDocList;
 667     }
 668
 669     /* (non-Javadoc)
 670      * @see org.collectionspace.services.nuxeo.client.java.RemoteDocumentModelHandlerImpl#extractPart(org.nuxeo.ecm.core.api.DocumentModel, java.lang.String, org.collectionspace.services.common.service.ObjectPartType)
 671      */
 672     @Override
 673     protected Map<String, Object> extractPart(DocumentModel docModel, String schema, ObjectPartType partMeta)
 674             throws Exception {
 675         Map<String, Object> unQObjectProperties = super.extractPart(docModel, schema, partMeta);
 676
 677         // Add the CSID to the common part, since they may have fetched via the shortId.
 678         if (partMeta.getLabel().equalsIgnoreCase(authorityItemCommonSchemaName)) {
 679             String csid = getCsid(docModel);//NuxeoUtils.extractId(docModel.getPathAsString());
 680             unQObjectProperties.put("csid", csid);
 681         }
 682
 683         return unQObjectProperties;
 684     }
 685
 686     /**
 687      * Filters out selected values supplied in an update request.
 688      *
 689      * For example, filters out AuthorityItemJAXBSchema.IN_AUTHORITY, to ensure
 690      * that the link to the item's parent remains untouched.
 691      *
 692      * @param objectProps the properties filtered out from the update payload
 693      * @param partMeta metadata for the object to fill
 694      */
 695     @Override
 696     public void filterReadOnlyPropertiesForPart(
 697             Map<String, Object> objectProps, ObjectPartType partMeta) {
 698         super.filterReadOnlyPropertiesForPart(objectProps, partMeta);
 699         String commonPartLabel = getServiceContext().getCommonPartLabel();
 700         if (partMeta.getLabel().equalsIgnoreCase(commonPartLabel)) {
 701             objectProps.remove(AuthorityItemJAXBSchema.IN_AUTHORITY);
 702             objectProps.remove(AuthorityItemJAXBSchema.CSID);
 703             objectProps.remove(AuthorityJAXBSchema.SHORT_IDENTIFIER);
 704             objectProps.remove(AuthorityItemJAXBSchema.REF_NAME);
 705         }
 706     }
 707
 708     /**
 709      * Returns the items in a list of term display names whose names contain
 710      * a partial term (as might be submitted in a search query, for instance).
 711      * @param termDisplayNameList a list of term display names.
 712      * @param partialTerm a partial term display name; that is, a portion
 713      * of a display name that might be expected to match 0-n terms in the list.
 714      * @return a list of term display names that matches the partial term.
 715      * Matches are case-insensitive. As well, before matching is performed, any
 716      * special-purpose characters that may appear in the partial term (such as
 717      * wildcards and anchor characters) are filtered out from both compared terms.
 718      */
 719     protected List<String> getPartialTermDisplayNameMatches(List<String> termDisplayNameList, String partialTerm) {
 720         List<String> result = new ArrayList<>();
 721         String partialTermMatchExpression = filterAnchorAndWildcardChars(partialTerm).toLowerCase();
 722         try {
 723             for (String termDisplayName : termDisplayNameList) {
 724                 if (termDisplayName.toLowerCase()
 725                         .matches(partialTermMatchExpression) == true) {
 726                         result.add(termDisplayName);
 727                 }
 728             }
 729         } catch (PatternSyntaxException pse) {
 730             logger.warn("Error in regex match pattern '%s' for term display names: %s",
 731                     partialTermMatchExpression, pse.getMessage());
 732         }
 733         return result;
 734     }
 735
 736     /**
 737      * Filters user-supplied anchor and wildcard characters in a string,
 738      * replacing them with equivalent regular expressions.
 739      * @param term a term in which to filter anchor and wildcard characters.
 740      * @return the term with those characters filtered.
 741      */
 742     protected String filterAnchorAndWildcardChars(String term) {
 743         if (Tools.isBlank(term)) {
 744             return term;
 745         }
 746         if (term.length() < 3) {
 747             return term;
 748         }
 749         if (logger.isTraceEnabled()) {
 750             logger.trace(String.format("Term = %s", term));
 751         }
 752         Boolean anchorAtStart = false;
 753         Boolean anchorAtEnd = false;
 754         String filteredTerm;
 755         StringBuilder filteredTermBuilder = new StringBuilder(term);
 756         // Term contains no anchor or wildcard characters.
 757         if ( (! term.contains(RepositoryClientImpl.USER_SUPPLIED_ANCHOR_CHAR))
 758                 && (! term.contains(RepositoryClientImpl.USER_SUPPLIED_WILDCARD)) ) {
 759             filteredTerm = term;
 760         } else {
 761             // Term contains at least one such character.
 762             try {
 763                 // Filter the starting anchor or wildcard character, if any.
 764                 String firstChar = filteredTermBuilder.substring(0,1);
 765                 switch (firstChar) {
 766                     case RepositoryClientImpl.USER_SUPPLIED_ANCHOR_CHAR:
 767                         anchorAtStart = true;
 768                         break;
 769                     case RepositoryClientImpl.USER_SUPPLIED_WILDCARD:
 770                         filteredTermBuilder.deleteCharAt(0);
 771                         break;
 772                 }
 773                 if (logger.isTraceEnabled()) {
 774                     logger.trace(String.format("After first char filtering = %s", filteredTermBuilder.toString()));
 775                 }
 776                 // Filter the ending anchor or wildcard character, if any.
 777                 int lastPos = filteredTermBuilder.length() - 1;
 778                 String lastChar = filteredTermBuilder.substring(lastPos);
 779                 switch (lastChar) {
 780                     case RepositoryClientImpl.USER_SUPPLIED_ANCHOR_CHAR:
 781                         filteredTermBuilder.deleteCharAt(lastPos);
 782                         filteredTermBuilder.insert(filteredTermBuilder.length(), RepositoryClientImpl.ENDING_ANCHOR_CHAR);
 783                         anchorAtEnd = true;
 784                         break;
 785                     case RepositoryClientImpl.USER_SUPPLIED_WILDCARD:
 786                         filteredTermBuilder.deleteCharAt(lastPos);
 787                         break;
 788                 }
 789                 if (logger.isTraceEnabled()) {
 790                     logger.trace(String.format("After last char filtering = %s", filteredTermBuilder.toString()));
 791                 }
 792                 filteredTerm = filteredTermBuilder.toString();
 793                 // Filter all other wildcards, if any.
 794                 filteredTerm = filteredTerm.replaceAll(RepositoryClientImpl.USER_SUPPLIED_WILDCARD_REGEX, ZERO_OR_MORE_ANY_CHAR_REGEX);
 795                 if (logger.isTraceEnabled()) {
 796                     logger.trace(String.format("After replacing user wildcards = %s", filteredTerm));
 797                 }
 798             } catch (Exception e) {
 799                 logger.warn(String.format("Error filtering anchor and wildcard characters from string: %s", e.getMessage()));
 800                 return term;
 801             }
 802         }
 803         // Wrap the term in beginning and ending regex wildcards, unless a
 804         // starting or ending anchor character was present.
 805         return (anchorAtStart ? "" : ZERO_OR_MORE_ANY_CHAR_REGEX)
 806                 + filteredTerm
 807                 + (anchorAtEnd ? "" : ZERO_OR_MORE_ANY_CHAR_REGEX);
 808     }
 809
 810     @SuppressWarnings("unchecked")
 811         private List<String> getPartialTermDisplayNameMatches(DocumentModel docModel, // REM - CSPACE-5133
 812                         String schema, ListResultField field, String partialTerm) {
 813         List<String> result = null;
 814
 815         String xpath = field.getXpath(); // results in something like "persons_common:personTermGroupList/[0]/termDisplayName"
 816         int endOfTermGroup = xpath.lastIndexOf("/[0]/");
 817         String propertyName = endOfTermGroup != -1 ? xpath.substring(0, endOfTermGroup) : xpath; // it may not be multivalued so the xpath passed in would be the property name
 818         Object value = null;
 819
 820                 try {
 821                         value = docModel.getProperty(schema, propertyName);
 822                 } catch (Exception e) {
 823                         logger.error("Could not extract term display name with property = "
 824                                         + propertyName, e);
 825                 }
 826
 827                 if (value != null && value instanceof ArrayList) {
 828                         ArrayList<HashMap<String, Object>> termGroupList = (ArrayList<HashMap<String, Object>>)value;
 829                         int arrayListSize = termGroupList.size();
 830                         if (arrayListSize > 1) { // if there's only 1 element in the list then we've already matched the primary term's display name
 831                                 List<String> displayNameList = new ArrayList<String>();
 832                                 for (int i = 1; i < arrayListSize; i++) { // start at 1, skip the primary term's displayName since we will always return it
 833                                         HashMap<String, Object> map = (HashMap<String, Object>)termGroupList.get(i);
 834                                         String termDisplayName = (String) map.get(AuthorityItemJAXBSchema.TERM_DISPLAY_NAME);
 835                                         displayNameList.add(i - 1, termDisplayName);
 836                                 }
 837
 838                                 result = getPartialTermDisplayNameMatches(displayNameList, partialTerm);
 839                         }
 840                 }
 841
 842         return result;
 843     }
 844
 845     @Override
 846         protected Object getListResultValue(DocumentModel docModel, // REM - CSPACE-5133
 847                         String schema, ListResultField field) throws DocumentException {
 848                 Object result = null;
 849
 850                 result = NuxeoUtils.getXPathValue(docModel, schema, field.getXpath());
 851
 852                 //
 853                 // Special handling of list item values for authority items (only)
 854                 // takes place here:
 855                 //
 856                 // If the list result field is the termDisplayName element,
 857                 // check whether a partial term matching query was made.
 858                 // If it was, emit values for both the preferred (aka primary)
 859                 // term and for all non-preferred terms, if any.
 860                 //
 861                 String elName = field.getElement();
 862                 if (isTermDisplayName(elName) == true) {
 863                         MultivaluedMap<String, String> queryParams = this.getServiceContext().getQueryParams();
 864                 String partialTerm = queryParams != null ? queryParams.getFirst(IQueryManager.SEARCH_TYPE_PARTIALTERM) : null;
 865                 if (partialTerm != null && partialTerm.trim().isEmpty() == false) {
 866                                 String primaryTermDisplayName = (String)result;
 867                         List<String> matches = getPartialTermDisplayNameMatches(docModel, schema, field, partialTerm);
 868                         if (matches != null && matches.isEmpty() == false) {
 869                                 matches.add(0, primaryTermDisplayName); // insert the primary term's display name at the beginning of the list
 870                                 result = matches; // set the result to a list of matching term display names with the primary term's display name at the beginning
 871                         }
 872                 }
 873                 }
 874
 875                 return result;
 876         }
 877
 878     @Override
 879     public void extractAllParts(DocumentWrapper<DocumentModel> wrapDoc) throws Exception {
 880         MultipartServiceContext ctx = (MultipartServiceContext) getServiceContext();
 881         super.extractAllParts(wrapDoc);
 882     }
 883
 884     protected List<RelationsCommonList.RelationListItem> cloneList(List<RelationsCommonList.RelationListItem> inboundList) {
 885         List<RelationsCommonList.RelationListItem> result = newRelationsCommonList();
 886         for (RelationsCommonList.RelationListItem item : inboundList) {
 887             result.add(item);
 888         }
 889         return result;
 890     }
 891
 892
 893     /* don't even THINK of re-using this method.
 894      * String example_uri = "/locationauthorities/7ec60f01-84ab-4908-9a6a/items/a5466530-713f-43b4-bc05";
 895      */
 896     @Deprecated
 897     private String extractInAuthorityCSID(String uri) {
 898         String IN_AUTHORITY_REGEX = "/(.*?)/(.*?)/(.*)";
 899         Pattern p = Pattern.compile(IN_AUTHORITY_REGEX);
 900         Matcher m = p.matcher(uri);
 901         if (m.find()) {
 902             if (m.groupCount() < 3) {
 903                 logger.warn("REGEX-WRONG-GROUPCOUNT looking in " + uri);
 904                 return "";
 905             } else {
 906                 //String service = m.group(1);
 907                 String inauth = m.group(2);
 908                 //String theRest = m.group(3);
 909                 return inauth;
 910                 //print("service:"+service+", inauth:"+inauth+", rest:"+rest);
 911             }
 912         } else {
 913             logger.warn("REGEX-NOT-MATCHED looking in " + uri);
 914             return "";
 915         }
 916     }
 917
 918     //ensures CSPACE-4042
 919     protected void uriPointsToSameAuthority(String thisURI, String inboundItemURI) throws Exception {
 920         String authorityCSID = extractInAuthorityCSID(thisURI);
 921         String authorityCSIDForInbound = extractInAuthorityCSID(inboundItemURI);
 922         if (Tools.isBlank(authorityCSID)
 923                 || Tools.isBlank(authorityCSIDForInbound)
 924                 || (!authorityCSID.equalsIgnoreCase(authorityCSIDForInbound))) {
 925             throw new Exception("Item URI " + thisURI + " must point to same authority as related item: " + inboundItemURI);
 926         }
 927     }
 928
 929     public String getItemTermInfoGroupXPathBase() {
 930         return authorityItemTermGroupXPathBase;
 931     }
 932
 933     public void setItemTermInfoGroupXPathBase(String itemTermInfoGroupXPathBase) {
 934         authorityItemTermGroupXPathBase = itemTermInfoGroupXPathBase;
 935     }
 936
 937     protected String getAuthorityItemCommonSchemaName() {
 938         return authorityItemCommonSchemaName;
 939     }
 940
 941     // @Override
 942     public boolean isJDBCQuery() {
 943         boolean result = false;
 944
 945         MultivaluedMap<String, String> queryParams = getServiceContext().getQueryParams();
 946         //
 947         // Look the query params to see if we need to make a SQL query.
 948         //
 949         String partialTerm = queryParams.getFirst(IQueryManager.SEARCH_TYPE_PARTIALTERM);
 950         if (partialTerm != null && partialTerm.trim().isEmpty() == false) {
 951                 result = true;
 952         }
 953
 954         return result;
 955     }
 956
 957     // By convention, the name of the database table that contains
 958     // repeatable term information group records is derivable from
 959     // an existing XPath base value, by removing a suffix and converting
 960     // to lowercase
 961     protected String getTermGroupTableName() {
 962         String termInfoGroupListName = getItemTermInfoGroupXPathBase();
 963         return termInfoGroupListName.substring(0, termInfoGroupListName.lastIndexOf(LIST_SUFFIX)).toLowerCase();
 964     }
 965
 966     protected String getInAuthorityValue() {
 967         String inAuthorityValue = getInAuthority();
 968         if (Tools.notBlank(inAuthorityValue)) {
 969             return inAuthorityValue;
 970         } else {
 971             return AuthorityResource.PARENT_WILDCARD;
 972         }
 973     }
 974
 975     @Override
 976     public Map<String,String> getJDBCQueryParams() {
 977         // FIXME: Get all of the following values from appropriate external constants.
 978         // At present, these are duplicated in both RepositoryClientImpl
 979         // and in AuthorityItemDocumentModelHandler.
 980         final String TERM_GROUP_LIST_NAME = "TERM_GROUP_LIST_NAME";
 981         final String TERM_GROUP_TABLE_NAME_PARAM = "TERM_GROUP_TABLE_NAME";
 982         final String IN_AUTHORITY_PARAM = "IN_AUTHORITY";
 983
 984         Map<String,String> params = super.getJDBCQueryParams();
 985         params.put(TERM_GROUP_LIST_NAME, getItemTermInfoGroupXPathBase());
 986         params.put(TERM_GROUP_TABLE_NAME_PARAM, getTermGroupTableName());
 987         params.put(IN_AUTHORITY_PARAM, getInAuthorityValue());
 988         return params;
 989     }
 990
 991 }