X-Git-Url: https://git.argeo.org/?a=blobdiff_plain;f=org.argeo.jcr%2Fsrc%2Forg%2Fargeo%2Fjcr%2FJcr.java;h=6f0e39d8298759db33affea0dc57d9a69b7bb47f;hb=93989c5786472b5fad58aec868fcfd1cd07059da;hp=0f6059c7f36d09dee42d6c0f85feeb55d622512e;hpb=b5644c1dac96afe8b9bdcd68068c054a9f780926;p=lgpl%2Fargeo-commons.git diff --git a/org.argeo.jcr/src/org/argeo/jcr/Jcr.java b/org.argeo.jcr/src/org/argeo/jcr/Jcr.java index 0f6059c7f..6f0e39d82 100644 --- a/org.argeo.jcr/src/org/argeo/jcr/Jcr.java +++ b/org.argeo.jcr/src/org/argeo/jcr/Jcr.java @@ -36,65 +36,120 @@ import javax.jcr.version.VersionManager; * exceptions. Loosely inspired by Java's Files singleton. */ public class Jcr { + /** + * The name of a node which will be serialized as XML text, as per section 7.3.1 + * of the JCR 2.0 specifications. + */ + public final static String JCR_XMLTEXT = "jcr:xmltext"; + /** + * The name of a property which will be serialized as XML text, as per section + * 7.3.1 of the JCR 2.0 specifications. + */ + public final static String JCR_XMLCHARACTERS = "jcr:xmlcharacters"; + /** + * jcr:name, when used in another context than + * {@link Property#JCR_NAME}, typically to name a node rather than a property. + */ + public final static String JCR_NAME = "jcr:name"; + /** + * jcr:path, when used in another context than + * {@link Property#JCR_PATH}, typically to name a node rather than a property. + */ + public final static String JCR_PATH = "jcr:path"; + /** + * jcr:primaryType with prefix instead of namespace (as in + * {@link Property#JCR_PRIMARY_TYPE}. + */ + public final static String JCR_PRIMARY_TYPE = "jcr:primaryType"; + /** + * jcr:mixinTypes with prefix instead of namespace (as in + * {@link Property#JCR_MIXIN_TYPES}. + */ + public final static String JCR_MIXIN_TYPES = "jcr:mixinTypes"; + /** + * jcr:uuid with prefix instead of namespace (as in + * {@link Property#JCR_UUID}. + */ + public final static String JCR_UUID = "jcr:uuid"; + /** + * jcr:created with prefix instead of namespace (as in + * {@link Property#JCR_CREATED}. + */ + public final static String JCR_CREATED = "jcr:created"; + /** + * jcr:createdBy with prefix instead of namespace (as in + * {@link Property#JCR_CREATED_BY}. + */ + public final static String JCR_CREATED_BY = "jcr:createdBy"; + /** + * jcr:lastModified with prefix instead of namespace (as in + * {@link Property#JCR_LAST_MODIFIED}. + */ + public final static String JCR_LAST_MODIFIED = "jcr:lastModified"; + /** + * jcr:lastModifiedBy with prefix instead of namespace (as in + * {@link Property#JCR_LAST_MODIFIED_BY}. + */ + public final static String JCR_LAST_MODIFIED_BY = "jcr:lastModifiedBy"; /** * @see Node#isNodeType(String) - * @throws IllegalStateException caused by {@link RepositoryException} + * @throws JcrException caused by {@link RepositoryException} */ public static boolean isNodeType(Node node, String nodeTypeName) { try { return node.isNodeType(nodeTypeName); } catch (RepositoryException e) { - throw new IllegalStateException("Cannot get whether " + node + " is of type " + nodeTypeName, e); + throw new JcrException("Cannot get whether " + node + " is of type " + nodeTypeName, e); } } /** * @see Node#hasNodes() - * @throws IllegalStateException caused by {@link RepositoryException} + * @throws JcrException caused by {@link RepositoryException} */ public static boolean hasNodes(Node node) { try { return node.hasNodes(); } catch (RepositoryException e) { - throw new IllegalStateException("Cannot get whether " + node + " has children.", e); + throw new JcrException("Cannot get whether " + node + " has children.", e); } } /** * @see Node#getParent() - * @throws IllegalStateException caused by {@link RepositoryException} + * @throws JcrException caused by {@link RepositoryException} */ public static Node getParent(Node node) { try { return isRoot(node) ? null : node.getParent(); } catch (RepositoryException e) { - throw new IllegalStateException("Cannot get parent of " + node, e); + throw new JcrException("Cannot get parent of " + node, e); } } /** * Whether this node is the root node. * - * @throws IllegalStateException caused by {@link RepositoryException} + * @throws JcrException caused by {@link RepositoryException} */ public static boolean isRoot(Node node) { try { return node.getDepth() == 0; } catch (RepositoryException e) { - throw new IllegalStateException("Cannot get depth of " + node, e); + throw new JcrException("Cannot get depth of " + node, e); } } /** * @see Node#getPath() - * @throws IllegalStateException caused by {@link RepositoryException} + * @throws JcrException caused by {@link RepositoryException} */ public static String getPath(Node node) { try { return node.getPath(); } catch (RepositoryException e) { - throw new IllegalStateException("Cannot get path of " + node, e); + throw new JcrException("Cannot get path of " + node, e); } } @@ -109,25 +164,25 @@ public class Jcr { /** * @see Node#getIdentifier() - * @throws IllegalStateException caused by {@link RepositoryException} + * @throws JcrException caused by {@link RepositoryException} */ public static String getIdentifier(Node node) { try { return node.getIdentifier(); } catch (RepositoryException e) { - throw new IllegalStateException("Cannot get identifier of " + node, e); + throw new JcrException("Cannot get identifier of " + node, e); } } /** * @see Node#getName() - * @throws IllegalStateException caused by {@link RepositoryException} + * @throws JcrException caused by {@link RepositoryException} */ public static String getName(Node node) { try { return node.getName(); } catch (RepositoryException e) { - throw new IllegalStateException("Cannot get name of " + node, e); + throw new JcrException("Cannot get name of " + node, e); } } @@ -157,20 +212,20 @@ public class Jcr { /** * @return the children as an {@link Iterable} for use in for-each llops. * @see Node#getNodes() - * @throws IllegalStateException caused by {@link RepositoryException} + * @throws JcrException caused by {@link RepositoryException} */ public static Iterable nodes(Node node) { try { return iterate(node.getNodes()); } catch (RepositoryException e) { - throw new IllegalStateException("Cannot get children of " + node, e); + throw new JcrException("Cannot get children of " + node, e); } } /** * @return the children as a (possibly empty) {@link List}. * @see Node#getNodes() - * @throws IllegalStateException caused by {@link RepositoryException} + * @throws JcrException caused by {@link RepositoryException} */ public static List getNodes(Node node) { List nodes = new ArrayList<>(); @@ -183,14 +238,14 @@ public class Jcr { } else return nodes; } catch (RepositoryException e) { - throw new IllegalStateException("Cannot get children of " + node, e); + throw new JcrException("Cannot get children of " + node, e); } } /** * @return the child or null if not found * @see Node#getNode(String) - * @throws IllegalStateException caused by {@link RepositoryException} + * @throws JcrException caused by {@link RepositoryException} */ public static Node getNode(Node node, String child) { try { @@ -199,14 +254,14 @@ public class Jcr { else return null; } catch (RepositoryException e) { - throw new IllegalStateException("Cannot get child of " + node, e); + throw new JcrException("Cannot get child of " + node, e); } } /** * @return the node at this path or null if not found * @see Session#getNode(String) - * @throws IllegalStateException caused by {@link RepositoryException} + * @throws JcrException caused by {@link RepositoryException} */ public static Node getNode(Session session, String path) { try { @@ -215,14 +270,14 @@ public class Jcr { else return null; } catch (RepositoryException e) { - throw new IllegalStateException("Cannot get node " + path, e); + throw new JcrException("Cannot get node " + path, e); } } /** * @return the node with htis id or null if not found * @see Session#getNodeByIdentifier(String) - * @throws IllegalStateException caused by {@link RepositoryException} + * @throws JcrException caused by {@link RepositoryException} */ public static Node getNodeById(Session session, String id) { try { @@ -230,7 +285,7 @@ public class Jcr { } catch (ItemNotFoundException e) { return null; } catch (RepositoryException e) { - throw new IllegalStateException("Cannot get node with id " + id, e); + throw new JcrException("Cannot get node with id " + id, e); } } @@ -238,12 +293,17 @@ public class Jcr { * Set a property to the given value, or remove it if the value is * null. * - * @throws IllegalStateException caused by {@link RepositoryException} + * @throws JcrException caused by {@link RepositoryException} */ public static void set(Node node, String property, Object value) { try { - if (!node.hasProperty(property)) - throw new IllegalArgumentException("No property " + property + " in " + node); + if (!node.hasProperty(property)) { + if (value != null) + node.setProperty(property, value.toString()); + return; + // throw new IllegalArgumentException("No property " + property + " in " + + // node); + } Property prop = node.getProperty(property); if (value == null) { prop.remove(); @@ -254,8 +314,12 @@ public class Jcr { prop.setValue((String) value); else if (value instanceof Long) prop.setValue((Long) value); + else if (value instanceof Integer) + prop.setValue(((Integer) value).longValue()); else if (value instanceof Double) prop.setValue((Double) value); + else if (value instanceof Float) + prop.setValue(((Float) value).doubleValue()); else if (value instanceof Calendar) prop.setValue((Calendar) value); else if (value instanceof BigDecimal) @@ -272,7 +336,7 @@ public class Jcr { } else // try with toString() prop.setValue(value.toString()); } catch (RepositoryException e) { - throw new IllegalStateException("Cannot set property " + property + " of " + node + " to " + value, e); + throw new JcrException("Cannot set property " + property + " of " + node + " to " + value, e); } } @@ -282,28 +346,38 @@ public class Jcr { * @return the value of * {@link Node#getProperty(String)}.{@link Property#getString()} or * null if the property does not exist. - * @throws IllegalStateException caused by {@link RepositoryException} + * @throws JcrException caused by {@link RepositoryException} */ public static String get(Node node, String property) { return get(node, property, null); } /** - * Get property as a {@link String}. + * Get property as a {@link String}. If the property is multiple it returns the + * first value. * * @return the value of * {@link Node#getProperty(String)}.{@link Property#getString()} or * defaultValue if the property does not exist. - * @throws IllegalStateException caused by {@link RepositoryException} + * @throws JcrException caused by {@link RepositoryException} */ public static String get(Node node, String property, String defaultValue) { try { - if (node.hasProperty(property)) - return node.getProperty(property).getString(); - else + if (node.hasProperty(property)) { + Property p = node.getProperty(property); + if (!p.isMultiple()) + return p.getString(); + else { + Value[] values = p.getValues(); + if (values.length == 0) + return defaultValue; + else + return values[0].getString(); + } + } else return defaultValue; } catch (RepositoryException e) { - throw new IllegalStateException("Cannot retrieve property " + property + " from " + node); + throw new JcrException("Cannot retrieve property " + property + " from " + node, e); } } @@ -312,7 +386,7 @@ public class Jcr { * * @return {@link Node#getProperty(String)} or null if the property * does not exist. - * @throws IllegalStateException caused by {@link RepositoryException} + * @throws JcrException caused by {@link RepositoryException} */ public static Value getValue(Node node, String property) { try { @@ -321,7 +395,7 @@ public class Jcr { else return null; } catch (RepositoryException e) { - throw new IllegalStateException("Cannot retrieve property " + property + " from " + node); + throw new JcrException("Cannot retrieve property " + property + " from " + node, e); } } @@ -331,12 +405,13 @@ public class Jcr { * @return the value of {@link Node#getProperty(String)} or * defaultValue if the property does not exist. * @throws IllegalArgumentException if the value could not be cast - * @throws IllegalStateException in case of unexpected + * @throws JcrException in case of unexpected * {@link RepositoryException} */ @SuppressWarnings("unchecked") public static T getAs(Node node, String property, T defaultValue) { try { + // TODO deal with multiple if (node.hasProperty(property)) { Property p = node.getProperty(property); try { @@ -362,7 +437,7 @@ public class Jcr { return defaultValue; } } catch (RepositoryException e) { - throw new IllegalStateException("Cannot retrieve property " + property + " from " + node); + throw new JcrException("Cannot retrieve property " + property + " from " + node, e); } } @@ -381,7 +456,25 @@ public class Jcr { try { return node.getSession(); } catch (RepositoryException e) { - throw new IllegalStateException("Cannot retrieve session related to " + node, e); + throw new JcrException("Cannot retrieve session related to " + node, e); + } + } + + /** Retrieves the root node related to this session. */ + public static Node getRootNode(Session session) { + try { + return session.getRootNode(); + } catch (RepositoryException e) { + throw new JcrException("Cannot get root node for " + session, e); + } + } + + /** Whether this item exists. */ + public static boolean itemExists(Session session, String path) { + try { + return session.itemExists(path); + } catch (RepositoryException e) { + throw new JcrException("Cannot check whether " + path + " exists", e); } } @@ -399,7 +492,7 @@ public class Jcr { if (session.hasPendingChanges()) session.save(); } catch (RepositoryException e) { - throw new IllegalStateException("Cannot save session related to " + node + " in workspace " + throw new JcrException("Cannot save session related to " + node + " in workspace " + session(node).getWorkspace().getName(), e); } } @@ -442,7 +535,7 @@ public class Jcr { Session session = node.getSession(); JcrUtils.addPrivilege(session, node.getPath(), principal, privilege); } catch (RepositoryException e) { - throw new IllegalStateException("Cannot add privilege " + privilege + " to " + node, e); + throw new JcrException("Cannot add privilege " + privilege + " to " + node, e); } } @@ -454,7 +547,7 @@ public class Jcr { try { return node.isCheckedOut(); } catch (RepositoryException e) { - throw new IllegalStateException("Cannot retrieve checked out status of " + node, e); + throw new JcrException("Cannot retrieve checked out status of " + node, e); } } @@ -463,7 +556,7 @@ public class Jcr { try { versionManager(node).checkpoint(node.getPath()); } catch (RepositoryException e) { - throw new IllegalStateException("Cannot check in " + node, e); + throw new JcrException("Cannot check in " + node, e); } } @@ -472,7 +565,7 @@ public class Jcr { try { versionManager(node).checkin(node.getPath()); } catch (RepositoryException e) { - throw new IllegalStateException("Cannot check in " + node, e); + throw new JcrException("Cannot check in " + node, e); } } @@ -481,7 +574,7 @@ public class Jcr { try { versionManager(node).checkout(node.getPath()); } catch (RepositoryException e) { - throw new IllegalStateException("Cannot check out " + node, e); + throw new JcrException("Cannot check out " + node, e); } } @@ -490,7 +583,7 @@ public class Jcr { try { return node.getSession().getWorkspace().getVersionManager(); } catch (RepositoryException e) { - throw new IllegalStateException("Cannot get version manager from " + node, e); + throw new JcrException("Cannot get version manager from " + node, e); } } @@ -499,7 +592,7 @@ public class Jcr { try { return versionManager(node).getVersionHistory(node.getPath()); } catch (RepositoryException e) { - throw new IllegalStateException("Cannot get version history from " + node, e); + throw new JcrException("Cannot get version history from " + node, e); } } @@ -517,7 +610,7 @@ public class Jcr { Collections.reverse(lst); return lst; } catch (RepositoryException e) { - throw new IllegalStateException("Cannot get linear versions from " + versionHistory, e); + throw new JcrException("Cannot get linear versions from " + versionHistory, e); } } @@ -526,7 +619,7 @@ public class Jcr { try { return version.getFrozenNode(); } catch (RepositoryException e) { - throw new IllegalStateException("Cannot get frozen node from " + version, e); + throw new JcrException("Cannot get frozen node from " + version, e); } } @@ -535,7 +628,7 @@ public class Jcr { try { return versionManager(node).getBaseVersion(node.getPath()); } catch (RepositoryException e) { - throw new IllegalStateException("Cannot get base version from " + node, e); + throw new JcrException("Cannot get base version from " + node, e); } } @@ -553,7 +646,7 @@ public class Jcr { throw new IllegalArgumentException(fileNode + " must be a file."); return getBinarySize(fileNode.getNode(Node.JCR_CONTENT).getProperty(Property.JCR_DATA).getBinary()); } catch (RepositoryException e) { - throw new IllegalStateException("Cannot get file size of " + fileNode, e); + throw new JcrException("Cannot get file size of " + fileNode, e); } } @@ -564,7 +657,7 @@ public class Jcr { return binary.getSize(); } } catch (RepositoryException e) { - throw new IllegalStateException("Cannot get file size of binary " + binaryArg, e); + throw new JcrException("Cannot get file size of binary " + binaryArg, e); } }