org.apache.jackrabbit.spi2jcr
Class RepositoryServiceImpl

java.lang.Object
  org.apache.jackrabbit.spi2jcr.RepositoryServiceImpl

All Implemented Interfaces:

RepositoryService

public class RepositoryServiceImpl
extends java.lang.Object
implements RepositoryService

RepositoryServiceImpl implements a repository service on top of a JCR Repository.

Constructor Summary

RepositoryServiceImpl(javax.jcr.Repository repository, BatchReadConfig batchReadConfig)
Creates a new repository service based on the given repository.

Method Summary

void	addVersionLabel(SessionInfo sessionInfo, NodeId versionHistoryId, NodeId versionId, Name label, boolean moveLabel) Add the given version label in the persistent layer.
NodeId	checkin(SessionInfo sessionInfo, NodeId nodeId) Performs a checkin for the Node identified by the given NodeId.
void	checkout(SessionInfo sessionInfo, NodeId nodeId) Performs a checkout for the Node identified by the given NodeId.
void	checkQueryStatement(SessionInfo sessionInfo, java.lang.String statement, java.lang.String language, java.util.Map namespaces) Checks if the query statement is valid according to the specified query language.
void	clone(SessionInfo sessionInfo, java.lang.String srcWorkspaceName, NodeId srcNodeId, NodeId destParentNodeId, Name destName, boolean removeExisting) Clone the subtree identified by the given srcNodeId in workspace named srcWorkspaceName to the destination in the workspace specified by the given SessionInfo.
void	copy(SessionInfo sessionInfo, java.lang.String srcWorkspaceName, NodeId srcNodeId, NodeId destParentNodeId, Name destName) Clone the subtree identified by the given srcNodeId in workspace named srcWorkspaceName to the destination in the workspace specified by the given SessionInfo.
Batch	createBatch(SessionInfo sessionInfo, ItemId itemId) Indicates the start of a set of operations that cause modifications on the underlying persistence layer.
EventFilter	createEventFilter(SessionInfo sessionInfo, int eventTypes, Path absPath, boolean isDeep, java.lang.String[] uuid, Name[] nodeTypeName, boolean noLocal) Creates an event filter.
Subscription	createSubscription(SessionInfo sessionInfo, EventFilter[] filters) Creates a new Subscription for events with an initial set of EventFilters.
void	dispose(SessionInfo sessionInfo) Indicates to the RepositoryService, that the given SessionInfo will not be used any more.
void	dispose(Subscription subscription) Indicates that the passed subscription is no longer needed.
QueryInfo	executeQuery(SessionInfo sessionInfo, java.lang.String statement, java.lang.String language, java.util.Map namespaces) Execute the given query statement with the specified query language.
java.util.Iterator	getChildInfos(SessionInfo sessionInfo, NodeId parentId) Returns an Iterator of ChildInfos present on the Node represented by the given parentId.
EventBundle[]	getEvents(Subscription subscription, long timeout) Retrieves the events that occurred since the last call to this method for the passed subscription.
IdFactory	getIdFactory() Return the IdFactory.
java.util.Iterator	getItemInfos(SessionInfo sessionInfo, NodeId nodeId) Method used to 'batch-read' from the persistent storage.
LockInfo	getLockInfo(SessionInfo sessionInfo, NodeId nodeId) Returns the lock information that applies to Node identified by the given NodeId or null.
NameFactory	getNameFactory() Return the NameFactory.
java.lang.String	getNamespacePrefix(SessionInfo sessionInfo, java.lang.String uri) Returns the namespace prefix for the given namespace uri.
java.lang.String	getNamespaceURI(SessionInfo sessionInfo, java.lang.String prefix) Returns the namespace URI for the given namespace prefix.
QNodeDefinition	getNodeDefinition(SessionInfo sessionInfo, NodeId nodeId) Returns the QNodeDefinition for the Node identified by the given id.
NodeInfo	getNodeInfo(SessionInfo sessionInfo, NodeId nodeId) Retrieve the NodeInfo for the node identified by the given NodeId.
PathFactory	getPathFactory() Return the PathFactory.
QPropertyDefinition	getPropertyDefinition(SessionInfo sessionInfo, PropertyId propertyId) Returns the QPropertyDefinition for the Property identified by the given id.
PropertyInfo	getPropertyInfo(SessionInfo sessionInfo, PropertyId propertyId) Returns the PropertyInfo for the Property identified by the given id.
java.util.Iterator	getQNodeTypeDefinitions(SessionInfo sessionInfo) Retrieve the QNodeTypeDefinitions of all registered nodetypes.
java.util.Iterator	getQNodeTypeDefinitions(SessionInfo sessionInfo, Name[] nodetypeNames) Retrieve QNodeTypeDefinitions for the given names.
QValueFactory	getQValueFactory() Return the QValueFactory defined with this SPI implementation.
java.util.Map	getRegisteredNamespaces(SessionInfo sessionInfo) Retrieve all registered namespaces.
java.util.Map	getRepositoryDescriptors() Returns all property descriptors that can be exposed with the Repository implementation built on top of this RepositoryService.
java.lang.String[]	getSupportedQueryLanguages(SessionInfo sessionInfo) Returns a String array identifying all query languages supported by this SPI implementation.
java.lang.String[]	getWorkspaceNames(SessionInfo sessionInfo) Return all workspace names available for the given SessionInfo.
SessionInfo	impersonate(SessionInfo sessionInfo, javax.jcr.Credentials credentials) Returns a SessionInfo that will be used by other methods on the RepositoryService.
void	importXml(SessionInfo sessionInfo, NodeId parentId, java.io.InputStream xmlStream, int uuidBehaviour) Imports the data present in the given InputStream into the persistent layer.
boolean	isGranted(SessionInfo sessionInfo, ItemId itemId, java.lang.String[] actions) Returns true if all actions defined in the specified array are granted to given SessionInfo.
LockInfo	lock(SessionInfo sessionInfo, NodeId nodeId, boolean deep, boolean sessionScoped) Create a lock on the Node identified by the given id.
java.util.Iterator	merge(SessionInfo sessionInfo, NodeId nodeId, java.lang.String srcWorkspaceName, boolean bestEffort) Merge the node identified by the given NodeId and its subtree with the corresponding node present in the workspace with the name of srcWorkspaceName.
void	move(SessionInfo sessionInfo, NodeId srcNodeId, NodeId destParentNodeId, Name destName) Moves the node identified by the given srcNodeId (and its entire subtree) to the new location defined by destParentNodeId and a new name (destName).
SessionInfo	obtain(javax.jcr.Credentials credentials, java.lang.String workspaceName) Returns a SessionInfo that will be used by other methods on the RepositoryService.
SessionInfo	obtain(SessionInfo sessionInfo, java.lang.String workspaceName) Returns a new SessionInfo for the given workspace name that will be used by other methods on the RepositoryService.
void	refreshLock(SessionInfo sessionInfo, NodeId nodeId) Explicit refresh of an existing lock.
void	registerNamespace(SessionInfo sessionInfo, java.lang.String prefix, java.lang.String uri) Register a new namespace with the given prefix and uri.
void	removeVersion(SessionInfo sessionInfo, NodeId versionHistoryId, NodeId versionId) Remove the version inditified by the specified versionId.
void	removeVersionLabel(SessionInfo sessionInfo, NodeId versionHistoryId, NodeId versionId, Name label) Remove the given version label in the persistent layer.
void	resolveMergeConflict(SessionInfo sessionInfo, NodeId nodeId, NodeId[] mergeFailedIds, NodeId[] predecessorIds) Resolve an existing merge conflict present with the node identified by the given NodeId.
void	restore(SessionInfo sessionInfo, NodeId[] versionIds, boolean removeExisting) Restore multiple versions at once.
void	restore(SessionInfo sessionInfo, NodeId nodeId, NodeId versionId, boolean removeExisting) Restores the node identified by nodeId to the state defined by the version with the specified versionId.
void	submit(Batch batch) Completes the given Batch or discard all the previous modifications.
void	unlock(SessionInfo sessionInfo, NodeId nodeId) Releases the lock on the Node identified by the given NodeId. Please note, that on logout all session-scoped locks must be released by calling unlock.
void	unregisterNamespace(SessionInfo sessionInfo, java.lang.String uri) Unregister the namespace identified by the given uri
void	update(SessionInfo sessionInfo, NodeId nodeId, java.lang.String srcWorkspaceName) Updates the node identified by the given NodeId replacing it (an the complete subtree) with a clone of its corresponding node present in the workspace with the given srcWorkspaceName.
void	updateEventFilters(Subscription subscription, EventFilter[] filters) Updates events filters on the subscription.

Methods inherited from class java.lang.Object

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

Constructor Detail

RepositoryServiceImpl

public RepositoryServiceImpl(javax.jcr.Repository repository,
                             BatchReadConfig batchReadConfig)

Creates a new repository service based on the given repository.

Parameters:

repository - a JCR repository instance.

batchReadConfig - getNodeInfo(SessionInfo, NodeId).

Method Detail

getIdFactory

public IdFactory getIdFactory()

Return the IdFactory.

Specified by:

getIdFactory in interface RepositoryService

Returns:

The IdFactory.

getNameFactory

public NameFactory getNameFactory()

Return the NameFactory.

Specified by:

getNameFactory in interface RepositoryService

Returns:

The NameFactory.

getPathFactory

public PathFactory getPathFactory()

Return the PathFactory.

Specified by:

getPathFactory in interface RepositoryService

Returns:

The PathFactory.

getQValueFactory

public QValueFactory getQValueFactory()

Return the QValueFactory defined with this SPI implementation.

Specified by:

getQValueFactory in interface RepositoryService

Returns:

The QValueFactory.

getRepositoryDescriptors

public java.util.Map getRepositoryDescriptors()
                                       throws javax.jcr.RepositoryException

Returns all property descriptors that can be exposed with the Repository implementation built on top of this RepositoryService.

Specified by:

getRepositoryDescriptors in interface RepositoryService

Returns:

key-value pairs for repository descriptor keys and values.

Throws:

javax.jcr.RepositoryException

See Also:

Repository.getDescriptorKeys(), Repository.getDescriptor(String)

obtain

public SessionInfo obtain(javax.jcr.Credentials credentials,
                          java.lang.String workspaceName)
                   throws javax.jcr.LoginException,
                          javax.jcr.NoSuchWorkspaceException,
                          javax.jcr.RepositoryException

Returns a SessionInfo that will be used by other methods on the RepositoryService. An implementation may choose to authenticate the user using the supplied credentials.

Specified by:

obtain in interface RepositoryService

Parameters:

credentials - the credentials of the user.

workspaceName - the name of the workspace the SessionInfo should be built for. If the specified workspaceName is null the implementation should select a default workspace.

Returns:

a SessionInfo if authentication was successful.

Throws:

javax.jcr.LoginException - if authentication of the user fails.

javax.jcr.NoSuchWorkspaceException - if the specified workspaceName is not recognized.

javax.jcr.RepositoryException - if an error occurs.

obtain

public SessionInfo obtain(SessionInfo sessionInfo,
                          java.lang.String workspaceName)
                   throws javax.jcr.LoginException,
                          javax.jcr.NoSuchWorkspaceException,
                          javax.jcr.RepositoryException

Returns a new SessionInfo for the given workspace name that will be used by other methods on the RepositoryService.

Specified by:

obtain in interface RepositoryService

Parameters:

sessionInfo - for another workspace

workspaceName - the name of the workspace the new SessionInfo should be built for. If the specified workspaceName is null the implementation should select a default workspace.

Returns:

a SessionInfo if authentication was successful.

Throws:

javax.jcr.LoginException - if authentication of the user fails.

javax.jcr.NoSuchWorkspaceException - if the specified workspaceName is not recognized.

javax.jcr.RepositoryException - if an error occurs.

impersonate

public SessionInfo impersonate(SessionInfo sessionInfo,
                               javax.jcr.Credentials credentials)
                        throws javax.jcr.LoginException,
                               javax.jcr.RepositoryException

Returns a SessionInfo that will be used by other methods on the RepositoryService.

Specified by:

impersonate in interface RepositoryService

Returns:

a SessionInfo if impersonate was successful.

Throws:

javax.jcr.LoginException

javax.jcr.RepositoryException

See Also:

Session.impersonate(javax.jcr.Credentials)

dispose

public void dispose(SessionInfo sessionInfo)
             throws javax.jcr.RepositoryException

Indicates to the RepositoryService, that the given SessionInfo will not be used any more.

Specified by:

dispose in interface RepositoryService

Throws:

javax.jcr.RepositoryException

getWorkspaceNames

public java.lang.String[] getWorkspaceNames(SessionInfo sessionInfo)
                                     throws javax.jcr.RepositoryException

Return all workspace names available for the given SessionInfo.

Specified by:

getWorkspaceNames in interface RepositoryService

Returns:

An array of workspace names.

Throws:

javax.jcr.RepositoryException

See Also:

Workspace.getAccessibleWorkspaceNames(), Workspace.getName()

isGranted

public boolean isGranted(SessionInfo sessionInfo,
                         ItemId itemId,
                         java.lang.String[] actions)
                  throws javax.jcr.RepositoryException

Returns true if all actions defined in the specified array are granted to given SessionInfo. False otherwise.

Specified by:

isGranted in interface RepositoryService

Returns:

true if the session with the given SessionInfo has the specified rights for the given item.

Throws:

javax.jcr.RepositoryException

See Also:

Session.checkPermission(String, String)

getNodeDefinition

public QNodeDefinition getNodeDefinition(SessionInfo sessionInfo,
                                         NodeId nodeId)
                                  throws javax.jcr.RepositoryException

Returns the QNodeDefinition for the Node identified by the given id. This method should only be used if the caller is not able to unambiguously determine the applicable definition from the parent node type definition or if no parent exists (i.e. for the root).

Specified by:

getNodeDefinition in interface RepositoryService

Returns:

The node definition applicable to the Node identified by the given id.

Throws:

javax.jcr.RepositoryException

getPropertyDefinition

public QPropertyDefinition getPropertyDefinition(SessionInfo sessionInfo,
                                                 PropertyId propertyId)
                                          throws javax.jcr.RepositoryException

Returns the QPropertyDefinition for the Property identified by the given id. This method should only be used if the caller is not able to unambiguously determine the applicable definition from the parent node type definition.

Specified by:

getPropertyDefinition in interface RepositoryService

Returns:

The property definition applicable for the Property identified by the given id.

Throws:

javax.jcr.RepositoryException

getNodeInfo

public NodeInfo getNodeInfo(SessionInfo sessionInfo,
                            NodeId nodeId)
                     throws javax.jcr.ItemNotFoundException,
                            javax.jcr.RepositoryException

Retrieve the NodeInfo for the node identified by the given NodeId. See RepositoryService.getItemInfos(SessionInfo, NodeId) for a similar method that in addition may return ItemInfos of children Items.

Specified by:

getNodeInfo in interface RepositoryService

Returns:

The NodeInfo for the node identified by the given id.

Throws:

javax.jcr.ItemNotFoundException

javax.jcr.RepositoryException

See Also:

Session.getItem(String), Node.getNode(String), VersionHistory.getAllVersions(), VersionHistory.getVersion(String), VersionHistory.getVersionByLabel(String), VersionHistory.getRootVersion(), Node.getBaseVersion(), Node.getVersionHistory(), Version.getContainingHistory()

getItemInfos

public java.util.Iterator getItemInfos(SessionInfo sessionInfo,
                                       NodeId nodeId)
                                throws javax.jcr.ItemNotFoundException,
                                       javax.jcr.RepositoryException

Method used to 'batch-read' from the persistent storage. It returns the NodeInfo for the given NodeId as the first element in the Iterator. In addition the iterator may contain arbitrary ItemInfos.

Specified by:

getItemInfos in interface RepositoryService

Returns:

An Iterator of ItemInfos containing at least a single element: the NodeInfo that represents the Node identified by the given NodeId. If the Iterator contains multiple elements, the first is expected to represent the Node identified by the given NodeId.

Throws:

javax.jcr.ItemNotFoundException

javax.jcr.RepositoryException

See Also:

Session.getItem(String), Node.getNode(String), VersionHistory.getAllVersions(), VersionHistory.getVersion(String), VersionHistory.getVersionByLabel(String), VersionHistory.getRootVersion(), Node.getBaseVersion(), Node.getVersionHistory(), Version.getContainingHistory()

getChildInfos

public java.util.Iterator getChildInfos(SessionInfo sessionInfo,
                                        NodeId parentId)
                                 throws javax.jcr.ItemNotFoundException,
                                        javax.jcr.RepositoryException

Returns an Iterator of ChildInfos present on the Node represented by the given parentId.

Specified by:

getChildInfos in interface RepositoryService

Returns:

An Iterator of ChildInfos present on the Node represented by the given parentId.

Throws:

javax.jcr.ItemNotFoundException

javax.jcr.RepositoryException

getPropertyInfo

public PropertyInfo getPropertyInfo(SessionInfo sessionInfo,
                                    PropertyId propertyId)
                             throws javax.jcr.ItemNotFoundException,
                                    javax.jcr.RepositoryException

Returns the PropertyInfo for the Property identified by the given id.

Specified by:

getPropertyInfo in interface RepositoryService

Returns:

The PropertyInfo for the Property identified by the given id.

Throws:

javax.jcr.ItemNotFoundException

javax.jcr.RepositoryException

See Also:

Session.getItem(String), Node.getProperty(String)

createBatch

public Batch createBatch(SessionInfo sessionInfo,
                         ItemId itemId)
                  throws javax.jcr.RepositoryException

Indicates the start of a set of operations that cause modifications on the underlying persistence layer. All modification called on the Batch must be executed at once or non must be executed upon calling RepositoryService.submit(Batch).

Specified by:

createBatch in interface RepositoryService

itemId - Id of the Item that is a common ancestor of all Items affected upon batch execution. This Item might itself be modified within the scope of the Batch.

Returns:

A Batch indicating the start of a set of transient modifications that will be execute at once upon RepositoryService.submit(Batch).

Throws:

javax.jcr.RepositoryException

See Also:

Item.save(), Session.save(), Batch

submit

public void submit(Batch batch)
            throws javax.jcr.PathNotFoundException,
                   javax.jcr.ItemNotFoundException,
                   javax.jcr.nodetype.NoSuchNodeTypeException,
                   javax.jcr.ValueFormatException,
                   javax.jcr.version.VersionException,
                   javax.jcr.lock.LockException,
                   javax.jcr.nodetype.ConstraintViolationException,
                   javax.jcr.AccessDeniedException,
                   javax.jcr.UnsupportedRepositoryOperationException,
                   javax.jcr.RepositoryException

Completes the given Batch or discard all the previous modifications. See RepositoryService.createBatch(SessionInfo,ItemId) for additional information regarding batch creation.

Specified by:

submit in interface RepositoryService

Throws:

javax.jcr.PathNotFoundException

javax.jcr.ItemNotFoundException

javax.jcr.nodetype.NoSuchNodeTypeException

javax.jcr.ValueFormatException

javax.jcr.version.VersionException

javax.jcr.lock.LockException

javax.jcr.nodetype.ConstraintViolationException

javax.jcr.AccessDeniedException

javax.jcr.UnsupportedRepositoryOperationException

javax.jcr.RepositoryException

See Also:

Batch

importXml

public void importXml(SessionInfo sessionInfo,
                      NodeId parentId,
                      java.io.InputStream xmlStream,
                      int uuidBehaviour)
               throws javax.jcr.ItemExistsException,
                      javax.jcr.PathNotFoundException,
                      javax.jcr.version.VersionException,
                      javax.jcr.nodetype.ConstraintViolationException,
                      javax.jcr.lock.LockException,
                      javax.jcr.AccessDeniedException,
                      javax.jcr.UnsupportedRepositoryOperationException,
                      javax.jcr.RepositoryException

Imports the data present in the given InputStream into the persistent layer. Note, that the implemenation is responsible for validating the data presented and for the integrity of the repository upon completion.

Specified by:

importXml in interface RepositoryService

Throws:

javax.jcr.ItemExistsException

javax.jcr.PathNotFoundException

javax.jcr.version.VersionException

javax.jcr.nodetype.ConstraintViolationException

javax.jcr.lock.LockException

javax.jcr.AccessDeniedException

javax.jcr.UnsupportedRepositoryOperationException

javax.jcr.RepositoryException

See Also:

Workspace.importXML(String, java.io.InputStream, int)

move

public void move(SessionInfo sessionInfo,
                 NodeId srcNodeId,
                 NodeId destParentNodeId,
                 Name destName)
          throws javax.jcr.ItemExistsException,
                 javax.jcr.PathNotFoundException,
                 javax.jcr.version.VersionException,
                 javax.jcr.nodetype.ConstraintViolationException,
                 javax.jcr.lock.LockException,
                 javax.jcr.AccessDeniedException,
                 javax.jcr.UnsupportedRepositoryOperationException,
                 javax.jcr.RepositoryException

Moves the node identified by the given srcNodeId (and its entire subtree) to the new location defined by destParentNodeId and a new name (destName).

Specified by:

move in interface RepositoryService

Throws:

javax.jcr.ItemExistsException

javax.jcr.PathNotFoundException

javax.jcr.version.VersionException

javax.jcr.nodetype.ConstraintViolationException

javax.jcr.lock.LockException

javax.jcr.AccessDeniedException

javax.jcr.UnsupportedRepositoryOperationException

javax.jcr.RepositoryException

See Also:

Workspace.move(String, String)

copy

public void copy(SessionInfo sessionInfo,
                 java.lang.String srcWorkspaceName,
                 NodeId srcNodeId,
                 NodeId destParentNodeId,
                 Name destName)
          throws javax.jcr.NoSuchWorkspaceException,
                 javax.jcr.nodetype.ConstraintViolationException,
                 javax.jcr.version.VersionException,
                 javax.jcr.AccessDeniedException,
                 javax.jcr.PathNotFoundException,
                 javax.jcr.ItemExistsException,
                 javax.jcr.lock.LockException,
                 javax.jcr.UnsupportedRepositoryOperationException,
                 javax.jcr.RepositoryException

Clone the subtree identified by the given srcNodeId in workspace named srcWorkspaceName to the destination in the workspace specified by the given SessionInfo. The destination is composed by the given parent id and the new name as indicated by destName.

Note, that srcWorkspaceName may be the same as the one specified within the SessionInfo. In this case the copy corresponds to a copy within a single workspace.

Specified by:

copy in interface RepositoryService

Throws:

javax.jcr.NoSuchWorkspaceException

javax.jcr.nodetype.ConstraintViolationException

javax.jcr.version.VersionException

javax.jcr.AccessDeniedException

javax.jcr.PathNotFoundException

javax.jcr.ItemExistsException

javax.jcr.lock.LockException

javax.jcr.UnsupportedRepositoryOperationException

javax.jcr.RepositoryException

See Also:

Workspace.copy(String, String), Workspace.copy(String, String, String)

update

public void update(SessionInfo sessionInfo,
                   NodeId nodeId,
                   java.lang.String srcWorkspaceName)
            throws javax.jcr.NoSuchWorkspaceException,
                   javax.jcr.AccessDeniedException,
                   javax.jcr.lock.LockException,
                   javax.jcr.InvalidItemStateException,
                   javax.jcr.RepositoryException

Updates the node identified by the given NodeId replacing it (an the complete subtree) with a clone of its corresponding node present in the workspace with the given srcWorkspaceName.

Specified by:

update in interface RepositoryService

Throws:

javax.jcr.NoSuchWorkspaceException

javax.jcr.AccessDeniedException

javax.jcr.lock.LockException

javax.jcr.InvalidItemStateException

javax.jcr.RepositoryException

See Also:

Node.update(String)

clone

public void clone(SessionInfo sessionInfo,
                  java.lang.String srcWorkspaceName,
                  NodeId srcNodeId,
                  NodeId destParentNodeId,
                  Name destName,
                  boolean removeExisting)
           throws javax.jcr.NoSuchWorkspaceException,
                  javax.jcr.nodetype.ConstraintViolationException,
                  javax.jcr.version.VersionException,
                  javax.jcr.AccessDeniedException,
                  javax.jcr.PathNotFoundException,
                  javax.jcr.ItemExistsException,
                  javax.jcr.lock.LockException,
                  javax.jcr.UnsupportedRepositoryOperationException,
                  javax.jcr.RepositoryException

Clone the subtree identified by the given srcNodeId in workspace named srcWorkspaceName to the destination in the workspace specified by the given SessionInfo. The destination is composed by the given parent id and the new name as indicated by destName.

Specified by:

clone in interface RepositoryService

Throws:

javax.jcr.NoSuchWorkspaceException

javax.jcr.nodetype.ConstraintViolationException

javax.jcr.version.VersionException

javax.jcr.AccessDeniedException

javax.jcr.PathNotFoundException

javax.jcr.ItemExistsException

javax.jcr.lock.LockException

javax.jcr.UnsupportedRepositoryOperationException

javax.jcr.RepositoryException

See Also:

Workspace.clone(String, String, String, boolean)

getLockInfo

public LockInfo getLockInfo(SessionInfo sessionInfo,
                            NodeId nodeId)
                     throws javax.jcr.RepositoryException

Returns the lock information that applies to Node identified by the given NodeId or null. If the implementation does not support locking at all, this method always returns null.

Specified by:

getLockInfo in interface RepositoryService

Returns:

The lock information for the Node identified by the given nodeId or null if no lock applies to that Node.

Throws:

javax.jcr.AccessDeniedException

javax.jcr.RepositoryException - If some other error occurs.

See Also:

Node.getLock()

lock

public LockInfo lock(SessionInfo sessionInfo,
                     NodeId nodeId,
                     boolean deep,
                     boolean sessionScoped)
              throws javax.jcr.UnsupportedRepositoryOperationException,
                     javax.jcr.lock.LockException,
                     javax.jcr.AccessDeniedException,
                     javax.jcr.InvalidItemStateException,
                     javax.jcr.RepositoryException

Create a lock on the Node identified by the given id.

Specified by:

lock in interface RepositoryService

Returns:

The LockInfo associated with the new lock that has been created.

Throws:

javax.jcr.UnsupportedRepositoryOperationException - If this SPI implementation does not support locking at all.

javax.jcr.lock.LockException - If the Node identified by the given id cannot be locked due to an existing lock or due to missing mixin type.

javax.jcr.AccessDeniedException

javax.jcr.RepositoryException - If another error occurs.

javax.jcr.InvalidItemStateException

See Also:

Node.lock(boolean, boolean)

refreshLock

public void refreshLock(SessionInfo sessionInfo,
                        NodeId nodeId)
                 throws javax.jcr.lock.LockException,
                        javax.jcr.RepositoryException

Explicit refresh of an existing lock. Existing locks should be refreshed implicitely with all read and write methods listed here.

Specified by:

refreshLock in interface RepositoryService

Throws:

javax.jcr.lock.LockException - If the Node identified by the given id is not locked (any more) or if the SessionInfo does not contain the token associated with the lock to be refreshed.

javax.jcr.UnsupportedRepositoryOperationException - If this SPI implementation does not support locking at all.

javax.jcr.AccessDeniedException

javax.jcr.RepositoryException - If another error occurs.

See Also:

Lock

unlock

public void unlock(SessionInfo sessionInfo,
                   NodeId nodeId)
            throws javax.jcr.UnsupportedRepositoryOperationException,
                   javax.jcr.lock.LockException,
                   javax.jcr.AccessDeniedException,
                   javax.jcr.InvalidItemStateException,
                   javax.jcr.RepositoryException

Releases the lock on the Node identified by the given NodeId.

Please note, that on logout all session-scoped locks must be released by calling unlock.

Specified by:

unlock in interface RepositoryService

Throws:

javax.jcr.UnsupportedRepositoryOperationException - If this SPI implementation does not support locking at all.

javax.jcr.lock.LockException - If the Node identified by the given id is not locked or if the SessionInfo does not contain the token associated with the lock to be released.

javax.jcr.AccessDeniedException

javax.jcr.RepositoryException - If another error occurs.

javax.jcr.InvalidItemStateException

See Also:

Node.unlock()

checkin

public NodeId checkin(SessionInfo sessionInfo,
                      NodeId nodeId)
               throws javax.jcr.version.VersionException,
                      javax.jcr.UnsupportedRepositoryOperationException,
                      javax.jcr.InvalidItemStateException,
                      javax.jcr.lock.LockException,
                      javax.jcr.RepositoryException

Performs a checkin for the Node identified by the given NodeId.

Specified by:

checkin in interface RepositoryService

Returns:

NodeId of newly created version

Throws:

javax.jcr.version.VersionException

javax.jcr.UnsupportedRepositoryOperationException

javax.jcr.InvalidItemStateException

javax.jcr.lock.LockException

javax.jcr.RepositoryException

See Also:

Node.checkin()

checkout

public void checkout(SessionInfo sessionInfo,
                     NodeId nodeId)
              throws javax.jcr.UnsupportedRepositoryOperationException,
                     javax.jcr.lock.LockException,
                     javax.jcr.RepositoryException

Performs a checkout for the Node identified by the given NodeId.

Specified by:

checkout in interface RepositoryService

Throws:

javax.jcr.UnsupportedRepositoryOperationException

javax.jcr.lock.LockException

javax.jcr.RepositoryException

See Also:

Node.checkout()

removeVersion

public void removeVersion(SessionInfo sessionInfo,
                          NodeId versionHistoryId,
                          NodeId versionId)
                   throws javax.jcr.ReferentialIntegrityException,
                          javax.jcr.AccessDeniedException,
                          javax.jcr.UnsupportedRepositoryOperationException,
                          javax.jcr.version.VersionException,
                          javax.jcr.RepositoryException

Remove the version inditified by the specified versionId.

Specified by:

removeVersion in interface RepositoryService

versionHistoryId - NodeId identifying the version history the version identified by versionId belongs to.

Throws:

javax.jcr.ReferentialIntegrityException

javax.jcr.AccessDeniedException

javax.jcr.UnsupportedRepositoryOperationException

javax.jcr.version.VersionException

javax.jcr.RepositoryException

See Also:

VersionHistory.removeVersion(String)

restore

public void restore(SessionInfo sessionInfo,
                    NodeId nodeId,
                    NodeId versionId,
                    boolean removeExisting)
             throws javax.jcr.version.VersionException,
                    javax.jcr.PathNotFoundException,
                    javax.jcr.ItemExistsException,
                    javax.jcr.UnsupportedRepositoryOperationException,
                    javax.jcr.lock.LockException,
                    javax.jcr.InvalidItemStateException,
                    javax.jcr.RepositoryException

Restores the node identified by nodeId to the state defined by the version with the specified versionId.

Specified by:

restore in interface RepositoryService

removeExisting - boolean flag indicating how to deal with an identifier collision that may occur if a node exists outside the subtree to be restored with the same identified as a node that would be introduces by the restore. If the removeExisting is true the restored node takes precedence and the existing node is removed. Otherwise the restore failes.

Throws:

javax.jcr.version.VersionException

javax.jcr.PathNotFoundException

javax.jcr.ItemExistsException

javax.jcr.UnsupportedRepositoryOperationException

javax.jcr.lock.LockException

javax.jcr.InvalidItemStateException

javax.jcr.RepositoryException

See Also:

Node.restore(String, boolean), Node.restore(javax.jcr.version.Version, boolean), Node.restore(javax.jcr.version.Version, String, boolean), Node.restoreByLabel(String, boolean)

restore

public void restore(SessionInfo sessionInfo,
                    NodeId[] versionIds,
                    boolean removeExisting)
             throws javax.jcr.ItemExistsException,
                    javax.jcr.UnsupportedRepositoryOperationException,
                    javax.jcr.version.VersionException,
                    javax.jcr.lock.LockException,
                    javax.jcr.InvalidItemStateException,
                    javax.jcr.RepositoryException

Restore multiple versions at once. The versions to be restored are identified by the given array of NodeIds.

Specified by:

restore in interface RepositoryService

removeExisting - boolean flag indicating how to deal with an identifier collision that may occur if a node exists outside the subtrees to be restored with the same identified as any node that would be introduces by the restore. If the removeExisting is true the node to be restored takes precedence and the existing node is removed. Otherwise the restore failes.

Throws:

javax.jcr.ItemExistsException

javax.jcr.UnsupportedRepositoryOperationException

javax.jcr.version.VersionException

javax.jcr.lock.LockException

javax.jcr.InvalidItemStateException

javax.jcr.RepositoryException

See Also:

Workspace.restore(javax.jcr.version.Version[], boolean)

merge

public java.util.Iterator merge(SessionInfo sessionInfo,
                                NodeId nodeId,
                                java.lang.String srcWorkspaceName,
                                boolean bestEffort)
                         throws javax.jcr.NoSuchWorkspaceException,
                                javax.jcr.AccessDeniedException,
                                javax.jcr.MergeException,
                                javax.jcr.lock.LockException,
                                javax.jcr.InvalidItemStateException,
                                javax.jcr.RepositoryException

Merge the node identified by the given NodeId and its subtree with the corresponding node present in the workspace with the name of srcWorkspaceName.

Specified by:

merge in interface RepositoryService

Returns:

an Iterator over the NodeIds of all nodes that received a merge result of "fail" in the course of this operation.

Throws:

javax.jcr.NoSuchWorkspaceException

javax.jcr.AccessDeniedException

javax.jcr.MergeException

javax.jcr.lock.LockException

javax.jcr.InvalidItemStateException

javax.jcr.RepositoryException

See Also:

Node.merge(String, boolean)

resolveMergeConflict

public void resolveMergeConflict(SessionInfo sessionInfo,
                                 NodeId nodeId,
                                 NodeId[] mergeFailedIds,
                                 NodeId[] predecessorIds)
                          throws javax.jcr.version.VersionException,
                                 javax.jcr.InvalidItemStateException,
                                 javax.jcr.UnsupportedRepositoryOperationException,
                                 javax.jcr.RepositoryException

Resolve an existing merge conflict present with the node identified by the given NodeId.

Specified by:

resolveMergeConflict in interface RepositoryService

mergeFailedIds - The NodeIds remaining in the jcr:mergeFailed REFERENCE property. The version id(s) to be resolved were removed from the array and added to the predecessor ids in case of Node.doneMerge(Version). In case of a Node.cancelMerge(Version) the version id only gets removed from the list.

predecessorIds - The complete set of predecessor id including those that have been added in order to resolve a merge conflict.

Throws:

javax.jcr.version.VersionException

javax.jcr.InvalidItemStateException

javax.jcr.UnsupportedRepositoryOperationException

javax.jcr.RepositoryException

See Also:

Node.cancelMerge(javax.jcr.version.Version), Node.doneMerge(javax.jcr.version.Version)

addVersionLabel

public void addVersionLabel(SessionInfo sessionInfo,
                            NodeId versionHistoryId,
                            NodeId versionId,
                            Name label,
                            boolean moveLabel)
                     throws javax.jcr.version.VersionException,
                            javax.jcr.RepositoryException

Add the given version label in the persistent layer.

Specified by:

addVersionLabel in interface RepositoryService

versionHistoryId - NodeId identifying the version history the version identified by versionId belongs to.

versionId - NodeId identifying the version the label belongs to.

label - The label to be added.

moveLabel - If the label is already assigned to a version within the same version history this parameter has the following effect: If true the label already present gets moved to be now be a label of the version indicated by versionId. If false this method fails and the label remains with the original version.

Throws:

javax.jcr.version.VersionException

javax.jcr.RepositoryException

See Also:

VersionHistory.addVersionLabel(String, String, boolean)

removeVersionLabel

public void removeVersionLabel(SessionInfo sessionInfo,
                               NodeId versionHistoryId,
                               NodeId versionId,
                               Name label)
                        throws javax.jcr.version.VersionException,
                               javax.jcr.RepositoryException

Remove the given version label in the persistent layer.

Specified by:

removeVersionLabel in interface RepositoryService

versionHistoryId - NodeId identifying the version history the version identified by versionId belongs to.

versionId - NodeId identifying the version the label belongs to.

label - The label to be removed.

Throws:

javax.jcr.version.VersionException

javax.jcr.RepositoryException

See Also:

VersionHistory.removeVersionLabel(String)

getSupportedQueryLanguages

public java.lang.String[] getSupportedQueryLanguages(SessionInfo sessionInfo)
                                              throws javax.jcr.RepositoryException

Returns a String array identifying all query languages supported by this SPI implementation.

Specified by:

getSupportedQueryLanguages in interface RepositoryService

Returns:

String array identifying all query languages supported by this SPI implementation.

Throws:

javax.jcr.RepositoryException

See Also:

QueryManager.getSupportedQueryLanguages()

checkQueryStatement

public void checkQueryStatement(SessionInfo sessionInfo,
                                java.lang.String statement,
                                java.lang.String language,
                                java.util.Map namespaces)
                         throws javax.jcr.query.InvalidQueryException,
                                javax.jcr.RepositoryException

Checks if the query statement is valid according to the specified query language.

Specified by:

checkQueryStatement in interface RepositoryService

Parameters:

sessionInfo - the session info.

statement - the query statement to check.

language - the query language.

namespaces - the locally re-mapped namespace which may be used in the query statement.

Throws:

javax.jcr.query.InvalidQueryException - if the query statement is invalid or the language is not supported.

javax.jcr.RepositoryException - if an error occurs while checking the statement.

See Also:

QueryManager.createQuery(String, String)

executeQuery

public QueryInfo executeQuery(SessionInfo sessionInfo,
                              java.lang.String statement,
                              java.lang.String language,
                              java.util.Map namespaces)
                       throws javax.jcr.RepositoryException

Execute the given query statement with the specified query language. The additional namespaces parameter provides a mapping of prefix to namespace uri in order to be able to properly resolve prefix:localname patterns present within the query statement.

Specified by:

executeQuery in interface RepositoryService

statement - the query statement to be execute.

language - the query language used to parse the query statement.

namespaces - the locally re-mapped namespace which may be used in the query statement.

Returns:

Throws:

javax.jcr.RepositoryException

See Also:

Query.execute()

createEventFilter

public EventFilter createEventFilter(SessionInfo sessionInfo,
                                     int eventTypes,
                                     Path absPath,
                                     boolean isDeep,
                                     java.lang.String[] uuid,
                                     Name[] nodeTypeName,
                                     boolean noLocal)
                              throws javax.jcr.UnsupportedRepositoryOperationException,
                                     javax.jcr.RepositoryException

Creates an event filter. If the repository supports observation, the filter created is based on the parameters available in ObservationManager.addEventListener(javax.jcr.observation.EventListener, int, java.lang.String, boolean, java.lang.String[], java.lang.String[], boolean).

Note, that an SPI implementation may support observation even if the corresponding repository descriptor does not return 'true'.

Specified by:

createEventFilter in interface RepositoryService

Parameters:

sessionInfo - the session info which requests an event filter.

eventTypes - A combination of one or more event type constants encoded as a bitmask.

absPath - An absolute path.

isDeep - A boolean.

uuid - Array of jcr:uuid properties.

nodeTypeName - Array of node type names.

noLocal - A boolean.

Returns:

the event filter instance with the given parameters.

Throws:

javax.jcr.UnsupportedRepositoryOperationException - if this SPI implementation does not allow to create event filters.

javax.jcr.RepositoryException - if an error occurs while creating the EventFilter.

See Also:

ObservationManager.addEventListener(javax.jcr.observation.EventListener, int, String, boolean, String[], String[], boolean)

createSubscription

public Subscription createSubscription(SessionInfo sessionInfo,
                                       EventFilter[] filters)
                                throws javax.jcr.UnsupportedRepositoryOperationException,
                                       javax.jcr.RepositoryException

Creates a new Subscription for events with an initial set of EventFilters. The returned subscription must provide events from the time when the subscription was created. If an empty array of filters is passed no events will be available through the created subscription unless the filters are later updated by calling RepositoryService.updateEventFilters(Subscription, EventFilter[]).

Specified by:

createSubscription in interface RepositoryService

Parameters:

sessionInfo - the session info.

filters - the initial event filters for the subscription.

Returns:

Throws:

javax.jcr.UnsupportedRepositoryOperationException - if this SPI implementation does not support observation.

javax.jcr.RepositoryException - if an error occurs while creating the Subscription.

getEvents

public EventBundle[] getEvents(Subscription subscription,
                               long timeout)
                        throws javax.jcr.RepositoryException,
                               javax.jcr.UnsupportedRepositoryOperationException,
                               java.lang.InterruptedException

Retrieves the events that occurred since the last call to this method for the passed subscription.

Note, that an SPI implementation may support observation even if the corresponding repository descriptor does return 'false'.

An implementation should un-block a calling thread and let it return if the associated subscription is disposed by another thread.

Specified by:

getEvents in interface RepositoryService

Parameters:

subscription - a subscription.

timeout - a timeout in milliseconds to wait at most for an event bundle. If timeout is up and no event occurred meanwhile an empty array is returned.

Returns:

an array of EventBundles representing the events that occurred.

Throws:

javax.jcr.RepositoryException - if an error occurs while retrieving the event bundles.

java.lang.InterruptedException - if the calling thread is interrupted while waiting for events within the specified timeout.

javax.jcr.UnsupportedRepositoryOperationException

updateEventFilters

public void updateEventFilters(Subscription subscription,
                               EventFilter[] filters)
                        throws javax.jcr.RepositoryException

Updates events filters on the subscription. When this method returns all events that go through the passed subscription and have been generated after this method call must be filtered using the passed filters.

An implementation is required to accept at least event filter instances created by RepositoryService.createEventFilter(org.apache.jackrabbit.spi.SessionInfo, int, org.apache.jackrabbit.spi.Path, boolean, java.lang.String[], org.apache.jackrabbit.spi.Name[], boolean). Optionally an implementation may also support event filters instanciated by the client itself. An implementation may require special deployment in that case, e.g. to make the event filter implementation class available to the repository server.

Note on thread-safety: it is permissible to call this methods while another thread is blocked in calling RepositoryService.getEvents(Subscription, long) using the same subscription instance as a parameter.

Specified by:

updateEventFilters in interface RepositoryService

Parameters:

subscription - the subscription where the event filters are applied.

filters - the filters that are applied to the events as they occurred on the repository. An event is included in an event bundle if it is accepted by at least one of the supplied filters. If an empty array is passed none of the potential events are include in an event bundle. This allows a client to skip or ignore events for a certain period of time.

Throws:

javax.jcr.RepositoryException - if an error occurs while updating the event filters.

dispose

public void dispose(Subscription subscription)
             throws javax.jcr.RepositoryException

Indicates that the passed subscription is no longer needed.

Note on thread-safety: it is permissible to call this methods while another thread is blocked in calling RepositoryService.getEvents(Subscription, long) using the same subscription instance as a parameter.

Specified by:

dispose in interface RepositoryService

Throws:

javax.jcr.RepositoryException - if an error occurs while the subscription is disposed.

getRegisteredNamespaces

public java.util.Map getRegisteredNamespaces(SessionInfo sessionInfo)
                                      throws javax.jcr.RepositoryException

Retrieve all registered namespaces. The namespace to prefix mapping is done using the prefix as key and the namespace as value in the Map.

Specified by:

getRegisteredNamespaces in interface RepositoryService

Returns:

Throws:

javax.jcr.RepositoryException

See Also:

Workspace.getNamespaceRegistry(), NamespaceRegistry.getPrefixes(), NamespaceRegistry.getURIs()

getNamespaceURI

public java.lang.String getNamespaceURI(SessionInfo sessionInfo,
                                        java.lang.String prefix)
                                 throws javax.jcr.NamespaceException,
                                        javax.jcr.RepositoryException

Returns the namespace URI for the given namespace prefix.

Specified by:

getNamespaceURI in interface RepositoryService

Parameters:

sessionInfo - the session info.

prefix - a namespace prefix to resolve.

Returns:

the namespace URI for the given namespace prefix.

Throws:

javax.jcr.NamespaceException - if prefix is not mapped to a namespace URI.

javax.jcr.RepositoryException - if another error occurs.

See Also:

NamespaceRegistry.getURI(String)

getNamespacePrefix

public java.lang.String getNamespacePrefix(SessionInfo sessionInfo,
                                           java.lang.String uri)
                                    throws javax.jcr.NamespaceException,
                                           javax.jcr.RepositoryException

Returns the namespace prefix for the given namespace uri.

Specified by:

getNamespacePrefix in interface RepositoryService

Parameters:

sessionInfo - the session info.

uri - the namespace URI.

Returns:

the namespace prefix.

Throws:

javax.jcr.NamespaceException - if the URI unknown.

javax.jcr.RepositoryException - if another error occurs.

See Also:

NamespaceRegistry.getPrefix(String)

registerNamespace

public void registerNamespace(SessionInfo sessionInfo,
                              java.lang.String prefix,
                              java.lang.String uri)
                       throws javax.jcr.NamespaceException,
                              javax.jcr.UnsupportedRepositoryOperationException,
                              javax.jcr.AccessDeniedException,
                              javax.jcr.RepositoryException

Register a new namespace with the given prefix and uri.

Specified by:

registerNamespace in interface RepositoryService

prefix - Prefix of the namespace to be registered.

uri - Namespace URI to be registered.

Throws:

javax.jcr.NamespaceException

javax.jcr.UnsupportedRepositoryOperationException

javax.jcr.AccessDeniedException

javax.jcr.RepositoryException

See Also:

NamespaceRegistry.registerNamespace(String, String)

unregisterNamespace

public void unregisterNamespace(SessionInfo sessionInfo,
                                java.lang.String uri)
                         throws javax.jcr.NamespaceException,
                                javax.jcr.UnsupportedRepositoryOperationException,
                                javax.jcr.AccessDeniedException,
                                javax.jcr.RepositoryException

Unregister the namespace identified by the given uri

Specified by:

unregisterNamespace in interface RepositoryService

uri - Namespace URI to be unregistered.

Throws:

javax.jcr.NamespaceException

javax.jcr.UnsupportedRepositoryOperationException

javax.jcr.AccessDeniedException

javax.jcr.RepositoryException

See Also:

NamespaceRegistry.unregisterNamespace(String)

getQNodeTypeDefinitions

public java.util.Iterator getQNodeTypeDefinitions(SessionInfo sessionInfo)
                                           throws javax.jcr.RepositoryException

Retrieve the QNodeTypeDefinitions of all registered nodetypes.

Specified by:

getQNodeTypeDefinitions in interface RepositoryService

Returns:

Iterator of QNodeTypeDefinitions.

Throws:

javax.jcr.RepositoryException

See Also:

Workspace.getNodeTypeManager(), NodeTypeManager.getAllNodeTypes(), NodeTypeManager.getMixinNodeTypes(), NodeTypeManager.getPrimaryNodeTypes(), NodeTypeManager.getNodeType(String)

getQNodeTypeDefinitions

public java.util.Iterator getQNodeTypeDefinitions(SessionInfo sessionInfo,
                                                  Name[] nodetypeNames)
                                           throws javax.jcr.RepositoryException

Retrieve QNodeTypeDefinitions for the given names. The implementation is free to return additional definitions which will (probably) be needed by the caller due to node type inheritance. The caller must be able to deal with any kind of additional QNodeTypeDefinitions present in the Iterator irrespective whether they have been loaded before or not.

Specified by:

getQNodeTypeDefinitions in interface RepositoryService

nodetypeNames - names of node types to retrieve

Returns:

QNodeTypeDefinition

Throws:

javax.jcr.nodetype.NoSuchNodeTypeException - if for any of the given names no QNodeTypeDefinition exists.

javax.jcr.RepositoryException

See Also:

Workspace.getNodeTypeManager(), NodeTypeManager.getAllNodeTypes(), NodeTypeManager.getMixinNodeTypes(), NodeTypeManager.getPrimaryNodeTypes(), NodeTypeManager.getNodeType(String)