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;
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 {
* 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() {
* 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;
/**
* 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);
}
}
+ /** 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);
+ }
+ }
+
/** Concisely get the boolean value of a property */
public static Boolean check(Node node, String propertyName) {
try {
/**
* 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) {
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) {
List<String> tokens = tokenize(relativePath);
}
/**
- * 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) {
try {
}
/**
- * @param type
- * the type of the leaf node
+ * @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. Requires read access to the root
- * node of the workspace.
+ * 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) {
try {
- if (path.equals('/'))
+ if (path.equals("/"))
return session.getRootNode();
if (session.itemExists(path)) {
// }
/**
- * 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) {
try {
}
/**
- * 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) {
try {
* 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 {
}
/**
- * 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) {
try {
}
/**
- * 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<String, PropertyDiff> diffs, String baseRelPath, Node reference,
Node observed) {
}
/**
- * 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<String, PropertyDiff> diffProperties(Node reference, Node observed, List<String> properties) {
}
/**
- * 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(':', '_');
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) {
/** 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);
} 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);
} 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 becomes 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)
}
/**
- * 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)
*/
}
/**
- * 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 {
}
}
- /** 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
+// }
}
/**
}
/**
- * 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 {
}
/**
- * 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,
- * <a href="https://issues.apache.org/jira/browse/JCR-2233">these properties
- * are not automatically updated</a>, 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,
+ * <a href="https://issues.apache.org/jira/browse/JCR-2233">these properties are
+ * not automatically updated</a>, hence the need for manual update. The session
+ * is not saved.
*/
public static void updateLastModified(Node node) {
try {
/**
* 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 {
}
/**
- * 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) {
}
/**
- * 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<Privilege> privs) throws RepositoryException {
* 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");
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();
// 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) {
+ } 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;
}
/**
- * 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);
+ // } 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);
+ // 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);
+ // } 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
*/
}
}
- /** 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);
+ }
+
}
projects / lgpl / argeo-commons.git / blobdiff