org.apache.jackrabbit.spi.commons
Class AbstractRepositoryService

java.lang.Object
  extended by org.apache.jackrabbit.spi.commons.AbstractRepositoryService
All Implemented Interfaces:
org.apache.jackrabbit.spi.RepositoryService
Direct Known Subclasses:
AbstractReadableRepositoryService

public abstract class AbstractRepositoryService
extends Object
implements org.apache.jackrabbit.spi.RepositoryService

AbstractRepositoryService provides an abstract base class for repository service implementations. This class provides default implementations for the following methods:


Field Summary
protected  Map<String,org.apache.jackrabbit.spi.QValue[]> descriptors
          The repository descriptors.
protected  NamespaceMapping namespaces
          The fixed set of namespaces known to the repository service.
protected  NodeTypeStorage nodeTypeDefs
          The fixed set of node type definitions known to the repository service.
protected  org.apache.jackrabbit.spi.QNodeDefinition rootNodeDefinition
          The node definition of the root node.
 
Constructor Summary
protected AbstractRepositoryService()
           
  AbstractRepositoryService(Map<String,org.apache.jackrabbit.spi.QValue[]> descriptors, Map<String,String> namespaces, org.apache.jackrabbit.spi.QNodeTypeDefinition[] nodeTypeDefs)
           
  AbstractRepositoryService(Map<String,org.apache.jackrabbit.spi.QValue[]> descriptors, Map<String,String> namespaces, Reader cnd)
           
 
Method Summary
 void addVersionLabel(org.apache.jackrabbit.spi.SessionInfo sessionInfo, org.apache.jackrabbit.spi.NodeId versionHistoryId, org.apache.jackrabbit.spi.NodeId versionId, org.apache.jackrabbit.spi.Name label, boolean moveLabel)
           
protected  void checkCredentials(Credentials credentials, String workspaceName)
          Checks if the given credentials are valid.
 org.apache.jackrabbit.spi.NodeId checkin(org.apache.jackrabbit.spi.SessionInfo sessionInfo, org.apache.jackrabbit.spi.NodeId nodeId)
           
 void checkout(org.apache.jackrabbit.spi.SessionInfo sessionInfo, org.apache.jackrabbit.spi.NodeId nodeId)
           
 void checkout(org.apache.jackrabbit.spi.SessionInfo sessionInfo, org.apache.jackrabbit.spi.NodeId nodeId, org.apache.jackrabbit.spi.NodeId activityId)
           
 org.apache.jackrabbit.spi.NodeId checkpoint(org.apache.jackrabbit.spi.SessionInfo sessionInfo, org.apache.jackrabbit.spi.NodeId nodeId)
           
 org.apache.jackrabbit.spi.NodeId checkpoint(org.apache.jackrabbit.spi.SessionInfo sessionInfo, org.apache.jackrabbit.spi.NodeId nodeId, org.apache.jackrabbit.spi.NodeId activityId)
           
 String[] checkQueryStatement(org.apache.jackrabbit.spi.SessionInfo sessionInfo, String statement, String language, Map<String,String> namespaces)
           
protected  void checkSessionInfo(org.apache.jackrabbit.spi.SessionInfo sessionInfo)
          Checks the type of the sessionInfo instance.
protected  void checkWorkspace(String workspaceName)
          Checks if the given workspace is available.
 void clone(org.apache.jackrabbit.spi.SessionInfo sessionInfo, String srcWorkspaceName, org.apache.jackrabbit.spi.NodeId srcNodeId, org.apache.jackrabbit.spi.NodeId destParentNodeId, org.apache.jackrabbit.spi.Name destName, boolean removeExisting)
           
 void copy(org.apache.jackrabbit.spi.SessionInfo sessionInfo, String srcWorkspaceName, org.apache.jackrabbit.spi.NodeId srcNodeId, org.apache.jackrabbit.spi.NodeId destParentNodeId, org.apache.jackrabbit.spi.Name destName)
           
 org.apache.jackrabbit.spi.NodeId createActivity(org.apache.jackrabbit.spi.SessionInfo sessionInfo, String title)
           
 org.apache.jackrabbit.spi.Batch createBatch(org.apache.jackrabbit.spi.SessionInfo sessionInfo, org.apache.jackrabbit.spi.ItemId itemId)
           
 org.apache.jackrabbit.spi.NodeId createConfiguration(org.apache.jackrabbit.spi.SessionInfo sessionInfo, org.apache.jackrabbit.spi.NodeId nodeId)
           
 org.apache.jackrabbit.spi.EventFilter createEventFilter(org.apache.jackrabbit.spi.SessionInfo sessionInfo, int eventTypes, org.apache.jackrabbit.spi.Path absPath, boolean isDeep, String[] uuid, org.apache.jackrabbit.spi.Name[] nodeTypeName, boolean noLocal)
           
protected abstract  org.apache.jackrabbit.spi.QNodeDefinition createRootNodeDefinition(org.apache.jackrabbit.spi.SessionInfo sessionInfo)
          Create the root node definition.
protected  org.apache.jackrabbit.spi.SessionInfo createSessionInfo(Credentials credentials, String workspaceName)
          Creates a session info instance for the given credentials and workspaceName.
protected  org.apache.jackrabbit.spi.SessionInfo createSessionInfo(org.apache.jackrabbit.spi.SessionInfo sessionInfo, String workspaceName)
          Creates a session info instance for the given sessionInfo and workspaceName.
 org.apache.jackrabbit.spi.Subscription createSubscription(org.apache.jackrabbit.spi.SessionInfo sessionInfo, org.apache.jackrabbit.spi.EventFilter[] filters)
           
 void createWorkspace(org.apache.jackrabbit.spi.SessionInfo sessionInfo, String name, String srcWorkspaceName)
           
 void deleteWorkspace(org.apache.jackrabbit.spi.SessionInfo sessionInfo, String name)
           
 void dispose(org.apache.jackrabbit.spi.SessionInfo sessionInfo)
          This default implementation does nothing.
 void dispose(org.apache.jackrabbit.spi.Subscription subscription)
           
 org.apache.jackrabbit.spi.QueryInfo executeQuery(org.apache.jackrabbit.spi.SessionInfo sessionInfo, String statement, String language, Map<String,String> namespaces, long limit, long offset, Map<String,org.apache.jackrabbit.spi.QValue> values)
           
 org.apache.jackrabbit.spi.EventBundle getEvents(org.apache.jackrabbit.spi.SessionInfo sessionInfo, org.apache.jackrabbit.spi.EventFilter filter, long after)
           
 org.apache.jackrabbit.spi.EventBundle[] getEvents(org.apache.jackrabbit.spi.Subscription subscription, long timeout)
           
 org.apache.jackrabbit.spi.IdFactory getIdFactory()
           
 org.apache.jackrabbit.spi.LockInfo getLockInfo(org.apache.jackrabbit.spi.SessionInfo sessionInfo, org.apache.jackrabbit.spi.NodeId nodeId)
           
 org.apache.jackrabbit.spi.NameFactory getNameFactory()
           
 String getNamespacePrefix(org.apache.jackrabbit.spi.SessionInfo sessionInfo, String uri)
          This default implementation first calls checkSessionInfo(SessionInfo) with the sessionInfo, then return the namespace prefix for the given uri.
 String getNamespaceURI(org.apache.jackrabbit.spi.SessionInfo sessionInfo, String prefix)
          This default implementation first calls checkSessionInfo(SessionInfo) with the sessionInfo, then returns the namepsace URI for the given prefix.
 org.apache.jackrabbit.spi.QNodeDefinition getNodeDefinition(org.apache.jackrabbit.spi.SessionInfo sessionInfo, org.apache.jackrabbit.spi.NodeId nodeId)
          This default implementation first calls checkSessionInfo(SessionInfo) with the sessionInfo, then lazily initializes rootNodeDefinition if nodeId denotes the root node; otherwise throws a UnsupportedRepositoryOperationException.
 org.apache.jackrabbit.spi.PathFactory getPathFactory()
           
 org.apache.jackrabbit.spi.QPropertyDefinition getPropertyDefinition(org.apache.jackrabbit.spi.SessionInfo sessionInfo, org.apache.jackrabbit.spi.PropertyId propertyId)
           
 Iterator<org.apache.jackrabbit.spi.QNodeTypeDefinition> getQNodeTypeDefinitions(org.apache.jackrabbit.spi.SessionInfo sessionInfo)
          This default implementation first calls checkSessionInfo(SessionInfo) with the sessionInfo,
 Iterator<org.apache.jackrabbit.spi.QNodeTypeDefinition> getQNodeTypeDefinitions(org.apache.jackrabbit.spi.SessionInfo sessionInfo, org.apache.jackrabbit.spi.Name[] nodetypeNames)
          This default implementation first calls checkSessionInfo(SessionInfo) with the sessionInfo, then gathers the QNodeTypeDefinitions with the given nodetypeNames.
 org.apache.jackrabbit.spi.QValueFactory getQValueFactory()
           
 Map<String,String> getRegisteredNamespaces(org.apache.jackrabbit.spi.SessionInfo sessionInfo)
          This default implementation first calls checkSessionInfo(SessionInfo) with the sessionInfo, then returns the prefix to namespace URL mapping that was provided in the constructor of this repository service.
 Map<String,org.apache.jackrabbit.spi.QValue[]> getRepositoryDescriptors()
          This default implementation returns the descriptors that were passed to the constructor of this repository service.
 String[] getSupportedQueryLanguages(org.apache.jackrabbit.spi.SessionInfo sessionInfo)
           
 org.apache.jackrabbit.spi.SessionInfo impersonate(org.apache.jackrabbit.spi.SessionInfo sessionInfo, Credentials credentials)
          This default implementation returns the session info returned by the call to obtain(Credentials, String) with the workspaceName taken from the passed sessionInfo.
 void importXml(org.apache.jackrabbit.spi.SessionInfo sessionInfo, org.apache.jackrabbit.spi.NodeId parentId, InputStream xmlStream, int uuidBehaviour)
           
 org.apache.jackrabbit.spi.LockInfo lock(org.apache.jackrabbit.spi.SessionInfo sessionInfo, org.apache.jackrabbit.spi.NodeId nodeId, boolean deep, boolean sessionScoped)
           
 org.apache.jackrabbit.spi.LockInfo lock(org.apache.jackrabbit.spi.SessionInfo sessionInfo, org.apache.jackrabbit.spi.NodeId nodeId, boolean deep, boolean sessionScoped, long timeoutHint, String ownerHint)
           
 Iterator<org.apache.jackrabbit.spi.NodeId> merge(org.apache.jackrabbit.spi.SessionInfo sessionInfo, org.apache.jackrabbit.spi.NodeId nodeId, String srcWorkspaceName, boolean bestEffort)
           
 Iterator<org.apache.jackrabbit.spi.NodeId> merge(org.apache.jackrabbit.spi.SessionInfo sessionInfo, org.apache.jackrabbit.spi.NodeId nodeId, String srcWorkspaceName, boolean bestEffort, boolean isShallow)
           
 Iterator<org.apache.jackrabbit.spi.NodeId> mergeActivity(org.apache.jackrabbit.spi.SessionInfo sessionInfo, org.apache.jackrabbit.spi.NodeId activityId)
           
 void move(org.apache.jackrabbit.spi.SessionInfo sessionInfo, org.apache.jackrabbit.spi.NodeId srcNodeId, org.apache.jackrabbit.spi.NodeId destParentNodeId, org.apache.jackrabbit.spi.Name destName)
           
 org.apache.jackrabbit.spi.SessionInfo obtain(Credentials credentials, String workspaceName)
          This default implementation does: calls checkCredentials(Credentials, String) calls checkWorkspace(String) calls createSessionInfo(Credentials, String).
 org.apache.jackrabbit.spi.SessionInfo obtain(org.apache.jackrabbit.spi.SessionInfo sessionInfo, String workspaceName)
          This default implementation returns the session info returned by the call to createSessionInfo(SessionInfo, String).
 void refreshLock(org.apache.jackrabbit.spi.SessionInfo sessionInfo, org.apache.jackrabbit.spi.NodeId nodeId)
           
 void registerNamespace(org.apache.jackrabbit.spi.SessionInfo sessionInfo, String prefix, String uri)
           
 void registerNodeTypes(org.apache.jackrabbit.spi.SessionInfo sessionInfo, org.apache.jackrabbit.spi.QNodeTypeDefinition[] nodeTypeDefinitions, boolean allowUpdate)
           
 void removeActivity(org.apache.jackrabbit.spi.SessionInfo sessionInfo, org.apache.jackrabbit.spi.NodeId activityId)
           
 void removeVersion(org.apache.jackrabbit.spi.SessionInfo sessionInfo, org.apache.jackrabbit.spi.NodeId versionHistoryId, org.apache.jackrabbit.spi.NodeId versionId)
           
 void removeVersionLabel(org.apache.jackrabbit.spi.SessionInfo sessionInfo, org.apache.jackrabbit.spi.NodeId versionHistoryId, org.apache.jackrabbit.spi.NodeId versionId, org.apache.jackrabbit.spi.Name label)
           
 void resolveMergeConflict(org.apache.jackrabbit.spi.SessionInfo sessionInfo, org.apache.jackrabbit.spi.NodeId nodeId, org.apache.jackrabbit.spi.NodeId[] mergeFailedIds, org.apache.jackrabbit.spi.NodeId[] predecessorIds)
           
 void restore(org.apache.jackrabbit.spi.SessionInfo sessionInfo, org.apache.jackrabbit.spi.NodeId[] versionIds, boolean removeExisting)
           
 void restore(org.apache.jackrabbit.spi.SessionInfo sessionInfo, org.apache.jackrabbit.spi.NodeId nodeId, org.apache.jackrabbit.spi.NodeId versionId, boolean removeExisting)
           
 void submit(org.apache.jackrabbit.spi.Batch batch)
           
 void unlock(org.apache.jackrabbit.spi.SessionInfo sessionInfo, org.apache.jackrabbit.spi.NodeId nodeId)
           
 void unregisterNamespace(org.apache.jackrabbit.spi.SessionInfo sessionInfo, String uri)
           
 void unregisterNodeTypes(org.apache.jackrabbit.spi.SessionInfo sessionInfo, org.apache.jackrabbit.spi.Name[] nodeTypeNames)
           
 void update(org.apache.jackrabbit.spi.SessionInfo sessionInfo, org.apache.jackrabbit.spi.NodeId nodeId, String srcWorkspaceName)
           
 void updateEventFilters(org.apache.jackrabbit.spi.Subscription subscription, org.apache.jackrabbit.spi.EventFilter[] filters)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.jackrabbit.spi.RepositoryService
getChildInfos, getItemInfoCache, getItemInfos, getNodeInfo, getPropertyInfo, getReferences, getWorkspaceNames, isGranted
 

Field Detail

descriptors

protected final Map<String,org.apache.jackrabbit.spi.QValue[]> descriptors
The repository descriptors.


namespaces

protected final NamespaceMapping namespaces
The fixed set of namespaces known to the repository service.


nodeTypeDefs

protected final NodeTypeStorage nodeTypeDefs
The fixed set of node type definitions known to the repository service.


rootNodeDefinition

protected org.apache.jackrabbit.spi.QNodeDefinition rootNodeDefinition
The node definition of the root node.

Constructor Detail

AbstractRepositoryService

protected AbstractRepositoryService()
                             throws RepositoryException
Throws:
RepositoryException

AbstractRepositoryService

public AbstractRepositoryService(Map<String,org.apache.jackrabbit.spi.QValue[]> descriptors,
                                 Map<String,String> namespaces,
                                 org.apache.jackrabbit.spi.QNodeTypeDefinition[] nodeTypeDefs)
                          throws RepositoryException
Throws:
RepositoryException

AbstractRepositoryService

public AbstractRepositoryService(Map<String,org.apache.jackrabbit.spi.QValue[]> descriptors,
                                 Map<String,String> namespaces,
                                 Reader cnd)
                          throws RepositoryException
Throws:
RepositoryException
Method Detail

getIdFactory

public org.apache.jackrabbit.spi.IdFactory getIdFactory()
                                                 throws RepositoryException
Specified by:
getIdFactory in interface org.apache.jackrabbit.spi.RepositoryService
Returns:
IdFactoryImpl.getInstance().
Throws:
RepositoryException - if an error occurs.

getNameFactory

public org.apache.jackrabbit.spi.NameFactory getNameFactory()
                                                     throws RepositoryException
Specified by:
getNameFactory in interface org.apache.jackrabbit.spi.RepositoryService
Returns:
NameFactoryImpl.getInstance().
Throws:
RepositoryException - if an error occurs.

getPathFactory

public org.apache.jackrabbit.spi.PathFactory getPathFactory()
                                                     throws RepositoryException
Specified by:
getPathFactory in interface org.apache.jackrabbit.spi.RepositoryService
Returns:
PathFactoryImpl.getInstance().
Throws:
RepositoryException - if an error occurs.

getQValueFactory

public org.apache.jackrabbit.spi.QValueFactory getQValueFactory()
                                                         throws RepositoryException
Specified by:
getQValueFactory in interface org.apache.jackrabbit.spi.RepositoryService
Returns:
QValueFactoryImpl.getInstance().
Throws:
RepositoryException - if an error occurs.

createRootNodeDefinition

protected abstract org.apache.jackrabbit.spi.QNodeDefinition createRootNodeDefinition(org.apache.jackrabbit.spi.SessionInfo sessionInfo)
                                                                               throws RepositoryException
Create the root node definition.

Parameters:
sessionInfo - the session info.
Returns:
the root node definition for a workspace.
Throws:
RepositoryException - if an error occurs.

checkCredentials

protected void checkCredentials(Credentials credentials,
                                String workspaceName)
                         throws LoginException
Checks if the given credentials are valid. This default implementation is empty thus allowing all credentials.

Parameters:
credentials - the credentials to check.
workspaceName - the workspace to access.
Throws:
LoginException - if the credentials are invalid.

checkWorkspace

protected void checkWorkspace(String workspaceName)
                       throws NoSuchWorkspaceException
Checks if the given workspace is available. The default implementation is empty thus admitting every workspace name.

Parameters:
workspaceName - Name of the workspace to check
Throws:
NoSuchWorkspaceException - If workspaceName is not available.

createSessionInfo

protected org.apache.jackrabbit.spi.SessionInfo createSessionInfo(Credentials credentials,
                                                                  String workspaceName)
                                                           throws RepositoryException
Creates a session info instance for the given credentials and workspaceName. This default implementation creates a SessionInfoImpl instance and sets the userId and workspaceName. The user userId is null or the userId from credentials if it is of type SimpleCredentials.

Parameters:
credentials - the credentials.
workspaceName - the name of the workspace to access or null for the default workspace.
Returns:
a session info instance for the given credentials and workspaceName.
Throws:
RepositoryException

createSessionInfo

protected org.apache.jackrabbit.spi.SessionInfo createSessionInfo(org.apache.jackrabbit.spi.SessionInfo sessionInfo,
                                                                  String workspaceName)
                                                           throws RepositoryException
Creates a session info instance for the given sessionInfo and workspaceName. This default implementation creates a SessionInfoImpl instance and sets the userId and workspaceName. The user userId is set to the return value of SessionInfo.getUserID().

Parameters:
sessionInfo - the sessionInfo.
workspaceName - the name of the workspace to access.
Returns:
a session info instance for the given credentials and workspaceName.
Throws:
RepositoryException

checkSessionInfo

protected void checkSessionInfo(org.apache.jackrabbit.spi.SessionInfo sessionInfo)
                         throws RepositoryException
Checks the type of the sessionInfo instance. This default implementation checks if sessionInfo is of type SessionInfoImpl, otherwise throws a RepositoryException.

Parameters:
sessionInfo - the session info to check.
Throws:
RepositoryException - if the given sessionInfo is not of the required type for this repository service implementation.

getRepositoryDescriptors

public Map<String,org.apache.jackrabbit.spi.QValue[]> getRepositoryDescriptors()
                                                                        throws RepositoryException
This default implementation returns the descriptors that were passed to the constructor of this repository service.

Specified by:
getRepositoryDescriptors in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
RepositoryException

obtain

public org.apache.jackrabbit.spi.SessionInfo obtain(Credentials credentials,
                                                    String workspaceName)
                                             throws LoginException,
                                                    NoSuchWorkspaceException,
                                                    RepositoryException
This default implementation does:

Specified by:
obtain in interface org.apache.jackrabbit.spi.RepositoryService
Parameters:
credentials - the credentials for the login.
workspaceName - the name of the workspace to log in.
Returns:
the session info.
Throws:
LoginException - if the credentials are invalid.
NoSuchWorkspaceException - if workspaceName is unknown.
RepositoryException - if another error occurs.

obtain

public org.apache.jackrabbit.spi.SessionInfo obtain(org.apache.jackrabbit.spi.SessionInfo sessionInfo,
                                                    String workspaceName)
                                             throws LoginException,
                                                    NoSuchWorkspaceException,
                                                    RepositoryException
This default implementation returns the session info returned by the call to createSessionInfo(SessionInfo, String).

Specified by:
obtain in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
LoginException
NoSuchWorkspaceException
RepositoryException

impersonate

public org.apache.jackrabbit.spi.SessionInfo impersonate(org.apache.jackrabbit.spi.SessionInfo sessionInfo,
                                                         Credentials credentials)
                                                  throws LoginException,
                                                         RepositoryException
This default implementation returns the session info returned by the call to obtain(Credentials, String) with the workspaceName taken from the passed sessionInfo.

Specified by:
impersonate in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
LoginException
RepositoryException

dispose

public void dispose(org.apache.jackrabbit.spi.SessionInfo sessionInfo)
             throws RepositoryException
This default implementation does nothing.

Specified by:
dispose in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
RepositoryException

getQNodeTypeDefinitions

public Iterator<org.apache.jackrabbit.spi.QNodeTypeDefinition> getQNodeTypeDefinitions(org.apache.jackrabbit.spi.SessionInfo sessionInfo)
                                                                                throws RepositoryException
This default implementation first calls checkSessionInfo(SessionInfo) with the sessionInfo,

Specified by:
getQNodeTypeDefinitions in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
RepositoryException

getQNodeTypeDefinitions

public Iterator<org.apache.jackrabbit.spi.QNodeTypeDefinition> getQNodeTypeDefinitions(org.apache.jackrabbit.spi.SessionInfo sessionInfo,
                                                                                       org.apache.jackrabbit.spi.Name[] nodetypeNames)
                                                                                throws RepositoryException
This default implementation first calls checkSessionInfo(SessionInfo) with the sessionInfo, then gathers the QNodeTypeDefinitions with the given nodetypeNames. If one of the nodetypeNames is not a valid node type definition then a RepositoryException is thrown.

Specified by:
getQNodeTypeDefinitions in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
RepositoryException

getNodeDefinition

public org.apache.jackrabbit.spi.QNodeDefinition getNodeDefinition(org.apache.jackrabbit.spi.SessionInfo sessionInfo,
                                                                   org.apache.jackrabbit.spi.NodeId nodeId)
                                                            throws RepositoryException
This default implementation first calls checkSessionInfo(SessionInfo) with the sessionInfo, then lazily initializes rootNodeDefinition if nodeId denotes the root node; otherwise throws a UnsupportedRepositoryOperationException.

Specified by:
getNodeDefinition in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
RepositoryException

getPropertyDefinition

public org.apache.jackrabbit.spi.QPropertyDefinition getPropertyDefinition(org.apache.jackrabbit.spi.SessionInfo sessionInfo,
                                                                           org.apache.jackrabbit.spi.PropertyId propertyId)
                                                                    throws RepositoryException
Specified by:
getPropertyDefinition in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
UnsupportedRepositoryOperationException - always.
RepositoryException

registerNodeTypes

public void registerNodeTypes(org.apache.jackrabbit.spi.SessionInfo sessionInfo,
                              org.apache.jackrabbit.spi.QNodeTypeDefinition[] nodeTypeDefinitions,
                              boolean allowUpdate)
                       throws InvalidNodeTypeDefinitionException,
                              NodeTypeExistsException,
                              UnsupportedRepositoryOperationException,
                              RepositoryException
Specified by:
registerNodeTypes in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
UnsupportedRepositoryOperationException - always.
InvalidNodeTypeDefinitionException
NodeTypeExistsException
RepositoryException

unregisterNodeTypes

public void unregisterNodeTypes(org.apache.jackrabbit.spi.SessionInfo sessionInfo,
                                org.apache.jackrabbit.spi.Name[] nodeTypeNames)
                         throws UnsupportedRepositoryOperationException,
                                NoSuchNodeTypeException,
                                RepositoryException
Specified by:
unregisterNodeTypes in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
UnsupportedRepositoryOperationException - always.
NoSuchNodeTypeException
RepositoryException

getRegisteredNamespaces

public Map<String,String> getRegisteredNamespaces(org.apache.jackrabbit.spi.SessionInfo sessionInfo)
                                           throws RepositoryException
This default implementation first calls checkSessionInfo(SessionInfo) with the sessionInfo, then returns the prefix to namespace URL mapping that was provided in the constructor of this repository service.

Specified by:
getRegisteredNamespaces in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
RepositoryException

getNamespaceURI

public String getNamespaceURI(org.apache.jackrabbit.spi.SessionInfo sessionInfo,
                              String prefix)
                       throws NamespaceException,
                              RepositoryException
This default implementation first calls checkSessionInfo(SessionInfo) with the sessionInfo, then returns the namepsace URI for the given prefix.

Specified by:
getNamespaceURI in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
NamespaceException
RepositoryException

getNamespacePrefix

public String getNamespacePrefix(org.apache.jackrabbit.spi.SessionInfo sessionInfo,
                                 String uri)
                          throws NamespaceException,
                                 RepositoryException
This default implementation first calls checkSessionInfo(SessionInfo) with the sessionInfo, then return the namespace prefix for the given uri.

Specified by:
getNamespacePrefix in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
NamespaceException
RepositoryException

createBatch

public org.apache.jackrabbit.spi.Batch createBatch(org.apache.jackrabbit.spi.SessionInfo sessionInfo,
                                                   org.apache.jackrabbit.spi.ItemId itemId)
                                            throws RepositoryException
Specified by:
createBatch in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
UnsupportedRepositoryOperationException - always.
RepositoryException

submit

public void submit(org.apache.jackrabbit.spi.Batch batch)
            throws PathNotFoundException,
                   ItemNotFoundException,
                   NoSuchNodeTypeException,
                   ValueFormatException,
                   VersionException,
                   LockException,
                   ConstraintViolationException,
                   AccessDeniedException,
                   UnsupportedRepositoryOperationException,
                   RepositoryException
Specified by:
submit in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
UnsupportedRepositoryOperationException - always.
PathNotFoundException
ItemNotFoundException
NoSuchNodeTypeException
ValueFormatException
VersionException
LockException
ConstraintViolationException
AccessDeniedException
RepositoryException

importXml

public void importXml(org.apache.jackrabbit.spi.SessionInfo sessionInfo,
                      org.apache.jackrabbit.spi.NodeId parentId,
                      InputStream xmlStream,
                      int uuidBehaviour)
               throws ItemExistsException,
                      PathNotFoundException,
                      VersionException,
                      ConstraintViolationException,
                      LockException,
                      AccessDeniedException,
                      UnsupportedRepositoryOperationException,
                      RepositoryException
Specified by:
importXml in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
UnsupportedRepositoryOperationException - always.
ItemExistsException
PathNotFoundException
VersionException
ConstraintViolationException
LockException
AccessDeniedException
RepositoryException

move

public void move(org.apache.jackrabbit.spi.SessionInfo sessionInfo,
                 org.apache.jackrabbit.spi.NodeId srcNodeId,
                 org.apache.jackrabbit.spi.NodeId destParentNodeId,
                 org.apache.jackrabbit.spi.Name destName)
          throws ItemExistsException,
                 PathNotFoundException,
                 VersionException,
                 ConstraintViolationException,
                 LockException,
                 AccessDeniedException,
                 UnsupportedRepositoryOperationException,
                 RepositoryException
Specified by:
move in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
UnsupportedRepositoryOperationException - always.
ItemExistsException
PathNotFoundException
VersionException
ConstraintViolationException
LockException
AccessDeniedException
RepositoryException

copy

public void copy(org.apache.jackrabbit.spi.SessionInfo sessionInfo,
                 String srcWorkspaceName,
                 org.apache.jackrabbit.spi.NodeId srcNodeId,
                 org.apache.jackrabbit.spi.NodeId destParentNodeId,
                 org.apache.jackrabbit.spi.Name destName)
          throws NoSuchWorkspaceException,
                 ConstraintViolationException,
                 VersionException,
                 AccessDeniedException,
                 PathNotFoundException,
                 ItemExistsException,
                 LockException,
                 UnsupportedRepositoryOperationException,
                 RepositoryException
Specified by:
copy in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
UnsupportedRepositoryOperationException - always.
NoSuchWorkspaceException
ConstraintViolationException
VersionException
AccessDeniedException
PathNotFoundException
ItemExistsException
LockException
RepositoryException

update

public void update(org.apache.jackrabbit.spi.SessionInfo sessionInfo,
                   org.apache.jackrabbit.spi.NodeId nodeId,
                   String srcWorkspaceName)
            throws NoSuchWorkspaceException,
                   AccessDeniedException,
                   LockException,
                   InvalidItemStateException,
                   RepositoryException
Specified by:
update in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
UnsupportedRepositoryOperationException - always.
NoSuchWorkspaceException
AccessDeniedException
LockException
InvalidItemStateException
RepositoryException

clone

public void clone(org.apache.jackrabbit.spi.SessionInfo sessionInfo,
                  String srcWorkspaceName,
                  org.apache.jackrabbit.spi.NodeId srcNodeId,
                  org.apache.jackrabbit.spi.NodeId destParentNodeId,
                  org.apache.jackrabbit.spi.Name destName,
                  boolean removeExisting)
           throws NoSuchWorkspaceException,
                  ConstraintViolationException,
                  VersionException,
                  AccessDeniedException,
                  PathNotFoundException,
                  ItemExistsException,
                  LockException,
                  UnsupportedRepositoryOperationException,
                  RepositoryException
Specified by:
clone in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
UnsupportedRepositoryOperationException - always.
NoSuchWorkspaceException
ConstraintViolationException
VersionException
AccessDeniedException
PathNotFoundException
ItemExistsException
LockException
RepositoryException

lock

public org.apache.jackrabbit.spi.LockInfo lock(org.apache.jackrabbit.spi.SessionInfo sessionInfo,
                                               org.apache.jackrabbit.spi.NodeId nodeId,
                                               boolean deep,
                                               boolean sessionScoped)
                                        throws UnsupportedRepositoryOperationException,
                                               LockException,
                                               AccessDeniedException,
                                               RepositoryException
Specified by:
lock in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
UnsupportedRepositoryOperationException - always.
LockException
AccessDeniedException
RepositoryException

lock

public org.apache.jackrabbit.spi.LockInfo lock(org.apache.jackrabbit.spi.SessionInfo sessionInfo,
                                               org.apache.jackrabbit.spi.NodeId nodeId,
                                               boolean deep,
                                               boolean sessionScoped,
                                               long timeoutHint,
                                               String ownerHint)
                                        throws UnsupportedRepositoryOperationException,
                                               LockException,
                                               AccessDeniedException,
                                               RepositoryException
Specified by:
lock in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
UnsupportedRepositoryOperationException - always.
LockException
AccessDeniedException
RepositoryException

getLockInfo

public org.apache.jackrabbit.spi.LockInfo getLockInfo(org.apache.jackrabbit.spi.SessionInfo sessionInfo,
                                                      org.apache.jackrabbit.spi.NodeId nodeId)
                                               throws AccessDeniedException,
                                                      RepositoryException
Specified by:
getLockInfo in interface org.apache.jackrabbit.spi.RepositoryService
Returns:
null.
Throws:
AccessDeniedException
RepositoryException

refreshLock

public void refreshLock(org.apache.jackrabbit.spi.SessionInfo sessionInfo,
                        org.apache.jackrabbit.spi.NodeId nodeId)
                 throws UnsupportedRepositoryOperationException,
                        LockException,
                        AccessDeniedException,
                        RepositoryException
Specified by:
refreshLock in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
UnsupportedRepositoryOperationException - always.
LockException
AccessDeniedException
RepositoryException

unlock

public void unlock(org.apache.jackrabbit.spi.SessionInfo sessionInfo,
                   org.apache.jackrabbit.spi.NodeId nodeId)
            throws UnsupportedRepositoryOperationException,
                   LockException,
                   AccessDeniedException,
                   RepositoryException
Specified by:
unlock in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
UnsupportedRepositoryOperationException - always.
LockException
AccessDeniedException
RepositoryException

checkin

public org.apache.jackrabbit.spi.NodeId checkin(org.apache.jackrabbit.spi.SessionInfo sessionInfo,
                                                org.apache.jackrabbit.spi.NodeId nodeId)
                                         throws VersionException,
                                                UnsupportedRepositoryOperationException,
                                                InvalidItemStateException,
                                                LockException,
                                                RepositoryException
Specified by:
checkin in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
UnsupportedRepositoryOperationException - always.
VersionException
InvalidItemStateException
LockException
RepositoryException

checkout

public void checkout(org.apache.jackrabbit.spi.SessionInfo sessionInfo,
                     org.apache.jackrabbit.spi.NodeId nodeId)
              throws UnsupportedRepositoryOperationException,
                     LockException,
                     RepositoryException
Specified by:
checkout in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
UnsupportedRepositoryOperationException - always.
LockException
RepositoryException

checkout

public void checkout(org.apache.jackrabbit.spi.SessionInfo sessionInfo,
                     org.apache.jackrabbit.spi.NodeId nodeId,
                     org.apache.jackrabbit.spi.NodeId activityId)
              throws UnsupportedRepositoryOperationException,
                     LockException,
                     RepositoryException
Specified by:
checkout in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
UnsupportedRepositoryOperationException - always.
LockException
RepositoryException

checkpoint

public org.apache.jackrabbit.spi.NodeId checkpoint(org.apache.jackrabbit.spi.SessionInfo sessionInfo,
                                                   org.apache.jackrabbit.spi.NodeId nodeId)
                                            throws UnsupportedRepositoryOperationException,
                                                   LockException,
                                                   RepositoryException
Specified by:
checkpoint in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
UnsupportedRepositoryOperationException - always.
LockException
RepositoryException

checkpoint

public org.apache.jackrabbit.spi.NodeId checkpoint(org.apache.jackrabbit.spi.SessionInfo sessionInfo,
                                                   org.apache.jackrabbit.spi.NodeId nodeId,
                                                   org.apache.jackrabbit.spi.NodeId activityId)
                                            throws UnsupportedRepositoryOperationException,
                                                   LockException,
                                                   RepositoryException
Specified by:
checkpoint in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
UnsupportedRepositoryOperationException - always.
LockException
RepositoryException

removeVersion

public void removeVersion(org.apache.jackrabbit.spi.SessionInfo sessionInfo,
                          org.apache.jackrabbit.spi.NodeId versionHistoryId,
                          org.apache.jackrabbit.spi.NodeId versionId)
                   throws ReferentialIntegrityException,
                          AccessDeniedException,
                          UnsupportedRepositoryOperationException,
                          VersionException,
                          RepositoryException
Specified by:
removeVersion in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
UnsupportedRepositoryOperationException - always.
ReferentialIntegrityException
AccessDeniedException
VersionException
RepositoryException

restore

public void restore(org.apache.jackrabbit.spi.SessionInfo sessionInfo,
                    org.apache.jackrabbit.spi.NodeId nodeId,
                    org.apache.jackrabbit.spi.NodeId versionId,
                    boolean removeExisting)
             throws VersionException,
                    PathNotFoundException,
                    ItemExistsException,
                    UnsupportedRepositoryOperationException,
                    LockException,
                    InvalidItemStateException,
                    RepositoryException
Specified by:
restore in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
UnsupportedRepositoryOperationException - always.
VersionException
PathNotFoundException
ItemExistsException
LockException
InvalidItemStateException
RepositoryException

restore

public void restore(org.apache.jackrabbit.spi.SessionInfo sessionInfo,
                    org.apache.jackrabbit.spi.NodeId[] versionIds,
                    boolean removeExisting)
             throws ItemExistsException,
                    UnsupportedRepositoryOperationException,
                    VersionException,
                    LockException,
                    InvalidItemStateException,
                    RepositoryException
Specified by:
restore in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
UnsupportedRepositoryOperationException - always.
ItemExistsException
VersionException
LockException
InvalidItemStateException
RepositoryException

merge

public Iterator<org.apache.jackrabbit.spi.NodeId> merge(org.apache.jackrabbit.spi.SessionInfo sessionInfo,
                                                        org.apache.jackrabbit.spi.NodeId nodeId,
                                                        String srcWorkspaceName,
                                                        boolean bestEffort)
                                                 throws NoSuchWorkspaceException,
                                                        AccessDeniedException,
                                                        MergeException,
                                                        LockException,
                                                        InvalidItemStateException,
                                                        RepositoryException
Specified by:
merge in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
UnsupportedRepositoryOperationException - always.
NoSuchWorkspaceException
AccessDeniedException
MergeException
LockException
InvalidItemStateException
RepositoryException

merge

public Iterator<org.apache.jackrabbit.spi.NodeId> merge(org.apache.jackrabbit.spi.SessionInfo sessionInfo,
                                                        org.apache.jackrabbit.spi.NodeId nodeId,
                                                        String srcWorkspaceName,
                                                        boolean bestEffort,
                                                        boolean isShallow)
                                                 throws NoSuchWorkspaceException,
                                                        AccessDeniedException,
                                                        MergeException,
                                                        LockException,
                                                        InvalidItemStateException,
                                                        RepositoryException
Specified by:
merge in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
UnsupportedRepositoryOperationException - always.
NoSuchWorkspaceException
AccessDeniedException
MergeException
LockException
InvalidItemStateException
RepositoryException

resolveMergeConflict

public void resolveMergeConflict(org.apache.jackrabbit.spi.SessionInfo sessionInfo,
                                 org.apache.jackrabbit.spi.NodeId nodeId,
                                 org.apache.jackrabbit.spi.NodeId[] mergeFailedIds,
                                 org.apache.jackrabbit.spi.NodeId[] predecessorIds)
                          throws VersionException,
                                 InvalidItemStateException,
                                 UnsupportedRepositoryOperationException,
                                 RepositoryException
Specified by:
resolveMergeConflict in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
UnsupportedRepositoryOperationException - always.
VersionException
InvalidItemStateException
RepositoryException

addVersionLabel

public void addVersionLabel(org.apache.jackrabbit.spi.SessionInfo sessionInfo,
                            org.apache.jackrabbit.spi.NodeId versionHistoryId,
                            org.apache.jackrabbit.spi.NodeId versionId,
                            org.apache.jackrabbit.spi.Name label,
                            boolean moveLabel)
                     throws VersionException,
                            RepositoryException
Specified by:
addVersionLabel in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
UnsupportedRepositoryOperationException - always.
VersionException
RepositoryException

removeVersionLabel

public void removeVersionLabel(org.apache.jackrabbit.spi.SessionInfo sessionInfo,
                               org.apache.jackrabbit.spi.NodeId versionHistoryId,
                               org.apache.jackrabbit.spi.NodeId versionId,
                               org.apache.jackrabbit.spi.Name label)
                        throws VersionException,
                               RepositoryException
Specified by:
removeVersionLabel in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
UnsupportedRepositoryOperationException - always.
VersionException
RepositoryException

createActivity

public org.apache.jackrabbit.spi.NodeId createActivity(org.apache.jackrabbit.spi.SessionInfo sessionInfo,
                                                       String title)
                                                throws UnsupportedRepositoryOperationException,
                                                       RepositoryException
Specified by:
createActivity in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
UnsupportedRepositoryOperationException - always.
RepositoryException

removeActivity

public void removeActivity(org.apache.jackrabbit.spi.SessionInfo sessionInfo,
                           org.apache.jackrabbit.spi.NodeId activityId)
                    throws UnsupportedRepositoryOperationException,
                           RepositoryException
Specified by:
removeActivity in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
UnsupportedRepositoryOperationException - always.
RepositoryException

mergeActivity

public Iterator<org.apache.jackrabbit.spi.NodeId> mergeActivity(org.apache.jackrabbit.spi.SessionInfo sessionInfo,
                                                                org.apache.jackrabbit.spi.NodeId activityId)
                                                         throws UnsupportedRepositoryOperationException,
                                                                RepositoryException
Specified by:
mergeActivity in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
UnsupportedRepositoryOperationException - always.
RepositoryException

createConfiguration

public org.apache.jackrabbit.spi.NodeId createConfiguration(org.apache.jackrabbit.spi.SessionInfo sessionInfo,
                                                            org.apache.jackrabbit.spi.NodeId nodeId)
                                                     throws UnsupportedRepositoryOperationException,
                                                            RepositoryException
Specified by:
createConfiguration in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
UnsupportedRepositoryOperationException - always.
RepositoryException

createEventFilter

public org.apache.jackrabbit.spi.EventFilter createEventFilter(org.apache.jackrabbit.spi.SessionInfo sessionInfo,
                                                               int eventTypes,
                                                               org.apache.jackrabbit.spi.Path absPath,
                                                               boolean isDeep,
                                                               String[] uuid,
                                                               org.apache.jackrabbit.spi.Name[] nodeTypeName,
                                                               boolean noLocal)
                                                        throws UnsupportedRepositoryOperationException,
                                                               RepositoryException
Specified by:
createEventFilter in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
UnsupportedRepositoryOperationException - always.
RepositoryException

createSubscription

public org.apache.jackrabbit.spi.Subscription createSubscription(org.apache.jackrabbit.spi.SessionInfo sessionInfo,
                                                                 org.apache.jackrabbit.spi.EventFilter[] filters)
                                                          throws UnsupportedRepositoryOperationException,
                                                                 RepositoryException
Specified by:
createSubscription in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
UnsupportedRepositoryOperationException - always.
RepositoryException

updateEventFilters

public void updateEventFilters(org.apache.jackrabbit.spi.Subscription subscription,
                               org.apache.jackrabbit.spi.EventFilter[] filters)
                        throws RepositoryException
Specified by:
updateEventFilters in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
UnsupportedRepositoryOperationException - always.
RepositoryException

getEvents

public org.apache.jackrabbit.spi.EventBundle[] getEvents(org.apache.jackrabbit.spi.Subscription subscription,
                                                         long timeout)
                                                  throws RepositoryException,
                                                         InterruptedException
Specified by:
getEvents in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
UnsupportedRepositoryOperationException - always.
RepositoryException
InterruptedException

getEvents

public org.apache.jackrabbit.spi.EventBundle getEvents(org.apache.jackrabbit.spi.SessionInfo sessionInfo,
                                                       org.apache.jackrabbit.spi.EventFilter filter,
                                                       long after)
                                                throws RepositoryException,
                                                       UnsupportedRepositoryOperationException
Specified by:
getEvents in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
UnsupportedRepositoryOperationException - always.
RepositoryException

dispose

public void dispose(org.apache.jackrabbit.spi.Subscription subscription)
             throws RepositoryException
Specified by:
dispose in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
UnsupportedRepositoryOperationException - always.
RepositoryException

registerNamespace

public void registerNamespace(org.apache.jackrabbit.spi.SessionInfo sessionInfo,
                              String prefix,
                              String uri)
                       throws NamespaceException,
                              UnsupportedRepositoryOperationException,
                              AccessDeniedException,
                              RepositoryException
Specified by:
registerNamespace in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
UnsupportedRepositoryOperationException - always.
NamespaceException
AccessDeniedException
RepositoryException

unregisterNamespace

public void unregisterNamespace(org.apache.jackrabbit.spi.SessionInfo sessionInfo,
                                String uri)
                         throws NamespaceException,
                                UnsupportedRepositoryOperationException,
                                AccessDeniedException,
                                RepositoryException
Specified by:
unregisterNamespace in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
UnsupportedRepositoryOperationException - always.
NamespaceException
AccessDeniedException
RepositoryException

createWorkspace

public void createWorkspace(org.apache.jackrabbit.spi.SessionInfo sessionInfo,
                            String name,
                            String srcWorkspaceName)
                     throws AccessDeniedException,
                            UnsupportedRepositoryOperationException,
                            NoSuchWorkspaceException,
                            RepositoryException
Specified by:
createWorkspace in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
UnsupportedRepositoryOperationException - always.
AccessDeniedException
NoSuchWorkspaceException
RepositoryException

deleteWorkspace

public void deleteWorkspace(org.apache.jackrabbit.spi.SessionInfo sessionInfo,
                            String name)
                     throws AccessDeniedException,
                            UnsupportedRepositoryOperationException,
                            NoSuchWorkspaceException,
                            RepositoryException
Specified by:
deleteWorkspace in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
UnsupportedRepositoryOperationException - always.
AccessDeniedException
NoSuchWorkspaceException
RepositoryException

getSupportedQueryLanguages

public String[] getSupportedQueryLanguages(org.apache.jackrabbit.spi.SessionInfo sessionInfo)
                                    throws RepositoryException
Specified by:
getSupportedQueryLanguages in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
RepositoryException

checkQueryStatement

public String[] checkQueryStatement(org.apache.jackrabbit.spi.SessionInfo sessionInfo,
                                    String statement,
                                    String language,
                                    Map<String,String> namespaces)
                             throws InvalidQueryException,
                                    RepositoryException
Specified by:
checkQueryStatement in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
InvalidQueryException
RepositoryException

executeQuery

public org.apache.jackrabbit.spi.QueryInfo executeQuery(org.apache.jackrabbit.spi.SessionInfo sessionInfo,
                                                        String statement,
                                                        String language,
                                                        Map<String,String> namespaces,
                                                        long limit,
                                                        long offset,
                                                        Map<String,org.apache.jackrabbit.spi.QValue> values)
                                                 throws RepositoryException
Specified by:
executeQuery in interface org.apache.jackrabbit.spi.RepositoryService
Throws:
RepositoryException


Copyright © 2004-2011 The Apache Software Foundation. All Rights Reserved.