Page tree

Archived

If you are looking for the last documentation in the 4.x series, see 4.7.5. 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 7 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

Fedora RESTful HTTP API uses the open source Jersey RESTful Web Services framework that provides support for JAX-RS APIs and serves as a JAX-RS (JSR 311 & JSR 339) Reference Implementation. The jersey servlet dispatcher is configured in web.xml as follows:

web.xml
<servlet>
	<servlet-name>jersey-servlet</servlet-name>
	<servlet-class>com.sun.jersey.spi.spring.container.servlet.SpringServlet</servlet-class>
	<init-param>
		<param-name>com.sun.jersey.config.property.packages</param-name>
		<param-value>org.fcrepo</param-value>
	</init-param>
	<init-param>
		<param-name>com.sun.jersey.api.json.POJOMappingFeature</param-name>
		<param-value>true</param-value>
	</init-param>
	<load-on-startup>1</load-on-startup>
</servlet>

 

The following spring files exist in a directory as configured in web.xml, which 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 InternalIdentifierConverter (identifier translationChain), StoragePolicyDecisionPointImpl, SessionFactory, and base-packages to auto scan into spring

eventing.xml  

  • bean implementation for eventing - observer, filter, event bus

jms.xml

  • here you can specify the implementation for processing events

transactions.xml

  • Specify the config for transactions

minter.xml

  • bean implementation for minting identifiers

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

activemq.xml

  • config for message broker

jgroups-fcrepo-tcp.xml

  • Config for the Messaging Toolkit JGroups to transfer state between nodes in a Fedora Cluster.

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/

Repository Config Options

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

 

/config/clustered-mysql/repository.json

  • Configuration for clustered repositories with a centralized MySQL object store.

/config/file-simple/repository.json

  • Configuration for file-based object store for testing, not recommended for production. 

 

/config/jdbc-mysql/repository.json 

 

  • Configuration for MySQL-based object store.

 

/config/jdbc-postgresql/repository.json

 

  • Configuration for PostgreSQL-based object store.

/config/servlet-auth/repository.json

  • Configuration with servlet authentication enabled.

Fedora 4 will store object properties to the configured backend datastore. 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.

Binary storage

fcrepo.binary.directory:target/binaries

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

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

Other module resources

fcrepo-module-auth-xacml

This XACML Authorization Delegate Module is based on the design documented here: XACML Authorization Delegate

/src/main/resources/policies

AdminPermissionPolicySet.xml

  • policy set for the admin role

AdminRolePolicySet.xml

  • define the policies for the admin role

GlobalPermissionPolicySet.xml

  • policy set for the basic role

GlobalRolesPolicySet.xml

  • define the policies for the basic role

PreventReadingMasterFilesPolicySet.xml

  • policy set that prevents access to any files with the mime type "image/tiff" that have the "http://example.com/mixins#master" type (example-mixins:master mixin)

ReadNormalNodePermissionPolicySet.xml

  • policy set for reading normal nodes

ReadOnlyExceptToLocalPolicySet.xml

  • policy set that prevents all repository-changing actions by all but those a localhost or on an internal network.

ReaderRolePolicySet.xml

  • define the policies for the reader role

WriteNormalNodePermissionPolicySet.xml

  • policy set for writing normals nodes.

WriterRolePolicySet.xml

  • define the policies for writing the normal nodes

/src/main/resources/cnd

xacml-policy.cnd

  • namespace properties to enable  XACML authorization

  • No labels