org.exoplatform.services.jcr

Interface RepositoryService

public interface RepositoryService

Created by The eXo Platform SAS
The repository service interface

Version:

$Id: RepositoryService.java 11907 2008-03-13 15:36:21Z ksm $

Author:

Gennady Azarenkov, Benjamin Mestrallet

Level API:

Provisional

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRemoveRepository(String repositoryName) Indicates if repository with name repositoryName can be removed.
void	createRepository(RepositoryEntry repositoryEntry) Create new repository .
RepositoryServiceConfiguration	getConfig() Get repository service configuration.
ManageableRepository	getCurrentRepository() Get current repository.
ManageableRepository	getDefaultRepository() Get default repository.
ManageableRepository	getRepository(String name) Get repository by name.
void	removeRepository(String repositoryName) Remove repository with name repositoryName.
void	removeRepository(String repositoryName, boolean forceRemove) Remove repository with name repositoryName.
void	setCurrentRepositoryName(String repositoryName) Set current repository name.

Method Detail

getDefaultRepository

ManageableRepository getDefaultRepository()
                                          throws javax.jcr.RepositoryException,
                                                 org.exoplatform.services.jcr.config.RepositoryConfigurationException

Get default repository.

Returns:

default repository

Throws:

javax.jcr.RepositoryException

org.exoplatform.services.jcr.config.RepositoryConfigurationException

getRepository

ManageableRepository getRepository(String name)
                                   throws javax.jcr.RepositoryException,
                                          org.exoplatform.services.jcr.config.RepositoryConfigurationException

Get repository by name.

Parameters:

name - repository name

Returns:

repository by name

Throws:

javax.jcr.RepositoryException

org.exoplatform.services.jcr.config.RepositoryConfigurationException

getCurrentRepository

ManageableRepository getCurrentRepository()
                                          throws javax.jcr.RepositoryException

Get current repository.

Returns:

ManagableRepository

Throws:

javax.jcr.RepositoryException

org.exoplatform.services.jcr.config.RepositoryConfigurationException

setCurrentRepositoryName

void setCurrentRepositoryName(String repositoryName)
                              throws org.exoplatform.services.jcr.config.RepositoryConfigurationException

Set current repository name.

Parameters:

repositoryName - repository name

Throws:

org.exoplatform.services.jcr.config.RepositoryConfigurationException

getConfig

RepositoryServiceConfiguration getConfig()

Get repository service configuration.

Returns:

RepositoryServiceConfiguration

createRepository

void createRepository(RepositoryEntry repositoryEntry)
                      throws org.exoplatform.services.jcr.config.RepositoryConfigurationException,
                             javax.jcr.RepositoryException

Create new repository .

Parameters:

repositoryEntry - repository entry

Throws:

org.exoplatform.services.jcr.config.RepositoryConfigurationException

javax.jcr.RepositoryException

removeRepository

void removeRepository(String repositoryName)
                      throws javax.jcr.RepositoryException

Remove repository with name repositoryName.

Parameters:

repositoryName - repository name

Throws:

javax.jcr.RepositoryException

removeRepository

void removeRepository(String repositoryName,
                    boolean forceRemove)
                      throws javax.jcr.RepositoryException

Remove repository with name repositoryName.

Parameters:

repositoryName - repository name

forceRemove - will be closed without checking opened session on repository.

Throws:

javax.jcr.RepositoryException

canRemoveRepository

boolean canRemoveRepository(String repositoryName)
                            throws javax.jcr.RepositoryException

Indicates if repository with name repositoryName can be removed.

Parameters:

repositoryName - repository name

Returns:

boolean

Throws:

javax.jcr.RepositoryException