Page tree

Old Release

This documentation covers an old version of Fedora. Looking for another version? See all documentation.

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 29 Next »

Here is found details of the locations and purposes of the Fedora 4 configuration files.

For details on how to enable and configure these options, see this page

fcrepo-webapp

The following spring files exist in a directory as configured in fcrepo4/fcrepo-webapp/src/main/webapp/WEB-INF/web.xml.  This web.xml file contains a context-param element with param-name "contextConfigLocation".  The param-value points to your spring context configuration files, WEB-INF/classes/*.xml.  Note that these files are in the source tree under fcrepo-webapp/src/main/resources/spring and copied to WEB-INF/classes upon build.

fcrepo-webapp/src/main/resources/spring

repo.xml

  • here you can specify the repository.json file to be loaded as the repositoryConfiguration, as well as the bean for repository factory and metrics
repo.xml
<bean name "modeshapeRepofactory" class= "org.fcrepo.kernel.spring.ModeshapeRepositoryFactoryBean">
	<property name="repositoryConfiguration" value="${fcrepo.modeshape.configuration:classpath:/config/single/repository.json"/>
</bean>

rest.xml

  • bean implementation for UUIDPathMinter, SessionFactory, and base-packages to autoscan into spring

eventing.xml  

  • bean implementation for eventing - observer, filter, eventbus

jms.xml

  • here you can specify the impementation for processing events

generator.xml

  • beans implementation for datastream generation, ex: dublin core

security.xml

  • bean implementation for OAuth security

fcrepo4/fcrepo-configs/src/main/resources/config

activemq.xml

  • config for message broker

fcrepo4/fcrepo-webapp/src/main/resources

logback.xml

Modeshape repository configuration

Fedora 4 uses Modeshape, a JCR implementation. We distribute a handful of known-good configurations for Modeshape and Infinispan, although we anticipate configuration tuning for deployment environments will be common.


https://github.com/ModeShape/modeshape/blob/master/modeshape-jcr/src/main/resources/org/modeshape/jcr/repository-config-schema.json

http://docs.jboss.org/infinispan/5.3/configdocs/

Modeshape Configurations

These configuration files are copied to WEB-INF/classes from fcrepo-configs/src/main/resources upon build.

/config/minimal-default/repository.json

  • Our default Modeshape configuration. 

/config/servlet-auth/repository.json

  • Default configuration with servlet authentication enabled.

/config/clustered/repository.json

  • Default configuration with repository clustering enabled. By default, uses /config/infinispan/clustered/infinispan.xml persistence configuration.

Infinispan configurations

These configuration files are copied to WEB-INF/classes from fcrepo-configs/src/main/resources upon build.

/config/infinispan/leveldb-default/infinispan.xml

  • Default configuration with leveldb object storage

/config/infinispan/leveldb/infinispan.xml

  • Configuration with leveldb object storage and filecachestore object storage

/config/infinispan/clustered/infinispan.xml

  • Example clustering configuration. Replicates object storage, distributes 2 copies of binary storage.

/config/infinispan/file/infinispan.xml

  • Configuration with filecachestore

/config/infinispam/ram/infinispan.xml

  • In-memory configuration for object storage (useful for testing)

 

Options:

fcrepo.modeshape.query.enabled:true
fcrepo.modeshape.query.mode:sync

Fedora 4 uses the Modeshape query index to power administrative search APIs. It can be disabled (or switched to asynchronous mode) to improve performance (see below).

fcrepo.modeshape.index.location:target/indexes
fcrepo.infinispan.cache_configuration:config/infinispan/leveldb-default/infinispan.xml

Fedora 4 can be configured to use different Infinispan configurations. By default, Fedora 4 configurations use the leveldb-default configuration.

fcrepo.ispn.repo.CacheDirPath:target/FedoraRepository/storage

Fedora 4 will store object properties to fcrepo.ispn.repo.CacheDirPath. These probably won't be very large, and should be stored on fast disk. The object properties are stored as binary JSON documents within the given cache store configuration.

fcrepo.binary-store-path:target/binaries
fcrepo.ispn.binary.CacheDirPath:target/FedoraRepositoryBinaryData/storage

fcrepo.ispn.binary.CacheDirPath:target/FedoraRepositoryBinaryData/storage - path to store binary content (when it's stored in infinispan e.g. /config/infinispan/clustered/infinispan.xml)

Fedora 4 stores binary content separately (to one of the above paths, depending on configuration). These files are stored hashed by the content SHA-1 hash. 


Performance considerations:

If your application does not use the query index (which powers basic administrative search, and the simple fcr:sparql endpoint), you can significantly improve repository performance by disabling indexing, or using asynchronous indexing instead.

fcrepo.modeshape.query.mode = async
fcrepo.modeshape.query.enabled = false
SettingAverage (s)Median (s)Standard
Deviation 
mode=async0.07810.06800.0477
enabled=false0.07360.06300.0445
mode=sync0.16890.1480.0685

 

Different Infinispan configurations can also have an impact on repository performance. 

 

Infinispan ConfigurationAverageMedianStandard
Deviation 
filecachestore0.11210.1050.0313
leveldb0.07360.06300.0445
leveldb with async persistence0.06100.05500.0220
RAM0.05170.04800.0148
leveldb with file binary store *0.06440.05700.0196
Total0.07030.05900.0318

* default configuration

Fedora Node Types - node definitions in terms of namespaced properties

Defining .cnd files such as these in repository.json will register namespaces and nodetypes found within:

fcrepo4/fcrepo-kernel/src/main/resources/fedora-node-types.cnd

fcrepo4/fcrepo-auth-roles-common/src/main/resources/cnd/access-control.cnd

Alternatively from definition in .cnd files as above, forms are available to add namespaces and nodetypes at these URL endpoints:

http://<host>/rest/fcr:namespaces
http://<host>/rest/fcr:nodetypes

Other module resources

fcrepo4/fcrepo-jms/src/main/resources

  • No labels