org.apache.jackrabbit.core.config
Class WorkspaceConfig

java.lang.Object
  org.apache.jackrabbit.core.config.WorkspaceConfig

All Implemented Interfaces:

FileSystemFactory

public class WorkspaceConfig
extends java.lang.Object
implements FileSystemFactory

Workspace configuration. This configuration class is used to create configured workspace objects.

The contained configuration information are: the home directory and name of the workspace, the file system, the persistence manager, the search index and the item state manager locking configuration. The search index and the item state manager locking and the security config are optional parts.

Constructor Summary

WorkspaceConfig(java.lang.String home, java.lang.String name, boolean clustered, FileSystemFactory fsf, PersistenceManagerConfig pmc, SearchConfig sc, ISMLockingConfig ismLockingConfig, WorkspaceSecurityConfig workspaceSecurityConfig)
Creates a workspace configuration object.

Method Summary

FileSystem	getFileSystem() Creates and returns the configured workspace file system.
java.lang.String	getHomeDir() Returns the workspace home directory.
ISMLockingConfig	getISMLockingConfig()
java.lang.String	getName() Returns the workspace name.
PersistenceManagerConfig	getPersistenceManagerConfig() Returns the workspace persistence manager configuration.
SearchConfig	getSearchConfig() Returns the workspace search index configuration.
WorkspaceSecurityConfig	getSecurityConfig()
boolean	isClustered() Returns a flag indicating whether this workspace participates in a cluster.

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkspaceConfig

public WorkspaceConfig(java.lang.String home,
                       java.lang.String name,
                       boolean clustered,
                       FileSystemFactory fsf,
                       PersistenceManagerConfig pmc,
                       SearchConfig sc,
                       ISMLockingConfig ismLockingConfig,
                       WorkspaceSecurityConfig workspaceSecurityConfig)

Creates a workspace configuration object.

Parameters:

home - home directory

name - workspace name

fsc - file system factory

pmc - persistence manager configuration

sc - search index configuration

ismLockingConfig - the item state manager locking configuration. If null is passed, a default configuration is taken.

workspaceSecurityConfig - the workspace specific security configuration.

Method Detail

getHomeDir

public java.lang.String getHomeDir()

Returns the workspace home directory.

Returns:

workspace home directory

getName

public java.lang.String getName()

Returns the workspace name.

Returns:

the workspace name

isClustered

public boolean isClustered()

Returns a flag indicating whether this workspace participates in a cluster.

Returns:

true if this workspace participates in a cluster; false otherwise

getISMLockingConfig

public ISMLockingConfig getISMLockingConfig()

Returns:

the configuration for the item state locking.

getFileSystem

public FileSystem getFileSystem()
                         throws javax.jcr.RepositoryException

Creates and returns the configured workspace file system.

Specified by:

getFileSystem in interface FileSystemFactory

Returns:

the configured FileSystem

Throws:

javax.jcr.RepositoryException - if the file system can not be created

getPersistenceManagerConfig

public PersistenceManagerConfig getPersistenceManagerConfig()

Returns the workspace persistence manager configuration.

Returns:

persistence manager configuration

getSearchConfig

public SearchConfig getSearchConfig()

Returns the workspace search index configuration. Returns null if a search index has not been configured.

Returns:

search index configuration, or null

getSecurityConfig

public WorkspaceSecurityConfig getSecurityConfig()

Returns:

workspace-specific security settings.

See Also:

WorkspaceSecurityConfig