org.apache.jackrabbit.spi
Interface RepositoryService

All Known Implementing Classes:
AbstractReadableRepositoryService, AbstractRepositoryService, RepositoryServiceLogger

public interface RepositoryService

The RepositoryService interface defines methods used to retrieve information from the persistent layer of the repository as well as the methods that modify its persistent state. The implementation of this interface is intended to hold only the state of the persistent layer, no session-related state should be held. Consequently, each method that alters persistent state always includes all the information necessary to fully specify and authorize a change.

For example, consider the method

    void RepositoryService.copy(SessionInfo sessionInfo,
                                String srcWorkspaceName,
                                NodeId srcNodeId, NodeId destParentNodeId,
                                Name destName)
 
This method performs an immediate persistent copy of the node identified by srcNodeId and that node's subtree to a position as child of the node identified by destParentNodeId and assigns the newly copied node the name destName.
The SessionInfo object provides user and workspace identification as well as eventual lock tokens required to execute the copy.
If srcWorkspaceName differs from the workspace name present with the SessionInfo, the copy is corresponds to a copy across workspaces. The source and destination of the copy operation are specified by NodeIds. The Name holds the new name. Taken together, this information is sufficient to completely specify and authorize the copy operations.

The RepositoryService in addition allows to create and submit Batch objects, that cover lists of operations that have to be applied to the persistent layer at once.


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 checkout(SessionInfo sessionInfo, NodeId nodeId, NodeId activityId)
          Performs a checkout for the Node identified by the given NodeId and for activity identified by the specified activityId.
 NodeId checkpoint(SessionInfo sessionInfo, NodeId nodeId)
          Performs a checkpoint for the Node identified by the given NodeId.
 NodeId checkpoint(SessionInfo sessionInfo, NodeId nodeId, NodeId activityId)
          Performs a checkpoint for the Node identified by the given NodeId.
 String[] checkQueryStatement(SessionInfo sessionInfo, String statement, String language, Map<String,String> namespaces)
          Checks if the query statement is valid according to the specified query language and returns the bind variable names found in the query statement.
 void clone(SessionInfo sessionInfo, 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, 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.
 NodeId createActivity(SessionInfo sessionInfo, String title)
          Create a new activity.
 Batch createBatch(SessionInfo sessionInfo, ItemId itemId)
          Indicates the start of a set of operations that cause modifications on the underlying persistence layer.
 NodeId createConfiguration(SessionInfo sessionInfo, NodeId nodeId)
           
 EventFilter createEventFilter(SessionInfo sessionInfo, int eventTypes, Path absPath, boolean isDeep, 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 createWorkspace(SessionInfo sessionInfo, String name, String srcWorkspaceName)
          Create a new workspace with the specified name.
 void deleteWorkspace(SessionInfo sessionInfo, String name)
          Deletes the workspace with the specified name.
 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, String statement, String language, Map<String,String> namespaces, long limit, long offset, Map<String,QValue> values)
          Execute the given query statement with the specified query language.
 Iterator<ChildInfo> getChildInfos(SessionInfo sessionInfo, NodeId parentId)
          Returns an Iterator of ChildInfos present on the Node represented by the given parentId.
 EventBundle getEvents(SessionInfo sessionInfo, EventFilter filter, long after)
          Returns events from the EventJournal after a given point in time.
 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.
 ItemInfoCache getItemInfoCache(SessionInfo sessionInfo)
          Returns a ItemInfoCache for the given SessionInfo.
 Iterator<? extends ItemInfo> getItemInfos(SessionInfo sessionInfo, ItemId itemId)
          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.
 String getNamespacePrefix(SessionInfo sessionInfo, String uri)
          Returns the namespace prefix for the given namespace uri.
 String getNamespaceURI(SessionInfo sessionInfo, 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)
          Deprecated. Use getItemInfos(SessionInfo, ItemId)
 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)
          Deprecated. Use getItemInfos(SessionInfo, ItemId)
 Iterator<QNodeTypeDefinition> getQNodeTypeDefinitions(SessionInfo sessionInfo)
          Retrieve the QNodeTypeDefinitions of all registered nodetypes.
 Iterator<QNodeTypeDefinition> getQNodeTypeDefinitions(SessionInfo sessionInfo, Name[] nodetypeNames)
          Retrieve QNodeTypeDefinitions for the given names.
 QValueFactory getQValueFactory()
          Return the QValueFactory defined with this SPI implementation.
 Iterator<PropertyId> getReferences(SessionInfo sessionInfo, NodeId nodeId, Name propertyName, boolean weakReferences)
          Returns the Ids of the properties that are referencing the node identified by the given nodeId.
 Map<String,String> getRegisteredNamespaces(SessionInfo sessionInfo)
          Retrieve all registered namespaces.
 Map<String,QValue[]> getRepositoryDescriptors()
          Returns all property descriptors that can be exposed with the Repository implementation built on top of this RepositoryService.
 String[] getSupportedQueryLanguages(SessionInfo sessionInfo)
          Returns a String array identifying all query languages supported by this SPI implementation.
 String[] getWorkspaceNames(SessionInfo sessionInfo)
          Return all workspace names available for the given SessionInfo.
 SessionInfo impersonate(SessionInfo sessionInfo, Credentials credentials)
          Returns a SessionInfo that will be used by other methods on the RepositoryService.
 void importXml(SessionInfo sessionInfo, NodeId parentId, InputStream xmlStream, int uuidBehaviour)
          Imports the data present in the given InputStream into the persistent layer.
 boolean isGranted(SessionInfo sessionInfo, ItemId itemId, 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.
 LockInfo lock(SessionInfo sessionInfo, NodeId nodeId, boolean deep, boolean sessionScoped, long timeoutHint, String ownerHint)
          Create a lock on the Node identified by the given id.
 Iterator<NodeId> merge(SessionInfo sessionInfo, NodeId nodeId, 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.
 Iterator<NodeId> merge(SessionInfo sessionInfo, NodeId nodeId, String srcWorkspaceName, boolean bestEffort, boolean isShallow)
          Merge the node identified by the given NodeId and its subtree with the corresponding node present in the workspace with the name of srcWorkspaceName.
 Iterator<NodeId> mergeActivity(SessionInfo sessionInfo, NodeId activityId)
          Merges the activity identified by the given activityId into the workspace the specified sessionInfo has been created for.
 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(Credentials credentials, String workspaceName)
          Returns a SessionInfo that will be used by other methods on the RepositoryService.
 SessionInfo obtain(SessionInfo sessionInfo, 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, String prefix, String uri)
          Register a new namespace with the given prefix and uri.
 void registerNodeTypes(SessionInfo sessionInfo, QNodeTypeDefinition[] nodeTypeDefinitions, boolean allowUpdate)
          Registers the node types with the specified QNodeTypeDefinitions.
 void removeActivity(SessionInfo sessionInfo, NodeId activityId)
          Removes the activity identified by the specified activityId.
 void removeVersion(SessionInfo sessionInfo, NodeId versionHistoryId, NodeId versionId)
          Remove the version identified 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.
 void unregisterNamespace(SessionInfo sessionInfo, String uri)
          Unregister the namespace identified by the given uri
 void unregisterNodeTypes(SessionInfo sessionInfo, Name[] nodeTypeNames)
          Unregisters the node types with the specified names.
 void update(SessionInfo sessionInfo, NodeId nodeId, 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.
 

Method Detail

getIdFactory

IdFactory getIdFactory()
                       throws RepositoryException
Return the IdFactory.

Returns:
The IdFactory.
Throws:
RepositoryException - If an error occurs.

getNameFactory

NameFactory getNameFactory()
                           throws RepositoryException
Return the NameFactory.

Returns:
The NameFactory.
Throws:
RepositoryException - If an error occurs.

getPathFactory

PathFactory getPathFactory()
                           throws RepositoryException
Return the PathFactory.

Returns:
The PathFactory.
Throws:
RepositoryException - If an error occurs.

getQValueFactory

QValueFactory getQValueFactory()
                               throws RepositoryException
Return the QValueFactory defined with this SPI implementation.

Returns:
The QValueFactory.
Throws:
RepositoryException - If an error occurs.

getItemInfoCache

ItemInfoCache getItemInfoCache(SessionInfo sessionInfo)
                               throws RepositoryException
Returns a ItemInfoCache for the given SessionInfo.

Parameters:
sessionInfo -
Returns:
Throws:
RepositoryException

getRepositoryDescriptors

Map<String,QValue[]> getRepositoryDescriptors()
                                              throws RepositoryException
Returns all property descriptors that can be exposed with the Repository implementation built on top of this RepositoryService.

Returns:
key-value pairs for repository descriptor keys and values.
Throws:
RepositoryException
See Also:
Repository.getDescriptorKeys(), Repository.getDescriptor(String)

obtain

SessionInfo obtain(Credentials credentials,
                   String workspaceName)
                   throws LoginException,
                          NoSuchWorkspaceException,
                          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.

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:
LoginException - if authentication of the user fails.
NoSuchWorkspaceException - if the specified workspaceName is not recognized.
RepositoryException - if an error occurs.

obtain

SessionInfo obtain(SessionInfo sessionInfo,
                   String workspaceName)
                   throws LoginException,
                          NoSuchWorkspaceException,
                          RepositoryException
Returns a new SessionInfo for the given workspace name that will be used by other methods on the 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:
LoginException - if authentication of the user fails.
NoSuchWorkspaceException - if the specified workspaceName is not recognized.
RepositoryException - if an error occurs.

impersonate

SessionInfo impersonate(SessionInfo sessionInfo,
                        Credentials credentials)
                        throws LoginException,
                               RepositoryException
Returns a SessionInfo that will be used by other methods on the RepositoryService.

Parameters:
sessionInfo -
credentials -
Returns:
a SessionInfo if impersonate was successful.
Throws:
LoginException
RepositoryException
See Also:
Session.impersonate(javax.jcr.Credentials)

dispose

void dispose(SessionInfo sessionInfo)
             throws RepositoryException
Indicates to the RepositoryService, that the given SessionInfo will not be used any more.

Parameters:
sessionInfo -
Throws:
RepositoryException

getWorkspaceNames

String[] getWorkspaceNames(SessionInfo sessionInfo)
                           throws RepositoryException
Return all workspace names available for the given SessionInfo.

Parameters:
sessionInfo -
Returns:
An array of workspace names.
Throws:
RepositoryException
See Also:
Workspace.getAccessibleWorkspaceNames(), Workspace.getName()

isGranted

boolean isGranted(SessionInfo sessionInfo,
                  ItemId itemId,
                  String[] actions)
                  throws RepositoryException
Returns true if all actions defined in the specified array are granted to given SessionInfo. False otherwise.

Parameters:
sessionInfo -
itemId -
actions -
Returns:
true if the session with the given SessionInfo has the specified rights for the given item.
Throws:
RepositoryException
See Also:
Session.checkPermission(String, String), Session.hasPermission(String, String)

getNodeDefinition

QNodeDefinition getNodeDefinition(SessionInfo sessionInfo,
                                  NodeId nodeId)
                                  throws 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).

Parameters:
sessionInfo -
nodeId -
Returns:
The node definition applicable to the Node identified by the given id.
Throws:
RepositoryException

getPropertyDefinition

QPropertyDefinition getPropertyDefinition(SessionInfo sessionInfo,
                                          PropertyId propertyId)
                                          throws 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.

Parameters:
sessionInfo -
propertyId -
Returns:
The property definition applicable for the Property identified by the given id.
Throws:
RepositoryException

getNodeInfo

NodeInfo getNodeInfo(SessionInfo sessionInfo,
                     NodeId nodeId)
                     throws ItemNotFoundException,
                            RepositoryException
Deprecated. Use getItemInfos(SessionInfo, ItemId)

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

Parameters:
sessionInfo -
nodeId -
Returns:
The NodeInfo for the node identified by the given id.
Throws:
ItemNotFoundException
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

Iterator<? extends ItemInfo> getItemInfos(SessionInfo sessionInfo,
                                          ItemId itemId)
                                          throws ItemNotFoundException,
                                                 RepositoryException
Method used to 'batch-read' from the persistent storage. It returns the ItemInfo for the given ItemId as the first element in the Iterator. In addition the iterator may contain arbitrary ItemInfos.

Parameters:
sessionInfo -
itemId -
Returns:
An Iterator of ItemInfos containing at least a single element: the ItemInfo that represents the Item identified by the given ItemId. If the Iterator contains multiple elements, the first is expected to represent the Item identified by the given ItemId.
Throws:
ItemNotFoundException
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

Iterator<ChildInfo> getChildInfos(SessionInfo sessionInfo,
                                  NodeId parentId)
                                  throws ItemNotFoundException,
                                         RepositoryException
Returns an Iterator of ChildInfos present on the Node represented by the given parentId.

Parameters:
sessionInfo -
parentId -
Returns:
An Iterator of ChildInfos present on the Node represented by the given parentId.
Throws:
ItemNotFoundException
RepositoryException

getReferences

Iterator<PropertyId> getReferences(SessionInfo sessionInfo,
                                   NodeId nodeId,
                                   Name propertyName,
                                   boolean weakReferences)
                                   throws ItemNotFoundException,
                                          RepositoryException
Returns the Ids of the properties that are referencing the node identified by the given nodeId. If weakReferences is true the ids of WEAKREFERENCE properties are returned, otherwise the property must be of type REFERENCE.

Parameters:
sessionInfo -
nodeId -
propertyName - name filter of referring properties to be returned; if null then all references are returned.
weakReferences - If true the properties must be of type PropertyType.WEAKREFERENCE, otherwise of type PropertyType.REFERENCE.
Returns:
An Iterator of Ids of the properties that are referencing the node identified by the given nodeId or an empty iterator if the node is not referenceable or no references exist.
Throws:
ItemNotFoundException
RepositoryException
Since:
JCR 2.0
See Also:
PropertyInfo.getId()

getPropertyInfo

PropertyInfo getPropertyInfo(SessionInfo sessionInfo,
                             PropertyId propertyId)
                             throws ItemNotFoundException,
                                    RepositoryException
Deprecated. Use getItemInfos(SessionInfo, ItemId)

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

Parameters:
sessionInfo -
propertyId -
Returns:
The PropertyInfo for the Property identified by the given id.
Throws:
ItemNotFoundException
RepositoryException
See Also:
Session.getItem(String), Node.getProperty(String)

createBatch

Batch createBatch(SessionInfo sessionInfo,
                  ItemId itemId)
                  throws 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 submit(Batch).

Parameters:
sessionInfo -
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 submit(Batch).
Throws:
RepositoryException
See Also:
Item.save(), Session.save(), Batch

submit

void submit(Batch batch)
            throws PathNotFoundException,
                   ItemNotFoundException,
                   NoSuchNodeTypeException,
                   ValueFormatException,
                   VersionException,
                   LockException,
                   ConstraintViolationException,
                   AccessDeniedException,
                   UnsupportedRepositoryOperationException,
                   RepositoryException
Completes the given Batch or discard all the previous modifications. See createBatch(SessionInfo,ItemId) for additional information regarding batch creation.

Parameters:
batch -
Throws:
PathNotFoundException
ItemNotFoundException
NoSuchNodeTypeException
ValueFormatException
VersionException
LockException
ConstraintViolationException
AccessDeniedException
UnsupportedRepositoryOperationException
RepositoryException
See Also:
Batch

importXml

void importXml(SessionInfo sessionInfo,
               NodeId parentId,
               InputStream xmlStream,
               int uuidBehaviour)
               throws ItemExistsException,
                      PathNotFoundException,
                      VersionException,
                      ConstraintViolationException,
                      LockException,
                      AccessDeniedException,
                      UnsupportedRepositoryOperationException,
                      RepositoryException
Imports the data present in the given InputStream into the persistent layer. Note, that the implementation is responsible for validating the data presented and for the integrity of the repository upon completion.

Parameters:
sessionInfo -
parentId -
xmlStream -
uuidBehaviour -
Throws:
ItemExistsException
PathNotFoundException
VersionException
ConstraintViolationException
LockException
AccessDeniedException
UnsupportedRepositoryOperationException
RepositoryException
See Also:
Workspace.importXML(String, java.io.InputStream, int)

move

void move(SessionInfo sessionInfo,
          NodeId srcNodeId,
          NodeId destParentNodeId,
          Name destName)
          throws ItemExistsException,
                 PathNotFoundException,
                 VersionException,
                 ConstraintViolationException,
                 LockException,
                 AccessDeniedException,
                 UnsupportedRepositoryOperationException,
                 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).

Parameters:
sessionInfo -
srcNodeId -
destParentNodeId -
destName -
Throws:
ItemExistsException
PathNotFoundException
VersionException
ConstraintViolationException
LockException
AccessDeniedException
UnsupportedRepositoryOperationException
RepositoryException
See Also:
Workspace.move(String, String)

copy

void copy(SessionInfo sessionInfo,
          String srcWorkspaceName,
          NodeId srcNodeId,
          NodeId destParentNodeId,
          Name destName)
          throws NoSuchWorkspaceException,
                 ConstraintViolationException,
                 VersionException,
                 AccessDeniedException,
                 PathNotFoundException,
                 ItemExistsException,
                 LockException,
                 UnsupportedRepositoryOperationException,
                 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.

Parameters:
sessionInfo -
srcWorkspaceName -
srcNodeId -
destParentNodeId -
destName -
Throws:
NoSuchWorkspaceException
ConstraintViolationException
VersionException
AccessDeniedException
PathNotFoundException
ItemExistsException
LockException
UnsupportedRepositoryOperationException
RepositoryException
See Also:
Workspace.copy(String, String), Workspace.copy(String, String, String)

update

void update(SessionInfo sessionInfo,
            NodeId nodeId,
            String srcWorkspaceName)
            throws NoSuchWorkspaceException,
                   AccessDeniedException,
                   LockException,
                   InvalidItemStateException,
                   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.

Parameters:
sessionInfo -
nodeId -
srcWorkspaceName -
Throws:
NoSuchWorkspaceException
AccessDeniedException
LockException
InvalidItemStateException
RepositoryException
See Also:
Node.update(String)

clone

void clone(SessionInfo sessionInfo,
           String srcWorkspaceName,
           NodeId srcNodeId,
           NodeId destParentNodeId,
           Name destName,
           boolean removeExisting)
           throws NoSuchWorkspaceException,
                  ConstraintViolationException,
                  VersionException,
                  AccessDeniedException,
                  PathNotFoundException,
                  ItemExistsException,
                  LockException,
                  UnsupportedRepositoryOperationException,
                  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.

Parameters:
sessionInfo -
srcWorkspaceName -
srcNodeId -
destParentNodeId -
destName -
removeExisting -
Throws:
NoSuchWorkspaceException
ConstraintViolationException
VersionException
AccessDeniedException
PathNotFoundException
ItemExistsException
LockException
UnsupportedRepositoryOperationException
RepositoryException
See Also:
Workspace.clone(String, String, String, boolean)

getLockInfo

LockInfo getLockInfo(SessionInfo sessionInfo,
                     NodeId nodeId)
                     throws AccessDeniedException,
                            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.

Parameters:
sessionInfo -
nodeId -
Returns:
The lock information for the Node identified by the given nodeId or null if no lock applies to that Node.
Throws:
AccessDeniedException
RepositoryException - If some other error occurs.
See Also:
Node.getLock()

lock

LockInfo lock(SessionInfo sessionInfo,
              NodeId nodeId,
              boolean deep,
              boolean sessionScoped)
              throws UnsupportedRepositoryOperationException,
                     LockException,
                     AccessDeniedException,
                     RepositoryException
Create a lock on the Node identified by the given id.

Parameters:
sessionInfo -
nodeId -
deep -
sessionScoped -
Returns:
The LockInfo associated with the new lock that has been created.
Throws:
UnsupportedRepositoryOperationException - If this SPI implementation does not support locking at all.
LockException - If the Node identified by the given id cannot be locked due to an existing lock or due to missing mixin type.
AccessDeniedException
RepositoryException - If another error occurs.
See Also:
Node.lock(boolean, boolean)

lock

LockInfo lock(SessionInfo sessionInfo,
              NodeId nodeId,
              boolean deep,
              boolean sessionScoped,
              long timeoutHint,
              String ownerHint)
              throws UnsupportedRepositoryOperationException,
                     LockException,
                     AccessDeniedException,
                     RepositoryException
Create a lock on the Node identified by the given id.

Parameters:
sessionInfo -
nodeId -
deep -
sessionScoped -
timeoutHint - long indicating the desired lock timeout in seconds. The implementation is free to ignore the hint.
ownerHint - String indicating the desired lockOwner info. The implementation is free to ignore the hint.
Returns:
The LockInfo associated with the new lock that has been created.
Throws:
UnsupportedRepositoryOperationException - If this SPI implementation does not support locking at all.
LockException - If the Node identified by the given id cannot be locked due to an existing lock or due to missing mixin type.
AccessDeniedException
RepositoryException - If another error occurs.
Since:
JCR 2.0
See Also:
LockManager.lock(String, boolean, boolean, long, String)

refreshLock

void refreshLock(SessionInfo sessionInfo,
                 NodeId nodeId)
                 throws UnsupportedRepositoryOperationException,
                        LockException,
                        AccessDeniedException,
                        RepositoryException
Explicit refresh of an existing lock. Existing locks should be refreshed implicitly with all read and write methods listed here.

Parameters:
sessionInfo -
nodeId -
Throws:
UnsupportedRepositoryOperationException - If this SPI implementation does not support locking at all.
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.
AccessDeniedException
RepositoryException - If another error occurs.
See Also:
Lock

unlock

void unlock(SessionInfo sessionInfo,
            NodeId nodeId)
            throws UnsupportedRepositoryOperationException,
                   LockException,
                   AccessDeniedException,
                   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.

Parameters:
sessionInfo -
nodeId -
Throws:
UnsupportedRepositoryOperationException - If this SPI implementation does not support locking at all.
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.
AccessDeniedException
RepositoryException - If another error occurs.
See Also:
Node.unlock()

checkin

NodeId checkin(SessionInfo sessionInfo,
               NodeId nodeId)
               throws VersionException,
                      UnsupportedRepositoryOperationException,
                      InvalidItemStateException,
                      LockException,
                      RepositoryException
Performs a checkin for the Node identified by the given NodeId.

Parameters:
sessionInfo -
nodeId -
Returns:
NodeId of newly created version
Throws:
VersionException
UnsupportedRepositoryOperationException
InvalidItemStateException
LockException
RepositoryException
See Also:
Node.checkin()

checkout

void checkout(SessionInfo sessionInfo,
              NodeId nodeId)
              throws UnsupportedRepositoryOperationException,
                     LockException,
                     RepositoryException
Performs a checkout for the Node identified by the given NodeId. Same as checkout(SessionInfo, NodeId, NodeId) where the activityId is null.

Parameters:
sessionInfo -
nodeId -
Throws:
UnsupportedRepositoryOperationException
LockException
RepositoryException
See Also:
Node.checkout()

checkout

void checkout(SessionInfo sessionInfo,
              NodeId nodeId,
              NodeId activityId)
              throws UnsupportedRepositoryOperationException,
                     LockException,
                     RepositoryException
Performs a checkout for the Node identified by the given NodeId and for activity identified by the specified activityId. If the activityId is null this corresponds to checkout(SessionInfo, NodeId)

Parameters:
sessionInfo -
nodeId -
activityId - Id of the activity node set to the editing session or null if no activity is in effect.
Throws:
UnsupportedRepositoryOperationException
LockException
RepositoryException
Since:
JCR 2.0

checkpoint

NodeId checkpoint(SessionInfo sessionInfo,
                  NodeId nodeId)
                  throws UnsupportedRepositoryOperationException,
                         RepositoryException
Performs a checkpoint for the Node identified by the given NodeId.

Parameters:
sessionInfo -
nodeId -
Returns:
NodeId of newly created version
Throws:
UnsupportedRepositoryOperationException
RepositoryException
Since:
JCR 2.0
See Also:
VersionManager.checkpoint(String)

checkpoint

NodeId checkpoint(SessionInfo sessionInfo,
                  NodeId nodeId,
                  NodeId activityId)
                  throws UnsupportedRepositoryOperationException,
                         RepositoryException
Performs a checkpoint for the Node identified by the given NodeId. For the checkout part the specified activityId is taken into account as specified in checkout(SessionInfo, NodeId, NodeId).

Parameters:
sessionInfo -
nodeId -
activityId - Id of the activity node set to the editing session or null if no activity is in effect.
Throws:
UnsupportedRepositoryOperationException
LockException
RepositoryException
Since:
JCR 2.0

removeVersion

void removeVersion(SessionInfo sessionInfo,
                   NodeId versionHistoryId,
                   NodeId versionId)
                   throws ReferentialIntegrityException,
                          AccessDeniedException,
                          UnsupportedRepositoryOperationException,
                          VersionException,
                          RepositoryException
Remove the version identified by the specified versionId.

Parameters:
sessionInfo -
versionHistoryId - NodeId identifying the version history the version identified by versionId belongs to.
versionId -
Throws:
ReferentialIntegrityException
AccessDeniedException
UnsupportedRepositoryOperationException
VersionException
RepositoryException
See Also:
VersionHistory.removeVersion(String)

restore

void restore(SessionInfo sessionInfo,
             NodeId nodeId,
             NodeId versionId,
             boolean removeExisting)
             throws VersionException,
                    PathNotFoundException,
                    ItemExistsException,
                    UnsupportedRepositoryOperationException,
                    LockException,
                    InvalidItemStateException,
                    RepositoryException
Restores the node identified by nodeId to the state defined by the version with the specified versionId.

Parameters:
sessionInfo -
nodeId -
versionId -
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 fails.
Throws:
VersionException
PathNotFoundException
ItemExistsException
UnsupportedRepositoryOperationException
LockException
InvalidItemStateException
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

void restore(SessionInfo sessionInfo,
             NodeId[] versionIds,
             boolean removeExisting)
             throws ItemExistsException,
                    UnsupportedRepositoryOperationException,
                    VersionException,
                    LockException,
                    InvalidItemStateException,
                    RepositoryException
Restore multiple versions at once. The versions to be restored are identified by the given array of NodeIds.

Parameters:
sessionInfo -
versionIds -
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 fails.
Throws:
ItemExistsException
UnsupportedRepositoryOperationException
VersionException
LockException
InvalidItemStateException
RepositoryException
See Also:
Workspace.restore(javax.jcr.version.Version[], boolean)

merge

Iterator<NodeId> merge(SessionInfo sessionInfo,
                       NodeId nodeId,
                       String srcWorkspaceName,
                       boolean bestEffort)
                       throws NoSuchWorkspaceException,
                              AccessDeniedException,
                              MergeException,
                              LockException,
                              InvalidItemStateException,
                              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.

Parameters:
sessionInfo -
nodeId -
srcWorkspaceName -
bestEffort -
Returns:
an Iterator over the NodeIds of all nodes that received a merge result of "fail" in the course of this operation.
Throws:
NoSuchWorkspaceException
AccessDeniedException
MergeException
LockException
InvalidItemStateException
RepositoryException
See Also:
Node.merge(String, boolean)

merge

Iterator<NodeId> merge(SessionInfo sessionInfo,
                       NodeId nodeId,
                       String srcWorkspaceName,
                       boolean bestEffort,
                       boolean isShallow)
                       throws NoSuchWorkspaceException,
                              AccessDeniedException,
                              MergeException,
                              LockException,
                              InvalidItemStateException,
                              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.

Parameters:
sessionInfo -
nodeId -
srcWorkspaceName -
bestEffort -
Returns:
an Iterator over the NodeIds of all nodes that received a merge result of "fail" in the course of this operation.
Throws:
NoSuchWorkspaceException
AccessDeniedException
MergeException
LockException
InvalidItemStateException
RepositoryException
Since:
JCR 2.0
See Also:
VersionManager.merge(String, String, boolean, boolean)

resolveMergeConflict

void resolveMergeConflict(SessionInfo sessionInfo,
                          NodeId nodeId,
                          NodeId[] mergeFailedIds,
                          NodeId[] predecessorIds)
                          throws VersionException,
                                 InvalidItemStateException,
                                 UnsupportedRepositoryOperationException,
                                 RepositoryException
Resolve an existing merge conflict present with the node identified by the given NodeId.

Parameters:
sessionInfo -
nodeId -
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:
VersionException
InvalidItemStateException
UnsupportedRepositoryOperationException
RepositoryException
See Also:
Node.cancelMerge(javax.jcr.version.Version), Node.doneMerge(javax.jcr.version.Version)

addVersionLabel

void addVersionLabel(SessionInfo sessionInfo,
                     NodeId versionHistoryId,
                     NodeId versionId,
                     Name label,
                     boolean moveLabel)
                     throws VersionException,
                            RepositoryException
Add the given version label in the persistent layer.

Parameters:
sessionInfo -
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:
VersionException
RepositoryException
See Also:
VersionHistory.addVersionLabel(String, String, boolean)

removeVersionLabel

void removeVersionLabel(SessionInfo sessionInfo,
                        NodeId versionHistoryId,
                        NodeId versionId,
                        Name label)
                        throws VersionException,
                               RepositoryException
Remove the given version label in the persistent layer.

Parameters:
sessionInfo -
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:
VersionException
RepositoryException
See Also:
VersionHistory.removeVersionLabel(String)

createActivity

NodeId createActivity(SessionInfo sessionInfo,
                      String title)
                      throws UnsupportedRepositoryOperationException,
                             RepositoryException
Create a new activity.

Parameters:
sessionInfo -
title -
Returns:
the NodeId of the new activity node.
Throws:
UnsupportedRepositoryOperationException
RepositoryException
Since:
JCR 2.0
See Also:
VersionManager.createActivity(String)

removeActivity

void removeActivity(SessionInfo sessionInfo,
                    NodeId activityId)
                    throws UnsupportedRepositoryOperationException,
                           RepositoryException
Removes the activity identified by the specified activityId.

Parameters:
sessionInfo -
activityId -
Throws:
UnsupportedRepositoryOperationException
RepositoryException
Since:
JCR 2.0
See Also:
VersionManager.removeActivity(Node)

mergeActivity

Iterator<NodeId> mergeActivity(SessionInfo sessionInfo,
                               NodeId activityId)
                               throws UnsupportedRepositoryOperationException,
                                      RepositoryException
Merges the activity identified by the given activityId into the workspace the specified sessionInfo has been created for.

Parameters:
sessionInfo -
activityId -
Returns:
an Iterator over the NodeIds of all nodes that received a merge result of "fail" in the course of this operation.
Throws:
UnsupportedRepositoryOperationException
RepositoryException

createConfiguration

NodeId createConfiguration(SessionInfo sessionInfo,
                           NodeId nodeId)
                           throws UnsupportedRepositoryOperationException,
                                  RepositoryException
Parameters:
sessionInfo -
nodeId -
Returns:
Throws:
UnsupportedRepositoryOperationException
RepositoryException
See Also:
VersionManager.createConfiguration(String)

getSupportedQueryLanguages

String[] getSupportedQueryLanguages(SessionInfo sessionInfo)
                                    throws RepositoryException
Returns a String array identifying all query languages supported by this SPI implementation.

Parameters:
sessionInfo -
Returns:
String array identifying all query languages supported by this SPI implementation.
Throws:
RepositoryException
See Also:
QueryManager.getSupportedQueryLanguages()

checkQueryStatement

String[] checkQueryStatement(SessionInfo sessionInfo,
                             String statement,
                             String language,
                             Map<String,String> namespaces)
                             throws InvalidQueryException,
                                    RepositoryException
Checks if the query statement is valid according to the specified query language and returns the bind variable names found in the query statement.

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.
Returns:
the bind variable names.
Throws:
InvalidQueryException - if the query statement is invalid or the language is not supported.
RepositoryException - if an error occurs while checking the statement.
See Also:
QueryManager.createQuery(String, String)

executeQuery

QueryInfo executeQuery(SessionInfo sessionInfo,
                       String statement,
                       String language,
                       Map<String,String> namespaces,
                       long limit,
                       long offset,
                       Map<String,QValue> values)
                       throws 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.

Parameters:
sessionInfo - the session info that wants to execute the query.
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.
limit - The maximum result size or -1 is no maximum is set.
offset - The offset in the total result set or -1 is no offset is set.
values - A Map of name/value pairs collected upon calls to Query.bindValue(String, javax.jcr.Value).
Returns:
The query info.
Throws:
RepositoryException - if an error occurs.
See Also:
Query.execute()

createEventFilter

EventFilter createEventFilter(SessionInfo sessionInfo,
                              int eventTypes,
                              Path absPath,
                              boolean isDeep,
                              String[] uuid,
                              Name[] nodeTypeName,
                              boolean noLocal)
                              throws UnsupportedRepositoryOperationException,
                                     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'.

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:
UnsupportedRepositoryOperationException - if this SPI implementation does not allow to create event filters.
RepositoryException - if an error occurs while creating the EventFilter.
See Also:
ObservationManager.addEventListener(javax.jcr.observation.EventListener, int, String, boolean, String[], String[], boolean)

createSubscription

Subscription createSubscription(SessionInfo sessionInfo,
                                EventFilter[] filters)
                                throws UnsupportedRepositoryOperationException,
                                       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 updateEventFilters(Subscription, EventFilter[]).

Parameters:
sessionInfo - the session info.
filters - the initial event filters for the subscription.
Returns:
Throws:
UnsupportedRepositoryOperationException - if this SPI implementation does not support observation.
RepositoryException - if an error occurs while creating the Subscription.

updateEventFilters

void updateEventFilters(Subscription subscription,
                        EventFilter[] filters)
                        throws 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 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 getEvents(Subscription, long) using the same subscription instance as a parameter.

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:
RepositoryException - if an error occurs while updating the event filters.

getEvents

EventBundle[] getEvents(Subscription subscription,
                        long timeout)
                        throws RepositoryException,
                               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.

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:
RepositoryException - if an error occurs while retrieving the event bundles.
InterruptedException - if the calling thread is interrupted while waiting for events within the specified timeout.

getEvents

EventBundle getEvents(SessionInfo sessionInfo,
                      EventFilter filter,
                      long after)
                      throws RepositoryException,
                             UnsupportedRepositoryOperationException
Returns events from the EventJournal after a given point in time. The returned event bundle may only contain events up to a given time. In order to retrieve more events a client must call this method again with the timestamp from the last event bundle. An empty bundle indicates that there are no more events.

Parameters:
sessionInfo - the session info.
filter - the event filter to apply. Please note: the noLocal flag is ignored.
after - retrieve events that occurred after the given timestamp.
Returns:
the event bundle.
Throws:
RepositoryException - if an error occurs.
UnsupportedRepositoryOperationException - if the underlying implementation does not support event journaling.

dispose

void dispose(Subscription subscription)
             throws 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 getEvents(Subscription, long) using the same subscription instance as a parameter.

Throws:
RepositoryException - if an error occurs while the subscription is disposed.

getRegisteredNamespaces

Map<String,String> getRegisteredNamespaces(SessionInfo sessionInfo)
                                           throws 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.

Parameters:
sessionInfo -
Returns:
Throws:
RepositoryException
See Also:
Workspace.getNamespaceRegistry(), NamespaceRegistry.getPrefixes(), NamespaceRegistry.getURIs()

getNamespaceURI

String getNamespaceURI(SessionInfo sessionInfo,
                       String prefix)
                       throws NamespaceException,
                              RepositoryException
Returns the namespace URI for the given namespace prefix.

Parameters:
sessionInfo - the session info.
prefix - a namespace prefix to resolve.
Returns:
the namespace URI for the given namespace prefix.
Throws:
NamespaceException - if prefix is not mapped to a namespace URI.
RepositoryException - if another error occurs.
See Also:
NamespaceRegistry.getURI(String)

getNamespacePrefix

String getNamespacePrefix(SessionInfo sessionInfo,
                          String uri)
                          throws NamespaceException,
                                 RepositoryException
Returns the namespace prefix for the given namespace uri.

Parameters:
sessionInfo - the session info.
uri - the namespace URI.
Returns:
the namespace prefix.
Throws:
NamespaceException - if the URI unknown.
RepositoryException - if another error occurs.
See Also:
NamespaceRegistry.getPrefix(String)

registerNamespace

void registerNamespace(SessionInfo sessionInfo,
                       String prefix,
                       String uri)
                       throws NamespaceException,
                              UnsupportedRepositoryOperationException,
                              AccessDeniedException,
                              RepositoryException
Register a new namespace with the given prefix and uri.

Parameters:
sessionInfo -
prefix - Prefix of the namespace to be registered.
uri - Namespace URI to be registered.
Throws:
NamespaceException
UnsupportedRepositoryOperationException
AccessDeniedException
RepositoryException
See Also:
NamespaceRegistry.registerNamespace(String, String)

unregisterNamespace

void unregisterNamespace(SessionInfo sessionInfo,
                         String uri)
                         throws NamespaceException,
                                UnsupportedRepositoryOperationException,
                                AccessDeniedException,
                                RepositoryException
Unregister the namespace identified by the given uri

Parameters:
sessionInfo -
uri - Namespace URI to be unregistered.
Throws:
NamespaceException
UnsupportedRepositoryOperationException
AccessDeniedException
RepositoryException
See Also:
NamespaceRegistry.unregisterNamespace(String)

getQNodeTypeDefinitions

Iterator<QNodeTypeDefinition> getQNodeTypeDefinitions(SessionInfo sessionInfo)
                                                      throws RepositoryException
Retrieve the QNodeTypeDefinitions of all registered nodetypes.

Parameters:
sessionInfo -
Returns:
Iterator of QNodeTypeDefinitions.
Throws:
RepositoryException
See Also:
Workspace.getNodeTypeManager(), NodeTypeManager.getAllNodeTypes(), NodeTypeManager.getMixinNodeTypes(), NodeTypeManager.getPrimaryNodeTypes(), NodeTypeManager.getNodeType(String)

getQNodeTypeDefinitions

Iterator<QNodeTypeDefinition> getQNodeTypeDefinitions(SessionInfo sessionInfo,
                                                      Name[] nodetypeNames)
                                                      throws 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.

Parameters:
sessionInfo -
nodetypeNames - names of node types to retrieve
Returns:
QNodeTypeDefinition
Throws:
NoSuchNodeTypeException - if for any of the given names no QNodeTypeDefinition exists.
RepositoryException
See Also:
Workspace.getNodeTypeManager(), NodeTypeManager.getAllNodeTypes(), NodeTypeManager.getMixinNodeTypes(), NodeTypeManager.getPrimaryNodeTypes(), NodeTypeManager.getNodeType(String)

registerNodeTypes

void registerNodeTypes(SessionInfo sessionInfo,
                       QNodeTypeDefinition[] nodeTypeDefinitions,
                       boolean allowUpdate)
                       throws InvalidNodeTypeDefinitionException,
                              NodeTypeExistsException,
                              UnsupportedRepositoryOperationException,
                              RepositoryException
Registers the node types with the specified QNodeTypeDefinitions. If allowUpdate is true this method may also be used to reregister existing node types with a modified definition, otherwise this method will fail with NodeTypeExistsException if any of the specified definition has the name of an already registered node type.

Parameters:
sessionInfo -
nodeTypeDefinitions -
allowUpdate -
Throws:
InvalidNodeTypeDefinitionException - If any of the specified definitions is invalid.
NodeTypeExistsException - If any of the specified definitions has the name of an already registered node type and allowUpdate is false.
UnsupportedRepositoryOperationException - If registering node types is not supported.
RepositoryException - If another error occurs.
See Also:
NodeTypeManager.registerNodeTypes(javax.jcr.nodetype.NodeTypeDefinition[], boolean)

unregisterNodeTypes

void unregisterNodeTypes(SessionInfo sessionInfo,
                         Name[] nodeTypeNames)
                         throws UnsupportedRepositoryOperationException,
                                NoSuchNodeTypeException,
                                RepositoryException
Unregisters the node types with the specified names.

Parameters:
sessionInfo -
nodeTypeNames -
Throws:
UnsupportedRepositoryOperationException - If unregistering node types is not supported.
NoSuchNodeTypeException - If any of the specified names has no corresponding registered node type.
RepositoryException - If another error occurs.
See Also:
NodeTypeManager.unregisterNodeTypes(String[])

createWorkspace

void createWorkspace(SessionInfo sessionInfo,
                     String name,
                     String srcWorkspaceName)
                     throws AccessDeniedException,
                            UnsupportedRepositoryOperationException,
                            NoSuchWorkspaceException,
                            RepositoryException
Create a new workspace with the specified name. If srcWorkspaceName isn't null the content of that workspace is 'cloned' to the new workspace as inital content, otherwise an empty workspace will be created.

Parameters:
sessionInfo -
name - The name of the new workspace.
srcWorkspaceName - The name of the workspace from which the initial content of the new workspace will be 'cloned'.
Throws:
AccessDeniedException
UnsupportedRepositoryOperationException
NoSuchWorkspaceException
RepositoryException
Since:
JCR 2.0
See Also:
Workspace.createWorkspace(String), Workspace.createWorkspace(String, String)

deleteWorkspace

void deleteWorkspace(SessionInfo sessionInfo,
                     String name)
                     throws AccessDeniedException,
                            UnsupportedRepositoryOperationException,
                            NoSuchWorkspaceException,
                            RepositoryException
Deletes the workspace with the specified name.

Parameters:
sessionInfo -
name - The name of the workspace to be deleted.
Throws:
AccessDeniedException
UnsupportedRepositoryOperationException
NoSuchWorkspaceException
RepositoryException
Since:
JCR 2.0
See Also:
Workspace.deleteWorkspace(String)


Copyright © 2011-2013 Adobe Systems Incorporated. All Rights Reserved.