X-Git-Url: https://git.argeo.org/?a=blobdiff_plain;f=org.argeo.jcr%2Fsrc%2Forg%2Fargeo%2Fjcr%2FJcrUtils.java;h=331164cf2b442dec485bb7a71ebb0d7a0c50dd65;hb=25e4528153640a2e211e217468f8f5aa01607cf0;hp=8ccdfc73d2285bb69f8f994dbb8f232a83b95fc1;hpb=77a5498dd5d10d2442127022efd6501a7dbddbae;p=lgpl%2Fargeo-commons.git diff --git a/org.argeo.jcr/src/org/argeo/jcr/JcrUtils.java b/org.argeo.jcr/src/org/argeo/jcr/JcrUtils.java index 8ccdfc73d..331164cf2 100644 --- a/org.argeo.jcr/src/org/argeo/jcr/JcrUtils.java +++ b/org.argeo.jcr/src/org/argeo/jcr/JcrUtils.java @@ -23,6 +23,7 @@ import java.io.IOException; import java.io.InputStream; import java.net.MalformedURLException; import java.net.URL; +import java.security.MessageDigest; import java.security.Principal; import java.text.DateFormat; import java.text.ParseException; @@ -63,7 +64,6 @@ import javax.jcr.security.Privilege; import org.apache.commons.io.IOUtils; import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; -import org.argeo.util.DigestUtils; /** Utility methods to simplify common JCR operations. */ public class JcrUtils { @@ -75,11 +75,8 @@ public class JcrUtils { * http://www.day.com/specs/jcr/2.0/3_Repository_Model.html#3.2.2%20Local * %20Names */ - public final static char[] INVALID_NAME_CHARACTERS = { '/', ':', '[', ']', - '|', '*', /* - * invalid XML chars : - */ - '<', '>', '&' }; + public final static char[] INVALID_NAME_CHARACTERS = { '/', ':', '[', ']', '|', '*', /* invalid for XML: */ '<', + '>', '&' }; /** Prevents instantiation */ private JcrUtils() { @@ -89,8 +86,7 @@ public class JcrUtils { * Queries one single node. * * @return one single node or null if none was found - * @throws ArgeoJcrException - * if more than one node was found + * @throws ArgeoJcrException if more than one node was found */ public static Node querySingleNode(Query query) { NodeIterator nodeIterator; @@ -146,7 +142,7 @@ public class JcrUtils { /** * Creates a deep path based on a URL: - * http://subdomain.example.com/to/content?args => + * http://subdomain.example.com/to/content?args becomes * com/example/subdomain/to/content */ public static String urlAsPath(String url) { @@ -172,23 +168,20 @@ public class JcrUtils { node.setProperty(Property.JCR_PORT, Integer.toString(u.getPort())); node.setProperty(Property.JCR_PATH, normalizePath(u.getPath())); } catch (Exception e) { - throw new ArgeoJcrException("Cannot set URL " + url - + " as nt:address properties", e); + throw new ArgeoJcrException("Cannot set URL " + url + " as nt:address properties", e); } } /** Build URL based on the {@link NodeType#NT_ADDRESS} properties. */ public static String urlFromAddressProperties(Node node) { try { - URL u = new URL( - node.getProperty(Property.JCR_PROTOCOL).getString(), node - .getProperty(Property.JCR_HOST).getString(), - (int) node.getProperty(Property.JCR_PORT).getLong(), node - .getProperty(Property.JCR_PATH).getString()); + URL u = new URL(node.getProperty(Property.JCR_PROTOCOL).getString(), + node.getProperty(Property.JCR_HOST).getString(), + (int) node.getProperty(Property.JCR_PORT).getLong(), + node.getProperty(Property.JCR_PATH).getString()); return u.toString(); } catch (Exception e) { - throw new ArgeoJcrException( - "Cannot get URL from nt:address properties of " + node, e); + throw new ArgeoJcrException("Cannot get URL from nt:address properties of " + node, e); } } @@ -196,7 +189,9 @@ public class JcrUtils { * PATH UTILITIES */ - /** Make sure that: starts with '/', do not end with '/', do not have '//' */ + /** + * Make sure that: starts with '/', do not end with '/', do not have '//' + */ public static String normalizePath(String path) { List tokens = tokenize(path); StringBuffer buf = new StringBuffer(path.length()); @@ -209,7 +204,7 @@ public class JcrUtils { /** * Creates a path from a FQDN, inverting the order of the component: - * www.argeo.org => org.argeo.www + * www.argeo.org becomes org.argeo.www */ public static String hostAsPath(String host) { StringBuffer path = new StringBuffer(host.length()); @@ -223,7 +218,7 @@ public class JcrUtils { } /** - * Creates a path from a UUID (e.g. 6ebda899-217d-4bf1-abe4-2839085c8f3c => + * Creates a path from a UUID (e.g. 6ebda899-217d-4bf1-abe4-2839085c8f3c becomes * 6ebda899-217d/4bf1/abe4/2839085c8f3c/). '/' at the end, not the beginning */ public static String uuidAsPath(String uuid) { @@ -240,10 +235,8 @@ public class JcrUtils { /** * The provided data as a path ('/' at the end, not the beginning) * - * @param cal - * the date - * @param addHour - * whether to add hour as well + * @param cal the date + * @param addHour whether to add hour as well */ public static String dateAsPath(Calendar cal, Boolean addHour) { StringBuffer buf = new StringBuffer(14); @@ -285,8 +278,7 @@ public class JcrUtils { calendar.setTime(date); return calendar; } catch (ParseException e) { - throw new ArgeoJcrException("Cannot parse " + value - + " with date format " + dateFormat, e); + throw new ArgeoJcrException("Cannot parse " + value + " with date format " + dateFormat, e); } } @@ -329,20 +321,16 @@ public class JcrUtils { * Routine that get the child with this name, adding id it does not already * exist */ - public static Node getOrAdd(Node parent, String childName, - String childPrimaryNodeType) throws RepositoryException { - return parent.hasNode(childName) ? parent.getNode(childName) : parent - .addNode(childName, childPrimaryNodeType); + public static Node getOrAdd(Node parent, String childName, String childPrimaryNodeType) throws RepositoryException { + return parent.hasNode(childName) ? parent.getNode(childName) : parent.addNode(childName, childPrimaryNodeType); } /** * Routine that get the child with this name, adding id it does not already * exist */ - public static Node getOrAdd(Node parent, String childName) - throws RepositoryException { - return parent.hasNode(childName) ? parent.getNode(childName) : parent - .addNode(childName); + public static Node getOrAdd(Node parent, String childName) throws RepositoryException { + return parent.hasNode(childName) ? parent.getNode(childName) : parent.addNode(childName); } /** Convert a {@link NodeIterator} to a list of {@link Node} */ @@ -368,8 +356,16 @@ public class JcrUtils { return null; return node.getProperty(propertyName).getString(); } catch (RepositoryException e) { - throw new ArgeoJcrException("Cannot get property " + propertyName - + " of " + node, e); + throw new ArgeoJcrException("Cannot get property " + propertyName + " of " + node, e); + } + } + + /** Concisely get the path of the given node. */ + public static String getPath(Node node) { + try { + return node.getPath(); + } catch (RepositoryException e) { + throw new ArgeoJcrException("Cannot get path of " + node, e); } } @@ -378,8 +374,7 @@ public class JcrUtils { try { return node.getProperty(propertyName).getBoolean(); } catch (RepositoryException e) { - throw new ArgeoJcrException("Cannot get property " + propertyName - + " of " + node, e); + throw new ArgeoJcrException("Cannot get property " + propertyName + " of " + node, e); } } @@ -388,54 +383,36 @@ public class JcrUtils { try { return getBinaryAsBytes(node.getProperty(propertyName)); } catch (RepositoryException e) { - throw new ArgeoJcrException("Cannot get property " + propertyName - + " of " + node, e); + throw new ArgeoJcrException("Cannot get property " + propertyName + " of " + node, e); } } - /** Creates the nodes making path, if they don't exist. */ - public static Node mkdirs(Session session, String path) { - return mkdirs(session, path, null, null, false); - } - - /** - * use {@link #mkdirs(Session, String, String, String, Boolean)} instead. - * - * @deprecated + /* + * MKDIRS */ - @Deprecated - public static Node mkdirs(Session session, String path, String type, - Boolean versioning) { - return mkdirs(session, path, type, type, false); - } /** - * @param type - * the type of the leaf node + * Create sub nodes relative to a parent node */ - public static Node mkdirs(Session session, String path, String type) { - return mkdirs(session, path, type, null, false); + public static Node mkdirs(Node parentNode, String relativePath) { + return mkdirs(parentNode, relativePath, null, null); } /** * Create sub nodes relative to a parent node * - * @param nodeType - * the type of the leaf node + * @param nodeType the type of the leaf node */ - public static Node mkdirs(Node parentNode, String relativePath, - String nodeType) { + public static Node mkdirs(Node parentNode, String relativePath, String nodeType) { return mkdirs(parentNode, relativePath, nodeType, null); } /** * Create sub nodes relative to a parent node * - * @param nodeType - * the type of the leaf node + * @param nodeType the type of the leaf node */ - public static Node mkdirs(Node parentNode, String relativePath, - String nodeType, String intermediaryNodeType) { + public static Node mkdirs(Node parentNode, String relativePath, String nodeType, String intermediaryNodeType) { List tokens = tokenize(relativePath); Node currParent = parentNode; try { @@ -445,8 +422,7 @@ public class JcrUtils { currParent = currParent.getNode(name); } else { if (i != (tokens.size() - 1)) {// intermediary - currParent = currParent.addNode(name, - intermediaryNodeType); + currParent = currParent.addNode(name, intermediaryNodeType); } else {// leaf currParent = currParent.addNode(name, nodeType); } @@ -454,21 +430,18 @@ public class JcrUtils { } return currParent; } catch (RepositoryException e) { - throw new ArgeoJcrException("Cannot mkdirs relative path " - + relativePath + " from " + parentNode, e); + throw new ArgeoJcrException("Cannot mkdirs relative path " + relativePath + " from " + parentNode, e); } } /** - * Synchronized and save is performed, to avoid race conditions in - * initializers leading to duplicate nodes. + * Synchronized and save is performed, to avoid race conditions in initializers + * leading to duplicate nodes. */ - public synchronized static Node mkdirsSafe(Session session, String path, - String type) { + public synchronized static Node mkdirsSafe(Session session, String path, String type) { try { if (session.hasPendingChanges()) - throw new ArgeoJcrException( - "Session has pending changes, save them first."); + throw new ArgeoJcrException("Session has pending changes, save them first."); Node node = mkdirs(session, path, type); session.save(); return node; @@ -482,33 +455,48 @@ public class JcrUtils { return mkdirsSafe(session, path, null); } + /** Creates the nodes making path, if they don't exist. */ + public static Node mkdirs(Session session, String path) { + return mkdirs(session, path, null, null, false); + } + + /** + * @param type the type of the leaf node + */ + public static Node mkdirs(Session session, String path, String type) { + return mkdirs(session, path, type, null, false); + } + /** - * Creates the nodes making path, if they don't exist. This is up to the - * caller to save the session. Use with caution since it can create - * duplicate nodes if used concurrently. + * Creates the nodes making path, if they don't exist. This is up to the caller + * to save the session. Use with caution since it can create duplicate nodes if + * used concurrently. Requires read access to the root node of the workspace. */ - public static Node mkdirs(Session session, String path, String type, - String intermediaryNodeType, Boolean versioning) { + public static Node mkdirs(Session session, String path, String type, String intermediaryNodeType, + Boolean versioning) { try { - if (path.equals('/')) + if (path.equals("/")) return session.getRootNode(); if (session.itemExists(path)) { Node node = session.getNode(path); // check type - if (type != null && !node.isNodeType(type) - && !node.getPath().equals("/")) - throw new ArgeoJcrException("Node " + node - + " exists but is of type " - + node.getPrimaryNodeType().getName() - + " not of type " + type); + if (type != null && !node.isNodeType(type) && !node.getPath().equals("/")) + throw new ArgeoJcrException("Node " + node + " exists but is of type " + + node.getPrimaryNodeType().getName() + " not of type " + type); // TODO: check versioning return node; } - StringBuffer current = new StringBuffer("/"); - Node currentNode = session.getRootNode(); - Iterator it = tokenize(path).iterator(); + // StringBuffer current = new StringBuffer("/"); + // Node currentNode = session.getRootNode(); + + Node currentNode = findClosestExistingParent(session, path); + String closestExistingParentPath = currentNode.getPath(); + StringBuffer current = new StringBuffer(closestExistingParentPath); + if (!closestExistingParentPath.endsWith("/")) + current.append('/'); + Iterator it = tokenize(path.substring(closestExistingParentPath.length())).iterator(); while (it.hasNext()) { String part = it.next(); current.append(part).append('/'); @@ -516,8 +504,7 @@ public class JcrUtils { if (!it.hasNext() && type != null) currentNode = currentNode.addNode(part, type); else if (it.hasNext() && intermediaryNodeType != null) - currentNode = currentNode.addNode(part, - intermediaryNodeType); + currentNode = currentNode.addNode(part, intermediaryNodeType); else currentNode = currentNode.addNode(part); if (versioning) @@ -536,6 +523,17 @@ public class JcrUtils { } } + private static Node findClosestExistingParent(Session session, String path) throws RepositoryException { + int idx = path.lastIndexOf('/'); + if (idx == 0) + return session.getRootNode(); + String parentPath = path.substring(0, idx); + if (session.itemExists(parentPath)) + return session.getNode(parentPath); + else + return findClosestExistingParent(session, parentPath); + } + /** Convert a path to the list of its tokens */ public static List tokenize(String path) { List tokens = new ArrayList(); @@ -569,44 +567,46 @@ public class JcrUtils { return Collections.unmodifiableList(tokens); } + // /** + // * use {@link #mkdirs(Session, String, String, String, Boolean)} instead. + // * + // * @deprecated + // */ + // @Deprecated + // public static Node mkdirs(Session session, String path, String type, + // Boolean versioning) { + // return mkdirs(session, path, type, type, false); + // } + /** - * Safe and repository implementation independent registration of a - * namespace. + * Safe and repository implementation independent registration of a namespace. */ - public static void registerNamespaceSafely(Session session, String prefix, - String uri) { + public static void registerNamespaceSafely(Session session, String prefix, String uri) { try { - registerNamespaceSafely(session.getWorkspace() - .getNamespaceRegistry(), prefix, uri); + registerNamespaceSafely(session.getWorkspace().getNamespaceRegistry(), prefix, uri); } catch (RepositoryException e) { throw new ArgeoJcrException("Cannot find namespace registry", e); } } /** - * Safe and repository implementation independent registration of a - * namespace. + * Safe and repository implementation independent registration of a namespace. */ - public static void registerNamespaceSafely(NamespaceRegistry nr, - String prefix, String uri) { + public static void registerNamespaceSafely(NamespaceRegistry nr, String prefix, String uri) { try { String[] prefixes = nr.getPrefixes(); for (String pref : prefixes) if (pref.equals(prefix)) { String registeredUri = nr.getURI(pref); if (!registeredUri.equals(uri)) - throw new ArgeoJcrException("Prefix " + pref - + " already registered for URI " - + registeredUri - + " which is different from provided URI " - + uri); + throw new ArgeoJcrException("Prefix " + pref + " already registered for URI " + registeredUri + + " which is different from provided URI " + uri); else return;// skip } nr.registerNamespace(prefix, uri); } catch (RepositoryException e) { - throw new ArgeoJcrException("Cannot register namespace " + uri - + " under prefix " + prefix, e); + throw new ArgeoJcrException("Cannot register namespace " + uri + " under prefix " + prefix, e); } } @@ -644,8 +644,7 @@ public class JcrUtils { // A multi-valued property, print all values Value[] values = property.getValues(); for (int i = 0; i < values.length; i++) { - log.debug(property.getPath() + "=" - + values[i].getString()); + log.debug(property.getPath() + "=" + values[i].getString()); } } else { // A single-valued property @@ -673,14 +672,12 @@ public class JcrUtils { return; try { - AccessControlPolicy[] effectivePolicies = session - .getAccessControlManager().getEffectivePolicies(path); + AccessControlPolicy[] effectivePolicies = session.getAccessControlManager().getEffectivePolicies(path); if (effectivePolicies.length > 0) { for (AccessControlPolicy policy : effectivePolicies) { if (policy instanceof AccessControlList) { AccessControlList acl = (AccessControlList) policy; - log.debug("Access control list for " + path + "\n" - + accessControlListSummary(acl)); + log.debug("Access control list for " + path + "\n" + accessControlListSummary(acl)); } } } else { @@ -696,8 +693,7 @@ public class JcrUtils { StringBuffer buf = new StringBuffer(""); try { for (AccessControlEntry ace : acl.getAccessControlEntries()) { - buf.append('\t').append(ace.getPrincipal().getName()) - .append('\n'); + buf.append('\t').append(ace.getPrincipal().getName()).append('\n'); for (Privilege priv : ace.getPrivileges()) buf.append("\t\t").append(priv.getName()).append('\n'); } @@ -711,9 +707,9 @@ public class JcrUtils { * Copies recursively the content of a node to another one. Do NOT copy the * property values of {@link NodeType#MIX_CREATED} and * {@link NodeType#MIX_LAST_MODIFIED}, but update the - * {@link Property#JCR_LAST_MODIFIED} and - * {@link Property#JCR_LAST_MODIFIED_BY} properties if the target node has - * the {@link NodeType#MIX_LAST_MODIFIED} mixin. + * {@link Property#JCR_LAST_MODIFIED} and {@link Property#JCR_LAST_MODIFIED_BY} + * properties if the target node has the {@link NodeType#MIX_LAST_MODIFIED} + * mixin. */ public static void copy(Node fromNode, Node toNode) { try { @@ -725,18 +721,14 @@ public class JcrUtils { properties: while (pit.hasNext()) { Property fromProperty = pit.nextProperty(); String propertyName = fromProperty.getName(); - if (toNode.hasProperty(propertyName) - && toNode.getProperty(propertyName).getDefinition() - .isProtected()) + if (toNode.hasProperty(propertyName) && toNode.getProperty(propertyName).getDefinition().isProtected()) continue properties; if (fromProperty.getDefinition().isProtected()) continue properties; - if (propertyName.equals("jcr:created") - || propertyName.equals("jcr:createdBy") - || propertyName.equals("jcr:lastModified") - || propertyName.equals("jcr:lastModifiedBy")) + if (propertyName.equals("jcr:created") || propertyName.equals("jcr:createdBy") + || propertyName.equals("jcr:lastModified") || propertyName.equals("jcr:lastModifiedBy")) continue properties; if (fromProperty.isMultiple()) { @@ -765,22 +757,19 @@ public class JcrUtils { if (toNode.hasNode(nodeRelPath)) toChild = toNode.getNode(nodeRelPath); else - toChild = toNode.addNode(fromChild.getName(), fromChild - .getPrimaryNodeType().getName()); + toChild = toNode.addNode(fromChild.getName(), fromChild.getPrimaryNodeType().getName()); copy(fromChild, toChild); } } catch (RepositoryException e) { - throw new ArgeoJcrException("Cannot copy " + fromNode + " to " - + toNode, e); + throw new ArgeoJcrException("Cannot copy " + fromNode + " to " + toNode, e); } } /** - * Check whether all first-level properties (except jcr:* properties) are - * equal. Skip jcr:* properties + * Check whether all first-level properties (except jcr:* properties) are equal. + * Skip jcr:* properties */ - public static Boolean allPropertiesEquals(Node reference, Node observed, - Boolean onlyCommonProperties) { + public static Boolean allPropertiesEquals(Node reference, Node observed, Boolean onlyCommonProperties) { try { PropertyIterator pit = reference.getProperties(); props: while (pit.hasNext()) { @@ -795,30 +784,27 @@ public class JcrUtils { else return false; // TODO: deal with multiple property values? - if (!observed.getProperty(propName).getValue() - .equals(propReference.getValue())) + if (!observed.getProperty(propName).getValue().equals(propReference.getValue())) return false; } return true; } catch (RepositoryException e) { - throw new ArgeoJcrException("Cannot check all properties equals of " - + reference + " and " + observed, e); + throw new ArgeoJcrException("Cannot check all properties equals of " + reference + " and " + observed, e); } } - public static Map diffProperties(Node reference, - Node observed) { + public static Map diffProperties(Node reference, Node observed) { Map diffs = new TreeMap(); diffPropertiesLevel(diffs, null, reference, observed); return diffs; } /** - * Compare the properties of two nodes. Recursivity to child nodes is not - * yet supported. Skip jcr:* properties. + * Compare the properties of two nodes. Recursivity to child nodes is not yet + * supported. Skip jcr:* properties. */ - static void diffPropertiesLevel(Map diffs, - String baseRelPath, Node reference, Node observed) { + static void diffPropertiesLevel(Map diffs, String baseRelPath, Node reference, + Node observed) { try { // check removed and modified PropertyIterator pit = reference.getProperties(); @@ -830,8 +816,7 @@ public class JcrUtils { if (!observed.hasProperty(name)) { String relPath = propertyRelPath(baseRelPath, name); - PropertyDiff pDiff = new PropertyDiff(PropertyDiff.REMOVED, - relPath, p.getValue(), null); + PropertyDiff pDiff = new PropertyDiff(PropertyDiff.REMOVED, relPath, p.getValue(), null); diffs.put(relPath, pDiff); } else { if (p.isMultiple()) { @@ -841,9 +826,8 @@ public class JcrUtils { Value newValue = observed.getProperty(name).getValue(); if (!referenceValue.equals(newValue)) { String relPath = propertyRelPath(baseRelPath, name); - PropertyDiff pDiff = new PropertyDiff( - PropertyDiff.MODIFIED, relPath, - referenceValue, newValue); + PropertyDiff pDiff = new PropertyDiff(PropertyDiff.MODIFIED, relPath, referenceValue, + newValue); diffs.put(relPath, pDiff); } } @@ -861,25 +845,21 @@ public class JcrUtils { // FIXME implement multiple } else { String relPath = propertyRelPath(baseRelPath, name); - PropertyDiff pDiff = new PropertyDiff( - PropertyDiff.ADDED, relPath, null, p.getValue()); + PropertyDiff pDiff = new PropertyDiff(PropertyDiff.ADDED, relPath, null, p.getValue()); diffs.put(relPath, pDiff); } } } } catch (RepositoryException e) { - throw new ArgeoJcrException("Cannot diff " + reference + " and " - + observed, e); + throw new ArgeoJcrException("Cannot diff " + reference + " and " + observed, e); } } /** - * Compare only a restricted list of properties of two nodes. No - * recursivity. + * Compare only a restricted list of properties of two nodes. No recursivity. * */ - public static Map diffProperties(Node reference, - Node observed, List properties) { + public static Map diffProperties(Node reference, Node observed, List properties) { Map diffs = new TreeMap(); try { Iterator pit = properties.iterator(); @@ -897,35 +877,29 @@ public class JcrUtils { } catch (Exception e) { // not parseable as String, silent } - PropertyDiff pDiff = new PropertyDiff(PropertyDiff.ADDED, - name, null, val); + PropertyDiff pDiff = new PropertyDiff(PropertyDiff.ADDED, name, null, val); diffs.put(name, pDiff); } else if (!observed.hasProperty(name)) { - PropertyDiff pDiff = new PropertyDiff(PropertyDiff.REMOVED, - name, reference.getProperty(name).getValue(), null); + PropertyDiff pDiff = new PropertyDiff(PropertyDiff.REMOVED, name, + reference.getProperty(name).getValue(), null); diffs.put(name, pDiff); } else { - Value referenceValue = reference.getProperty(name) - .getValue(); + Value referenceValue = reference.getProperty(name).getValue(); Value newValue = observed.getProperty(name).getValue(); if (!referenceValue.equals(newValue)) { - PropertyDiff pDiff = new PropertyDiff( - PropertyDiff.MODIFIED, name, referenceValue, - newValue); + PropertyDiff pDiff = new PropertyDiff(PropertyDiff.MODIFIED, name, referenceValue, newValue); diffs.put(name, pDiff); } } } } catch (RepositoryException e) { - throw new ArgeoJcrException("Cannot diff " + reference + " and " - + observed, e); + throw new ArgeoJcrException("Cannot diff " + reference + " and " + observed, e); } return diffs; } /** Builds a property relPath to be used in the diff. */ - private static String propertyRelPath(String baseRelPath, - String propertyName) { + private static String propertyRelPath(String baseRelPath, String propertyName) { if (baseRelPath == null) return propertyName; else @@ -933,8 +907,8 @@ public class JcrUtils { } /** - * Normalizes a name so that it can be stored in contexts not supporting - * names with ':' (typically databases). Replaces ':' by '_'. + * Normalizes a name so that it can be stored in contexts not supporting names + * with ':' (typically databases). Replaces ':' by '_'. */ public static String normalize(String name) { return name.replace(':', '_'); @@ -976,16 +950,16 @@ public class JcrUtils { return name; } - /** - * Removes forbidden characters from a path, replacing them with '_' - * - * @deprecated use {@link #replaceInvalidChars(String)} instead - */ - public static String removeForbiddenCharacters(String str) { - return str.replace('[', '_').replace(']', '_').replace('/', '_') - .replace('*', '_'); - - } + // /** + // * Removes forbidden characters from a path, replacing them with '_' + // * + // * @deprecated use {@link #replaceInvalidChars(String)} instead + // */ + // public static String removeForbiddenCharacters(String str) { + // return str.replace('[', '_').replace(']', '_').replace('/', '_').replace('*', + // '_'); + // + // } /** Cleanly disposes a {@link Binary} even if it is null. */ public static void closeQuietly(Binary binary) { @@ -996,49 +970,48 @@ public class JcrUtils { /** Retrieve a {@link Binary} as a byte array */ public static byte[] getBinaryAsBytes(Property property) { - ByteArrayOutputStream out = new ByteArrayOutputStream(); - InputStream in = null; - Binary binary = null; - try { - binary = property.getBinary(); - in = binary.getStream(); + // ByteArrayOutputStream out = new ByteArrayOutputStream(); + // InputStream in = null; + // Binary binary = null; + try (ByteArrayOutputStream out = new ByteArrayOutputStream(); + Bin binary = new Bin(property); + InputStream in = binary.getStream()) { + // binary = property.getBinary(); + // in = binary.getStream(); IOUtils.copy(in, out); return out.toByteArray(); } catch (Exception e) { - throw new ArgeoJcrException("Cannot read binary " + property - + " as bytes", e); + throw new ArgeoJcrException("Cannot read binary " + property + " as bytes", e); } finally { - IOUtils.closeQuietly(out); - IOUtils.closeQuietly(in); - closeQuietly(binary); + // IOUtils.closeQuietly(out); + // IOUtils.closeQuietly(in); + // closeQuietly(binary); } } /** Writes a {@link Binary} from a byte array */ public static void setBinaryAsBytes(Node node, String property, byte[] bytes) { - InputStream in = null; + // InputStream in = null; Binary binary = null; - try { - in = new ByteArrayInputStream(bytes); + try (InputStream in = new ByteArrayInputStream(bytes)) { + // in = new ByteArrayInputStream(bytes); binary = node.getSession().getValueFactory().createBinary(in); node.setProperty(property, binary); } catch (Exception e) { - throw new ArgeoJcrException("Cannot read binary " + property - + " as bytes", e); + throw new ArgeoJcrException("Cannot read binary " + property + " as bytes", e); } finally { - IOUtils.closeQuietly(in); + // IOUtils.closeQuietly(in); closeQuietly(binary); } } /** - * Creates depth from a string (typically a username) by adding levels based - * on its first characters: "aBcD",2 => a/aB + * Creates depth from a string (typically a username) by adding levels based on + * its first characters: "aBcD",2 becomes a/aB */ public static String firstCharsToPath(String str, Integer nbrOfChars) { if (str.length() < nbrOfChars) - throw new ArgeoJcrException("String " + str - + " length must be greater or equal than " + nbrOfChars); + throw new ArgeoJcrException("String " + str + " length must be greater or equal than " + nbrOfChars); StringBuffer path = new StringBuffer(""); StringBuffer curr = new StringBuffer(""); for (int i = 0; i < nbrOfChars; i++) { @@ -1051,8 +1024,8 @@ public class JcrUtils { } /** - * Discards the current changes in the session attached to this node. To be - * used typically in a catch block. + * Discards the current changes in the session attached to this node. To be used + * typically in a catch block. * * @see #discardQuietly(Session) */ @@ -1060,8 +1033,7 @@ public class JcrUtils { try { discardQuietly(node.getSession()); } catch (RepositoryException e) { - log.warn("Cannot quietly discard session of node " + node + ": " - + e.getMessage()); + log.warn("Cannot quietly discard session of node " + node + ": " + e.getMessage()); } } @@ -1075,17 +1047,16 @@ public class JcrUtils { if (session != null) session.refresh(false); } catch (RepositoryException e) { - log.warn("Cannot quietly discard session " + session + ": " - + e.getMessage()); + log.warn("Cannot quietly discard session " + session + ": " + e.getMessage()); } } /** - * Login to a workspace with implicit credentials, creates the workspace - * with these credentials if it does not already exist. + * Login to a workspace with implicit credentials, creates the workspace with + * these credentials if it does not already exist. */ - public static Session loginOrCreateWorkspace(Repository repository, - String workspaceName) throws RepositoryException { + public static Session loginOrCreateWorkspace(Repository repository, String workspaceName) + throws RepositoryException { Session workspaceSession = null; Session defaultSession = null; try { @@ -1103,56 +1074,49 @@ public class JcrUtils { } } - /** Logs out the session, not throwing any exception, even if it is null. */ + /** + * Logs out the session, not throwing any exception, even if it is null. + * {@link Jcr#logout(Session)} should rather be used. + */ public static void logoutQuietly(Session session) { - try { - if (session != null) - if (session.isLive()) - session.logout(); - } catch (Exception e) { - // silent - } + Jcr.logout(session); +// try { +// if (session != null) +// if (session.isLive()) +// session.logout(); +// } catch (Exception e) { +// // silent +// } } /** * Convenient method to add a listener. uuids passed as null, deep=true, * local=true, only one node type */ - public static void addListener(Session session, EventListener listener, - int eventTypes, String basePath, String nodeType) { + public static void addListener(Session session, EventListener listener, int eventTypes, String basePath, + String nodeType) { try { - session.getWorkspace() - .getObservationManager() - .addEventListener( - listener, - eventTypes, - basePath, - true, - null, - nodeType == null ? null : new String[] { nodeType }, - true); + session.getWorkspace().getObservationManager().addEventListener(listener, eventTypes, basePath, true, null, + nodeType == null ? null : new String[] { nodeType }, true); } catch (RepositoryException e) { - throw new ArgeoJcrException("Cannot add JCR listener " + listener - + " to session " + session, e); + throw new ArgeoJcrException("Cannot add JCR listener " + listener + " to session " + session, e); } } /** Removes a listener without throwing exception */ - public static void removeListenerQuietly(Session session, - EventListener listener) { + public static void removeListenerQuietly(Session session, EventListener listener) { if (session == null || !session.isLive()) return; try { - session.getWorkspace().getObservationManager() - .removeEventListener(listener); + session.getWorkspace().getObservationManager().removeEventListener(listener); } catch (RepositoryException e) { // silent } } /** - * Quietly unregisters an {@link EventListener} from the udnerlying - * workspace of this node. + * Quietly unregisters an {@link EventListener} from the udnerlying workspace of + * this node. */ public static void unregisterQuietly(Node node, EventListener eventListener) { try { @@ -1160,57 +1124,48 @@ public class JcrUtils { } catch (RepositoryException e) { // silent if (log.isTraceEnabled()) - log.trace("Could not unregister event listener " - + eventListener); + log.trace("Could not unregister event listener " + eventListener); } } /** Quietly unregisters an {@link EventListener} from this workspace */ - public static void unregisterQuietly(Workspace workspace, - EventListener eventListener) { + public static void unregisterQuietly(Workspace workspace, EventListener eventListener) { if (eventListener == null) return; try { - workspace.getObservationManager() - .removeEventListener(eventListener); + workspace.getObservationManager().removeEventListener(eventListener); } catch (RepositoryException e) { // silent if (log.isTraceEnabled()) - log.trace("Could not unregister event listener " - + eventListener); + log.trace("Could not unregister event listener " + eventListener); } } /** - * If this node is has the {@link NodeType#MIX_LAST_MODIFIED} mixin, it - * updates the {@link Property#JCR_LAST_MODIFIED} property with the current - * time and the {@link Property#JCR_LAST_MODIFIED_BY} property with the - * underlying session user id. In Jackrabbit 2.x, these properties - * are not automatically updated, hence the need for manual update. The - * session is not saved. + * If this node is has the {@link NodeType#MIX_LAST_MODIFIED} mixin, it updates + * the {@link Property#JCR_LAST_MODIFIED} property with the current time and the + * {@link Property#JCR_LAST_MODIFIED_BY} property with the underlying session + * user id. In Jackrabbit 2.x, + * these properties are + * not automatically updated, hence the need for manual update. The session + * is not saved. */ public static void updateLastModified(Node node) { try { if (!node.isNodeType(NodeType.MIX_LAST_MODIFIED)) node.addMixin(NodeType.MIX_LAST_MODIFIED); - node.setProperty(Property.JCR_LAST_MODIFIED, - new GregorianCalendar()); - node.setProperty(Property.JCR_LAST_MODIFIED_BY, node.getSession() - .getUserID()); + node.setProperty(Property.JCR_LAST_MODIFIED, new GregorianCalendar()); + node.setProperty(Property.JCR_LAST_MODIFIED_BY, node.getSession().getUserID()); } catch (RepositoryException e) { - throw new ArgeoJcrException("Cannot update last modified on " + node, - e); + throw new ArgeoJcrException("Cannot update last modified on " + node, e); } } /** * Update lastModified recursively until this parent. * - * @param node - * the node - * @param untilPath - * the base path, null is equivalent to "/" + * @param node the node + * @param untilPath the base path, null is equivalent to "/" */ public static void updateLastModifiedAndParents(Node node, String untilPath) { try { @@ -1225,14 +1180,13 @@ public class JcrUtils { updateLastModifiedAndParents(node.getParent(), untilPath); } } catch (RepositoryException e) { - throw new ArgeoJcrException("Cannot update lastModified from " + node - + " until " + untilPath, e); + throw new ArgeoJcrException("Cannot update lastModified from " + node + " until " + untilPath, e); } } /** - * Returns a String representing the short version (see Node type + * Returns a String representing the short version (see + * Node type * Notation attributes grammar) of the main business attributes of this * property definition * @@ -1250,17 +1204,15 @@ public class JcrUtils { if (prop.getDefinition().isMultiple()) sbuf.append("*"); } catch (RepositoryException re) { - throw new ArgeoJcrException( - "unexpected error while getting property definition as String", - re); + throw new ArgeoJcrException("unexpected error while getting property definition as String", re); } return sbuf.toString(); } /** - * Estimate the sub tree size from current node. Computation is based on the - * Jcr {@link Property.getLength()} method. Note : it is not the exact size - * used on the disk by the current part of the JCR Tree. + * Estimate the sub tree size from current node. Computation is based on the Jcr + * {@link Property#getLength()} method. Note : it is not the exact size used on + * the disk by the current part of the JCR Tree. */ public static long getNodeApproxSize(Node node) { @@ -1272,8 +1224,7 @@ public class JcrUtils { if (prop.isMultiple()) { int nb = prop.getLengths().length; for (int i = 0; i < nb; i++) { - curNodeSize += (prop.getLengths()[i] > 0 ? prop - .getLengths()[i] : 0); + curNodeSize += (prop.getLengths()[i] > 0 ? prop.getLengths()[i] : 0); } } else curNodeSize += (prop.getLength() > 0 ? prop.getLength() : 0); @@ -1284,9 +1235,7 @@ public class JcrUtils { curNodeSize += getNodeApproxSize(ni.nextNode()); return curNodeSize; } catch (RepositoryException re) { - throw new ArgeoJcrException( - "Unexpected error while recursively determining node size.", - re); + throw new ArgeoJcrException("Unexpected error while recursively determining node size.", re); } } @@ -1298,29 +1247,26 @@ public class JcrUtils { * Convenience method for adding a single privilege to a principal (user or * role), typically jcr:all */ - public synchronized static void addPrivilege(Session session, String path, - String principal, String privilege) throws RepositoryException { + public synchronized static void addPrivilege(Session session, String path, String principal, String privilege) + throws RepositoryException { List privileges = new ArrayList(); - privileges.add(session.getAccessControlManager().privilegeFromName( - privilege)); + privileges.add(session.getAccessControlManager().privilegeFromName(privilege)); addPrivileges(session, path, new SimplePrincipal(principal), privileges); } /** - * Add privileges on a path to a {@link Principal}. The path must already - * exist. Session is saved. Synchronized to prevent concurrent modifications - * of the same node. + * Add privileges on a path to a {@link Principal}. The path must already exist. + * Session is saved. Synchronized to prevent concurrent modifications of the + * same node. */ - public synchronized static Boolean addPrivileges(Session session, - String path, Principal principal, List privs) - throws RepositoryException { + public synchronized static Boolean addPrivileges(Session session, String path, Principal principal, + List privs) throws RepositoryException { // make sure the session is in line with the persisted state session.refresh(false); AccessControlManager acm = session.getAccessControlManager(); AccessControlList acl = getAccessControlList(acm, path); - accessControlEntries: for (AccessControlEntry ace : acl - .getAccessControlEntries()) { + accessControlEntries: for (AccessControlEntry ace : acl.getAccessControlEntries()) { Principal currentPrincipal = ace.getPrincipal(); if (currentPrincipal.getName().equals(principal.getName())) { Privilege[] currentPrivileges = ace.getPrivileges(); @@ -1344,8 +1290,7 @@ public class JcrUtils { StringBuffer privBuf = new StringBuffer(); for (Privilege priv : privs) privBuf.append(priv.getName()); - log.debug("Added privileges " + privBuf + " to " - + principal.getName() + " on " + path + " in '" + log.debug("Added privileges " + privBuf + " to " + principal.getName() + " on " + path + " in '" + session.getWorkspace().getName() + "'"); } session.refresh(true); @@ -1354,16 +1299,14 @@ public class JcrUtils { } /** Gets access control list for this path, throws exception if not found */ - public synchronized static AccessControlList getAccessControlList( - AccessControlManager acm, String path) throws RepositoryException { + public synchronized static AccessControlList getAccessControlList(AccessControlManager acm, String path) + throws RepositoryException { // search for an access control list AccessControlList acl = null; - AccessControlPolicyIterator policyIterator = acm - .getApplicablePolicies(path); + AccessControlPolicyIterator policyIterator = acm.getApplicablePolicies(path); if (policyIterator.hasNext()) { while (policyIterator.hasNext()) { - AccessControlPolicy acp = policyIterator - .nextAccessControlPolicy(); + AccessControlPolicy acp = policyIterator.nextAccessControlPolicy(); if (acp instanceof AccessControlList) acl = ((AccessControlList) acp); } @@ -1381,8 +1324,8 @@ public class JcrUtils { } /** Clear authorizations for a user at this path */ - public synchronized static void clearAccessControList(Session session, - String path, String username) throws RepositoryException { + public synchronized static void clearAccessControList(Session session, String path, String username) + throws RepositoryException { AccessControlManager acm = session.getAccessControlManager(); AccessControlList acl = getAccessControlList(acm, path); for (AccessControlEntry ace : acl.getAccessControlEntries()) { @@ -1402,43 +1345,44 @@ public class JcrUtils { * Creates the nodes making the path as {@link NodeType#NT_FOLDER} */ public static Node mkfolders(Session session, String path) { - return mkdirs(session, path, NodeType.NT_FOLDER, NodeType.NT_FOLDER, - false); + return mkdirs(session, path, NodeType.NT_FOLDER, NodeType.NT_FOLDER, false); } /** * Copy only nt:folder and nt:file, without their additional types and * properties. * - * @param recursive - * if true copies folders as well, otherwise only first level - * files + * @param recursive if true copies folders as well, otherwise only first level + * files * @return how many files were copied */ - public static Long copyFiles(Node fromNode, Node toNode, Boolean recursive, - JcrMonitor monitor) { + public static Long copyFiles(Node fromNode, Node toNode, Boolean recursive, JcrMonitor monitor, boolean onlyAdd) { long count = 0l; - Binary binary = null; - InputStream in = null; + // Binary binary = null; + // InputStream in = null; try { NodeIterator fromChildren = fromNode.getNodes(); - while (fromChildren.hasNext()) { + children: while (fromChildren.hasNext()) { if (monitor != null && monitor.isCanceled()) - throw new ArgeoJcrException( - "Copy cancelled before it was completed"); + throw new ArgeoJcrException("Copy cancelled before it was completed"); Node fromChild = fromChildren.nextNode(); String fileName = fromChild.getName(); if (fromChild.isNodeType(NodeType.NT_FILE)) { + if (onlyAdd && toNode.hasNode(fileName)) { + monitor.subTask("Skip existing " + fileName); + continue children; + } + if (monitor != null) monitor.subTask("Copy " + fileName); - binary = fromChild.getNode(Node.JCR_CONTENT) - .getProperty(Property.JCR_DATA).getBinary(); - in = binary.getStream(); - copyStreamAsFile(toNode, fileName, in); - IOUtils.closeQuietly(in); - closeQuietly(binary); + try (Bin binary = new Bin(fromChild.getNode(Node.JCR_CONTENT).getProperty(Property.JCR_DATA)); + InputStream in = binary.getStream();) { + copyStreamAsFile(toNode, fileName, in); + } + // IOUtils.closeQuietly(in); + // closeQuietly(binary); // save session toNode.getSession().save(); @@ -1448,40 +1392,34 @@ public class JcrUtils { log.debug("Copied file " + fromChild.getPath()); if (monitor != null) monitor.worked(1); - } else if (fromChild.isNodeType(NodeType.NT_FOLDER) - && recursive) { + } else if (fromChild.isNodeType(NodeType.NT_FOLDER) && recursive) { Node toChildFolder; if (toNode.hasNode(fileName)) { toChildFolder = toNode.getNode(fileName); if (!toChildFolder.isNodeType(NodeType.NT_FOLDER)) - throw new ArgeoJcrException(toChildFolder - + " is not of type nt:folder"); + throw new ArgeoJcrException(toChildFolder + " is not of type nt:folder"); } else { - toChildFolder = toNode.addNode(fileName, - NodeType.NT_FOLDER); + toChildFolder = toNode.addNode(fileName, NodeType.NT_FOLDER); // save session toNode.getSession().save(); } - count = count - + copyFiles(fromChild, toChildFolder, recursive, - monitor); + count = count + copyFiles(fromChild, toChildFolder, recursive, monitor, onlyAdd); } } return count; - } catch (RepositoryException e) { - throw new ArgeoJcrException("Cannot copy files between " + fromNode - + " and " + toNode); + } catch (RepositoryException | IOException e) { + throw new ArgeoJcrException("Cannot copy files between " + fromNode + " and " + toNode); } finally { // in case there was an exception - IOUtils.closeQuietly(in); - closeQuietly(binary); + // IOUtils.closeQuietly(in); + // closeQuietly(binary); } } /** - * Iteratively count all file nodes in subtree, inefficient but can be - * useful when query are poorly supported, such as in remoting. + * Iteratively count all file nodes in subtree, inefficient but can be useful + * when query are poorly supported, such as in remoting. */ public static Long countFiles(Node node) { Long localCount = 0l; @@ -1500,47 +1438,43 @@ public class JcrUtils { } /** - * Copy a file as an nt:file, assuming an nt:folder hierarchy. The session - * is NOT saved. + * Copy a file as an nt:file, assuming an nt:folder hierarchy. The session is + * NOT saved. * * @return the created file node */ public static Node copyFile(Node folderNode, File file) { - InputStream in = null; - try { - in = new FileInputStream(file); + // InputStream in = null; + try (InputStream in = new FileInputStream(file)) { + // in = new FileInputStream(file); return copyStreamAsFile(folderNode, file.getName(), in); } catch (IOException e) { - throw new ArgeoJcrException("Cannot copy file " + file + " under " - + folderNode, e); - } finally { - IOUtils.closeQuietly(in); + throw new ArgeoJcrException("Cannot copy file " + file + " under " + folderNode, e); + // } finally { + // IOUtils.closeQuietly(in); } } /** Copy bytes as an nt:file */ - public static Node copyBytesAsFile(Node folderNode, String fileName, - byte[] bytes) { - InputStream in = null; - try { - in = new ByteArrayInputStream(bytes); + public static Node copyBytesAsFile(Node folderNode, String fileName, byte[] bytes) { + // InputStream in = null; + try (InputStream in = new ByteArrayInputStream(bytes)) { + // in = new ByteArrayInputStream(bytes); return copyStreamAsFile(folderNode, fileName, in); } catch (Exception e) { - throw new ArgeoJcrException("Cannot copy file " + fileName + " under " - + folderNode, e); - } finally { - IOUtils.closeQuietly(in); + throw new ArgeoJcrException("Cannot copy file " + fileName + " under " + folderNode, e); + // } finally { + // IOUtils.closeQuietly(in); } } /** - * Copy a stream as an nt:file, assuming an nt:folder hierarchy. The session - * is NOT saved. + * Copy a stream as an nt:file, assuming an nt:folder hierarchy. The session is + * NOT saved. * * @return the created file node */ - public static Node copyStreamAsFile(Node folderNode, String fileName, - InputStream in) { + public static Node copyStreamAsFile(Node folderNode, String fileName, InputStream in) { Binary binary = null; try { Node fileNode; @@ -1548,42 +1482,75 @@ public class JcrUtils { if (folderNode.hasNode(fileName)) { fileNode = folderNode.getNode(fileName); if (!fileNode.isNodeType(NodeType.NT_FILE)) - throw new ArgeoJcrException(fileNode - + " is not of type nt:file"); + throw new ArgeoJcrException(fileNode + " is not of type nt:file"); // we assume that the content node is already there contentNode = fileNode.getNode(Node.JCR_CONTENT); } else { fileNode = folderNode.addNode(fileName, NodeType.NT_FILE); - contentNode = fileNode.addNode(Node.JCR_CONTENT, - NodeType.NT_RESOURCE); + contentNode = fileNode.addNode(Node.JCR_CONTENT, NodeType.NT_RESOURCE); } - binary = contentNode.getSession().getValueFactory() - .createBinary(in); + binary = contentNode.getSession().getValueFactory().createBinary(in); contentNode.setProperty(Property.JCR_DATA, binary); return fileNode; } catch (Exception e) { - throw new ArgeoJcrException("Cannot create file node " + fileName - + " under " + folderNode, e); + throw new ArgeoJcrException("Cannot create file node " + fileName + " under " + folderNode, e); } finally { closeQuietly(binary); } } - /** Computes the checksum of an nt:file */ + /** + * Computes the checksum of an nt:file. + * + * @deprecated use separate digest utilities + */ + @Deprecated public static String checksumFile(Node fileNode, String algorithm) { Binary data = null; - InputStream in = null; - try { - data = fileNode.getNode(Node.JCR_CONTENT) - .getProperty(Property.JCR_DATA).getBinary(); - in = data.getStream(); - return DigestUtils.digest(algorithm, in); - } catch (RepositoryException e) { + try (InputStream in = fileNode.getNode(Node.JCR_CONTENT).getProperty(Property.JCR_DATA).getBinary() + .getStream()) { + return digest(algorithm, in); + } catch (RepositoryException | IOException e) { throw new ArgeoJcrException("Cannot checksum file " + fileNode, e); } finally { - IOUtils.closeQuietly(in); closeQuietly(data); } } + @Deprecated + private static String digest(String algorithm, InputStream in) { + final Integer byteBufferCapacity = 100 * 1024;// 100 KB + try { + MessageDigest digest = MessageDigest.getInstance(algorithm); + byte[] buffer = new byte[byteBufferCapacity]; + int read = 0; + while ((read = in.read(buffer)) > 0) { + digest.update(buffer, 0, read); + } + + byte[] checksum = digest.digest(); + String res = encodeHexString(checksum); + return res; + } catch (Exception e) { + throw new ArgeoJcrException("Cannot digest with algorithm " + algorithm, e); + } + } + + /** + * From + * http://stackoverflow.com/questions/9655181/how-to-convert-a-byte-array-to + * -a-hex-string-in-java + */ + @Deprecated + private static String encodeHexString(byte[] bytes) { + final char[] hexArray = "0123456789abcdef".toCharArray(); + char[] hexChars = new char[bytes.length * 2]; + for (int j = 0; j < bytes.length; j++) { + int v = bytes[j] & 0xFF; + hexChars[j * 2] = hexArray[v >>> 4]; + hexChars[j * 2 + 1] = hexArray[v & 0x0F]; + } + return new String(hexChars); + } + }