com.openkm.module.jcr

Class JcrRepositoryModule

java.lang.Object

com.openkm.module.jcr.JcrRepositoryModule

All Implemented Interfaces:

RepositoryModule

public class JcrRepositoryModule
extends Object
implements RepositoryModule

Constructor Summary

Constructors

Constructor and Description
JcrRepositoryModule()

Method Summary

Methods

Modifier and Type	Method and Description
static String	create(javax.jcr.Session session) Create OpenKM repository structure
AppVersion	getAppVersion(String token) Retrieve application version.
Folder	getCategoriesFolder(String token) Obtain the categories folder of the repository.
Folder	getMailFolder(String token) Obtain the personal mails folder of the repository.
Folder	getMailFolderBase(String token)
String	getNodePath(String token, String uuid) Obtain the node path with a given uuid.
String	getNodeUuid(String token, String path) Obtain the node uuid with a given path.
Folder	getPersonalFolder(String token) Obtain the personal documents folder of the repository.
Folder	getPersonalFolderBase(String token)
static javax.jcr.Repository	getRepository() Cache the repository information
static org.apache.jackrabbit.core.config.RepositoryConfig	getRepositoryConfig() Obtain repository configuration
String	getRepositoryUuid(String token) Get the unique repository identifier
Folder	getRootFolder(String token) Obtain the root folder of the repository.
static javax.jcr.Session	getSystemSession() Get the System User Session to perform unsecured operations.
Folder	getTemplatesFolder(String token) Obtain the template folder of the repository.
Folder	getThesaurusFolder(String token) Obtain the thesaurus folder of the repository.
Folder	getTrashFolder(String token) Obtains the user trash folder.
Folder	getTrashFolderBase(String token)
String	getUpdateMessage(String token) Get the update message, if any.
boolean	hasNode(String token, String path) Test if a node path exists
static String	initialize() Initialize the repository.
void	purgeTrash(String token) Remove all the items in the user trash folder for ever.
static void	registerCustomNodeTypes(javax.jcr.Session session, InputStream cndFile) Register custom node definition from file.
void	remove() Remove a repository from disk.
static void	shutdown() Close repository and free the lock

Methods inherited from class java.lang.Object

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

Constructor Detail

JcrRepositoryModule

public JcrRepositoryModule()

Method Detail

getRepository

public static javax.jcr.Repository getRepository()
                                          throws javax.jcr.RepositoryException

Cache the repository information

Returns:

The actual repository.

Throws:

javax.jcr.RepositoryException

getRepositoryConfig

public static org.apache.jackrabbit.core.config.RepositoryConfig getRepositoryConfig()
                                                                              throws org.apache.jackrabbit.core.config.ConfigurationException

Obtain repository configuration

Throws:

org.apache.jackrabbit.core.config.ConfigurationException

shutdown

public static void shutdown()

Close repository and free the lock

getSystemSession

public static javax.jcr.Session getSystemSession()

Get the System User Session to perform unsecured operations.

Returns:

The System User Session.

initialize

public static String initialize()
                         throws javax.jcr.RepositoryException,
                                FileNotFoundException,
                                org.apache.jackrabbit.core.nodetype.InvalidNodeTypeDefException,
                                org.apache.jackrabbit.core.nodetype.compact.ParseException,
                                DatabaseException

Initialize the repository.

Returns:

The root path of the initialized repository.

Throws:

AccessDeniedException - If there is any security problem: you can't access the parent document folder because of lack of permissions.

RepositoryException - If there is any general repository problem.

javax.jcr.RepositoryException

FileNotFoundException

org.apache.jackrabbit.core.nodetype.InvalidNodeTypeDefException

org.apache.jackrabbit.core.nodetype.compact.ParseException

DatabaseException

create

public static String create(javax.jcr.Session session)
                     throws javax.jcr.RepositoryException,
                            FileNotFoundException,
                            org.apache.jackrabbit.core.nodetype.InvalidNodeTypeDefException,
                            org.apache.jackrabbit.core.nodetype.compact.ParseException

Create OpenKM repository structure

Throws:

javax.jcr.RepositoryException

FileNotFoundException

org.apache.jackrabbit.core.nodetype.InvalidNodeTypeDefException

org.apache.jackrabbit.core.nodetype.compact.ParseException

remove

public void remove()
            throws RepositoryException

Remove a repository from disk.

Throws:

AccessDeniedException - If there is any security problem: you can't access the parent document folder because of lack of permissions.

RepositoryException - If there is any general repository problem.

getRootFolder

public Folder getRootFolder(String token)
                     throws PathNotFoundException,
                            RepositoryException,
                            DatabaseException

Description copied from interface: RepositoryModule

Obtain the root folder of the repository.

Specified by:

getRootFolder in interface RepositoryModule

Returns:

A folder object with the repository root node properties.

Throws:

PathNotFoundException - If there is no root folder node in the repository.

RepositoryException - If there is any general repository problem.

DatabaseException

getTrashFolder

public Folder getTrashFolder(String token)
                      throws PathNotFoundException,
                             RepositoryException,
                             DatabaseException

Description copied from interface: RepositoryModule

Obtains the user trash folder.

Specified by:

getTrashFolder in interface RepositoryModule

Returns:

A folder object with the user trash node properties.

Throws:

PathNotFoundException - If there is no user trash folder node in the repository.

RepositoryException - If there is any general repository problem.

DatabaseException

getTrashFolderBase

public Folder getTrashFolderBase(String token)
                          throws PathNotFoundException,
                                 RepositoryException,
                                 DatabaseException

Specified by:

getTrashFolderBase in interface RepositoryModule

Throws:

PathNotFoundException

RepositoryException

DatabaseException

getTemplatesFolder

public Folder getTemplatesFolder(String token)
                          throws PathNotFoundException,
                                 RepositoryException,
                                 DatabaseException

Description copied from interface: RepositoryModule

Obtain the template folder of the repository.

Specified by:

getTemplatesFolder in interface RepositoryModule

Returns:

A folder object with the templates node properties.

Throws:

PathNotFoundException - If there is no templates folder node in the repository.

RepositoryException - If there is any general repository problem.

DatabaseException

getPersonalFolder

public Folder getPersonalFolder(String token)
                         throws PathNotFoundException,
                                RepositoryException,
                                DatabaseException

Description copied from interface: RepositoryModule

Obtain the personal documents folder of the repository.

Specified by:

getPersonalFolder in interface RepositoryModule

Returns:

A folder object with the user documents folder node properties.

Throws:

PathNotFoundException - If there is no user documents folder node in the repository.

RepositoryException - If there is any general repository problem.

DatabaseException

getPersonalFolderBase

public Folder getPersonalFolderBase(String token)
                             throws PathNotFoundException,
                                    RepositoryException,
                                    DatabaseException

Specified by:

getPersonalFolderBase in interface RepositoryModule

Throws:

PathNotFoundException

RepositoryException

DatabaseException

getMailFolder

public Folder getMailFolder(String token)
                     throws PathNotFoundException,
                            RepositoryException,
                            DatabaseException

Description copied from interface: RepositoryModule

Obtain the personal mails folder of the repository.

Specified by:

getMailFolder in interface RepositoryModule

Returns:

A folder object with the user mails folder node properties.

Throws:

PathNotFoundException - If there is no user documents folder node in the repository.

RepositoryException - If there is any general repository problem.

DatabaseException

getMailFolderBase

public Folder getMailFolderBase(String token)
                         throws PathNotFoundException,
                                RepositoryException,
                                DatabaseException

Specified by:

getMailFolderBase in interface RepositoryModule

Throws:

PathNotFoundException

RepositoryException

DatabaseException

getThesaurusFolder

public Folder getThesaurusFolder(String token)
                          throws PathNotFoundException,
                                 RepositoryException,
                                 DatabaseException

Description copied from interface: RepositoryModule

Obtain the thesaurus folder of the repository.

Specified by:

getThesaurusFolder in interface RepositoryModule

Returns:

A folder object with the thesaurus folder node properties.

Throws:

PathNotFoundException - If there is no user documents folder node in the repository.

RepositoryException - If there is any general repository problem.

DatabaseException

getCategoriesFolder

public Folder getCategoriesFolder(String token)
                           throws PathNotFoundException,
                                  RepositoryException,
                                  DatabaseException

Description copied from interface: RepositoryModule

Obtain the categories folder of the repository.

Specified by:

getCategoriesFolder in interface RepositoryModule

Returns:

A folder object with the categories folder node properties.

Throws:

PathNotFoundException - If there is no user documents folder node in the repository.

RepositoryException - If there is any general repository problem.

DatabaseException

registerCustomNodeTypes

public static void registerCustomNodeTypes(javax.jcr.Session session,
                           InputStream cndFile)
                                    throws FileNotFoundException,
                                           org.apache.jackrabbit.core.nodetype.compact.ParseException,
                                           javax.jcr.RepositoryException,
                                           org.apache.jackrabbit.core.nodetype.InvalidNodeTypeDefException

Register custom node definition from file. TODO For Jackrabbit 2.0 should be done as: InputStream is = getClass().getClassLoader().getResourceAsStream("test.cnd"); Reader cnd = new InputStreamReader(is); NodeType[] nodeTypes = CndImporter.registerNodeTypes(cnd, session); The key method is: CndImporter.registerNodeTypes("cndfile", session);

Throws:

FileNotFoundException

org.apache.jackrabbit.core.nodetype.compact.ParseException

javax.jcr.RepositoryException

org.apache.jackrabbit.core.nodetype.InvalidNodeTypeDefException

purgeTrash

public void purgeTrash(String token)
                throws AccessDeniedException,
                       RepositoryException,
                       DatabaseException

Description copied from interface: RepositoryModule

Remove all the items in the user trash folder for ever. You can't recover this items any more.

Specified by:

purgeTrash in interface RepositoryModule

Throws:

AccessDeniedException - If there is any security problem: you can't modify the user deleted folders and documents because of lack of permissions.

RepositoryException - If there is any general repository problem.

DatabaseException

getUpdateMessage

public String getUpdateMessage(String token)
                        throws RepositoryException

Description copied from interface: RepositoryModule

Get the update message, if any.

Specified by:

getUpdateMessage in interface RepositoryModule

Returns:

A possible update message or simple info for the application.

Throws:

RepositoryException - If there is any general repository problem.

getRepositoryUuid

public String getRepositoryUuid(String token)
                         throws RepositoryException

Description copied from interface: RepositoryModule

Get the unique repository identifier

Specified by:

getRepositoryUuid in interface RepositoryModule

Returns:

The repository UUID

Throws:

RepositoryException - If there is any general repository problem.

hasNode

public boolean hasNode(String token,
              String path)
                throws RepositoryException,
                       DatabaseException

Description copied from interface: RepositoryModule

Test if a node path exists

Specified by:

hasNode in interface RepositoryModule

path - The node path to test

Returns:

true if the node exist or false if not

Throws:

RepositoryException - If there is any general repository problem.

DatabaseException

getNodePath

public String getNodePath(String token,
                 String uuid)
                   throws PathNotFoundException,
                          RepositoryException,
                          DatabaseException

Description copied from interface: RepositoryModule

Obtain the node path with a given uuid.

Specified by:

getNodePath in interface RepositoryModule

uuid - An unique node identifier

Returns:

The path of the node with the given uuid

Throws:

PathNotFoundException - If there is no user node in the repository with this uuid.

RepositoryException - If there is any general repository problem.

DatabaseException

getNodeUuid

public String getNodeUuid(String token,
                 String path)
                   throws PathNotFoundException,
                          RepositoryException,
                          DatabaseException

Description copied from interface: RepositoryModule

Obtain the node uuid with a given path.

Specified by:

getNodeUuid in interface RepositoryModule

path - An unique path node identifier

Returns:

The path of the node with the given uuid

Throws:

PathNotFoundException - If there is no user node in the repository with this uuid.

RepositoryException - If there is any general repository problem.

DatabaseException

getAppVersion

public AppVersion getAppVersion(String token)
                         throws RepositoryException,
                                DatabaseException

Description copied from interface: RepositoryModule

Retrieve application version.

Specified by:

getAppVersion in interface RepositoryModule

Parameters:

token - Security token.

Returns:

Application version.

Throws:

RepositoryException

DatabaseException