org.argeo.jcr

Class Jcr

java.lang.Object

org.argeo.jcr.Jcr

public class Jcr
extends java.lang.Object

Utility class whose purpose is to make using JCR less verbose by systematically using unchecked exceptions and returning null when something is not found. This is especially useful when writing user interfaces (such as with SWT) where listeners and callbacks expect unchecked exceptions. Loosely inspired by Java's Files singleton.

Method Summary

Modifier and Type	Method and Description
static void	addPrivilege(Node node, java.lang.String principal, java.lang.String privilege) Add a single privilege to a node.
static void	checkin(Node node)
static void	checkout(Node node)
static void	checkpoint(Node node)
static java.lang.String	get(Node node, java.lang.String property) Get property as String.
static java.lang.String	get(Node node, java.lang.String property, java.lang.String defaultValue) Get property as a String.
static <T> T	getAs(Node node, java.lang.String property, T defaultValue) Get property doing a best effort to cast it as the target object.
static Version	getBaseVersion(Node node) Get the base Version related to this node.
static long	getBinarySize(Binary binaryArg) Returns the size of this Binary.
static long	getFileSize(Node fileNode) Returns the size of this file.
static Node	getFrozenNode(Version version) The frozen node related to this Version.
static java.lang.String	getIdentifier(Node node)
static java.util.List<Version>	getLinearVersions(VersionHistory versionHistory) The linear versions of this version history in reverse order and without the root version.
static java.lang.String	getName(Node node)
static Node	getNode(Node node, java.lang.String child)
static Node	getNode(Session session, java.lang.String path)
static Node	getNodeById(Session session, java.lang.String id)
static java.util.List<Node>	getNodes(Node node)
static Node	getParent(Node node)
static java.lang.String	getPath(Node node)
static Value	getValue(Node node, java.lang.String property) Get property as a Value.
static VersionHistory	getVersionHistory(Node node) Get the VersionHistory related to this node.
static boolean	hasNodes(Node node)
static boolean	isCheckedOut(Node node) Get checked out status.
static boolean	isNodeType(Node node, java.lang.String nodeTypeName)
static boolean	isRoot(Node node) Whether this node is the root node.
static java.lang.Iterable<Node>	iterate(NodeIterator nodeIterator) Accesses a NodeIterator as an Iterable.
static Session	login(Repository repository, java.lang.String workspace) Login to a JCR repository.
static void	logout(Session session) Safely and silently logs out a session.
static java.lang.Iterable<Node>	nodes(Node node)
static void	save(Node node) Saves the Session related to this node.
static Session	session(Node node) Retrieves the Session related to this node.
static void	set(Node node, java.lang.String property, java.lang.Object value) Set a property to the given value, or remove it if the value is null.
static VersionManager	versionManager(Node node) Get the VersionManager related to this node.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

isNodeType

public static boolean isNodeType(Node node,
                                 java.lang.String nodeTypeName)

Throws:

java.lang.IllegalStateException - caused by RepositoryException

See Also:

Node.isNodeType(String)

hasNodes

public static boolean hasNodes(Node node)

Throws:

java.lang.IllegalStateException - caused by RepositoryException

See Also:

Node.hasNodes()

getParent

public static Node getParent(Node node)

Throws:

java.lang.IllegalStateException - caused by RepositoryException

See Also:

Item.getParent()

isRoot

public static boolean isRoot(Node node)

Whether this node is the root node.

Throws:

java.lang.IllegalStateException - caused by RepositoryException

getPath

public static java.lang.String getPath(Node node)

Throws:

java.lang.IllegalStateException - caused by RepositoryException

See Also:

Item.getPath()

getIdentifier

public static java.lang.String getIdentifier(Node node)

Throws:

java.lang.IllegalStateException - caused by RepositoryException

See Also:

Node.getIdentifier()

getName

public static java.lang.String getName(Node node)

Throws:

java.lang.IllegalStateException - caused by RepositoryException

See Also:

Item.getName()

iterate

public static java.lang.Iterable<Node> iterate(NodeIterator nodeIterator)

Accesses a NodeIterator as an Iterable.

nodes

public static java.lang.Iterable<Node> nodes(Node node)

Returns:

the children as an Iterable for use in for-each llops.

Throws:

java.lang.IllegalStateException - caused by RepositoryException

See Also:

Node.getNodes()

getNodes

public static java.util.List<Node> getNodes(Node node)

Returns:

the children as a (possibly empty) List.

Throws:

java.lang.IllegalStateException - caused by RepositoryException

See Also:

Node.getNodes()

getNode

public static Node getNode(Node node,
                           java.lang.String child)

Returns:

the child or null if not found

Throws:

java.lang.IllegalStateException - caused by RepositoryException

See Also:

Node.getNode(String)

getNode

public static Node getNode(Session session,
                           java.lang.String path)

Returns:

the node at this path or null if not found

Throws:

java.lang.IllegalStateException - caused by RepositoryException

See Also:

Session.getNode(String)

getNodeById

public static Node getNodeById(Session session,
                               java.lang.String id)

Returns:

the node with htis id or null if not found

Throws:

java.lang.IllegalStateException - caused by RepositoryException

See Also:

Session.getNodeByIdentifier(String)

set

public static void set(Node node,
                       java.lang.String property,
                       java.lang.Object value)

Set a property to the given value, or remove it if the value is null.

Throws:

java.lang.IllegalStateException - caused by RepositoryException

get

public static java.lang.String get(Node node,
                                   java.lang.String property)

Get property as String.

Returns:

the value of Node.getProperty(String).Property.getString() or null if the property does not exist.

Throws:

java.lang.IllegalStateException - caused by RepositoryException

get

public static java.lang.String get(Node node,
                                   java.lang.String property,
                                   java.lang.String defaultValue)

Get property as a String.

Returns:

the value of Node.getProperty(String).Property.getString() or defaultValue if the property does not exist.

Throws:

java.lang.IllegalStateException - caused by RepositoryException

getValue

public static Value getValue(Node node,
                             java.lang.String property)

Get property as a Value.

Returns:

Node.getProperty(String) or null if the property does not exist.

Throws:

java.lang.IllegalStateException - caused by RepositoryException

getAs

public static <T> T getAs(Node node,
                          java.lang.String property,
                          T defaultValue)

Get property doing a best effort to cast it as the target object.

Returns:

the value of Node.getProperty(String) or defaultValue if the property does not exist.

Throws:

java.lang.IllegalArgumentException - if the value could not be cast

java.lang.IllegalStateException - in case of unexpected RepositoryException

session

public static Session session(Node node)

Retrieves the Session related to this node.

save

public static void save(Node node)

Saves the Session related to this node. Note that all other unrelated modifications in this session will also be saved.

login

public static Session login(Repository repository,
                            java.lang.String workspace)

Login to a JCR repository.

logout

public static void logout(Session session)

Safely and silently logs out a session.

addPrivilege

public static void addPrivilege(Node node,
                                java.lang.String principal,
                                java.lang.String privilege)

Add a single privilege to a node.

See Also:

Privilege

isCheckedOut

public static boolean isCheckedOut(Node node)

Get checked out status.

checkpoint

public static void checkpoint(Node node)

See Also:

VersionManager.checkpoint(String)

checkin

public static void checkin(Node node)

See Also:

VersionManager.checkin(String)

checkout

public static void checkout(Node node)

See Also:

VersionManager.checkout(String)

versionManager

public static VersionManager versionManager(Node node)

Get the VersionManager related to this node.

getVersionHistory

public static VersionHistory getVersionHistory(Node node)

Get the VersionHistory related to this node.

getLinearVersions

public static java.util.List<Version> getLinearVersions(VersionHistory versionHistory)

The linear versions of this version history in reverse order and without the root version.

getFrozenNode

public static Node getFrozenNode(Version version)

The frozen node related to this Version.

getBaseVersion

public static Version getBaseVersion(Node node)

Get the base Version related to this node.

getFileSize

public static long getFileSize(Node fileNode)

Returns the size of this file.

See Also:

NodeType.NT_FILE

getBinarySize

public static long getBinarySize(Binary binaryArg)

Returns the size of this Binary.