Commit 5affc003 authored by Aaron Coburn's avatar Aaron Coburn
Browse files

Update README files

parent 7ae961b4
......@@ -3,32 +3,32 @@ Amherst College Repository Services
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/edu.amherst.acdc/acrepo-karaf/badge.svg)](https://maven-badges.herokuapp.com/maven-central/edu.amherst.acdc/acrepo-karaf/)
This is a collection of OSGi services that extend the functionality of a [Fedora4](https://wiki.duraspace.org/display/FF/Fedora+Repository+Home) repository.
This is a collection of OSGi services that extend the functionality of an [LDP](https://www.w3.org/TR/ldp/) server.
Extensions
----------
These modules extend the behavior of Fedora resources. Specifically, they connect Fedora Resources to specific services
These modules extend the behavior of LDP resources. Specifically, they connect LDP Resources to specific services
by making available a REST-based HTTP interface. The intention is that these extensions will be compatible with the
[Fedora API Extension](https://wiki.duraspace.org/display/FF/Design+-+API+Extension+Architecture) architecture.
* [`acrepo-exts-entailment`](acrepo-exts-entailment): This service will return RDFS entailment information associated with a Fedora Resource
* [`acrepo-exts-fits`](acrepo-exts-fits): This service will return FITS information associated with a Fedora Binary, in XML format
* [`acrepo-exts-entailment`](acrepo-exts-entailment): This service will return RDFS entailment information associated with an LDP Resource
* [`acrepo-exts-fits`](acrepo-exts-fits): This service will return FITS information associated with an LDP-NR (Binary), in XML format
* [`acrepo-exts-image`](acrepo-exts-image): An image manipulation service
* [`acrepo-exts-ldpath`](acrepo-exts-ldpath): This module extends `fcrepo-ldpath` to support additional Linked Data endpoints (e.g. Getty)
* [`acrepo-exts-ore`](acrepo-exts-ore): This constructs a complete ORE Aggregation graph for Fedora resources
* [`acrepo-exts-pcdm`](acrepo-exts-pcdm): This constructs a complete PCDM object graph for Fedora resources
* [`acrepo-exts-serialize-xml`](acrepo-exts-serialize-xml): This service translates Fedora RDF documents into MODS/XML or DC/XML
* [`acrepo-exts-template`](acrepo-exts-template): A module for converting Fedora resources into some other form, using a [mustache](https://mustache.github.io/) template.
* [`acrepo-exts-ore`](acrepo-exts-ore): This constructs a complete ORE Aggregation graph for LDP resources
* [`acrepo-exts-pcdm`](acrepo-exts-pcdm): This constructs a complete PCDM object graph for LDP resources
* [`acrepo-exts-serialize-xml`](acrepo-exts-serialize-xml): This service translates LDP-RS (RDF) documents into MODS/XML or DC/XML
* [`acrepo-exts-template`](acrepo-exts-template): A module for converting LDP resources into some other form, using a [mustache](https://mustache.github.io/) template.
Services
--------
These modules provide particular services, independent of Fedora Resources.
These modules provide particular services, independent of LDP Resources.
* [`acrepo-services-entailment`](acrepo-services-entailment): An OSGi-based service for getting RDFS entailment information about resource
* [`acrepo-services-inference`](acrepo-services-inference): An OSGi-based structural typing service using owl inference
* [`acrepo-services-mint`](acrepo-services-mint): This mints random (public) URIs for use with Fedora resources
* [`acrepo-services-mint`](acrepo-services-mint): This mints random (public) URIs for use with creating LDP resources
* [`acrepo-services-ore`](acrepo-services-ore): This makes it easy to work with ORE aggregations
* [`acrepo-services-pcdm`](acrepo-services-pcdm): This makes it easy to work with PCDM objects
......@@ -38,10 +38,10 @@ Connectors
These modules listen to repository events and react accordingly.
* [`acrepo-connector-broadcast`](acrepo-connector-broadcast): Message Broadcast Service: This rebroadcasts messages from one queue/topic to every queue/topic in a specified list
* [`acrepo-connector-idiomatic`](acrepo-connector-idiomatic): Id Mapping Service: This maps a public ID to a (internal and typically much longer) Fedora URI
* [`acrepo-connector-idiomatic`](acrepo-connector-idiomatic): Id Mapping Service: This maps a public ID to an internal (and in some cases, much longer) LDP server URI
* [`acrepo-connector-idiomatic-mysql`](acrepo-connector-idiomatic-mysql): Id Mapping Service Database: This exposes a MySQL datastore for use with the Id Mapping service
* [`acrepo-connector-idiomatic-pgsql`](acrepo-connector-idiomatic-pgsql): Id Mapping Service Database: This exposes a Postgres datastore for use with the Id Mapping service
* [`acrepo-connector-triplestore`](acrepo-connector-triplestore): Triplestore Indexing Service: This indexes Fedora resources into named graphs in an external triplestore.
* [`acrepo-connector-triplestore`](acrepo-connector-triplestore): Triplestore Indexing Service: This indexes LDP resources into named graphs in an external triplestore.
Other OSGi Features
-------------------
......
Amherst College Triplestore Indexer
===================================
The Triplestore indexer will index Fedora content into an external triplestore. It differs
The Triplestore indexer will index LDP content into an external triplestore. It differs
from the `fcrepo-indexer-triplestore` in that each resource is indexed into its own named
graph.
......@@ -80,13 +80,13 @@ The base URL of the triplestore being used.
triplestore.baseUrl=http://localhost:8080/fuseki/test/update
The Fedora configuration.
The LDP server configuration.
fcrepo.baseUrl=http://localhost:8080/fcrepo/rest
fcrepo.authUsername=
fcrepo.authPassword=
A comma-delimited list of URIs to filter. That is, any Fedora resource that either matches or is contained in one of
A comma-delimited list of URIs to filter. That is, any LDP resource that either matches or is contained in one of
the URIs listed will not be processed by the application.
filter.containers=http://localhost:8080/fcrepo/rest/test
......
......@@ -8,7 +8,7 @@ The service is invoked like so:
curl http://localhost:9601/fits?context=http://localhost:8080/fcrepo/rest/image
The appropriate Fedora resource is identified with either the `context` query option
The appropriate LDP resource is identified with either the `context` query option
or the `Apix-Ldp-Resource-Path` header.
Building
......@@ -35,7 +35,7 @@ The application can be configured by creating the following configuration
file `KARAF_HOME/etc/edu.amherst.acdc.exts.fits.cfg`. The following values
are available for configuration:
The base URL of the Fedora repository and any authentication parameters
The base URL of the LDP server and any authentication parameters
fcrepo.baseUrl=http://localhost:8080/fcrepo/rest
fcrepo.authHost=
......
......@@ -9,7 +9,7 @@ to ImageMagick. The `Accept` header is used to change the format of the image. B
the output is JPEG, but any format listed in the configuration under `valid.formats` can be used.
By default, the valid output formats are `image/tiff`, `image/jp2` and `image/jpeg`.
A `context` parameter is used to define the path to the Fedora resource. Alternately, the
A `context` parameter is used to define the path to the LDP resource. Alternately, the
`Apix-Ldp-Resource-Path` header may be used to identify the resource path.
An example:
......
Amherst College XML-based metadata serialization extension
=========================================================
This service implements a translation service from Fedora RDF-based metadata
This service implements a translation service from LDP RDF-based metadata
to either a DC/XML or MODS/XML serialization. This translation relies on
pluggable XSLT 2.0 documents.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment