org.modeshape.jcr
Class JcrEngine

java.lang.Object
  extended by org.modeshape.repository.ModeShapeEngine
      extended by org.modeshape.jcr.JcrEngine
All Implemented Interfaces:
Repositories

@ThreadSafe
public class JcrEngine
extends ModeShapeEngine
implements Repositories

The basic component that encapsulates the ModeShape services, including the Repository instances.


Nested Class Summary
 
Nested classes/interfaces inherited from class org.modeshape.repository.ModeShapeEngine
ModeShapeEngine.ConfigurationScanner
 
Field Summary
 
Fields inherited from class org.modeshape.repository.ModeShapeEngine
configuration, CONFIGURATION_REPOSITORY_NAME, context
 
Method Summary
 boolean awaitTermination(long timeout, TimeUnit unit)
          Blocks until the shutdown has completed, or the timeout occurs, or the current thread is interrupted, whichever happens first.
protected  JcrRepository doCreateJcrRepository(String repositoryName)
           
 JcrRepository getRepository(String repositoryName)
          Get the Repository implementation for the named repository.
 Set<String> getRepositoryNames()
          Get the names of each of the JCR repositories.
protected  String readable(Location location)
           
protected  String readable(Name name)
           
protected  String readable(Path path)
           
 void shutdown()
          Shutdown this engine to close all connections, terminate any ongoing background operations (such as sequencing), and reclaim any resources that were acquired by this engine.
 void start()
          Start this engine to make it available for use.
 
Methods inherited from class org.modeshape.repository.ModeShapeEngine
checkRunning, getConfigurationGraph, getExecutionContext, getGraph, getGraph, getMimeTypeDetector, getProblems, getRepositoryConnectionFactory, getRepositoryService, getRepositorySource, getSequencingService
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

shutdown

public void shutdown()
Description copied from class: ModeShapeEngine
Shutdown this engine to close all connections, terminate any ongoing background operations (such as sequencing), and reclaim any resources that were acquired by this engine. This method may be called multiple times, but only the first time has an effect.

Overrides:
shutdown in class ModeShapeEngine
See Also:
ModeShapeEngine.start()

awaitTermination

public boolean awaitTermination(long timeout,
                                TimeUnit unit)
                         throws InterruptedException
Description copied from class: ModeShapeEngine
Blocks until the shutdown has completed, or the timeout occurs, or the current thread is interrupted, whichever happens first.

Overrides:
awaitTermination in class ModeShapeEngine
Parameters:
timeout - the maximum time to wait for each component in this engine
unit - the time unit of the timeout argument
Returns:
true if this service complete shut down and false if the timeout elapsed before it was shut down completely
Throws:
InterruptedException - if interrupted while waiting

start

public void start()
Description copied from class: ModeShapeEngine
Start this engine to make it available for use.

Overrides:
start in class ModeShapeEngine
See Also:
ModeShapeEngine.shutdown()

getRepository

public final JcrRepository getRepository(String repositoryName)
                                  throws RepositoryException
Get the Repository implementation for the named repository.

Specified by:
getRepository in interface Repositories
Parameters:
repositoryName - the name of the repository, which corresponds to the name of a configured RepositorySource
Returns:
the named repository instance
Throws:
IllegalArgumentException - if the repository name is null, blank or invalid
RepositoryException - if there is no repository with the specified name
IllegalStateException - if this engine was not started

getRepositoryNames

public Set<String> getRepositoryNames()
Get the names of each of the JCR repositories.

Specified by:
getRepositoryNames in interface Repositories
Returns:
the immutable names of the repositories that exist at the time this method is called

doCreateJcrRepository

protected JcrRepository doCreateJcrRepository(String repositoryName)
                                       throws RepositoryException,
                                              PathNotFoundException
Throws:
RepositoryException
PathNotFoundException

readable

protected final String readable(Name name)

readable

protected final String readable(Path path)

readable

protected final String readable(Location location)


Copyright © 2008-2010 JBoss, a division of Red Hat. All Rights Reserved.