List of all basic services

This page lists all basic services that have been developed during the course of the FREME project.

• Proxy Filter
• Rate Limiter
• Pipelines
• Test Helper
• Package Maker
• CORS Filter
• Postprocessing Filter
• Internalization Filter
• Logging Filter
• Internationalization
• NIF Converter
• SPARQL Converters
• Users Controller
• XSLT Converter
• Tika Filter

proxy.proxy-id.servlet_url: /e-entity/freme-ner/documents
proxy.proxy-id.target_url: http://example.org/freme-ner

proxy.freme-ner-documents.servlet_url: /e-entity/freme-ner/documents
proxy.freme-ner-documents.target_url: http://rv2622.1blu.de:7001/e-entity/freme-ner/documents

ratelimiter.enabled=true
ratelimiter.yaml=ratelimiter.yaml
ratelimiter.clear.timer=3600000

time-frame: 600   # time period in seconds
rate-limits:
ROLE_ANONYMOUS:
default:
- 50
- 10000 # anomyous user has 50 requests or 1000 kb in the time period
/e-entity/freme-ner/datasets:
- 10
- 1000000 # override for anonymous user to allow 50 requests or 1 000 000 characters in the time period
ROLE_USER:
default:
- 100
- 100000 # anomyous user has 50 requests or 1000 kb in the time period
/e-entity/freme-ner/datasets:
- 50
- 2000000 # override for authenticated users to allow 50 requests or 2 000 000 characters in the time period
ROLE_ADMIN:
default:
- 0
- 0 # admin user has no rate limits configured
henry:
/e-translation/tilde:
- 50
- 100000 # user henry has a special override on tilde

This service allows for chaining multiple endpoints together. In-depth information can be found in our API Documentation and an example tutorial can be found here.

Quick overview

Internationalisation filter

This filter extends FREME services with additional data formats. An in-depth article on the conveniences of this service can be found here.

Quick overview

Logging-Filter

This filter is responsible for logging requests and responses internally.

Quick overview

Configuration options

The logging-filter can be configured using the application.properties file.

loggingfilter.maxsize determines the maximum length of requests/responses to be logged. Any requests longer will be truncated.

loggingfilter.whitelist should be an array of content-types/informats that should be logged. They are to be seperated by a comma. If this parameter is not provided it defaults to null, which in turn will get the list of allowed content-types and informats from the internal list of RDF Serialization Formats.

Example configuration

This example configuration truncates all requests and responses longer than 1800 character and logs only requests in the turtle format

loggingfilter.maxsize=1800
loggingfilter.whitelist=turtle,text/turtle,application/x-turtle

Test Helper

The Test Helper basic service assists user in setting up unit tests and integration tests. So it is usually not part of a FREME package but rather a dependency of basic services and e-Services. The articles Creating a basic service and How to write an e-Service provide examples on how to use the test-helper.

Quick overview

Configuration options

The test helper does not use any configuration options.

Package Maker

The package-maker service provide some tools like server start and stop scripts for FREME. It should be part of any FREME package.

Quick overview

Configuration options

Package maker does not use any configuration options.

CORS Filter

The CORS filter adds the necessary headers for Cross Origin Resource Sharing to all responses of API requests. In the current implementation it sends these headers:

Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: x-requested-with, content-type

In a future version we plan to allow configuration of these values so one can specify a list of hosts for the header Access-Control-Allow-Origin in the FREME configuration file.

Quick overview

Configuration options

CORS filter does not use any configuration options.

Postprocessing Filter

Linked Data is often considered complicated. Application developers often have no experience with Linked Data formats. Further in some programming languages, e.g. Javascript which is important for websites, do not support Linked Data. For these use cases the postprocessing filters have been developed. This technology converts Linked Open Data to tabular formats like Comma Separated Values. An expert with knowledge about Linked Data technologies can create the filter and the application developer can use it. In this way it is possible to use the Linked Data based workflows of FREME without getting touch with Linked Data. See Simplify output of FREME using SPARQL filters for more information about this feature.

Quick overview

Configuration options

The Postprocessing Filter does not use any configuration options.

Internationalization Filter

The Internalisation Filter enables processing of different input formats like XML, HTML, XLIFF or ODT for several FREME e-services and roundtripping functionality for XML and HTML. See the e-Internationalisation article for more information about this feature.

Quick overview

Configuration options

The Internalisation Filter can be disabled for certain endpoints by adding them to a blacklist.

The parameter accepts a comma separated list of regular expressions which will be matched with the endpoint subpath.

The following configuration disables the filter for all `/e-entity/freme-ner/documents` endpoints:

freme.einternationalization.endpoint-blacklist = /e-entity/freme-ner/documents.*

Logging Filter

The Logging Filter simplifies logging output. It truncates long requests, for instance.

Quick overview

Configuration options

The Logging Filter does not use any configuration options.

e-Internalisation

e-Internalisation implements XML, HTML, ODT and XLIFF to NIF conversion. It is used by Internalisation Filter and NIF Converter. See the e-Internationalisation article for further information.

Quick overview

Configuration options

e-Internalisation does not use any configuration options.

NIF Converter

The NIF Converter enables an api endpoint

/toolbox/nif-converter

which let you convert documents in several formats like PLAIN TEXT, XML, HTML, ODT or XLIFF into NIF. It uses e-Internalisation.

Quick overview

Configuration options

The NIF Converter does not use any configuration options.

SPARQL Converters

SPARQL Converters enables endpoints to manage postprocessing sparql converter at

/toolbox/convert/manage

and the sparql conversion endpoint

/toolbox/convert

This endpoint is used by the Postprocessing Filter. See the article Simplify FREME output using SPARQL filters for more information about this feature.

Quick overview

Configuration options

SPARQL Converters does not use any configuration options.

Users Controller

The Users Controller enables simple user management via the endpoints located at

/user

This is necessary if you use any Restricted Resource in your package. See the Authentication article for further information.

Quick overview

Configuration options

The Users Controller does not use any configuration options.

XSLT Converter

The XSLT Converter enables endpoints to manage xslt-converter at

/toolbox/xslt-converter/manage

and the XSLT conversion endpoint

/toolbox/xslt-converter/documents/{converterName}

See the article XSLT Conversion for more information about this feature.

Quick overview

Configuration options

The XSLT Converter does not use any configuration options.

Tika filter

The Tika Filter makes it possible to upload files of many more formats than those e-internationalization can handle.

Quick overview

Configuration options

When you want to upload a file of any format supported by TIKA, you have to specify the following two additional parameters in your request:

1. filename=THE_NAME_OF_YOUR_FILE
2. informat=TIKAFile