public class RepositoryServiceLogger extends AbstractLogger implements RepositoryService
RepositoryService
.Constructor and Description |
---|
RepositoryServiceLogger(RepositoryService service,
LogWriter writer)
Create a new instance for the given
service which uses
writer for persisting log messages. |
Modifier and Type | Method and Description |
---|---|
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 . |
java.lang.String[] |
checkQueryStatement(SessionInfo sessionInfo,
java.lang.String statement,
java.lang.String language,
java.util.Map<java.lang.String,java.lang.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,
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 . |
NodeId |
createActivity(SessionInfo sessionInfo,
java.lang.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,
java.lang.String[] uuid,
Name[] qnodeTypeName,
boolean noLocal)
Creates an event filter.
|
Subscription |
createSubscription(SessionInfo sessionInfo,
EventFilter[] filters)
Creates a new
Subscription for events with an initial set of
EventFilter s. |
Tree |
createTree(SessionInfo sessionInfo,
Batch batch,
Name nodeName,
Name primaryTypeName,
java.lang.String uniqueId)
Creates a new
Tree that can be populated and later on be applied
to the specified Batch by calling #setTree . |
void |
createWorkspace(SessionInfo sessionInfo,
java.lang.String name,
java.lang.String srcWorkspaceName)
Create a new workspace with the specified
name . |
void |
deleteWorkspace(SessionInfo sessionInfo,
java.lang.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,
java.lang.String statement,
java.lang.String language,
java.util.Map<java.lang.String,java.lang.String> namespaces,
long limit,
long offset,
java.util.Map<java.lang.String,QValue> values)
Execute the given query statement with the specified query language.
|
java.util.Iterator<ChildInfo> |
getChildInfos(SessionInfo sessionInfo,
NodeId parentId)
Returns an Iterator of
ChildInfo s 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 . |
java.util.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 . |
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 . |
PrivilegeDefinition[] |
getPrivilegeDefinitions(SessionInfo sessionInfo)
TODO
|
Name[] |
getPrivilegeNames(SessionInfo sessionInfo,
NodeId nodeId)
TODO
|
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<QNodeTypeDefinition> |
getQNodeTypeDefinitions(SessionInfo sessionInfo)
Retrieve the
QNodeTypeDefinition s of all registered nodetypes. |
java.util.Iterator<QNodeTypeDefinition> |
getQNodeTypeDefinitions(SessionInfo sessionInfo,
Name[] nodetypeNames)
Retrieve
QNodeTypeDefinition s for the given names. |
QValueFactory |
getQValueFactory()
Return the
QValueFactory defined with this SPI implementation. |
java.util.Iterator<PropertyId> |
getReferences(SessionInfo sessionInfo,
NodeId nodeId,
Name propertyName,
boolean weakReferences)
Returns the
Id s of the properties that are referencing
the node identified by the given nodeId . |
java.util.Map<java.lang.String,java.lang.String> |
getRegisteredNamespaces(SessionInfo sessionInfo)
Retrieve all registered namespaces.
|
java.util.Map<java.lang.String,QValue[]> |
getRepositoryDescriptors()
Returns all property descriptors that can be exposed with the
Repository implementation built on top of
this RepositoryService . |
RepositoryService |
getRepositoryService() |
PrivilegeDefinition[] |
getSupportedPrivileges(SessionInfo sessionInfo,
NodeId nodeId)
TODO
|
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,
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. |
LockInfo |
lock(SessionInfo sessionInfo,
NodeId nodeId,
boolean deep,
boolean sessionScoped,
long timeoutHint,
java.lang.String ownerHint)
Create a lock on the
Node identified by the given id. |
java.util.Iterator<NodeId> |
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 . |
java.util.Iterator<NodeId> |
merge(SessionInfo sessionInfo,
NodeId nodeId,
java.lang.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 . |
java.util.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,
java.lang.String workspaceName)
Returns a
SessionInfo 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 |
registerNodeTypes(SessionInfo sessionInfo,
QNodeTypeDefinition[] nodeTypeDefinitions,
boolean allowUpdate)
Registers the node types with the specified
QNodeTypeDefinition s. |
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[] nodeIds,
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,
java.lang.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,
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[] eventFilters)
Updates events filters on the subscription.
|
public RepositoryServiceLogger(RepositoryService service, LogWriter writer)
service
which uses
writer
for persisting log messages.service
- writer
- public RepositoryService getRepositoryService()
public NameFactory getNameFactory() throws RepositoryException
RepositoryService
NameFactory
.getNameFactory
in interface RepositoryService
NameFactory
.RepositoryException
- If an error occurs.public PathFactory getPathFactory() throws RepositoryException
RepositoryService
PathFactory
.getPathFactory
in interface RepositoryService
PathFactory
.RepositoryException
- If an error occurs.public IdFactory getIdFactory() throws RepositoryException
RepositoryService
IdFactory
.getIdFactory
in interface RepositoryService
IdFactory
.RepositoryException
- If an error occurs.public QValueFactory getQValueFactory() throws RepositoryException
RepositoryService
QValueFactory
defined with this SPI implementation.getQValueFactory
in interface RepositoryService
QValueFactory
.RepositoryException
- If an error occurs.public java.util.Map<java.lang.String,QValue[]> getRepositoryDescriptors() throws RepositoryException
RepositoryService
Repository
implementation built on top of
this RepositoryService
.getRepositoryDescriptors
in interface RepositoryService
RepositoryException
javax.jcr.Repository#getDescriptorKeys()
,
javax.jcr.Repository#getDescriptor(String)
public ItemInfoCache getItemInfoCache(SessionInfo sessionInfo) throws RepositoryException
RepositoryService
ItemInfoCache
for the given SessionInfo
.getItemInfoCache
in interface RepositoryService
RepositoryException
public SessionInfo obtain(Credentials credentials, java.lang.String workspaceName) throws RepositoryException
RepositoryService
SessionInfo
that will be used by other methods
on the RepositoryService
.
An implementation may choose to authenticate the user using the supplied
credentials
.obtain
in interface RepositoryService
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.SessionInfo
if authentication was successful.RepositoryException
- if an error occurs.public SessionInfo impersonate(SessionInfo sessionInfo, Credentials credentials) throws RepositoryException
RepositoryService
SessionInfo
that will be used by other methods
on the RepositoryService
.impersonate
in interface RepositoryService
SessionInfo
if impersonate was successful.RepositoryException
javax.jcr.Session#impersonate(javax.jcr.Credentials)
public void dispose(SessionInfo sessionInfo) throws RepositoryException
RepositoryService
RepositoryService
, that the given SessionInfo
will not be used any more.dispose
in interface RepositoryService
RepositoryException
public java.lang.String[] getWorkspaceNames(SessionInfo sessionInfo) throws RepositoryException
RepositoryService
SessionInfo
.getWorkspaceNames
in interface RepositoryService
RepositoryException
javax.jcr.Workspace#getAccessibleWorkspaceNames()
,
javax.jcr.Workspace#getName()
public boolean isGranted(SessionInfo sessionInfo, ItemId itemId, java.lang.String[] actions) throws RepositoryException
RepositoryService
SessionInfo
. False otherwise.isGranted
in interface RepositoryService
SessionInfo
has
the specified rights for the given item.RepositoryException
javax.jcr.Session#checkPermission(String, String)
,
javax.jcr.Session#hasPermission(String, String)
public PrivilegeDefinition[] getPrivilegeDefinitions(SessionInfo sessionInfo) throws RepositoryException
RepositoryService
getPrivilegeDefinitions
in interface RepositoryService
RepositoryException
public PrivilegeDefinition[] getSupportedPrivileges(SessionInfo sessionInfo, NodeId nodeId) throws RepositoryException
RepositoryService
getSupportedPrivileges
in interface RepositoryService
RepositoryException
public Name[] getPrivilegeNames(SessionInfo sessionInfo, NodeId nodeId) throws RepositoryException
RepositoryService
getPrivilegeNames
in interface RepositoryService
RepositoryException
public QNodeDefinition getNodeDefinition(SessionInfo sessionInfo, NodeId nodeId) throws RepositoryException
RepositoryService
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).getNodeDefinition
in interface RepositoryService
Node
identified
by the given id.RepositoryException
public QPropertyDefinition getPropertyDefinition(SessionInfo sessionInfo, PropertyId propertyId) throws RepositoryException
RepositoryService
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.getPropertyDefinition
in interface RepositoryService
Property
identified by the given id.RepositoryException
public NodeInfo getNodeInfo(SessionInfo sessionInfo, NodeId nodeId) throws RepositoryException
RepositoryService
NodeInfo
for the node identified by the given
NodeId
. See RepositoryService.getItemInfos(SessionInfo, ItemId)
for
a similar method that in addition may return ItemInfo
s of
children Item
s.getNodeInfo
in interface RepositoryService
NodeInfo
for the node identified by the given id.RepositoryException
javax.jcr.Session#getItem(String)
,
javax.jcr.Node#getNode(String)
,
javax.jcr.version.VersionHistory#getAllVersions()
,
javax.jcr.version.VersionHistory#getVersion(String)
,
javax.jcr.version.VersionHistory#getVersionByLabel(String)
,
javax.jcr.version.VersionHistory#getRootVersion()
,
javax.jcr.Node#getBaseVersion()
,
javax.jcr.Node#getVersionHistory()
,
javax.jcr.version.Version#getContainingHistory()
public java.util.Iterator<? extends ItemInfo> getItemInfos(SessionInfo sessionInfo, ItemId itemId) throws RepositoryException
RepositoryService
ItemInfo
for the given ItemId
as the first
element in the Iterator
. In addition the iterator may contain
arbitrary ItemInfo
s.getItemInfos
in interface RepositoryService
Iterator
of ItemInfo
s 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
.RepositoryException
javax.jcr.Session#getItem(String)
,
javax.jcr.Node#getNode(String)
,
javax.jcr.version.VersionHistory#getAllVersions()
,
javax.jcr.version.VersionHistory#getVersion(String)
,
javax.jcr.version.VersionHistory#getVersionByLabel(String)
,
javax.jcr.version.VersionHistory#getRootVersion()
,
javax.jcr.Node#getBaseVersion()
,
javax.jcr.Node#getVersionHistory()
,
javax.jcr.version.Version#getContainingHistory()
public java.util.Iterator<ChildInfo> getChildInfos(SessionInfo sessionInfo, NodeId parentId) throws RepositoryException
RepositoryService
ChildInfo
s present on the
Node represented by the given parentId.getChildInfos
in interface RepositoryService
ChildInfo
s present on the
Node represented by the given parentId.RepositoryException
public java.util.Iterator<PropertyId> getReferences(SessionInfo sessionInfo, NodeId nodeId, Name propertyName, boolean weakReferences) throws RepositoryException
RepositoryService
Id
s 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
.getReferences
in interface RepositoryService
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
javax.jcr.PropertyType#WEAKREFERENCE
, otherwise of type
javax.jcr.PropertyType#REFERENCE
.Id
s 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.RepositoryException
PropertyInfo.getId()
public PropertyInfo getPropertyInfo(SessionInfo sessionInfo, PropertyId propertyId) throws RepositoryException
RepositoryService
PropertyInfo
for the Property
identified by the given id.getPropertyInfo
in interface RepositoryService
PropertyInfo
for the Property
identified by the given id.RepositoryException
javax.jcr.Session#getItem(String)
,
javax.jcr.Node#getProperty(String)
public Batch createBatch(SessionInfo sessionInfo, ItemId itemId) throws RepositoryException
RepositoryService
Batch
must be executed at once or non must be executed upon
calling RepositoryService.submit(Batch)
.createBatch
in interface RepositoryService
itemId
- Id of the Item that is a common ancestor of all
Item
s affected upon batch execution. This Item
might itself be modified within the scope of the Batch
.RepositoryService.submit(Batch)
.RepositoryException
javax.jcr.Item#save()
,
javax.jcr.Session#save()
,
Batch
public void submit(Batch batch) throws RepositoryException
RepositoryService
Batch
or discard all the previous modifications.
See RepositoryService.createBatch(SessionInfo,ItemId)
for additional information
regarding batch creation.submit
in interface RepositoryService
RepositoryException
Batch
public Tree createTree(SessionInfo sessionInfo, Batch batch, Name nodeName, Name primaryTypeName, java.lang.String uniqueId) throws RepositoryException
RepositoryService
Tree
that can be populated and later on be applied
to the specified Batch
by calling #setTree
.createTree
in interface RepositoryService
Tree
instance.RepositoryException
public void importXml(SessionInfo sessionInfo, NodeId parentId, java.io.InputStream xmlStream, int uuidBehaviour) throws RepositoryException
RepositoryService
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.importXml
in interface RepositoryService
RepositoryException
javax.jcr.Workspace#importXML(String, java.io.InputStream, int)
public void move(SessionInfo sessionInfo, NodeId srcNodeId, NodeId destParentNodeId, Name destName) throws RepositoryException
RepositoryService
srcNodeId
(and its
entire subtree) to the new location defined by destParentNodeId
and a new name (destName
).move
in interface RepositoryService
RepositoryException
javax.jcr.Workspace#move(String, String)
public void copy(SessionInfo sessionInfo, java.lang.String srcWorkspaceName, NodeId srcNodeId, NodeId destParentNodeId, Name destName) throws RepositoryException
RepositoryService
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.
copy
in interface RepositoryService
RepositoryException
javax.jcr.Workspace#copy(String, String)
,
javax.jcr.Workspace#copy(String, String, String)
public void update(SessionInfo sessionInfo, NodeId nodeId, java.lang.String srcWorkspaceName) throws RepositoryException
RepositoryService
NodeId
replacing
it (an the complete subtree) with a clone of its corresponding node
present in the workspace with the given srcWorkspaceName
.update
in interface RepositoryService
RepositoryException
javax.jcr.Node#update(String)
public void clone(SessionInfo sessionInfo, java.lang.String srcWorkspaceName, NodeId srcNodeId, NodeId destParentNodeId, Name destName, boolean removeExisting) throws RepositoryException
RepositoryService
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
.clone
in interface RepositoryService
RepositoryException
javax.jcr.Workspace#clone(String, String, String, boolean)
public LockInfo getLockInfo(SessionInfo sessionInfo, NodeId nodeId) throws RepositoryException
RepositoryService
Node
identified
by the given NodeId
or null
. If the implementation
does not support locking at all, this method always returns null
.getLockInfo
in interface RepositoryService
nodeId
or null
if no lock applies to that Node.RepositoryException
Node#getLock()
public LockInfo lock(SessionInfo sessionInfo, NodeId nodeId, boolean deep, boolean sessionScoped) throws RepositoryException
RepositoryService
Node
identified by the given id.lock
in interface RepositoryService
LockInfo
associated with the new lock
that has been created.RepositoryException
javax.jcr.Node#lock(boolean, boolean)
public LockInfo lock(SessionInfo sessionInfo, NodeId nodeId, boolean deep, boolean sessionScoped, long timeoutHint, java.lang.String ownerHint) throws RepositoryException
RepositoryService
Node
identified by the given id.lock
in interface RepositoryService
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.LockInfo
associated with the new lock
that has been created.RepositoryException
javax.jcr.lock.LockManager#lock(String, boolean, boolean, long, String)
public void refreshLock(SessionInfo sessionInfo, NodeId nodeId) throws RepositoryException
RepositoryService
refreshLock
in interface RepositoryService
RepositoryException
javax.jcr.lock.Lock
public void unlock(SessionInfo sessionInfo, NodeId nodeId) throws RepositoryException
RepositoryService
Node
identified by the given
NodeId
.
Please note, that on logout
all
session-scoped locks must be released by calling unlock.
unlock
in interface RepositoryService
RepositoryException
javax.jcr.Node#unlock()
public NodeId checkin(SessionInfo sessionInfo, NodeId nodeId) throws RepositoryException
RepositoryService
Node
identified by the given
NodeId
.checkin
in interface RepositoryService
NodeId
of newly created versionRepositoryException
javax.jcr.Node#checkin()
public void checkout(SessionInfo sessionInfo, NodeId nodeId) throws RepositoryException
RepositoryService
Node
identified by the given
NodeId
. Same as RepositoryService.checkout(SessionInfo, NodeId, NodeId)
where the activityId
is null
.checkout
in interface RepositoryService
RepositoryException
javax.jcr.Node#checkout()
public void checkout(SessionInfo sessionInfo, NodeId nodeId, NodeId activityId) throws RepositoryException
RepositoryService
Node
identified by the given
NodeId
and for activity identified by the specified
activityId
. If the activityId
is null
this corresponds to RepositoryService.checkout(SessionInfo, NodeId)
checkout
in interface RepositoryService
activityId
- Id of the activity node set to the editing session or
null
if no activity is in effect.RepositoryException
public NodeId checkpoint(SessionInfo sessionInfo, NodeId nodeId) throws UnsupportedRepositoryOperationException, RepositoryException
RepositoryService
Node
identified by the given
NodeId
.checkpoint
in interface RepositoryService
NodeId
of newly created versionUnsupportedRepositoryOperationException
RepositoryException
javax.jcr.version.VersionManager#checkpoint(String)
public NodeId checkpoint(SessionInfo sessionInfo, NodeId nodeId, NodeId activityId) throws UnsupportedRepositoryOperationException, RepositoryException
RepositoryService
Node
identified by the given
NodeId
. For the checkout part the specified activityId
is taken into account as specified in RepositoryService.checkout(SessionInfo, NodeId, NodeId)
.checkpoint
in interface RepositoryService
activityId
- Id of the activity node set to the editing session or
null
if no activity is in effect.UnsupportedRepositoryOperationException
RepositoryException
public void removeVersion(SessionInfo sessionInfo, NodeId versionHistoryId, NodeId versionId) throws RepositoryException
RepositoryService
versionId
.removeVersion
in interface RepositoryService
versionHistoryId
- NodeId
identifying the version
history the version identified by versionId
belongs to.RepositoryException
javax.jcr.version.VersionHistory#removeVersion(String)
public void restore(SessionInfo sessionInfo, NodeId nodeId, NodeId versionId, boolean removeExisting) throws RepositoryException
RepositoryService
nodeId
to the state defined
by the version with the specified versionId
.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 fails.RepositoryException
javax.jcr.Node#restore(String, boolean)
,
javax.jcr.Node#restore(javax.jcr.version.Version, boolean)
,
javax.jcr.Node#restore(javax.jcr.version.Version, String, boolean)
,
javax.jcr.Node#restoreByLabel(String, boolean)
public void restore(SessionInfo sessionInfo, NodeId[] nodeIds, boolean removeExisting) throws RepositoryException
RepositoryService
NodeId
s.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 fails.RepositoryException
javax.jcr.Workspace#restore(javax.jcr.version.Version[], boolean)
public java.util.Iterator<NodeId> merge(SessionInfo sessionInfo, NodeId nodeId, java.lang.String srcWorkspaceName, boolean bestEffort) throws RepositoryException
RepositoryService
NodeId
and its subtree
with the corresponding node present in the workspace with the name of
srcWorkspaceName
.merge
in interface RepositoryService
Iterator
over the NodeId
s of all nodes that
received a merge result of "fail" in the course of this operation.RepositoryException
javax.jcr.Node#merge(String, boolean)
public java.util.Iterator<NodeId> merge(SessionInfo sessionInfo, NodeId nodeId, java.lang.String srcWorkspaceName, boolean bestEffort, boolean isShallow) throws RepositoryException
RepositoryService
NodeId
and its subtree
with the corresponding node present in the workspace with the name of
srcWorkspaceName
.merge
in interface RepositoryService
Iterator
over the NodeId
s of all nodes that
received a merge result of "fail" in the course of this operation.RepositoryException
javax.jcr.version.VersionManager#merge(String, String, boolean, boolean)
public void resolveMergeConflict(SessionInfo sessionInfo, NodeId nodeId, NodeId[] mergeFailedIds, NodeId[] predecessorIds) throws RepositoryException
RepositoryService
NodeId
.resolveMergeConflict
in interface RepositoryService
mergeFailedIds
- The NodeId
s 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.RepositoryException
javax.jcr.Node#cancelMerge(javax.jcr.version.Version)
,
javax.jcr.Node#doneMerge(javax.jcr.version.Version)
public void addVersionLabel(SessionInfo sessionInfo, NodeId versionHistoryId, NodeId versionId, Name label, boolean moveLabel) throws RepositoryException
RepositoryService
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.RepositoryException
javax.jcr.version.VersionHistory#addVersionLabel(String, String, boolean)
public void removeVersionLabel(SessionInfo sessionInfo, NodeId versionHistoryId, NodeId versionId, Name label) throws RepositoryException
RepositoryService
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.RepositoryException
javax.jcr.version.VersionHistory#removeVersionLabel(String)
public NodeId createActivity(SessionInfo sessionInfo, java.lang.String title) throws UnsupportedRepositoryOperationException, RepositoryException
RepositoryService
createActivity
in interface RepositoryService
NodeId
of the new activity node.UnsupportedRepositoryOperationException
RepositoryException
javax.jcr.version.VersionManager#createActivity(String)
public void removeActivity(SessionInfo sessionInfo, NodeId activityId) throws UnsupportedRepositoryOperationException, RepositoryException
RepositoryService
activityId
.removeActivity
in interface RepositoryService
UnsupportedRepositoryOperationException
RepositoryException
javax.jcr.version.VersionManager#removeActivity(Node)
public java.util.Iterator<NodeId> mergeActivity(SessionInfo sessionInfo, NodeId activityId) throws UnsupportedRepositoryOperationException, RepositoryException
RepositoryService
activityId
into
the workspace the specified sessionInfo
has been created for.mergeActivity
in interface RepositoryService
Iterator
over the NodeId
s of all nodes that
received a merge result of "fail" in the course of this operation.UnsupportedRepositoryOperationException
RepositoryException
public NodeId createConfiguration(SessionInfo sessionInfo, NodeId nodeId) throws UnsupportedRepositoryOperationException, RepositoryException
createConfiguration
in interface RepositoryService
UnsupportedRepositoryOperationException
RepositoryException
javax.jcr.version.VersionManager#createConfiguration(String)
public java.lang.String[] getSupportedQueryLanguages(SessionInfo sessionInfo) throws RepositoryException
RepositoryService
getSupportedQueryLanguages
in interface RepositoryService
RepositoryException
javax.jcr.query.QueryManager#getSupportedQueryLanguages()
public java.lang.String[] checkQueryStatement(SessionInfo sessionInfo, java.lang.String statement, java.lang.String language, java.util.Map<java.lang.String,java.lang.String> namespaces) throws RepositoryException
RepositoryService
statement
is valid according to the
specified query language
and returns the bind variable
names found in the query statement.checkQueryStatement
in interface RepositoryService
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
.RepositoryException
- if an error occurs while checking the
statement.javax.jcr.query.QueryManager#createQuery(String, String)
public QueryInfo executeQuery(SessionInfo sessionInfo, java.lang.String statement, java.lang.String language, java.util.Map<java.lang.String,java.lang.String> namespaces, long limit, long offset, java.util.Map<java.lang.String,QValue> values) throws RepositoryException
RepositoryService
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.executeQuery
in interface RepositoryService
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
javax.jcr.query.Query#bindValue(String,
javax.jcr.Value)
.RepositoryException
- if an error occurs.javax.jcr.query.Query#execute()
public EventFilter createEventFilter(SessionInfo sessionInfo, int eventTypes, Path absPath, boolean isDeep, java.lang.String[] uuid, Name[] qnodeTypeName, boolean noLocal) throws RepositoryException
RepositoryService
javax.jcr.observation.ObservationManager#addEventListener
.
Note, that an SPI implementation may support observation even if
the corresponding repository descriptor
does not return 'true'.
createEventFilter
in interface RepositoryService
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.qnodeTypeName
- Array of node type names.noLocal
- A boolean
.RepositoryException
- if an error occurs while creating the
EventFilter.javax.jcr.observation.ObservationManager#addEventListener(javax.jcr.observation.EventListener, int, String, boolean, String[], String[], boolean)
public Subscription createSubscription(SessionInfo sessionInfo, EventFilter[] filters) throws RepositoryException
RepositoryService
Subscription
for events with an initial set of
EventFilter
s. 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[])
.createSubscription
in interface RepositoryService
sessionInfo
- the session info.filters
- the initial event filters for the subscription.RepositoryException
- if an error occurs while creating the
Subscription.public EventBundle[] getEvents(Subscription subscription, long timeout) throws RepositoryException, java.lang.InterruptedException
RepositoryService
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.
getEvents
in interface RepositoryService
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.EventBundle
s representing the events
that occurred.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
.public EventBundle getEvents(SessionInfo sessionInfo, EventFilter filter, long after) throws RepositoryException, UnsupportedRepositoryOperationException
RepositoryService
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.getEvents
in interface RepositoryService
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.RepositoryException
- if an error occurs.UnsupportedRepositoryOperationException
- if the underlying implementation does not
support event journaling.public void updateEventFilters(Subscription subscription, EventFilter[] eventFilters) throws RepositoryException
RepositoryService
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.
updateEventFilters
in interface RepositoryService
subscription
- the subscription where the event filters are
applied.eventFilters
- 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 accept
ed 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.RepositoryException
- if an error occurs while updating the event
filters.public void dispose(Subscription subscription) throws RepositoryException
RepositoryService
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.
dispose
in interface RepositoryService
RepositoryException
- if an error occurs while the subscription is
disposed.public java.util.Map<java.lang.String,java.lang.String> getRegisteredNamespaces(SessionInfo sessionInfo) throws RepositoryException
RepositoryService
getRegisteredNamespaces
in interface RepositoryService
RepositoryException
javax.jcr.Workspace#getNamespaceRegistry()
,
javax.jcr.NamespaceRegistry#getPrefixes()
,
javax.jcr.NamespaceRegistry#getURIs()
public java.lang.String getNamespaceURI(SessionInfo sessionInfo, java.lang.String prefix) throws RepositoryException
RepositoryService
prefix
.getNamespaceURI
in interface RepositoryService
sessionInfo
- the session info.prefix
- a namespace prefix to resolve.prefix
.RepositoryException
- if another error occurs.javax.jcr.NamespaceRegistry#getURI(String)
public java.lang.String getNamespacePrefix(SessionInfo sessionInfo, java.lang.String uri) throws RepositoryException
RepositoryService
uri
.getNamespacePrefix
in interface RepositoryService
sessionInfo
- the session info.uri
- the namespace URI.RepositoryException
- if another error occurs.javax.jcr.NamespaceRegistry#getPrefix(String)
public void registerNamespace(SessionInfo sessionInfo, java.lang.String prefix, java.lang.String uri) throws RepositoryException
RepositoryService
registerNamespace
in interface RepositoryService
prefix
- Prefix of the namespace to be registered.uri
- Namespace URI to be registered.RepositoryException
javax.jcr.NamespaceRegistry#registerNamespace(String, String)
public void unregisterNamespace(SessionInfo sessionInfo, java.lang.String uri) throws RepositoryException
RepositoryService
unregisterNamespace
in interface RepositoryService
uri
- Namespace URI to be unregistered.RepositoryException
javax.jcr.NamespaceRegistry#unregisterNamespace(String)
public java.util.Iterator<QNodeTypeDefinition> getQNodeTypeDefinitions(SessionInfo sessionInfo) throws RepositoryException
RepositoryService
QNodeTypeDefinition
s of all registered nodetypes.getQNodeTypeDefinitions
in interface RepositoryService
QNodeTypeDefinition
s.RepositoryException
javax.jcr.Workspace#getNodeTypeManager()
,
javax.jcr.nodetype.NodeTypeManager#getAllNodeTypes()
,
javax.jcr.nodetype.NodeTypeManager#getMixinNodeTypes()
,
javax.jcr.nodetype.NodeTypeManager#getPrimaryNodeTypes()
,
javax.jcr.nodetype.NodeTypeManager#getNodeType(String)
public java.util.Iterator<QNodeTypeDefinition> getQNodeTypeDefinitions(SessionInfo sessionInfo, Name[] nodetypeNames) throws RepositoryException
RepositoryService
QNodeTypeDefinition
s 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 QNodeTypeDefinition
s
present in the Iterator
irrespective whether they have been
loaded before or not.getQNodeTypeDefinitions
in interface RepositoryService
nodetypeNames
- names of node types to retrieveQNodeTypeDefinition
RepositoryException
javax.jcr.Workspace#getNodeTypeManager()
,
javax.jcr.nodetype.NodeTypeManager#getAllNodeTypes()
,
javax.jcr.nodetype.NodeTypeManager#getMixinNodeTypes()
,
javax.jcr.nodetype.NodeTypeManager#getPrimaryNodeTypes()
,
javax.jcr.nodetype.NodeTypeManager#getNodeType(String)
public void registerNodeTypes(SessionInfo sessionInfo, QNodeTypeDefinition[] nodeTypeDefinitions, boolean allowUpdate) throws InvalidNodeTypeDefinitionException, NodeTypeExistsException, UnsupportedRepositoryOperationException, RepositoryException
RepositoryService
QNodeTypeDefinition
s.
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.registerNodeTypes
in interface RepositoryService
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.javax.jcr.nodetype.NodeTypeManager#registerNodeTypes(javax.jcr.nodetype.NodeTypeDefinition[], boolean)
public void unregisterNodeTypes(SessionInfo sessionInfo, Name[] nodeTypeNames) throws UnsupportedRepositoryOperationException, NoSuchNodeTypeException, RepositoryException
RepositoryService
names
.unregisterNodeTypes
in interface RepositoryService
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.javax.jcr.nodetype.NodeTypeManager#unregisterNodeTypes(String[])
public void createWorkspace(SessionInfo sessionInfo, java.lang.String name, java.lang.String srcWorkspaceName) throws RepositoryException
RepositoryService
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.createWorkspace
in interface RepositoryService
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'.RepositoryException
javax.jcr.Workspace#createWorkspace(String)
,
javax.jcr.Workspace#createWorkspace(String, String)
public void deleteWorkspace(SessionInfo sessionInfo, java.lang.String name) throws RepositoryException
RepositoryService
name
.deleteWorkspace
in interface RepositoryService
name
- The name of the workspace to be deleted.RepositoryException
javax.jcr.Workspace#deleteWorkspace(String)
"Copyright © 2010 - 2020 Adobe Systems Incorporated. All Rights Reserved"