org.exoplatform.services.jcr.core

Interface ManageableRepository

All Superinterfaces:

javax.jcr.Repository

public interface ManageableRepository
extends javax.jcr.Repository

Created by The eXo Platform SAS
This interface provides advanced methods that are not part of the Repository Interface defined in the specification JSR-170.

Version:

$Id: ManageableRepository.java 13931 2008-05-06 12:10:00Z pnedonosko $

Author:

Gennady Azarenkov

Level API:

Experimental

Field Summary

Fields

Modifier and Type	Field and Description
static int	OFFLINE Repository OFFLINE status.
static int	ONLINE Repository ONLINE status.
static int	SUSPENDED Repository SUSPENDED status.
static int	UNDEFINED Repository UNDEFINED status.

Fields inherited from interface javax.jcr.Repository

LEVEL_1_SUPPORTED, LEVEL_2_SUPPORTED, OPTION_LOCKING_SUPPORTED, OPTION_OBSERVATION_SUPPORTED, OPTION_QUERY_SQL_SUPPORTED, OPTION_TRANSACTIONS_SUPPORTED, OPTION_VERSIONING_SUPPORTED, QUERY_XPATH_DOC_ORDER, QUERY_XPATH_POS_INDEX, REP_NAME_DESC, REP_VENDOR_DESC, REP_VENDOR_URL_DESC, REP_VERSION_DESC, SPEC_NAME_DESC, SPEC_VERSION_DESC

Method Summary

Methods

Modifier and Type	Method and Description
void	addItemPersistenceListener(String workspaceName, ItemsPersistenceListener listener) Add the items persistence listener to the named workspace.
boolean	canRemoveWorkspace(String workspaceName) Indicates if workspace with name workspaceName can be removed.
void	configWorkspace(WorkspaceEntry wsConfig) Add new workspace configuration.
void	createWorkspace(String workspaceName) Create new workspace with name workspaceName.
RepositoryEntry	getConfiguration()
javax.jcr.Session	getDynamicSession(String workspaceName, Collection<MembershipEntry> membershipEntries)
javax.jcr.NamespaceRegistry	getNamespaceRegistry()
ExtendedNodeTypeManager	getNodeTypeManager()
int	getState() Returns repository state.
String	getStateTitle() Returns the string representation of current repository state.
javax.jcr.Session	getSystemSession(String workspaceName)
org.exoplatform.services.jcr.core.WorkspaceContainerFacade	getWorkspaceContainer(String workspaceName) Returns an entry point of workspace managing objects.
String[]	getWorkspaceNames()
void	importWorkspace(String workspaceName, InputStream xmlSource) Create new workspace with name workspaceName and import data from exported XML.
boolean	isWorkspaceInitialized(String workspaceName) Check if workspace is initialized.
void	removeWorkspace(String workspaceName) Remove workspace with name workspaceName.
void	setState(int state) Set repository state.

Methods inherited from interface javax.jcr.Repository

getDescriptor, getDescriptorKeys, login, login, login, login

Field Detail

OFFLINE

static final int OFFLINE

Repository OFFLINE status.

See Also:

Constant Field Values

ONLINE

static final int ONLINE

Repository ONLINE status.

See Also:

Constant Field Values

SUSPENDED

static final int SUSPENDED

Repository SUSPENDED status.

See Also:

Constant Field Values

UNDEFINED

static final int UNDEFINED

Repository UNDEFINED status.

See Also:

Constant Field Values

Method Detail

addItemPersistenceListener

void addItemPersistenceListener(String workspaceName,
                              ItemsPersistenceListener listener)

Add the items persistence listener to the named workspace.

Parameters:

workspaceName - - name of workspace

listener - Item persistence listener

canRemoveWorkspace

boolean canRemoveWorkspace(String workspaceName)
                           throws javax.jcr.NoSuchWorkspaceException

Indicates if workspace with name workspaceName can be removed.

Parameters:

workspaceName - - name of workspace

Returns:

if workspace with name workspaceName can be removed

Throws:

javax.jcr.NoSuchWorkspaceException

configWorkspace

void configWorkspace(WorkspaceEntry wsConfig)
                     throws org.exoplatform.services.jcr.config.RepositoryConfigurationException,
                            javax.jcr.RepositoryException

Add new workspace configuration.

Parameters:

wsConfig - - configuration of workspace

Throws:

org.exoplatform.services.jcr.config.RepositoryConfigurationException

javax.jcr.RepositoryException

createWorkspace

void createWorkspace(String workspaceName)
                     throws javax.jcr.RepositoryException

Create new workspace with name workspaceName.

Parameters:

workspaceName - - name of workspace

Throws:

javax.jcr.RepositoryException

getConfiguration

RepositoryEntry getConfiguration()

Returns:

the configuration of this repository

getNamespaceRegistry

javax.jcr.NamespaceRegistry getNamespaceRegistry()

Returns:

the namespace registry

getNodeTypeManager

ExtendedNodeTypeManager getNodeTypeManager()

Returns:

the node type manager

getSystemSession

javax.jcr.Session getSystemSession(String workspaceName)
                                   throws javax.jcr.RepositoryException

Parameters:

workspaceName - - name of workspace

Returns:

the System session (session with SYSTEM identity)

Throws:

javax.jcr.RepositoryException

getDynamicSession

javax.jcr.Session getDynamicSession(String workspaceName,
                                  Collection<MembershipEntry> membershipEntries)
                                    throws javax.jcr.RepositoryException

Parameters:

workspaceName - - name of workspace

membershipEntries - - list of memberships

Returns:

the Dynamic session (session with Dynamic identity)

Throws:

javax.jcr.RepositoryException

getWorkspaceNames

String[] getWorkspaceNames()

Returns:

array of workspace names

importWorkspace

void importWorkspace(String workspaceName,
                   InputStream xmlSource)
                     throws javax.jcr.RepositoryException,
                            IOException

Create new workspace with name workspaceName and import data from exported XML.

Parameters:

workspaceName - - name of workspace

xmlSource - - InputStream with content of workspace

Throws:

javax.jcr.RepositoryException

IOException

isWorkspaceInitialized

boolean isWorkspaceInitialized(String workspaceName)
                               throws javax.jcr.RepositoryException

Check if workspace is initialized.

Parameters:

workspaceName - - name of workspace

Returns:

true if workspace is initialized and false otherwise

Throws:

javax.jcr.RepositoryException

removeWorkspace

void removeWorkspace(String workspaceName)
                     throws javax.jcr.RepositoryException

Remove workspace with name workspaceName.

Parameters:

workspaceName - - name of workspace

Throws:

javax.jcr.RepositoryException

getWorkspaceContainer

org.exoplatform.services.jcr.core.WorkspaceContainerFacade getWorkspaceContainer(String workspaceName)

Returns an entry point of workspace managing objects.

Returns:

workspace serving container

setState

void setState(int state)
              throws javax.jcr.RepositoryException

Set repository state.

Parameters:

state - the new repository state to set

Throws:

javax.jcr.RepositoryException

getState

int getState()

Returns repository state.

Returns:

repository state

getStateTitle

String getStateTitle()

Returns the string representation of current repository state.

Returns:

repository state