org.modeshape.jcr.api

Interface RepositoryFactory

All Superinterfaces:

RepositoryFactory

public interface RepositoryFactory
extends RepositoryFactory

ModeShape's RepositoryFactory.

ModeShape's RepositoryFactory implementation looks for two parameters:

• org.modeshape.jcr.URL - This parameter specifies the URL of the configuration file for the repository to be used.
• org.modeshape.jcr.RepositoryName - This parameter specifies the name of the repository that is to be used.

Often, both properties will be used, resulting in ModeShape's factory using this logic:

1. Look for an already-deployed repository with the name given by org.modeshape.jcr.RepositoryName. If one is found, then return that Repository instance.
2. Look for the repository's configuration file at the URL given by org.modeshape.jcr.URL. If the file had already been loaded, find the repository and return it; otherwise attempt to load the file, deploy the repository, and return the Repository instance.

But strictly speaking, only the org.modeshape.jcr.api.URL parameter is required, since the configuration file contains the name of the repository. So why supply the org.modeshape.jcr.RepositoryName parameter? Because ModeShape's RepositoryFactory.getRepository(Map) method can look up an existing repository by name faster than it can load the configuration file. In other words, using both parameters makes for a faster operation.

Use the Standard JCR API

The best way for your application to use the RepositoryFactory is to use only the JCR API, and load the properties from a file. This way, only the file has implementation-specific information, while your application uses only the standard JCR API:

 Properties parameters = new Properties();
 parameters.load(...); // Load from a stream or reader
 
 Repository repository = null;
 for (RepositoryFactory factory : ServiceLoader.load(RepositoryFactory.class)) {
     repository = factory.getRepository(parameters);
     if (repository != null) break;
 }
 

Use the ModeShape constants

If you'd rather your application programmatically create the parameters to pass to JCR's RepositoryFactory, and your application is already dependent upon the ModeShape public API, you can use the constants in this interface to build your parameters.

 String configUrl = "file://path/to/configFile.json"; // URL that points to the repository's configuration file
 String repoName = "MyRepository"; // Name of the repository (this is optional)
 
 Map<String, String> parameters = new HashMap<String, String>();
 parameters.put(org.modeshape.jcr.api.RepositoryFactory.URL, configUrl);
 parameters.put(org.modeshape.jcr.api.RepositoryFactory.RepositoryName, repoName);
 
 Repository repository = null;
 for (RepositoryFactory factory : ServiceLoader.load(RepositoryFactory.class)) {
     repository = factory.getRepository(parameters);
     if (repository != null) break;
 }
 

ModeShape also provides and alternative service: RepositoriesContainer which offers more control over the set of managed repositories.

Field Summary

Fields

Modifier and Type	Field and Description
static String	REPOSITORY_NAME The name of the key for the ModeShape JCR repository name in the parameter map.
static String	URL The name of the key for the ModeShape JCR URL in the parameter map.

Method Summary

Methods inherited from interface javax.jcr.RepositoryFactory

getRepository

Field Detail

URL

static final String URL

The name of the key for the ModeShape JCR URL in the parameter map.

For example, define a URL that points to the configuration file for your repository:

 \// Define a 
 String configUrl = "file://path/to/configFile.xml?repositoryName=myRepository"; // URL that points to your configuration file
 
 Map<String, String> parameters = new HashMap<String, String>();
 parameters.put(org.modeshape.jcr.api.RepositoryFactory.URL, configUrl);
 
 Repository repository = null;
 for (RepositoryFactory factory : ServiceLoader.load(RepositoryFactory.class)) {
     repository = factory.getRepository(parameters);
     if (repository != null) break;
 }
 

See Also:

Constant Field Values

REPOSITORY_NAME

static final String REPOSITORY_NAME

The name of the key for the ModeShape JCR repository name in the parameter map. This can be used as an alternative to specifying the repository name as a URL parameter within the URL.

For example:

 String configUrl = "file://path/to/configFile.json"; // URL that points to your configuration file
 String repoName = "myRepository"; // Name of your repository defined within the configuration file
 
 Map<String, String> parameters = new HashMap<String, String>();
 parameters.put(org.modeshape.jcr.api.RepositoryFactory.URL, configUrl);
 parameters.put(org.modeshape.jcr.api.RepositoryFactory.REPOSITORY_NAME, repoName);
 
 Repository repository = null;
 for (RepositoryFactory factory : ServiceLoader.load(RepositoryFactory.class)) {
     repository = factory.getRepository(parameters);
     if (repository != null) break;
 }
 

See Also:

Constant Field Values