1 package org.collectionspace.services.common.vocabulary;
3 import java.util.regex.Matcher;
4 import java.util.regex.Pattern;
6 import javax.ws.rs.core.Response;
8 import org.collectionspace.services.client.AuthorityClient;
9 import org.collectionspace.services.client.PoxPayloadIn;
10 import org.collectionspace.services.common.api.RefNameUtils.AuthorityTermInfo;
11 import org.collectionspace.services.common.context.MultipartServiceContextImpl;
12 import org.collectionspace.services.common.context.ServiceContext;
13 import org.collectionspace.services.common.vocabulary.RefNameServiceUtils.AuthorityItemSpecifier;
14 import org.collectionspace.services.common.vocabulary.RefNameServiceUtils.Specifier;
15 import org.collectionspace.services.common.vocabulary.nuxeo.AuthorityIdentifierUtils;
16 import org.collectionspace.services.nuxeo.client.java.CoreSessionInterface;
17 import org.collectionspace.services.nuxeo.util.NuxeoUtils;
18 import org.dom4j.DocumentException;
19 import org.nuxeo.ecm.core.api.DocumentModel;
20 import org.slf4j.Logger;
21 import org.slf4j.LoggerFactory;
23 public class AuthorityServiceUtils {
24 private static final Logger logger = LoggerFactory.getLogger(AuthorityIdentifierUtils.class);
26 // Used to keep track if an authority item's is deprecated
27 public static final String IS_DEPRECATED_PROPERTY = "IS_DEPRECATED_PROPERTY";
28 public static final Boolean DEPRECATED = true;
29 public static final Boolean NOT_DEPRECATED = !DEPRECATED;
31 // Used to keep track if an authority item's rev number should be updated
32 public static final String SHOULD_UPDATE_REV_PROPERTY = "SHOULD_UPDATE_REV_PROPERTY";
33 public static final boolean UPDATE_REV = true;
34 public static final boolean DONT_UPDATE_REV = !UPDATE_REV;
36 // Used to keep track if an authority item is a locally proposed member of a SAS authority
37 public static final String IS_PROPOSED_PROPERTY = "IS_PROPOSED";
38 public static final Boolean PROPOSED = true;
39 public static final Boolean NOT_PROPOSED = !PROPOSED;
40 public static final Boolean NO_CHANGE = null;
42 static public PoxPayloadIn requestPayloadIn(ServiceContext ctx, Specifier specifier, Class responseType) throws Exception {
43 PoxPayloadIn result = null;
45 AuthorityClient client = (AuthorityClient) ctx.getClient();
46 Response res = client.read(specifier.getURNValue());
48 int statusCode = res.getStatus();
50 // Check the status code of the response: does it match
51 // the expected response(s)?
52 if (logger.isDebugEnabled()) {
53 logger.debug(client.getClass().getCanonicalName() + ": status = " + statusCode);
56 result = new PoxPayloadIn((String)res.readEntity(responseType)); // Get the entire response!
65 // Makes a call to the SAS server for a authority item payload
67 static public PoxPayloadIn requestPayloadIn(AuthorityItemSpecifier specifier, String serviceName, Class responseType) throws Exception {
68 PoxPayloadIn result = null;
70 ServiceContext parentCtx = new MultipartServiceContextImpl(serviceName);
71 AuthorityClient client = (AuthorityClient) parentCtx.getClient();
72 Response res = client.readItem(specifier.getParentSpecifier().getURNValue(), specifier.getItemSpecifier().getURNValue());
74 int statusCode = res.getStatus();
76 // Check the status code of the response: does it match
77 // the expected response(s)?
78 if (logger.isDebugEnabled()) {
79 logger.debug(client.getClass().getCanonicalName() + ": status = " + statusCode);
82 result = new PoxPayloadIn((String)res.readEntity(responseType)); // Get the entire response!
90 static public boolean setAuthorityItemDeprecated(ServiceContext ctx,
91 DocumentModel docModel, String authorityItemCommonSchemaName, Boolean flag) throws Exception {
92 boolean result = false;
94 docModel.setProperty(authorityItemCommonSchemaName, AuthorityItemJAXBSchema.DEPRECATED,
96 CoreSessionInterface repoSession = (CoreSessionInterface) ctx.getCurrentRepositorySession();
97 repoSession.saveDocument(docModel);
104 * The domain name part of refnames on SAS may not match that of local refnames, so we need to update all the payload's
105 * refnames with the correct domain name
107 static public PoxPayloadIn filterRefnameDomains(ServiceContext ctx,
108 PoxPayloadIn payload) throws DocumentException {
109 PoxPayloadIn result = null;
112 String payloadStr = payload.getXmlPayload();
113 Pattern p = Pattern.compile("(urn:cspace:)(([a-z]{1,}\\.?)*)"); // matches the domain name part of a RefName. For example, matches "core.collectionspace.org" of RefName urn:cspace:core.collectionspace.org:personauthorities:name(person):item:name(BigBird1461101206103)'Big Bird'
114 Matcher m = p.matcher(payloadStr);
116 StringBuffer filteredPayloadStr = new StringBuffer();
117 while (m.find() == true) {
118 if (logger.isDebugEnabled()) {
119 logger.debug("Replacing: " + m.group(2));
121 m.appendReplacement(filteredPayloadStr, m.group(1) + ctx.getTenantName());
123 m.appendTail(filteredPayloadStr);
124 result = new PoxPayloadIn(filteredPayloadStr.toString());
126 if (logger.isDebugEnabled()) {
127 logger.debug(String.format("", filteredPayloadStr));
134 * Mark the authority item as deprecated.
140 static public boolean markAuthorityItemAsDeprecated(ServiceContext ctx, String authorityItemCommonSchemaName, String itemCsid) throws Exception {
141 boolean result = false;
144 DocumentModel docModel = NuxeoUtils.getDocFromCsid(ctx, (CoreSessionInterface)ctx.getCurrentRepositorySession(), itemCsid);
145 result = setAuthorityItemDeprecated(ctx, docModel, authorityItemCommonSchemaName, AuthorityServiceUtils.DEPRECATED);
146 } catch (Exception e) {
147 logger.warn(String.format("Could not mark item '%s' as deprecated.", itemCsid), e);