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:
6 * http://www.collectionspace.org
7 * http://wiki.collectionspace.org
9 * Copyright 2009 University of California at Berkeley
11 * Licensed under the Educational Community License (ECL), Version 2.0.
12 * You may not use this file except in compliance with this License.
14 * You may obtain a copy of the ECL 2.0 License at
16 * https://source.collectionspace.org/collection-space/LICENSE.txt
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.
24 package org.collectionspace.services.servicegroup.nuxeo;
26 import java.util.ArrayList;
27 import java.util.HashMap;
28 import java.util.Iterator;
29 import java.util.List;
32 import javax.ws.rs.core.Response;
34 import org.collectionspace.services.nuxeo.client.java.CommonList;
35 import org.collectionspace.services.nuxeo.client.java.NuxeoDocumentModelHandler;
36 import org.collectionspace.services.nuxeo.client.java.CoreSessionInterface;
37 import org.collectionspace.services.nuxeo.client.java.RepositoryClientImpl;
38 import org.collectionspace.services.nuxeo.util.NuxeoUtils;
39 import org.collectionspace.services.jaxb.AbstractCommonList;
40 import org.collectionspace.services.client.IQueryManager;
41 import org.collectionspace.services.client.PoxPayloadIn;
42 import org.collectionspace.services.client.PoxPayloadOut;
44 import org.collectionspace.services.common.CSWebApplicationException;
45 import org.collectionspace.services.common.ServiceMain;
46 import org.collectionspace.services.common.ServiceMessages;
47 import org.collectionspace.services.common.StoredValuesUriTemplate;
48 import org.collectionspace.services.common.UriTemplateFactory;
49 import org.collectionspace.services.common.UriTemplateRegistry;
50 import org.collectionspace.services.common.UriTemplateRegistryKey;
51 import org.collectionspace.services.common.config.TenantBindingConfigReaderImpl;
52 import org.collectionspace.services.common.context.ServiceBindingUtils;
53 import org.collectionspace.services.common.context.ServiceContext;
54 import org.collectionspace.services.common.document.DocumentException;
55 import org.collectionspace.services.common.document.DocumentFilter;
56 import org.collectionspace.services.common.document.DocumentWrapper;
57 import org.collectionspace.services.common.security.SecurityUtils;
58 import org.collectionspace.services.common.query.nuxeo.QueryManagerNuxeoImpl;
60 import org.collectionspace.services.config.service.ServiceBindingType;
61 import org.collectionspace.services.config.service.ServiceObjectType;
62 import org.collectionspace.services.servicegroup.ServicegroupsCommon;
64 import org.nuxeo.ecm.core.api.DocumentModel;
65 import org.nuxeo.ecm.core.api.DocumentModelList;
67 import org.slf4j.Logger;
68 import org.slf4j.LoggerFactory;
70 public class ServiceGroupDocumentModelHandler
71 extends NuxeoDocumentModelHandler<ServicegroupsCommon> {
73 protected final Logger logger = LoggerFactory.getLogger(this.getClass());
75 protected static final int NUM_META_FIELDS = 3;
76 protected static final String DOC_TYPE_FIELD = "docType";
77 protected static final String DOC_NUMBER_FIELD = "docNumber";
78 protected static final String DOC_NAME_FIELD = "docName";
80 public AbstractCommonList getItemsForGroup(
81 ServiceContext<PoxPayloadIn, PoxPayloadOut> ctx,
82 List<String> serviceGroupNames) throws Exception {
83 CommonList commonList = new CommonList();
84 AbstractCommonList list = (AbstractCommonList)commonList;
85 CoreSessionInterface repoSession = null;
86 boolean releaseRepoSession = false;
89 RepositoryClientImpl repoClient = (RepositoryClientImpl)this.getRepositoryClient(ctx);
90 repoSession = this.getRepositorySession();
91 if (repoSession == null) {
92 repoSession = repoClient.getRepositorySession(ctx);
93 releaseRepoSession = true;
96 DocumentFilter myFilter = getDocumentFilter();
97 int pageSize = myFilter.getPageSize();
98 int pageNum = myFilter.getStartPage();
99 list.setPageNum(pageNum);
100 list.setPageSize(pageSize);
102 Map<String, ServiceBindingType> queriedServiceBindings = new HashMap<String, ServiceBindingType>();
103 RepositoryClientImpl nuxeoRepoClient = (RepositoryClientImpl)repoClient;
104 // Get the service bindings for this tenant
105 TenantBindingConfigReaderImpl tReader = ServiceMain.getInstance().getTenantBindingConfigReader();
106 // We need to get all the procedures, authorities, and objects.
107 List<ServiceBindingType> servicebindings =
108 tReader.getServiceBindingsByType(ctx.getTenantId(), serviceGroupNames);
109 if (servicebindings == null || servicebindings.isEmpty()) {
110 Response response = Response.status(Response.Status.NOT_FOUND).entity(
111 ServiceMessages.READ_FAILED +
112 ServiceMessages.resourceNotFoundMsg(implode(serviceGroupNames, ","))).type("text/plain").build();
113 throw new CSWebApplicationException(response);
116 servicebindings = SecurityUtils.getReadableServiceBindingsForCurrentUser(servicebindings);
117 // Build the list of docTypes for allowed serviceBindings
118 ArrayList<String> docTypes = new ArrayList<String>();
119 for(ServiceBindingType binding:servicebindings) {
120 ServiceObjectType serviceObj = binding.getObject();
121 if(serviceObj!=null) {
122 String docType = serviceObj.getName();
123 docTypes.add(docType);
124 queriedServiceBindings.put(docType, binding);
128 // This should be type "Document" but CMIS is gagging on that right now.
129 ctx.getQueryParams().add(IQueryManager.SELECT_DOC_TYPE_FIELD, QueryManagerNuxeoImpl.COLLECTIONSPACE_DOCUMENT_TYPE);
131 // Now we have to issue the search
132 // The findDocs() method will build a QueryContext, which wants to see a docType for our context
133 ctx.setDocumentType(QueryManagerNuxeoImpl.NUXEO_DOCUMENT_TYPE);
134 DocumentWrapper<DocumentModelList> docListWrapper =
135 nuxeoRepoClient.findDocs(ctx, this, repoSession, docTypes );
136 // Now we gather the info for each document into the list and return
137 DocumentModelList docList = docListWrapper.getWrappedObject();
138 if (docList == null) { // found no authRef fields - nothing to process
141 processDocList(ctx.getTenantId(), docList, queriedServiceBindings, commonList);
142 list.setItemsInPage(docList.size());
143 list.setTotalItems(docList.totalSize());
144 } catch (DocumentException de) {
146 } catch (Exception e) {
147 if (logger.isDebugEnabled()) {
148 logger.debug("Caught exception ", e);
150 throw new DocumentException(e);
152 if (releaseRepoSession && repoSession != null) {
153 repoClient.releaseRepositorySession(ctx, repoSession);
156 } catch (Exception e) {
157 if (logger.isDebugEnabled()) {
158 logger.debug("Caught exception ", e);
160 throw new DocumentException(e);
166 // Move this to a Utils class!
167 public static String implode(List<String> stringList, String sep) {
168 StringBuilder sb = new StringBuilder();
170 boolean fFirst = false;
171 for (String name:stringList) {
180 return sb.toString();
183 private String getUriFromServiceBinding(ServiceBindingType sb, String csid) {
184 return "/" + sb.getName().toLowerCase() + "/" + csid;
187 private void processDocList(String tenantId,
188 DocumentModelList docList,
189 Map<String, ServiceBindingType> queriedServiceBindings,
191 String fields[] = new String[NUM_META_FIELDS + NUM_STANDARD_LIST_RESULT_FIELDS];
192 fields[0] = STANDARD_LIST_CSID_FIELD;
193 fields[1] = STANDARD_LIST_URI_FIELD;
194 fields[2] = STANDARD_LIST_UPDATED_AT_FIELD;
195 fields[3] = STANDARD_LIST_WORKFLOW_FIELD;
196 fields[4] = STANDARD_LIST_REFNAME_FIELD;
197 fields[5] = DOC_NAME_FIELD;
198 fields[6] = DOC_NUMBER_FIELD;
199 fields[7] = DOC_TYPE_FIELD;
200 list.setFieldsReturned(fields);
202 Iterator<DocumentModel> iter = docList.iterator();
203 HashMap<String, Object> item = new HashMap<String, Object>();
204 while (iter.hasNext()) {
205 DocumentModel docModel = iter.next();
206 String docType = docModel.getDocumentType().getName();
207 docType = ServiceBindingUtils.getUnqualifiedTenantDocType(docType);
208 ServiceBindingType sb = queriedServiceBindings.get(docType);
210 throw new RuntimeException(
211 "processDocList: No Service Binding for docType: " + docType);
214 String csid = NuxeoUtils.getCsid(docModel);
215 item.put(STANDARD_LIST_CSID_FIELD, csid);
217 UriTemplateRegistry uriTemplateRegistry = ServiceMain.getInstance().getUriTemplateRegistry();
218 StoredValuesUriTemplate storedValuesResourceTemplate = uriTemplateRegistry.get(new UriTemplateRegistryKey(tenantId, docType));
219 Map<String, String> additionalValues = new HashMap<String, String>();
220 if (storedValuesResourceTemplate.getUriTemplateType() == UriTemplateFactory.ITEM) {
222 String inAuthorityCsid = (String) NuxeoUtils.getProperyValue(docModel, "inAuthority"); //docModel.getPropertyValue("inAuthority"); // AuthorityItemJAXBSchema.IN_AUTHORITY
223 additionalValues.put(UriTemplateFactory.IDENTIFIER_VAR, inAuthorityCsid);
224 additionalValues.put(UriTemplateFactory.ITEM_IDENTIFIER_VAR, csid);
225 } catch (Exception e) {
226 String msg = String.format("Could not extract inAuthority property from authority item with CSID = ", docModel.getName());
230 additionalValues.put(UriTemplateFactory.IDENTIFIER_VAR, csid);
233 String uriStr = storedValuesResourceTemplate.buildUri(additionalValues);
234 item.put(STANDARD_LIST_URI_FIELD, uriStr);
236 item.put(STANDARD_LIST_UPDATED_AT_FIELD, getUpdatedAtAsString(docModel));
237 item.put(STANDARD_LIST_WORKFLOW_FIELD, docModel.getCurrentLifeCycleState());
238 item.put(STANDARD_LIST_REFNAME_FIELD, getRefname(docModel));
239 } catch(Exception e) {
240 logger.error("Error getting core values for doc ["+csid+"]: "+e.getLocalizedMessage());
243 String value = ServiceBindingUtils.getMappedFieldInDoc(sb, ServiceBindingUtils.OBJ_NUMBER_PROP, docModel);
245 item.put(DOC_NUMBER_FIELD, value);
248 value = ServiceBindingUtils.getMappedFieldInDoc(sb, ServiceBindingUtils.OBJ_NAME_PROP, docModel);
250 item.put(DOC_NAME_FIELD, value);
253 item.put(DOC_TYPE_FIELD, docType);
254 // add the item to the list