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.nuxeo.client.java;
  25
  26 import java.util.ArrayList;
  27 import java.util.HashMap;
  28 import java.util.List;
  29 import java.util.Map;
  30 import java.util.Map.Entry;
  31 import java.util.Set;
  32
  33 import javax.ws.rs.core.MediaType;
  34 import javax.ws.rs.core.MultivaluedMap;
  35 import javax.ws.rs.core.Response;
  36 import javax.ws.rs.core.UriInfo;
  37 import javax.xml.bind.JAXBElement;
  38
  39 import org.collectionspace.authentication.spi.AuthNContext;
  40 import org.collectionspace.services.authorization.AccountPermission;
  41 import org.collectionspace.services.jaxb.AbstractCommonList;
  42 import org.collectionspace.services.lifecycle.TransitionDef;
  43 import org.collectionspace.services.client.CollectionSpaceClient;
  44 import org.collectionspace.services.client.PayloadInputPart;
  45 import org.collectionspace.services.client.PayloadOutputPart;
  46 import org.collectionspace.services.client.PoxPayloadIn;
  47 import org.collectionspace.services.client.PoxPayloadOut;
  48 import org.collectionspace.services.client.Profiler;
  49 import org.collectionspace.services.client.RelationClient;
  50 import org.collectionspace.services.client.workflow.WorkflowClient;
  51 import org.collectionspace.services.common.CSWebApplicationException;
  52 import org.collectionspace.services.common.NuxeoBasedResource;
  53 import org.collectionspace.services.common.authorityref.AuthorityRefList;
  54 import org.collectionspace.services.common.config.ServiceConfigUtils;
  55 import org.collectionspace.services.common.context.JaxRsContext;
  56 import org.collectionspace.services.common.context.MultipartServiceContext;
  57 import org.collectionspace.services.common.context.ServiceBindingUtils;
  58 import org.collectionspace.services.common.context.ServiceContext;
  59 import org.collectionspace.services.common.document.BadRequestException;
  60 import org.collectionspace.services.common.document.DocumentException;
  61 import org.collectionspace.services.common.document.DocumentUtils;
  62 import org.collectionspace.services.common.document.DocumentWrapper;
  63 import org.collectionspace.services.common.document.DocumentFilter;
  64 import org.collectionspace.services.client.IRelationsManager;
  65 import org.collectionspace.services.common.relation.RelationResource;
  66 import org.collectionspace.services.common.repository.RepositoryClient;
  67 import org.collectionspace.services.common.security.SecurityUtils;
  68 import org.collectionspace.services.common.storage.jpa.JpaStorageUtils;
  69 import org.collectionspace.services.common.api.CommonAPI;
  70 import org.collectionspace.services.common.api.RefNameUtils;
  71 import org.collectionspace.services.common.api.Tools;
  72 import org.collectionspace.services.common.vocabulary.RefNameServiceUtils;
  73 import org.collectionspace.services.common.vocabulary.RefNameServiceUtils.AuthRefConfigInfo;
  74 import org.collectionspace.services.config.service.DocHandlerParams;
  75 import org.collectionspace.services.config.service.ListResultField;
  76 import org.collectionspace.services.config.service.ObjectPartType;
  77 import org.collectionspace.services.nuxeo.util.NuxeoUtils;
  78 import org.collectionspace.services.relation.RelationsCommon;
  79 import org.collectionspace.services.relation.RelationsCommonList;
  80 import org.collectionspace.services.relation.RelationsDocListItem;
  81 import org.collectionspace.services.relation.RelationshipType;
  82
  83 import org.dom4j.Element;
  84
  85 import org.nuxeo.ecm.core.api.DocumentModel;
  86 import org.nuxeo.ecm.core.api.DocumentModelList;
  87 import org.nuxeo.ecm.core.api.model.PropertyException;
  88
  89 import org.slf4j.Logger;
  90 import org.slf4j.LoggerFactory;
  91
  92 /**
  93  * RemoteDocumentModelHandler
  94  *
  95  * $LastChangedRevision: $
  96  * $LastChangedDate: $
  97  * @param <T>
  98  * @param <TL>
  99  */
 100 public abstract class   RemoteDocumentModelHandlerImpl<T, TL>
 101         extends DocumentModelHandler<T, TL> {
 102
 103     /** The logger. */
 104     private final Logger logger = LoggerFactory.getLogger(RemoteDocumentModelHandlerImpl.class);
 105     private final static String CR = "\r\n";
 106     private final static String EMPTYSTR = "";
 107
 108     /* (non-Javadoc)
 109      * @see org.collectionspace.services.common.document.AbstractDocumentHandlerImpl#setServiceContext(org.collectionspace.services.common.context.ServiceContext)
 110      */
 111     @Override
 112     public void setServiceContext(ServiceContext ctx) {  //FIXME: Apply proper generics to ServiceContext<PoxPayloadIn, PoxPayloadOut>
 113         if (ctx instanceof MultipartServiceContext) {
 114             super.setServiceContext(ctx);
 115         } else {
 116             throw new IllegalArgumentException("setServiceContext requires instance of "
 117                     + MultipartServiceContext.class.getName());
 118         }
 119     }
 120
 121     @Override
 122     protected String getRefnameDisplayName(DocumentWrapper<DocumentModel> docWrapper) {
 123         return getRefnameDisplayName(docWrapper.getWrappedObject());
 124     }
 125
 126         private String getRefnameDisplayName(DocumentModel docModel) { // Look in the tenant bindings to see what field should be our display name for our refname value
 127                 String result = null;
 128                 ServiceContext<PoxPayloadIn, PoxPayloadOut> ctx = this.getServiceContext();
 129
 130         DocHandlerParams.Params params = null;
 131         try {
 132                         params = ServiceConfigUtils.getDocHandlerParams(ctx);
 133                         ListResultField field = params.getRefnameDisplayNameField();
 134
 135                         String schema = field.getSchema();
 136                         if (schema == null || schema.trim().isEmpty()) {
 137                                 schema = ctx.getCommonPartLabel();
 138                         }
 139
 140                         result = getStringValue(docModel, schema, field);
 141                 } catch (Exception e) {
 142                         if (logger.isWarnEnabled()) {
 143                                 logger.warn(String.format("Call failed to getRefnameDisplayName() for class %s", this.getClass().getName()));
 144                         }
 145                 }
 146
 147                 return result;
 148         }
 149
 150     @Override
 151     public boolean supportsHierarchy() {
 152         boolean result = false;
 153
 154         DocHandlerParams.Params params = null;
 155         try {
 156                 ServiceContext<PoxPayloadIn, PoxPayloadOut> ctx = this.getServiceContext();
 157                         params = ServiceConfigUtils.getDocHandlerParams(ctx);
 158                         Boolean bool = params.isSupportsHierarchy();
 159                         if (bool != null) {
 160                                 result = bool.booleanValue();
 161                         }
 162                 } catch (DocumentException e) {
 163                         // TODO Auto-generated catch block
 164                         String errMsg = String.format("Could not get document handler params from config bindings for class %s", this.getClass().getName());
 165                         if (logger.isWarnEnabled() == true) {
 166                                 logger.warn(errMsg);
 167                         }
 168                 }
 169
 170         return result;
 171     }
 172
 173     @Override
 174     public boolean supportsVersioning() {
 175         boolean result = false;
 176
 177         DocHandlerParams.Params params = null;
 178         try {
 179                 ServiceContext<PoxPayloadIn, PoxPayloadOut> ctx = this.getServiceContext();
 180                         params = ServiceConfigUtils.getDocHandlerParams(ctx);
 181                         Boolean bool = params.isSupportsVersioning();
 182                         if (bool != null) {
 183                                 result = bool.booleanValue();
 184                         }
 185                 } catch (DocumentException e) {
 186                         // TODO Auto-generated catch block
 187                         String errMsg = String.format("Could not get document handler params from config bindings for class %s", this.getClass().getName());
 188                         if (logger.isWarnEnabled() == true) {
 189                                 logger.warn(errMsg);
 190                         }
 191                 }
 192
 193         return result;
 194     }
 195
 196
 197         @Override
 198         public void handleWorkflowTransition(DocumentWrapper<DocumentModel> wrapDoc, TransitionDef transitionDef)
 199                         throws Exception {
 200                 // Do nothing by default, but children can override if they want.  The real workflow transition happens in the WorkflowDocumemtModelHandler class
 201         }
 202
 203     @Override
 204     public void completeCreate(DocumentWrapper<DocumentModel> wrapDoc) throws Exception {
 205         super.completeCreate(wrapDoc);
 206         if (supportsHierarchy() == true) {
 207                 handleRelationsPayload(wrapDoc, false);
 208         }
 209     }
 210
 211     /* NOTE: The authority item doc handler overrides (after calling) this method.  It performs refName updates.  In this
 212      * method we just update any and all relationship records that use refNames that have changed.
 213      * (non-Javadoc)
 214      * @see org.collectionspace.services.nuxeo.client.java.DocumentModelHandler#completeUpdate(org.collectionspace.services.common.document.DocumentWrapper)
 215      */
 216     @Override
 217     public void completeUpdate(DocumentWrapper<DocumentModel> wrapDoc) throws Exception {
 218         DocumentModel docModel = wrapDoc.getWrappedObject();
 219         // We need to return at least those document part(s) and corresponding payloads that were received
 220         Map<String, ObjectPartType> partsMetaMap = getServiceContext().getPartsMetadata();
 221         MultipartServiceContext ctx = (MultipartServiceContext) getServiceContext();
 222         PoxPayloadIn input = ctx.getInput();
 223         if (input != null) {
 224                 List<PayloadInputPart> inputParts = ctx.getInput().getParts();
 225                 for (PayloadInputPart part : inputParts) {
 226                     String partLabel = part.getLabel();
 227                 try{
 228                     ObjectPartType partMeta = partsMetaMap.get(partLabel);
 229                     // CSPACE-4030 - generates NPE if the part is missing.
 230                     if(partMeta!=null) {
 231                             Map<String, Object> unQObjectProperties = extractPart(docModel, partLabel, partMeta);
 232                             if(unQObjectProperties!=null) {
 233                                 addOutputPart(unQObjectProperties, partLabel, partMeta);
 234                             }
 235                     }
 236                 } catch (Throwable t){
 237                     logger.error("Unable to addOutputPart: " + partLabel
 238                                                + " in serviceContextPath: "+this.getServiceContextPath()
 239                                                + " with URI: " + this.getServiceContext().getUriInfo().getPath()
 240                                                + " error: " + t);
 241                 }
 242                 }
 243         } else {
 244                 if (logger.isWarnEnabled() == true) {
 245                         logger.warn("MultipartInput part was null for document id = " +
 246                                         docModel.getName());
 247                 }
 248         }
 249         //
 250         //  If the resource's service supports hierarchy then we need to perform a little more work
 251         //
 252         if (supportsHierarchy() == true) {
 253             handleRelationsPayload(wrapDoc, true); // refNames in relations payload should refer to pre-updated record refName value
 254             handleRefNameReferencesUpdate(); // if our refName changed, we need to update any and all relationship records that used the old one
 255         }
 256     }
 257
 258     /**
 259      * Adds the output part.
 260      *
 261      * @param unQObjectProperties the un q object properties
 262      * @param schema the schema
 263      * @param partMeta the part meta
 264      * @throws Exception the exception
 265      * MediaType.APPLICATION_XML_TYPE
 266      */
 267     protected void addOutputPart(Map<String, Object> unQObjectProperties, String schema, ObjectPartType partMeta)
 268             throws Exception {
 269         Element doc = DocumentUtils.buildDocument(partMeta, schema,
 270                 unQObjectProperties);
 271         if (logger.isTraceEnabled() == true) {
 272             logger.trace(doc.asXML());
 273         }
 274         MultipartServiceContext ctx = (MultipartServiceContext) getServiceContext();
 275         ctx.addOutputPart(schema, doc, partMeta.getContent().getContentType());
 276     }
 277
 278     /**
 279      * Extract paging info.
 280      *
 281      * @param commonsList the commons list
 282      * @return the tL
 283      * @throws Exception the exception
 284      */
 285     public TL extractPagingInfo(TL theCommonList, DocumentWrapper<DocumentModelList> wrapDoc)
 286             throws Exception {
 287         AbstractCommonList commonList = (AbstractCommonList) theCommonList;
 288
 289         DocumentFilter docFilter = this.getDocumentFilter();
 290         long pageSize = docFilter.getPageSize();
 291         long pageNum = pageSize != 0 ? docFilter.getOffset() / pageSize : pageSize;
 292         // set the page size and page number
 293         commonList.setPageNum(pageNum);
 294         commonList.setPageSize(pageSize);
 295         DocumentModelList docList = wrapDoc.getWrappedObject();
 296         // Set num of items in list. this is useful to our testing framework.
 297         commonList.setItemsInPage(docList.size());
 298         // set the total result size
 299         commonList.setTotalItems(docList.totalSize());
 300
 301         return (TL) commonList;
 302     }
 303
 304     /* (non-Javadoc)
 305      * @see org.collectionspace.services.nuxeo.client.java.DocumentModelHandler#extractAllParts(org.collectionspace.services.common.document.DocumentWrapper)
 306      */
 307     @Override
 308     public void extractAllParts(DocumentWrapper<DocumentModel> wrapDoc)
 309             throws Exception {
 310
 311         DocumentModel docModel = wrapDoc.getWrappedObject();
 312         String[] schemas = docModel.getDeclaredSchemas();
 313         Map<String, ObjectPartType> partsMetaMap = getServiceContext().getPartsMetadata();
 314         for (String schema : schemas) {
 315             ObjectPartType partMeta = partsMetaMap.get(schema);
 316             if (partMeta == null) {
 317                 continue; // unknown part, ignore
 318             }
 319             Map<String, Object> unQObjectProperties = extractPart(docModel, schema, partMeta);
 320             if(CollectionSpaceClient.COLLECTIONSPACE_CORE_SCHEMA.equals(schema)) {
 321                 addExtraCoreValues(docModel, unQObjectProperties);
 322             }
 323             addOutputPart(unQObjectProperties, schema, partMeta);
 324         }
 325
 326         MultipartServiceContext ctx = (MultipartServiceContext) getServiceContext();
 327
 328         if (supportsHierarchy() == true) {
 329             String showSiblings = ctx.getQueryParams().getFirst(CommonAPI.showSiblings_QP);
 330             if (Tools.isTrue(showSiblings)) {
 331                 showSiblings(wrapDoc, ctx);
 332                 return;   // actual result is returned on ctx.addOutputPart();
 333             }
 334
 335             String showRelations = ctx.getQueryParams().getFirst(CommonAPI.showRelations_QP);
 336             if (Tools.isTrue(showRelations)) {
 337                 showRelations(wrapDoc, ctx);
 338                 return;   // actual result is returned on ctx.addOutputPart();
 339             }
 340
 341             String showAllRelations = ctx.getQueryParams().getFirst(CommonAPI.showAllRelations_QP);
 342             if (Tools.isTrue(showAllRelations)) {
 343                 showAllRelations(wrapDoc, ctx);
 344                 return;   // actual result is returned on ctx.addOutputPart();
 345             }
 346         }
 347
 348         String currentUser = ctx.getUserId();
 349         if (currentUser.equalsIgnoreCase(AuthNContext.ANONYMOUS_USER) == false) {
 350                 addAccountPermissionsPart();
 351         }
 352     }
 353
 354     private void addExtraCoreValues(DocumentModel docModel, Map<String, Object> unQObjectProperties)
 355                 throws Exception {
 356         unQObjectProperties.put(CollectionSpaceClient.COLLECTIONSPACE_CORE_WORKFLOWSTATE, docModel.getCurrentLifeCycleState());
 357     }
 358
 359     private void addAccountPermissionsPart() throws Exception {
 360         Profiler profiler = new Profiler("addAccountPermissionsPart():", 1);
 361         profiler.start();
 362
 363         MultipartServiceContext ctx = (MultipartServiceContext) getServiceContext();
 364         String currentServiceName = ctx.getServiceName();
 365         String workflowSubResource = "/";
 366         JaxRsContext jaxRsContext = ctx.getJaxRsContext();
 367         if (jaxRsContext != null) { // If not null then we're dealing with an authority item
 368                 String resourceName = SecurityUtils.getResourceName(jaxRsContext.getUriInfo());
 369                 workflowSubResource = workflowSubResource + resourceName + WorkflowClient.SERVICE_PATH + "/";
 370         } else {
 371                 workflowSubResource = workflowSubResource + currentServiceName + WorkflowClient.SERVICE_AUTHZ_SUFFIX;
 372         }
 373         AccountPermission accountPermission = JpaStorageUtils.getAccountPermissions(JpaStorageUtils.CS_CURRENT_USER,
 374                         currentServiceName, workflowSubResource);
 375         org.collectionspace.services.authorization.ObjectFactory objectFactory =
 376                 new org.collectionspace.services.authorization.ObjectFactory();
 377         JAXBElement<AccountPermission> ap = objectFactory.createAccountPermission(accountPermission);
 378         PayloadOutputPart accountPermissionPart = new PayloadOutputPart("account_permission", ap); // REM - "account_permission" should be using a constant and not a literal
 379         ctx.addOutputPart(accountPermissionPart);
 380
 381         profiler.stop();
 382     }
 383
 384     /* (non-Javadoc)
 385      * @see org.collectionspace.services.nuxeo.client.java.DocumentModelHandler#fillAllParts(org.collectionspace.services.common.document.DocumentWrapper)
 386      */
 387     @Override
 388     public void fillAllParts(DocumentWrapper<DocumentModel> wrapDoc, Action action) throws Exception {
 389
 390         //TODO filling extension parts should be dynamic
 391         //Nuxeo APIs lack to support stream/byte[] input, get/setting properties is
 392         //not an ideal way of populating objects.
 393         DocumentModel docModel = wrapDoc.getWrappedObject();
 394         MultipartServiceContext ctx = (MultipartServiceContext) getServiceContext();
 395         PoxPayloadIn input = ctx.getInput();
 396         if (input.getParts().isEmpty()) {
 397             String msg = "No payload found!";
 398             logger.error(msg + "Ctx=" + getServiceContext().toString());
 399             throw new BadRequestException(msg);
 400         }
 401
 402         Map<String, ObjectPartType> partsMetaMap = getServiceContext().getPartsMetadata();
 403
 404         //iterate over parts received and fill those parts
 405         List<PayloadInputPart> inputParts = input.getParts();
 406         for (PayloadInputPart part : inputParts) {
 407
 408             String partLabel = part.getLabel();
 409             if (partLabel == null) {
 410                 String msg = "Part label is missing or empty!";
 411                 logger.error(msg + "Ctx=" + getServiceContext().toString());
 412                 throw new BadRequestException(msg);
 413             }
 414
 415             //skip if the part is not in metadata
 416             ObjectPartType partMeta = partsMetaMap.get(partLabel);
 417             if (partMeta == null) {
 418                 continue;
 419             }
 420             fillPart(part, docModel, partMeta, action, ctx);
 421         }//rof
 422
 423     }
 424
 425     /**
 426      * fillPart fills an XML part into given document model
 427      * @param part to fill
 428      * @param docModel for the given object
 429      * @param partMeta metadata for the object to fill
 430      * @throws Exception
 431      */
 432     protected void fillPart(PayloadInputPart part, DocumentModel docModel,
 433             ObjectPartType partMeta, Action action, ServiceContext<PoxPayloadIn, PoxPayloadOut> ctx)
 434             throws Exception {
 435         //check if this is an xml part
 436         if (part.getMediaType().equals(MediaType.APPLICATION_XML_TYPE)) {
 437                 Element element = part.getElementBody();
 438             Map<String, Object> objectProps = DocumentUtils.parseProperties(partMeta, element, ctx);
 439                 if (action == Action.UPDATE) {
 440                     this.filterReadOnlyPropertiesForPart(objectProps, partMeta);
 441                 }
 442                 docModel.setProperties(partMeta.getLabel(), objectProps);
 443             }
 444         }
 445
 446     /**
 447      * Filters out read only properties, so they cannot be set on update.
 448      * TODO: add configuration support to do this generally
 449      * @param objectProps the properties parsed from the update payload
 450      * @param partMeta metadata for the object to fill
 451      */
 452     public void filterReadOnlyPropertiesForPart(
 453             Map<String, Object> objectProps, ObjectPartType partMeta) {
 454         // Should add in logic to filter most of the core items on update
 455         if(partMeta.getLabel().equalsIgnoreCase(CollectionSpaceClient.COLLECTIONSPACE_CORE_SCHEMA)) {
 456                 objectProps.remove(CollectionSpaceClient.COLLECTIONSPACE_CORE_CREATED_AT);
 457                 objectProps.remove(CollectionSpaceClient.COLLECTIONSPACE_CORE_CREATED_BY);
 458                 objectProps.remove(CollectionSpaceClient.COLLECTIONSPACE_CORE_URI);
 459                 objectProps.remove(CollectionSpaceClient.COLLECTIONSPACE_CORE_TENANTID);
 460                 // Note that the updatedAt/updatedBy fields are set internally
 461                 // in DocumentModelHandler.handleCoreValues().
 462         }
 463     }
 464
 465     /**
 466      * extractPart extracts an XML object from given DocumentModel
 467      * @param docModel
 468      * @param schema of the object to extract
 469      * @param partMeta metadata for the object to extract
 470      * @throws Exception
 471      */
 472     protected Map<String, Object> extractPart(DocumentModel docModel, String schema)
 473             throws Exception {
 474         return extractPart(docModel, schema, (Map<String, Object>)null);
 475     }
 476
 477     /**
 478      * extractPart extracts an XML object from given DocumentModel
 479      * @param docModel
 480      * @param schema of the object to extract
 481      * @param partMeta metadata for the object to extract
 482      * @throws Exception
 483      */
 484     @Deprecated
 485     protected Map<String, Object> extractPart(DocumentModel docModel, String schema, ObjectPartType partMeta)
 486             throws Exception {
 487         return extractPart(docModel, schema, partMeta, null);
 488     }
 489
 490     /**
 491      * extractPart extracts an XML object from given DocumentModel
 492      * @param docModel
 493      * @param schema of the object to extract
 494      * @param partMeta metadata for the object to extract
 495      * @throws Exception
 496      */
 497     protected Map<String, Object> extractPart(
 498             DocumentModel docModel,
 499             String schema,
 500             Map<String, Object> addToMap)
 501             throws Exception {
 502         Map<String, Object> result = null;
 503
 504         Map<String, Object> objectProps = docModel.getProperties(schema);
 505         if (objectProps != null) {
 506                 //unqualify properties before sending the doc over the wire (to save bandwidh)
 507                 //FIXME: is there a better way to avoid duplication of a Map/Collection?
 508                 Map<String, Object> unQObjectProperties =
 509                         (addToMap != null) ? addToMap : (new HashMap<String, Object>());
 510                 Set<Entry<String, Object>> qualifiedEntries = objectProps.entrySet();
 511                 for (Entry<String, Object> entry : qualifiedEntries) {
 512                     String unqProp = getUnQProperty(entry.getKey());
 513                     unQObjectProperties.put(unqProp, entry.getValue());
 514                 }
 515                 result = unQObjectProperties;
 516         }
 517
 518         return result;
 519     }
 520
 521     /**
 522      * extractPart extracts an XML object from given DocumentModel
 523      * @param docModel
 524      * @param schema of the object to extract
 525      * @param partMeta metadata for the object to extract
 526      * @throws Exception
 527      */
 528     @Deprecated
 529     protected Map<String, Object> extractPart(
 530             DocumentModel docModel, String schema, ObjectPartType partMeta,
 531             Map<String, Object> addToMap)
 532             throws Exception {
 533         Map<String, Object> result = null;
 534
 535         result = this.extractPart(docModel, schema, addToMap);
 536
 537         return result;
 538     }
 539
 540     /*
 541     public String getStringPropertyFromDoc(
 542                 ServiceContext ctx,
 543                 String csid,
 544                 String propertyXPath ) throws DocumentNotFoundException, DocumentException {
 545         RepositoryInstance repoSession = null;
 546         boolean releaseRepoSession = false;
 547         String returnValue = null;
 548
 549         try{
 550                 RepositoryJavaClientImpl repoClient = (RepositoryJavaClientImpl)this.getRepositoryClient(ctx);
 551                 repoSession = this.getRepositorySession();
 552                 if (repoSession == null) {
 553                         repoSession = repoClient.getRepositorySession();
 554                         releaseRepoSession = true;
 555                 }
 556
 557                 try {
 558                         DocumentWrapper<DocumentModel> wrapper = repoClient.getDoc(repoSession, ctx, csid);
 559                         DocumentModel docModel = wrapper.getWrappedObject();
 560                         returnValue = (String) docModel.getPropertyValue(propertyXPath);
 561                 } catch (PropertyException pe) {
 562                         throw pe;
 563                 } catch (DocumentException de) {
 564                         throw de;
 565                 } catch (Exception e) {
 566                         if (logger.isDebugEnabled()) {
 567                                 logger.debug("Caught exception ", e);
 568                         }
 569                         throw new DocumentException(e);
 570                 } finally {
 571                         if (releaseRepoSession && repoSession != null) {
 572                                 repoClient.releaseRepositorySession(repoSession);
 573                         }
 574                 }
 575         } catch (Exception e) {
 576                 if (logger.isDebugEnabled()) {
 577                         logger.debug("Caught exception ", e);
 578                 }
 579                 throw new DocumentException(e);
 580         }
 581
 582
 583         if (logger.isWarnEnabled() == true) {
 584                 logger.warn("Returned DocumentModel instance was created with a repository session that is now closed.");
 585         }
 586         return returnValue;
 587     }
 588      */
 589
 590
 591
 592     /* (non-Javadoc)
 593      * @see org.collectionspace.services.nuxeo.client.java.DocumentModelHandler#getAuthorityRefs(org.collectionspace.services.common.document.DocumentWrapper, java.util.List)
 594      */
 595     @Override
 596     public AuthorityRefList getAuthorityRefs(
 597             String csid,
 598             List<AuthRefConfigInfo> authRefsInfo) throws PropertyException, Exception {
 599
 600         AuthorityRefList authRefList = new AuthorityRefList();
 601         AbstractCommonList commonList = (AbstractCommonList) authRefList;
 602
 603         DocumentFilter docFilter = this.getDocumentFilter();
 604         long pageSize = docFilter.getPageSize();
 605         long pageNum = pageSize != 0 ? docFilter.getOffset() / pageSize : pageSize;
 606         // set the page size and page number
 607         commonList.setPageNum(pageNum);
 608         commonList.setPageSize(pageSize);
 609
 610         List<AuthorityRefList.AuthorityRefItem> list = authRefList.getAuthorityRefItem();
 611
 612         try {
 613                 int iFirstToUse = (int)(pageSize*pageNum);
 614                 int nFoundInPage = 0;
 615                 int nFoundTotal = 0;
 616
 617                 ArrayList<RefNameServiceUtils.AuthRefInfo> foundProps
 618                         = new ArrayList<RefNameServiceUtils.AuthRefInfo>();
 619
 620                 boolean releaseRepoSession = false;
 621                 ServiceContext<PoxPayloadIn, PoxPayloadOut> ctx = this.getServiceContext();
 622                 RepositoryJavaClientImpl repoClient = (RepositoryJavaClientImpl)this.getRepositoryClient(ctx);
 623                 CoreSessionInterface repoSession = this.getRepositorySession();
 624                 if (repoSession == null) {
 625                         repoSession = repoClient.getRepositorySession(ctx);
 626                         releaseRepoSession = true;
 627                 }
 628
 629                 try {
 630                         DocumentModel docModel = repoClient.getDoc(repoSession, ctx, csid).getWrappedObject();
 631                         RefNameServiceUtils.findAuthRefPropertiesInDoc(docModel, authRefsInfo, null, foundProps);
 632                         // Slightly goofy pagination support - how many refs do we expect from one object?
 633                         for(RefNameServiceUtils.AuthRefInfo ari:foundProps) {
 634                                 if((nFoundTotal >= iFirstToUse) && (nFoundInPage < pageSize)) {
 635                                         if(appendToAuthRefsList(ari, list)) {
 636                                                 nFoundInPage++;
 637                                         nFoundTotal++;
 638                                         }
 639                                 } else {
 640                                         nFoundTotal++;
 641                                 }
 642                         }
 643                 } finally {
 644                         if (releaseRepoSession == true) {
 645                                 repoClient.releaseRepositorySession(ctx, repoSession);
 646                         }
 647                 }
 648
 649             // Set num of items in list. this is useful to our testing framework.
 650             commonList.setItemsInPage(nFoundInPage);
 651             // set the total result size
 652             commonList.setTotalItems(nFoundTotal);
 653
 654         } catch (PropertyException pe) {
 655             String msg = "Attempted to retrieve value for invalid or missing authority field. "
 656                     + "Check authority field properties in tenant bindings.";
 657             logger.warn(msg, pe);
 658             throw pe;
 659         } catch (Exception e) {
 660             if (logger.isDebugEnabled()) {
 661                 logger.debug("Caught exception in getAuthorityRefs", e);
 662             }
 663             Response response = Response.status(
 664                     Response.Status.INTERNAL_SERVER_ERROR).entity(
 665                     "Failed to retrieve authority references").type(
 666                     "text/plain").build();
 667             throw new CSWebApplicationException(e, response);
 668         }
 669
 670         return authRefList;
 671     }
 672
 673     private boolean appendToAuthRefsList(RefNameServiceUtils.AuthRefInfo ari,
 674                                                 List<AuthorityRefList.AuthorityRefItem> list)
 675             throws Exception {
 676         String fieldName = ari.getQualifiedDisplayName();
 677         try {
 678                         String refNameValue = (String)ari.getProperty().getValue();
 679                         AuthorityRefList.AuthorityRefItem item = authorityRefListItem(fieldName, refNameValue);
 680                         if(item!=null) {        // ignore garbage values.
 681                                 list.add(item);
 682                                 return true;
 683                         }
 684         } catch(PropertyException pe) {
 685                         logger.debug("PropertyException on: "+ari.getProperty().getPath()+pe.getLocalizedMessage());
 686         }
 687         return false;
 688     }
 689
 690     private AuthorityRefList.AuthorityRefItem authorityRefListItem(String authRefFieldName, String refName) {
 691
 692         AuthorityRefList.AuthorityRefItem ilistItem = new AuthorityRefList.AuthorityRefItem();
 693         try {
 694             RefNameUtils.AuthorityTermInfo termInfo = RefNameUtils.parseAuthorityTermInfo(refName);
 695             ilistItem.setRefName(refName);
 696             ilistItem.setAuthDisplayName(termInfo.inAuthority.displayName);
 697             ilistItem.setItemDisplayName(termInfo.displayName);
 698             ilistItem.setSourceField(authRefFieldName);
 699             ilistItem.setUri(termInfo.getRelativeUri());
 700         } catch (Exception e) {
 701                 logger.error("Trouble parsing refName from value: "+refName+" in field: "+authRefFieldName+e.getLocalizedMessage());
 702                 ilistItem = null;
 703         }
 704         return ilistItem;
 705     }
 706
 707     /**
 708      * Returns the primary value from a list of values.
 709      *
 710      * Assumes that the first value is the primary value.
 711      * This assumption may change when and if the primary value
 712      * is identified explicitly.
 713      *
 714      * @param values a list of values.
 715      * @param propertyName the name of a property through
 716      *     which the value can be extracted.
 717      * @return the primary value.
 718     protected String primaryValueFromMultivalue(List<Object> values, String propertyName) {
 719         String primaryValue = "";
 720         if (values == null || values.size() == 0) {
 721             return primaryValue;
 722         }
 723         Object value = values.get(0);
 724         if (value instanceof String) {
 725             if (value != null) {
 726                 primaryValue = (String) value;
 727             }
 728        // Multivalue group of fields
 729        } else if (value instanceof Map) {
 730             if (value != null) {
 731                 Map map = (Map) value;
 732                 if (map.values().size() > 0) {
 733                     if (map.get(propertyName) != null) {
 734                       primaryValue = (String) map.get(propertyName);
 735                     }
 736                 }
 737             }
 738        } else {
 739             logger.warn("Unexpected type for property " + propertyName
 740                     + " in multivalue list: not String or Map.");
 741        }
 742        return primaryValue;
 743     }
 744      */
 745
 746     /**
 747      * Gets a simple property from the document.
 748      *
 749      * For completeness, as this duplicates DocumentModel method.
 750      *
 751      * @param docModel The document model to get info from
 752      * @param schema The name of the schema (part)
 753      * @param propertyName The simple scalar property type
 754      * @return property value as String
 755      */
 756     protected String getSimpleStringProperty(DocumentModel docModel, String schema, String propName) {
 757         String xpath = "/"+schema+":"+propName;
 758         try {
 759                 return (String)docModel.getPropertyValue(xpath);
 760         } catch(PropertyException pe) {
 761                 throw new RuntimeException("Problem retrieving property {"+xpath+"}. Not a simple String property?"
 762                                 +pe.getLocalizedMessage());
 763         } catch(ClassCastException cce) {
 764                 throw new RuntimeException("Problem retrieving property {"+xpath+"} as String. Not a scalar String property?"
 765                                 +cce.getLocalizedMessage());
 766         } catch(Exception e) {
 767                 throw new RuntimeException("Unknown problem retrieving property {"+xpath+"}."
 768                                 +e.getLocalizedMessage());
 769         }
 770     }
 771
 772     /**
 773      * Gets first of a repeating list of scalar values, as a String, from the document.
 774      *
 775      * @param docModel The document model to get info from
 776      * @param schema The name of the schema (part)
 777      * @param listName The name of the scalar list property
 778      * @return first value in list, as a String, or empty string if the list is empty
 779      */
 780     protected String getFirstRepeatingStringProperty(
 781                 DocumentModel docModel, String schema, String listName) {
 782         String xpath = "/"+schema+":"+listName+"/[0]";
 783         try {
 784                 return (String)docModel.getPropertyValue(xpath);
 785         } catch(PropertyException pe) {
 786                 throw new RuntimeException("Problem retrieving property {"+xpath+"}. Not a repeating scalar?"
 787                                 +pe.getLocalizedMessage());
 788         } catch(IndexOutOfBoundsException ioobe) {
 789                 // Nuxeo sometimes handles missing sub, and sometimes does not. Odd.
 790                 return "";      // gracefully handle missing elements
 791         } catch(ClassCastException cce) {
 792                 throw new RuntimeException("Problem retrieving property {"+xpath+"} as String. Not a repeating String property?"
 793                                 +cce.getLocalizedMessage());
 794         } catch(Exception e) {
 795                 throw new RuntimeException("Unknown problem retrieving property {"+xpath+"}."
 796                                 +e.getLocalizedMessage());
 797         }
 798     }
 799
 800
 801     /**
 802      * Gets first of a repeating list of scalar values, as a String, from the document.
 803      *
 804      * @param docModel The document model to get info from
 805      * @param schema The name of the schema (part)
 806      * @param listName The name of the scalar list property
 807      * @return first value in list, as a String, or empty string if the list is empty
 808      */
 809     protected String getStringValueInPrimaryRepeatingComplexProperty(
 810                 DocumentModel docModel, String schema, String complexPropertyName, String fieldName) {
 811         String result = null;
 812
 813         String xpath = "/" + NuxeoUtils.getPrimaryXPathPropertyName(schema, complexPropertyName, fieldName);
 814         try {
 815                 result = (String)docModel.getPropertyValue(xpath);
 816         } catch(PropertyException pe) {
 817                 throw new RuntimeException("Problem retrieving property {"+xpath+"}. Bad propertyNames?"
 818                                 +pe.getLocalizedMessage());
 819         } catch(IndexOutOfBoundsException ioobe) {
 820                 // Nuxeo sometimes handles missing sub, and sometimes does not. Odd.
 821                 result = "";    // gracefully handle missing elements
 822         } catch(ClassCastException cce) {
 823                 throw new RuntimeException("Problem retrieving property {"+xpath+"} as String. Not a String property?"
 824                                 +cce.getLocalizedMessage());
 825         } catch(Exception e) {
 826                 throw new RuntimeException("Unknown problem retrieving property {"+xpath+"}."
 827                                 +e.getLocalizedMessage());
 828         }
 829
 830         return result;
 831     }
 832
 833     /**
 834      * Gets XPath value from schema. Note that only "/" and "[n]" are
 835      * supported for xpath. Can omit grouping elements for repeating complex types,
 836      * e.g., "fieldList/[0]" can be used as shorthand for "fieldList/field[0]" and
 837      * "fieldGroupList/[0]/field" can be used as shorthand for "fieldGroupList/fieldGroup[0]/field".
 838      * If there are no entries for a list of scalars or for a list of complex types,
 839      * a 0 index expression (e.g., "fieldGroupList/[0]/field") will safely return an empty
 840      * string. A non-zero index will throw an IndexOutOfBoundsException if there are not
 841      * that many elements in the list.
 842      * N.B.: This does not follow the XPath spec - indices are 0-based, not 1-based.
 843      *
 844      * @param docModel The document model to get info from
 845      * @param schema The name of the schema (part)
 846      * @param xpath The XPath expression (without schema prefix)
 847      * @return value the indicated property value as a String
 848      * @throws DocumentException
 849      */
 850         protected Object getListResultValue(DocumentModel docModel, // REM - CSPACE-5133
 851                         String schema, ListResultField field) throws DocumentException {
 852                 Object result = null;
 853
 854                 result = NuxeoUtils.getXPathValue(docModel, schema, field.getXpath());
 855
 856                 return result;
 857         }
 858
 859         protected String getStringValue(DocumentModel docModel,
 860                         String schema, ListResultField field) throws DocumentException {
 861                 String result = null;
 862
 863                 Object value = getListResultValue(docModel, schema, field);
 864                 if (value != null && value instanceof String) {
 865                         String strValue = (String) value;
 866                         if (strValue.trim().isEmpty() == false) {
 867                                 result = strValue;
 868                         }
 869                 }
 870
 871                 return result;
 872         }
 873
 874     protected void removeFromList(List<RelationsCommonList.RelationListItem> list, RelationsCommonList.RelationListItem item) {
 875         list.remove(item);
 876     }
 877
 878     private void itemToString(StringBuilder sb, String prefix, RelationsCommonList.RelationListItem item ) {
 879         sb.append(prefix);
 880                 sb.append((item.getCsid()!= null)?item.getCsid():"NO CSID");
 881         sb.append(": [");
 882         sb.append((item.getSubject().getCsid()!=null)?item.getSubject().getCsid():item.getSubject().getRefName());
 883         sb.append("]--");
 884         sb.append(item.getPredicate());
 885         sb.append("-->[");
 886         sb.append((item.getObject().getCsid()!=null)?item.getObject().getCsid():item.getObject().getRefName());
 887         sb.append("]");
 888     }
 889
 890     private String dumpList(List<RelationsCommonList.RelationListItem> list, String label) {
 891         StringBuilder sb = new StringBuilder();
 892         String s;
 893         if (list.size() > 0) {
 894             sb.append("=========== " + label + " ==========" + CR);
 895         }
 896         for (RelationsCommonList.RelationListItem item : list) {
 897                 itemToString(sb, "==  ", item);
 898                 sb.append(CR);
 899         }
 900         return sb.toString();
 901     }
 902
 903     /** @return null on parent not found
 904      */
 905     protected String getParentCSID(String thisCSID) throws Exception {
 906         String parentCSID = null;
 907         try {
 908             String predicate = RelationshipType.HAS_BROADER.value();
 909             RelationsCommonList parentListOuter = getRelations(thisCSID, null, predicate);
 910             List<RelationsCommonList.RelationListItem> parentList = parentListOuter.getRelationListItem();
 911             if (parentList != null) {
 912                 if (parentList.size() == 0) {
 913                     return null;
 914                 }
 915                 RelationsCommonList.RelationListItem relationListItem = parentList.get(0);
 916                 parentCSID = relationListItem.getObjectCsid();
 917             }
 918             return parentCSID;
 919         } catch (Exception e) {
 920             logger.error("Could not find parent for this: " + thisCSID, e);
 921             return null;
 922         }
 923     }
 924
 925     protected List<RelationsCommonList.RelationListItem> newRelationsCommonList() {
 926         List<RelationsCommonList.RelationListItem> result = new ArrayList<RelationsCommonList.RelationListItem>();
 927         return result;
 928     }
 929
 930     public void showSiblings(DocumentWrapper<DocumentModel> wrapDoc,
 931             MultipartServiceContext ctx) throws Exception {
 932         String thisCSID = NuxeoUtils.getCsid(wrapDoc.getWrappedObject());
 933         String parentCSID = getParentCSID(thisCSID);
 934         if (parentCSID == null) {
 935             logger.warn("~~~~~\r\n~~~~ Could not find parent for this: " + thisCSID);
 936             return;
 937         }
 938
 939         String predicate = RelationshipType.HAS_BROADER.value();
 940         RelationsCommonList siblingListOuter = getRelations(null, parentCSID, predicate);
 941         List<RelationsCommonList.RelationListItem> siblingList = siblingListOuter.getRelationListItem();
 942
 943         List<RelationsCommonList.RelationListItem> toRemoveList = newRelationsCommonList();
 944
 945
 946         RelationsCommonList.RelationListItem item = null;
 947         for (RelationsCommonList.RelationListItem sibling : siblingList) {
 948             if (thisCSID.equals(sibling.getSubjectCsid())) {
 949                 toRemoveList.add(sibling);   //IS_A copy of the main item, i.e. I have a parent that is my parent, so I'm in the list from the above query.
 950             }
 951         }
 952         //rather than create an immutable iterator, I'm just putting the items to remove on a separate list, then looping over that list and removing.
 953         for (RelationsCommonList.RelationListItem self : toRemoveList) {
 954             removeFromList(siblingList, self);
 955         }
 956
 957         long siblingSize = siblingList.size();
 958         siblingListOuter.setTotalItems(siblingSize);
 959         siblingListOuter.setItemsInPage(siblingSize);
 960         if(logger.isTraceEnabled()) {
 961             String dump = dumpList(siblingList, "Siblings of: "+thisCSID);
 962             logger.trace("~~~~~~~~~~~~~~~~~~~~~~ showSiblings ~~~~~~~~~~~~~~~~~~~~~~~~" + CR + dump);
 963         }
 964
 965         PayloadOutputPart relationsPart = new PayloadOutputPart(RelationClient.SERVICE_COMMON_LIST_NAME, siblingListOuter);
 966         ctx.addOutputPart(relationsPart);
 967     }
 968
 969     public void showRelations(DocumentWrapper<DocumentModel> wrapDoc,
 970             MultipartServiceContext ctx) throws Exception {
 971         String thisCSID = NuxeoUtils.getCsid(wrapDoc.getWrappedObject());
 972
 973         String predicate = RelationshipType.HAS_BROADER.value();
 974         RelationsCommonList parentListOuter = getRelations(thisCSID, null, predicate);
 975         List<RelationsCommonList.RelationListItem> parentList = parentListOuter.getRelationListItem();
 976
 977         RelationsCommonList childrenListOuter = getRelations(null, thisCSID, predicate);
 978         List<RelationsCommonList.RelationListItem> childrenList = childrenListOuter.getRelationListItem();
 979
 980         if(logger.isTraceEnabled()) {
 981             String dump = dumpLists(thisCSID, parentList, childrenList, null);
 982             logger.trace("~~~~~~~~~~~~~~~~~~~~~~ showRelations ~~~~~~~~~~~~~~~~~~~~~~~~" + CR + dump);
 983         }
 984
 985         //Assume that there are more children than parents.  Will be true for parent/child, but maybe not for other relations.
 986         //Now add all parents to our childrenList, to be able to return just one list of consolidated results.
 987         //Not optimal, but that's the current design spec.
 988         long added = 0;
 989         for (RelationsCommonList.RelationListItem parent : parentList) {
 990             childrenList.add(parent);
 991             added++;
 992         }
 993         long childrenSize = childrenList.size();
 994         childrenListOuter.setTotalItems(childrenSize);
 995         childrenListOuter.setItemsInPage(childrenListOuter.getItemsInPage() + added);
 996
 997         PayloadOutputPart relationsPart = new PayloadOutputPart(RelationClient.SERVICE_COMMON_LIST_NAME, childrenListOuter);
 998         ctx.addOutputPart(relationsPart);
 999     }
1000
1001     public void showAllRelations(DocumentWrapper<DocumentModel> wrapDoc, MultipartServiceContext ctx) throws Exception {
1002         String thisCSID = NuxeoUtils.getCsid(wrapDoc.getWrappedObject());
1003
1004         RelationsCommonList subjectListOuter = getRelations(thisCSID, null, null);   //  nulls are wildcards:  predicate=*, and object=*
1005         List<RelationsCommonList.RelationListItem> subjectList = subjectListOuter.getRelationListItem();
1006
1007         RelationsCommonList objectListOuter = getRelations(null, thisCSID, null);   //  nulls are wildcards:  subject=*, and predicate=*
1008         List<RelationsCommonList.RelationListItem> objectList = objectListOuter.getRelationListItem();
1009
1010         if(logger.isTraceEnabled()) {
1011             String dump = dumpLists(thisCSID, subjectList, objectList, null);
1012             logger.trace("~~~~~~~~~~~~~~~~~~~~~~ showAllRelations ~~~~~~~~~~~~~~~~~~~~~~~~" + CR + dump);
1013         }
1014         //  MERGE LISTS:
1015         subjectList.addAll(objectList);
1016
1017         //now subjectList actually has records BOTH where thisCSID is subject and object.
1018         long relatedSize = subjectList.size();
1019         subjectListOuter.setTotalItems(relatedSize);
1020         subjectListOuter.setItemsInPage(relatedSize);
1021
1022         PayloadOutputPart relationsPart = new PayloadOutputPart(RelationClient.SERVICE_COMMON_LIST_NAME, subjectListOuter);
1023         ctx.addOutputPart(relationsPart);
1024     }
1025
1026     private String dumpLists(String itemCSID,
1027             List<RelationsCommonList.RelationListItem> parentList,
1028             List<RelationsCommonList.RelationListItem> childList,
1029             List<RelationsCommonList.RelationListItem> actionList) {
1030         StringBuilder sb = new StringBuilder();
1031         sb.append("itemCSID: " + itemCSID + CR);
1032         if(parentList!=null) {
1033                 sb.append(dumpList(parentList, "parentList"));
1034         }
1035         if(childList!=null) {
1036                 sb.append(dumpList(childList, "childList"));
1037         }
1038         if(actionList!=null) {
1039                 sb.append(dumpList(actionList, "actionList"));
1040         }
1041         return sb.toString();
1042     }
1043
1044     //================= TODO: move this to common, refactoring this and  CollectionObjectResource.java
1045     public RelationsCommonList getRelations(String subjectCSID, String objectCSID, String predicate) throws Exception {
1046         ServiceContext<PoxPayloadIn, PoxPayloadOut> ctx = getServiceContext();
1047         MultivaluedMap<String, String> queryParams = ctx.getQueryParams();
1048         queryParams.putSingle(IRelationsManager.PREDICATE_QP, predicate);
1049         queryParams.putSingle(IRelationsManager.SUBJECT_QP, subjectCSID);
1050         queryParams.putSingle(IRelationsManager.OBJECT_QP, objectCSID);
1051
1052         RelationResource relationResource = new RelationResource(); //is this still acting like a singleton as it should be?
1053         RelationsCommonList relationsCommonList = relationResource.getList(ctx);
1054         return relationsCommonList;
1055     }
1056     //============================= END TODO refactor ==========================
1057
1058     // this method calls the RelationResource to have it create the relations and persist them.
1059     private void createRelations(List<RelationsCommonList.RelationListItem> inboundList,
1060                 ServiceContext<PoxPayloadIn, PoxPayloadOut> ctx) throws Exception {
1061         for (RelationsCommonList.RelationListItem item : inboundList) {
1062             RelationsCommon rc = new RelationsCommon();
1063             //rc.setCsid(item.getCsid());
1064             //todo: assignTo(item, rc);
1065             RelationsDocListItem itemSubject = item.getSubject();
1066             RelationsDocListItem itemObject = item.getObject();
1067
1068             // Set at least one of CSID and refName for Subject and Object
1069             // Either value might be null for for each of Subject and Object
1070             String subjectCsid = itemSubject.getCsid();
1071             rc.setSubjectCsid(subjectCsid);
1072
1073             String objCsid = itemObject.getCsid();
1074             rc.setObjectCsid(objCsid);
1075
1076             rc.setSubjectRefName(itemSubject.getRefName());
1077             rc.setObjectRefName(itemObject.getRefName());
1078
1079             rc.setRelationshipType(item.getPredicate());
1080             rc.setRelationshipMetaType(item.getRelationshipMetaType());
1081             //RelationshipType  foo = (RelationshipType.valueOf(item.getPredicate())) ;
1082             //rc.setPredicate(foo);     //this must be one of the type found in the enum in  services/jaxb/src/main/resources/relations_common.xsd
1083
1084             // This is superfluous, since it will be fetched by the Relations Create logic.
1085             rc.setSubjectDocumentType(itemSubject.getDocumentType());
1086             rc.setObjectDocumentType(itemObject.getDocumentType());
1087
1088             // This is superfluous, since it will be fetched by the Relations Create logic.
1089             rc.setSubjectUri(itemSubject.getUri());
1090             rc.setObjectUri(itemObject.getUri());
1091             // May not have the info here. Only really require CSID or refName.
1092             // Rest is handled in the Relation create mechanism
1093             //uriPointsToSameAuthority(itemSubject.getUri(), itemObject.getUri());
1094
1095             PoxPayloadOut payloadOut = new PoxPayloadOut(RelationClient.SERVICE_PAYLOAD_NAME);
1096             PayloadOutputPart outputPart = new PayloadOutputPart(RelationClient.SERVICE_COMMONPART_NAME, rc);
1097             payloadOut.addPart(outputPart);
1098             RelationResource relationResource = new RelationResource();
1099             Response res = relationResource.create(ctx, ctx.getResourceMap(),
1100                     ctx.getUriInfo(), payloadOut.toXML());    //NOTE ui recycled from above to pass in unknown query params.
1101         }
1102     }
1103
1104     // Note that item2 may be sparse (only refName, no CSID for subject or object)
1105     // But item1 must not be sparse
1106     private boolean itemsEqual(RelationsCommonList.RelationListItem item1, RelationsCommonList.RelationListItem item2) {
1107         if (item1 == null || item2 == null) {
1108             return false;
1109         }
1110         RelationsDocListItem subj1 = item1.getSubject();
1111         RelationsDocListItem subj2 = item2.getSubject();
1112         RelationsDocListItem obj1 = item1.getObject();
1113         RelationsDocListItem obj2 = item2.getObject();
1114
1115         String subj1Csid = subj1.getCsid();
1116         String subj2Csid = subj2.getCsid();
1117         String subj1RefName = subj1.getRefName();
1118         String subj2RefName = subj2.getRefName();
1119
1120         String obj1Csid = obj1.getCsid();
1121         String obj2Csid = obj2.getCsid();
1122         String obj1RefName = obj1.getRefName();
1123         String obj2RefName = obj2.getRefName();
1124
1125         String item1Metatype = item1.getRelationshipMetaType();
1126         item1Metatype = item1Metatype != null ? item1Metatype : EMPTYSTR;
1127
1128         String item2Metatype = item2.getRelationshipMetaType();
1129         item2Metatype = item2Metatype != null ? item2Metatype : EMPTYSTR;
1130
1131         boolean isEqual = (subj1Csid.equals(subj2Csid) || ((subj2Csid==null)  && subj1RefName.equals(subj2RefName)))
1132                 && (obj1Csid.equals(obj2Csid)   || ((obj2Csid==null)   && obj1RefName.equals(obj2RefName)))
1133                 // predicate is proper, but still allow relationshipType
1134                 && (item1.getPredicate().equals(item2.getPredicate())
1135                         ||  ((item2.getPredicate()==null)  && item1.getRelationshipType().equals(item2.getRelationshipType())))
1136                 // Allow missing docTypes, so long as they do not conflict
1137                 && (obj1.getDocumentType().equals(obj2.getDocumentType()) || obj2.getDocumentType()==null)
1138                 && (subj1.getDocumentType().equals(subj2.getDocumentType()) || subj2.getDocumentType()==null)
1139                 && (item1Metatype.equalsIgnoreCase(item2Metatype));
1140         return isEqual;
1141     }
1142
1143     // Note that the item argument may be sparse (only refName, no CSID for subject or object)
1144     // But the list items must not be sparse
1145     private RelationsCommonList.RelationListItem findInList(
1146                 List<RelationsCommonList.RelationListItem> list,
1147                 RelationsCommonList.RelationListItem item) {
1148         RelationsCommonList.RelationListItem foundItem = null;
1149         for (RelationsCommonList.RelationListItem listItem : list) {
1150             if (itemsEqual(listItem, item)) {   //equals must be defined, else
1151                 foundItem = listItem;
1152                 break;
1153             }
1154         }
1155         return foundItem;
1156     }
1157
1158     /**  updateRelations strategy:
1159      *
1160      *
1161     go through inboundList, remove anything from childList that matches  from childList
1162     go through inboundList, remove anything from parentList that matches  from parentList
1163     go through parentList, delete all remaining
1164     go through childList, delete all remaining
1165     go through actionList, add all remaining.
1166     check for duplicate children
1167     check for more than one parent.
1168
1169     inboundList                           parentList                      childList          actionList
1170     ----------------                          ---------------                  ----------------       ----------------
1171     child-a                                   parent-c                        child-a             child-b
1172     child-b                                   parent-d                        child-c
1173     parent-a
1174      *
1175      *
1176      */
1177     private RelationsCommonList updateRelations(
1178             String itemCSID, PoxPayloadIn input, DocumentWrapper<DocumentModel> wrapDoc, boolean fUpdate)
1179             throws Exception {
1180         if (logger.isTraceEnabled()) {
1181             logger.trace("AuthItemDocHndler.updateRelations for: " + itemCSID);
1182         }
1183         PayloadInputPart part = input.getPart(RelationClient.SERVICE_COMMON_LIST_NAME);        //input.getPart("relations_common");
1184         if (part == null) {
1185             return null;  //nothing to do--they didn't send a list of relations.
1186         }
1187         RelationsCommonList relationsCommonListBody = (RelationsCommonList) part.getBody();
1188         List<RelationsCommonList.RelationListItem> inboundList = relationsCommonListBody.getRelationListItem();
1189         List<RelationsCommonList.RelationListItem> actionList = newRelationsCommonList();
1190         List<RelationsCommonList.RelationListItem> childList = null;
1191         List<RelationsCommonList.RelationListItem> parentList = null;
1192         DocumentModel docModel = wrapDoc.getWrappedObject();
1193                 String itemRefName = (String) docModel.getProperty(CollectionSpaceClient.COLLECTIONSPACE_CORE_SCHEMA,
1194                         CollectionSpaceClient.COLLECTIONSPACE_CORE_REFNAME);
1195
1196                 ServiceContext<PoxPayloadIn, PoxPayloadOut> ctx = getServiceContext();
1197         //Do magic replacement of ${itemCSID} and fix URI's.
1198         fixupInboundListItems(ctx, inboundList, docModel, itemCSID);
1199
1200         String HAS_BROADER = RelationshipType.HAS_BROADER.value();
1201         UriInfo uriInfo = ctx.getUriInfo();
1202         MultivaluedMap<String, String> queryParams = uriInfo.getQueryParameters();
1203
1204         if (fUpdate) {
1205             //Run getList() once as sent to get childListOuter:
1206             String predicate = RelationshipType.HAS_BROADER.value();
1207             queryParams.putSingle(IRelationsManager.PREDICATE_QP, predicate);
1208             queryParams.putSingle(IRelationsManager.SUBJECT_QP, null);
1209             queryParams.putSingle(IRelationsManager.SUBJECT_TYPE_QP, null);
1210             queryParams.putSingle(IRelationsManager.OBJECT_QP, itemCSID);
1211             queryParams.putSingle(IRelationsManager.OBJECT_TYPE_QP, null);
1212
1213             RelationResource relationResource = new RelationResource();
1214             RelationsCommonList childListOuter = relationResource.getList(ctx);    // Knows all query params because they are in the context.
1215
1216             //Now run getList() again, leaving predicate, swapping subject and object, to get parentListOuter.
1217             queryParams.putSingle(IRelationsManager.PREDICATE_QP, predicate);
1218             queryParams.putSingle(IRelationsManager.SUBJECT_QP, itemCSID);
1219             queryParams.putSingle(IRelationsManager.OBJECT_QP, null);
1220             RelationsCommonList parentListOuter = relationResource.getList(ctx);
1221
1222
1223             childList = childListOuter.getRelationListItem();
1224             parentList = parentListOuter.getRelationListItem();
1225
1226             if (parentList.size() > 1) {
1227                 throw new Exception("Too many parents for object: " + itemCSID + " list: " + dumpList(parentList, "parentList"));
1228             }
1229
1230             if (logger.isTraceEnabled()) {
1231                 logger.trace("AuthItemDocHndler.updateRelations for: " + itemCSID + " got existing relations.");
1232             }
1233         }
1234
1235         for (RelationsCommonList.RelationListItem inboundItem : inboundList) {
1236             // Note that the relations may specify the other (non-item) bit with a refName, not a CSID,
1237             // and so the CSID for those may be null
1238             if(inboundItem.getPredicate().equals(HAS_BROADER)) {
1239                 // Look for parents and children
1240                 if(itemCSID.equals(inboundItem.getObject().getCsid())
1241                                 || itemRefName.equals(inboundItem.getObject().getRefName())) {
1242                         //then this is an item that says we have a child.  That child is inboundItem
1243                         RelationsCommonList.RelationListItem childItem =
1244                                         (childList == null) ? null : findInList(childList, inboundItem);
1245                         if (childItem != null) {
1246                         if (logger.isTraceEnabled()) {
1247                                 StringBuilder sb = new StringBuilder();
1248                                 itemToString(sb, "== Child: ", childItem);
1249                             logger.trace("Found inboundChild in current child list: " + sb.toString());
1250                         }
1251                                 removeFromList(childList, childItem);    //exists, just take it off delete list
1252                         } else {
1253                         if (logger.isTraceEnabled()) {
1254                                 StringBuilder sb = new StringBuilder();
1255                                 itemToString(sb, "== Child: ", inboundItem);
1256                             logger.trace("inboundChild not in current child list, will add: " + sb.toString());
1257                         }
1258                                 actionList.add(inboundItem);   //doesn't exist as a child, but is a child.  Add to additions list
1259                                 String newChildCsid = inboundItem.getSubject().getCsid();
1260                                 if(newChildCsid == null) {
1261                                         String newChildRefName = inboundItem.getSubject().getRefName();
1262                                         if(newChildRefName==null) {
1263                                                 throw new RuntimeException("Child with no CSID or refName!");
1264                                         }
1265                             if (logger.isTraceEnabled()) {
1266                                 logger.trace("Fetching CSID for child with only refname: "+newChildRefName);
1267                             }
1268                                 DocumentModel newChildDocModel =
1269                                         NuxeoBasedResource.getDocModelForRefName(this.getRepositorySession(),
1270                                                         newChildRefName, getServiceContext().getResourceMap());
1271                                 newChildCsid = getCsid(newChildDocModel);
1272                                 }
1273                                 ensureChildHasNoOtherParents(ctx, queryParams, newChildCsid);
1274                         }
1275
1276                 } else if (itemCSID.equals(inboundItem.getSubject().getCsid())
1277                                         || itemRefName.equals(inboundItem.getSubject().getRefName())) {
1278                         //then this is an item that says we have a parent.  inboundItem is that parent.
1279                         RelationsCommonList.RelationListItem parentItem =
1280                                         (parentList == null) ? null : findInList(parentList, inboundItem);
1281                         if (parentItem != null) {
1282                                 removeFromList(parentList, parentItem);    //exists, just take it off delete list
1283                         } else {
1284                                 actionList.add(inboundItem);   //doesn't exist as a parent, but is a parent. Add to additions list
1285                         }
1286                 } else {
1287                     logger.error("Parent/Child Element didn't link to this item. inboundItem: " + inboundItem);
1288                 }
1289             } else {
1290                 logger.warn("Non-parent relation ignored. inboundItem: " + inboundItem);
1291             }
1292         }
1293         if (logger.isTraceEnabled()) {
1294             String dump = dumpLists(itemCSID, parentList, childList, actionList);
1295             logger.trace("~~~~~~~~~~~~~~~~~~~~~~dump~~~~~~~~~~~~~~~~~~~~~~~~" + CR + dump);
1296         }
1297         if (fUpdate) {
1298             if (logger.isTraceEnabled()) {
1299                 logger.trace("AuthItemDocHndler.updateRelations for: " + itemCSID + " deleting "
1300                         + parentList.size() + " existing parents and " + childList.size() + " existing children.");
1301             }
1302             deleteRelations(parentList, ctx, "parentList");               //todo: there are items appearing on both lists....april 20.
1303             deleteRelations(childList, ctx, "childList");
1304         }
1305         if (logger.isTraceEnabled()) {
1306             logger.trace("AuthItemDocHndler.updateRelations for: " + itemCSID + " adding "
1307                     + actionList.size() + " new parents and children.");
1308         }
1309         createRelations(actionList, ctx);
1310         if (logger.isTraceEnabled()) {
1311             logger.trace("AuthItemDocHndler.updateRelations for: " + itemCSID + " done.");
1312         }
1313         //We return all elements on the inbound list, since we have just worked to make them exist in the system
1314         // and be non-redundant, etc.  That list came from relationsCommonListBody, so it is still attached to it, just pass that back.
1315         return relationsCommonListBody;
1316     }
1317
1318     /** Performs substitution for ${itemCSID} (see CommonAPI.AuthorityItemCSID_REPLACE for constant)
1319      *   and sets URI correctly for related items.
1320      *   Operates directly on the items in the list.  Does not change the list ordering, does not add or remove any items.
1321      */
1322     protected void fixupInboundListItems(ServiceContext<PoxPayloadIn, PoxPayloadOut> ctx,
1323             List<RelationsCommonList.RelationListItem> inboundList,
1324             DocumentModel docModel,
1325             String itemCSID) throws Exception {
1326         String thisURI = this.getUri(docModel);
1327         // WARNING:  the two code blocks below are almost identical  and seem to ask to be put in a generic method.
1328         //                    beware of the little diffs in  inboundItem.setObjectCsid(itemCSID); and   inboundItem.setSubjectCsid(itemCSID); in the two blocks.
1329         for (RelationsCommonList.RelationListItem inboundItem : inboundList) {
1330             RelationsDocListItem inboundItemObject = inboundItem.getObject();
1331             RelationsDocListItem inboundItemSubject = inboundItem.getSubject();
1332
1333             if (CommonAPI.AuthorityItemCSID_REPLACE.equalsIgnoreCase(inboundItemObject.getCsid())) {
1334                 inboundItem.setObjectCsid(itemCSID);
1335                 inboundItemObject.setCsid(itemCSID);
1336                 //inboundItemObject.setUri(getUri(docModel));
1337             } else {
1338                 /*
1339                 String objectCsid = inboundItemObject.getCsid();
1340                 DocumentModel itemDocModel = NuxeoUtils.getDocFromCsid(getRepositorySession(), ctx, objectCsid);    //null if not found.
1341                 DocumentWrapper wrapper = new DocumentWrapperImpl(itemDocModel);
1342                 String uri = this.getRepositoryClient(ctx).getDocURI(wrapper);
1343                 inboundItemObject.setUri(uri);    //CSPACE-4037
1344                  */
1345             }
1346             //uriPointsToSameAuthority(thisURI, inboundItemObject.getUri());    //CSPACE-4042
1347
1348             if (CommonAPI.AuthorityItemCSID_REPLACE.equalsIgnoreCase(inboundItemSubject.getCsid())) {
1349                 inboundItem.setSubjectCsid(itemCSID);
1350                 inboundItemSubject.setCsid(itemCSID);
1351                 //inboundItemSubject.setUri(getUri(docModel));
1352             } else {
1353                 /*
1354                 String subjectCsid = inboundItemSubject.getCsid();
1355                 DocumentModel itemDocModel = NuxeoUtils.getDocFromCsid(getRepositorySession(), ctx, subjectCsid);    //null if not found.
1356                 DocumentWrapper wrapper = new DocumentWrapperImpl(itemDocModel);
1357                 String uri = this.getRepositoryClient(ctx).getDocURI(wrapper);
1358                 inboundItemSubject.setUri(uri);    //CSPACE-4037
1359                  */
1360             }
1361             //uriPointsToSameAuthority(thisURI, inboundItemSubject.getUri());  //CSPACE-4042
1362
1363         }
1364     }
1365
1366     private void ensureChildHasNoOtherParents(ServiceContext<PoxPayloadIn, PoxPayloadOut> ctx,
1367                 MultivaluedMap<String, String> queryParams, String childCSID) {
1368         logger.trace("ensureChildHasNoOtherParents for: " + childCSID );
1369         queryParams.putSingle(IRelationsManager.SUBJECT_QP, childCSID);
1370         queryParams.putSingle(IRelationsManager.PREDICATE_QP, RelationshipType.HAS_BROADER.value());
1371         queryParams.putSingle(IRelationsManager.OBJECT_QP, null);  //null means ANY
1372
1373         RelationResource relationResource = new RelationResource();
1374         RelationsCommonList parentListOuter = relationResource.getList(ctx);
1375         List<RelationsCommonList.RelationListItem> parentList = parentListOuter.getRelationListItem();
1376         //logger.warn("ensureChildHasNoOtherParents preparing to delete relations on "+childCSID+"\'s parent list: \r\n"+dumpList(parentList, "duplicate parent list"));
1377         deleteRelations(parentList, ctx, "parentList-delete");
1378     }
1379
1380     private void deleteRelations(List<RelationsCommonList.RelationListItem> list,
1381                 ServiceContext<PoxPayloadIn, PoxPayloadOut> ctx,
1382                 String listName) {
1383         try {
1384             for (RelationsCommonList.RelationListItem item : list) {
1385                 RelationResource relationResource = new RelationResource();
1386                 if(logger.isTraceEnabled()) {
1387                         StringBuilder sb = new StringBuilder();
1388                         itemToString(sb, "==== TO DELETE: ", item);
1389                         logger.trace(sb.toString());
1390                 }
1391                 Response res = relationResource.deleteWithParentCtx(ctx, item.getCsid());
1392                 if (logger.isDebugEnabled()) {
1393                         logger.debug("Status of authority item deleteRelations method call was: " + res.getStatus());
1394                 }
1395             }
1396         } catch (Throwable t) {
1397             String msg = "Unable to deleteRelations: " + Tools.errorToString(t, true);
1398             logger.error(msg);
1399         }
1400     }
1401
1402     // Note that we must do this after we have completed the Update, so that the repository has the
1403     // info for the item itself. The relations code must call into the repo to get info for each end.
1404     // This could be optimized to pass in the parent docModel, since it will often be one end.
1405     // Nevertheless, we should complete the item save before we do work on the relations, especially
1406     // since a save on Create might fail, and we would not want to create relations for something
1407     // that may not be created...
1408     private void handleRelationsPayload(DocumentWrapper<DocumentModel> wrapDoc, boolean fUpdate) throws Exception {
1409         ServiceContext<PoxPayloadIn, PoxPayloadOut> ctx = getServiceContext();
1410         PoxPayloadIn input = ctx.getInput();
1411         DocumentModel documentModel = (wrapDoc.getWrappedObject());
1412         String itemCsid = documentModel.getName();
1413
1414         //Updates relations part
1415         RelationsCommonList relationsCommonList = updateRelations(itemCsid, input, wrapDoc, fUpdate);
1416
1417         PayloadOutputPart payloadOutputPart = new PayloadOutputPart(RelationClient.SERVICE_COMMON_LIST_NAME, relationsCommonList);  //FIXME: REM - We should check for a null relationsCommonList and not create the new common list payload
1418         ctx.setProperty(RelationClient.SERVICE_COMMON_LIST_NAME, payloadOutputPart);
1419
1420         //now we add part for relations list
1421         //ServiceContext ctx = getServiceContext();
1422         //PayloadOutputPart foo = (PayloadOutputPart) ctx.getProperty(RelationClient.SERVICE_COMMON_LIST_NAME);
1423         ctx.getOutput().addPart(payloadOutputPart);
1424     }
1425
1426     /**
1427      * Checks to see if the refName has changed, and if so,
1428      * uses utilities to find all references and update them to use the new refName.
1429      * @throws Exception
1430      */
1431     protected void handleRefNameReferencesUpdate() throws Exception {
1432         if (hasRefNameUpdate() == true) {
1433             ServiceContext<PoxPayloadIn, PoxPayloadOut> ctx = getServiceContext();
1434             RepositoryClient<PoxPayloadIn, PoxPayloadOut> repoClient = getRepositoryClient(ctx);
1435             CoreSessionInterface repoSession = this.getRepositorySession();
1436
1437             // Update all the relationship records that referred to the old refName
1438             RefNameServiceUtils.updateRefNamesInRelations(ctx, repoClient, repoSession,
1439                     oldRefNameOnUpdate, newRefNameOnUpdate);
1440         }
1441     }
1442
1443     protected String getRefNameUpdate() {
1444         String result = null;
1445
1446         if (hasRefNameUpdate() == true) {
1447                 result = newRefNameOnUpdate;
1448                 if (logger.isDebugEnabled() == true) {
1449                         logger.debug(String.format("There was a refName update.  New: %s Old: %s" ,
1450                                         newRefNameOnUpdate, oldRefNameOnUpdate));
1451                 }
1452         }
1453
1454         return result;
1455     }
1456
1457     /*
1458      * Note: The Vocabulary document handler overrides this method.
1459      */
1460     protected String getRefPropName() {
1461         return ServiceBindingUtils.AUTH_REF_PROP;
1462     }
1463
1464
1465
1466 }