Provide asynchronous event service (AES)
Switch branches/tags
Nothing to show
Clone or download
mreno-EBSCO Merge pull request #5 from folio-org/UXPROD-336
Implement PII message identification (UXPROD-336)
Latest commit 30b42d8 Dec 13, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
descriptors revive data capture poc work Oct 4, 2018
docker revive data capture poc work Oct 4, 2018
src Implement PII message identification (UXPROD-336) Dec 13, 2018
.dockerignore revive data capture poc work Oct 4, 2018
.editorconfig revive data capture poc work Oct 4, 2018
.gitignore revive data capture poc work Oct 4, 2018
CONTRIBUTING.md revive data capture poc work Oct 4, 2018
Dockerfile
Jenkinsfile revive data capture poc work Oct 4, 2018
LICENSE revive data capture poc work Oct 4, 2018
NEWS.md revive data capture poc work Oct 4, 2018
README.md Remove the dev path from the image name in zookeeper Oct 15, 2018
pom.xml Implement PII message identification (UXPROD-336) Dec 13, 2018

README.md

mod-aes

Copyright (C) 2017-2018 The Open Library Foundation

This software is distributed under the terms of the Apache License, Version 2.0. See the file "LICENSE" for more information.

Introduction

The mod-aes module provides FOLIO asynchronous event service (AES)

Permissions

Additional information

Messaging Queue

The reference implementation will use Apache Kafka as the messaging queue and Apache Zookeeper as the coordinator.

To set this up we recommend using docker images as follows:

$ git clone https://github.com/wurstmeister/kafka-docker.git

Edit the docker-compose.yml file as follows:

version: '2'
services:
  zookeeper:
    image: zookeeper
    restart: always
    hostname: zoo1
    ports:
      - 2181:2181
    environment:
      ZOO_MY_ID: 1
      ZOO_SERVERS: server.1=<ZOOKEEPER_IP>:2888:3888
  kafka:
    build: .
    ports:
      - 9092:9092
    environment:
      KAFKA_ADVERTISED_HOST_NAME: <KAFKA_IP>
      KAFKA_ZOOKEEPER_CONNECT: <ZOOKEEPER_IP>:2181
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock

If running on the same machine the KAFKA_IP and ZOOKEEPER_IP will be the same.

Execute the container as follows:

  • Start: $ /usr/local/bin/docker-compose up -d
  • Stop: $ /usr/local/bin/docker-compose stop

Note: you may need to be root (sudo) to do this.

Launch mod-aes as described below.

Example AES input:

$ curl -X POST http://localhost:8081/test -H 'Content-Type: application/json'   -H 'X-Okapi-Tenant: test' -H 'x-okapi-filter: pre'  -d '{"test": "some value"}'

Other documentation

Other modules are described, with further FOLIO Developer documentation at dev.folio.org

Issue tracker

See project MODAES at the FOLIO issue tracker.

Quick start

Compile with mvn clean install

Run the local stand-alone instance:

java -jar target/mod-aes-fat.jar -Dhttp.port=8081 -Dkafka.url=10.23.33.20:9092

API documentation

There is no public API exposed by this module.

Code analysis

SonarQube analysis.

Download and configuration

The built artifacts for this module are available. See configuration for repository access, and the Docker image.