-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathconfig-sample.yaml
154 lines (154 loc) · 8.64 KB
/
config-sample.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
## Remark - when metadata triples/graphs are listed in the comments below
# [res] --property--> value
# means that a Fedora resource `res` has a metadata property `property` with a value `value`.
# If a `[res]` is used on the value side, like
# [res] --property--> [otherRes]
# it denotes the `[otherRes]` URI.
oai:
info:
## Information reported for `verb=Identify`
# (deletedRecord is provided by the deletedClass)
repositoryName: ARCHE
baseURL: https://arche.acdh.oeaw.ac.at/oai
earliestDatestamp: "1900-01-01T00:00:00Z"
adminEmail: acdh-tech@oeaw.ac.at
granularity: YYYY-MM-DDThh:mm:ssZ
# Repository database connection data
dbConnStr: "pgsql: "
# Cache dir - leave empty not to use cache
cacheDir: ""
# Logging settings
logging:
file: /home/www-data/log/oaipmh.log
level: debug
deleted:
# Class implementing deleted resources handling. There are two implementations
# available:
# - \acdhOeaw\arche\oaipmh\deleted\No - when the feature is not supported
# - \acdhOeaw\arche\oaipmh\deleted\Tombstone - when resources in the tombstone state
# should be reported as deleted
# - \acdhOeaw\arche\oaipmh\deleted\RdfProperty - when the deleted resources have a given
# RDF property values (and not deleted resources don't)
deletedClass: \acdhOeaw\arche\oaipmh\deleted\Tombstone
# Value to be reported for the `deletedRecord` property for the OAI-PMH
# `identify` request (can be "transient" or "persistent" -
# see https://www.openarchives.org/OAI/openarchivesprotocol.html#DeletedRecords).
# Needed only if `oaiDeletedClass` other then "acdhOeaw\oai\deleted\no".
deletedRecord: transient
# RDF property indicating a resource is deleted
# Needed only if `oaiDeletedClass` equals "acdhOeaw\oai\deleted\RdfProperty".
deletedProp: https://vocabs.acdh.oeaw.ac.at/schema#isDeleted
# `deletedProp` RDF property value indicating a resource is deleted. If empty,
# the existence of the `deletedProp` will be reported as a deletion state
# Needed only if `oaiDeletedClass` equals "acdhOeaw\oai\deleted\RdfProperty".
deletedPropValue: ''
search:
# Class used to implement the search.
# There is only one implementation provided \acdhOeaw\arche\oaipmh\search\BaseSearch.
# If it doesn't fit your needs, provide your own and update this property.
searchClass: \acdhOeaw\arche\oaipmh\search\BaseSearch
# RDF property storing last modification date
dateProp: http://fedora.info/definitions/v4/repository#lastModified
# Namespace of the identfier to be used as the OAI-PMH resource id
idNmsp: http://hdl.handle.net/
# Required repository-related settings
id: https://vocabs.acdh.oeaw.ac.at/schema#hasIdentifier
repoBaseUrl: http://127.0.0.1/rest/
# Execution time after each a resumption token is returned
# for the listRecords verb
resumptionTimeout: 120
resumptionDir: "tmp"
# Number of seconds a resumption token stays alive
resumptionKeepAlive: 600
sets:
# Class implementing sets. There are four implementations available:
# - \acdhOeaw\arche\oaipmh\set\NoSets - when your repository doesn't use sets
# - \acdhOeaw\arche\oaipmh\set\Simple - when the set(s) resource belongs to is denoted
# by a given RDF property value(s) but there is no other iformation about
# the sets (<setName> equals <setSet>, no <setDescription> in reply to ListSets OAI-PMH request)
# - \acdhOeaw\arche\oaipmh\set\Complex - when a given RDF property points to other
# repository resource describing the set. In this case full set information
# can be provided in reply to ListSets OAI-PMH request but of course corresponding
# resources describing sets must exist in your repository. <setDescripiotn> is
# gathered using the `\acdhOeaw\arche\oaipmh\metadata\DcMetadata` class created for the
# resource describing a set.
# If none of them fits your needs, provide your own implementation and update this property.
setClass: \acdhOeaw\arche\oaipmh\set\Simple
# Only when class equals \acdhOeaw\arche\oaipmh\set\Simple or \acdhOeaw\arche\oaipmh\set\Complex
# RDF property denoting sets the resource is part of
setProp: https://vocabs.acdh.oeaw.ac.at/schema#hasOaiSet
# Only when class equals \acdhOeaw\arche\oaipmh\set\Complex
# RDF property storing OAI-PMH <setSpec> value:
# [setResource] --oaiSetSpecProp--> setSpecValue
setSpecProp: https://vocabs.acdh.oeaw.ac.at/schema#hasDescription
# Only when class equals \acdhOeaw\arche\oaipmh\set\Complex
# RDF property storing OAI-PMH <setName> value
# [setResource] --oaiSetTitleProp--> setTitleValue
setNameProp: https://vocabs.acdh.oeaw.ac.at/schema#hasTitle
# Only when class equals \acdhOeaw\arche\oaipmh\set\Simple
# Namespace of the resource identifiers storing the set name
# (in case sets are denoted using relations instead of literal values)
setNameNamespace: https://vocabs.acdh.oeaw.ac.at/archeoaisets/
## Metadata formats description
#
# Each section describes a single metadata format:
# - Section name is not important (it has to be unique but nothing more then that).
# - `metadataPrefix`, `schema` and `metadataNamespace` configuration properties
# are simply OAI properties reported for `verb=ListMetadataFormats`
# - `class` configuration property denotes a PHP class implementing the given metadata format.
# At the moment six classes are available:
# - `\acdhOeaw\arche\oaipmh\metatada\DcMetata` - takes resource's RDF metadata and
# extracts all RDF properties in `dc` and `dcterms` namespaces.
# - `\acdhOeaw\arche\oaipmh\metadata\RdfXml` - takes resource's RDF metadata and serialises
# them as an RDF-XML.
# Doesn't require any additional configuration properties.
# - `\acdhOeaw\arche\oaipmh\metadata\ResMetadata` - fetches metadata from a binary
# content of another repository resource:
# [oaiRes] --format.metaResProp--> metaRes
# [metaRes] binary contains XML with the metadata
# Requires additional configuration properties: `metaResProp` and `requestOptions`.
# - `\acdhOeaw\arche\oaipmh\metadata\CmdiMetadata` - fetches metadata from a binary
# content of another repository resource checking if schema match requested
# format schema:
# [oaiRes] --format.metaResProp--> metaRes
# [metaRes] --format.cmdiSchemaProp--> format.schema
# [metaRes] binary contains XML with the metadata
# Requires additional configuration properties: `metaResProp`, `cmdiSchemaProp`,
# `requestOptions` and `schema`.
# - `\acdhOeaw\arche\oaipmh\metadata\TemplateMetadata` - generates metadata by filling up
# XML templates with resource's metadata values
# Requires additional configuration properties: `templatePath`
# The `rdfNamespace[]`, `keepComments` and `xmlErrors` configuration properties are optional.
# - ... other properties required by class handling given metadata format
# (see classes documentation)
formats:
oai_dc:
metadataPrefix: oai_dc
schema: http://www.openarchives.org/OAI/2.0/oai_dc.xsd
metadataNamespace: http://www.openarchives.org/OAI/2.0/oai_dc/
class: \acdhOeaw\arche\oaipmh\metadata\DcMetadata
rdfxml:
metadataPrefix: rdfxml
schema: http://unknown/schema
metadataNamespace: http://unknown/namespace
class: \acdhOeaw\arche\oaipmh\metadata\RdfXml
resmeta:
metadataPrefix: resmeta
schema: http://unknown/schema
metadataNamespace: http://unknown/namespace
class: \acdhOeaw\arche\oaipmh\metadata\ResMetadata
metaResProp: https://vocabs.acdh.oeaw.ac.at/schema#hasMetadata
requestOptions:
headers:
eppn: admin
tmplmeta:
metadataPrefix: tmplmeta
metadataNamespace: http://unknown/namespace
schema: http://unknown/schema
class: \acdhOeaw\arche\oaipmh\metadata\TemplateMetadata
templatePath: "template.xml"
keepComments: false
xmlErrors: true
rdfNamespaces:
acdh: https://vocabs.acdh.oeaw.ac.at/schema#
skos: http://www.w3.org/2004/02/skos/core#