org.modeshape.jcr

Interface Environment

All Known Implementing Classes:

LocalEnvironment, RepositoryService

@ThreadSafe
public interface Environment

A basic environment in which a repository operates. The logical names supplied to these methods are typically obtained directly from the RepositoryConfiguration.

Method Summary

Modifier and Type	Method and Description
default Document	defaultPersistenceConfiguration() Returns a default persistence configuration document, when nothing is explicitly configured for a repository.
org.jgroups.Channel	getChannel(String name) Get the JGroups channel with the given logical name.
ClassLoader	getClassLoader(Object caller, String... classpathEntries) Get a classloader given the supplied set of logical classpath entries, which the implementation can interpret however it needs.
default SchematicDb	getDb(Document persistenceConfig) Returns SchematicDb instance for the given configuration and optional classpath entries using a custom loader.
default void	shutdown() Shutdown this environment, allowing it to reclaim any resources.

Method Detail

defaultPersistenceConfiguration

default Document defaultPersistenceConfiguration()

Returns a default persistence configuration document, when nothing is explicitly configured for a repository.

Returns:

a Document instance, never null

getDb

default SchematicDb getDb(Document persistenceConfig)

Returns SchematicDb instance for the given configuration and optional classpath entries using a custom loader. The supplied configuration document may contain a custom RepositoryConfiguration.FieldName.CLASSLOADER attribute which if present, will be used as an additional classpath entry.

Parameters:

persistenceConfig - a Document representing the persistence configuration document; it may be null in which case a default configuration will be used

Returns:

a SchematicDb instance, never null

Throws:

ConfigurationException - if no persistence provider can return a valid database.

getClassLoader

ClassLoader getClassLoader(Object caller,
                           String... classpathEntries)

Get a classloader given the supplied set of logical classpath entries, which the implementation can interpret however it needs.

Parameters:

caller - the object instance which calls this method and whose class loader will be used as a fallback; may not be null

classpathEntries - the logical classpath entries; may be null

Returns:

a classloader instance, never null

getChannel

org.jgroups.Channel getChannel(String name)
                        throws Exception

Get the JGroups channel with the given logical name.

Parameters:

name - the name of the channel; may not be null

Returns:

the channel, or null if there is no such channel and the environment does not support clustering

Throws:

Exception - if there is a problem obtaining the named channel

shutdown

default void shutdown()

Shutdown this environment, allowing it to reclaim any resources.