org.apache.jackrabbit.core.config
Class WorkspaceConfig

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

public class WorkspaceConfig

extends Object

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, and the file system, the persistence manager, and the search index configuration. The search index is an optional part of the configuration.

Constructor Summary

WorkspaceConfig(String home, String name, FileSystemConfig fsc, PersistenceManagerConfig pmc, SearchConfig sc)
Creates a workspace configuration object.

Method Summary

FileSystemConfig	getFileSystemConfig() Returns the file system configuration.
String	getHomeDir() Returns the workspace home directory.
String	getName() Returns the workspace name.
PersistenceManagerConfig	getPersistenceManagerConfig() Returns the workspace persistence manager configuration.
SearchConfig	getSearchConfig() Returns the workspace search index configuration.
void	init() Initializes the search index implementation.

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkspaceConfig

public WorkspaceConfig(String home,
                       String name,
                       FileSystemConfig fsc,
                       PersistenceManagerConfig pmc,
                       SearchConfig sc)

Creates a workspace configuration object.

Parameters:

home - home directory

name - workspace name

fsc - file system configuration

pmc - persistence manager configuration

sc - search index configuration

Method Detail

init

public void init()
          throws ConfigurationException

Initializes the search index implementation.

Throws:

ConfigurationException - on initialization errors

getHomeDir

public String getHomeDir()

Returns the workspace home directory.

Returns:

workspace home directory

getName

public String getName()

Returns the workspace name.

Returns:

the workspace name

getFileSystemConfig

public FileSystemConfig getFileSystemConfig()

Returns the file system configuration.

Returns:

file system configuration

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