DigitalCollections: cudami Model (Jackson Bindings)

Cudami is a Digital Asset Management System for management and editing of cultural objects.

License

License

Categories

Categories

Jackson Data JSON
GroupId

GroupId

de.digitalcollections.cudami
ArtifactId

ArtifactId

dc-cudami-model-jackson
Last Version

Last Version

2.2.1
Release Date

Release Date

Type

Type

jar
Description

Description

DigitalCollections: cudami Model (Jackson Bindings)
Cudami is a Digital Asset Management System for management and editing of cultural objects.

Download dc-cudami-model-jackson

How to add to project

<!-- https://jarcasting.com/artifacts/de.digitalcollections.cudami/dc-cudami-model-jackson/ -->
<dependency>
    <groupId>de.digitalcollections.cudami</groupId>
    <artifactId>dc-cudami-model-jackson</artifactId>
    <version>2.2.1</version>
</dependency>
// https://jarcasting.com/artifacts/de.digitalcollections.cudami/dc-cudami-model-jackson/
implementation 'de.digitalcollections.cudami:dc-cudami-model-jackson:2.2.1'
// https://jarcasting.com/artifacts/de.digitalcollections.cudami/dc-cudami-model-jackson/
implementation ("de.digitalcollections.cudami:dc-cudami-model-jackson:2.2.1")
'de.digitalcollections.cudami:dc-cudami-model-jackson:jar:2.2.1'
<dependency org="de.digitalcollections.cudami" name="dc-cudami-model-jackson" rev="2.2.1">
  <artifact name="dc-cudami-model-jackson" type="jar" />
</dependency>
@Grapes(
@Grab(group='de.digitalcollections.cudami', module='dc-cudami-model-jackson', version='2.2.1')
)
libraryDependencies += "de.digitalcollections.cudami" % "dc-cudami-model-jackson" % "2.2.1"
[de.digitalcollections.cudami/dc-cudami-model-jackson "2.2.1"]

Dependencies

compile (6)

Group / Artifact Type Version
com.fasterxml.jackson.core : jackson-databind jar 2.9.5
com.fasterxml.jackson.datatype : jackson-datatype-jsr310 jar 2.9.5
de.digitalcollections.commons : dc-commons-prosemirror-model-jackson jar 1.3.0
de.digitalcollections.core : dc-core-model-jackson jar 2.1.0
de.digitalcollections.cudami : dc-cudami-model jar 2.2.1
org.slf4j : slf4j-api jar 1.7.24

test (4)

Group / Artifact Type Version
commons-beanutils : commons-beanutils jar 1.9.3
org.assertj : assertj-core jar 3.7.0
org.junit.jupiter : junit-jupiter-api jar 5.1.0
org.junit.jupiter : junit-jupiter-engine jar 5.1.0

Project Modules

There are no modules declared in this project.

cudami (cultural digital asset management)

Javadocs Build Status Codecov License GitHub release Maven Central

cudami is an editorial backoffice for managing cultural digital assets like websites, articles, digitized objects, digital native objects and entities.

Technologies used:

  • Overall: Java, Spring Boot, Spring Security
  • Frontend: Spring MVC, Thymeleaf, React
  • Business: Java
  • Backend: JDBI/PostgreSql, Flyway

Architecture:

  • Cudami repository server with REST-interface
  • Cudami webapp GUI connected over REST-Interface with cudami repository server as backend.

Model:

Features:

  • Automatic admin user wizard.
  • Multilingual GUI.
  • Login/logout.
  • User management (CRUD)
  • Session logging incl. AOP-logging
  • Layer modularization (Frontend, Business, Backend; each API and IMPL)
  • Completely REST-based repository

Installation

  1. Install PostgreSql:

    on Ubuntu:

    $ apt-cache search postgresql
    ...
    postgresql - object-relational SQL database (supported version)
    postgresql-9.4 - object-relational SQL database, version 9.4 server
    ...
    $ sudo apt-get install postgresql
    
  2. Create a database on your PostgreSql instance:

    $ sudo su - postgres
    
    ($ dropdb 'cudami')
    
    $ psql -c "CREATE USER cudami PASSWORD 'somepassword';"
    
    CREATE ROLE
    
    $ createdb cudami -O cudami
    

    Check:

    List databases:

    $ psql -l
                                      List of databases
       Name    |  Owner   | Encoding |   Collate   |    Ctype    |   Access privileges   
    -----------+----------+----------+-------------+-------------+-----------------------
     postgres  | postgres | UTF8     | en_US.UTF-8 | en_US.UTF-8 |
     template0 | postgres | UTF8     | en_US.UTF-8 | en_US.UTF-8 | =c/postgres          +
               |          |          |             |             | postgres=CTc/postgres
     template1 | postgres | UTF8     | en_US.UTF-8 | en_US.UTF-8 | =c/postgres          +
               |          |          |             |             | postgres=CTc/postgres
     cudami    | cudami   | UTF8     | en_US.UTF-8 | en_US.UTF-8 |
     (4 rows)
    

    List tables of database cudami:

    $ psql -d cudami
    psql (9.5.7, server 9.4.8)
    Type "help" for help.
    
    cudami=# \d
    No relations found.
    cudami=# \q
    
  3. Put your database properties into configuration file(s):

     $ cd <cudami source directory>
     $ vi dc-cudami-server/dc-cudami-server-backend-jdbi/src/main/resources/de/digitalcollections/cudami/config/SpringConfigBackend-<profile>.properties
    
     database.name=cudami
     database.hostname=localhost
     database.password=somepassword
     database.port=5432
     database.username=cudami
    

Build

Build cudami:

$ cd <cudami source directory>
$ mvn clean install

Usage

Run cudami (with "local" profile = configuration for local test)

Start repository and then cudami GUI webapp:

$ java -jar dc-cudami-server-webapp-<VERSION>-exec.jar --spring.profiles.active=local &
$ java -jar dc-cudami-admin-webapp-<VERSION>-exec.jar --spring.profiles.active=local &

Run cudami (with "PROD" profile = configuration for production)

Start repository and then cudami GUI webapp:

$ java -jar dc-cudami-server-webapp-<VERSION>-exec.jar --spring.profiles.active=PROD &
$ java -jar dc-cudami-client-webapp-<VERSION>-exec.jar --spring.profiles.active=PROD &

GUI

Local running cudami: http://localhost:9898

cudami GUI webapp connects to cudami repository server and if no admin user exists, the admin user creation assistant is launched. Create an admin user and log in.

Enjoy!

Development Quickstart using Docker Compose

Installation

Install Docker according to the official Docker documentation. Install Docker Compose according to the official documentation.

Debian 9

$ su -
# apt-get install apt-transport-https dirmngr
# echo 'deb https://apt.dockerproject.org/repo debian-stretch main' >> /etc/apt/sources.list
# apt-key adv --keyserver hkp://p80.pool.sks-keyservers.net:80 --recv-keys F76221572C52609D
Executing: /tmp/apt-key-gpghome.wDKSqs4VYM/gpg.1.sh --keyserver hkp://p80.pool.sks-keyservers.net:80 --recv-keys F76221572C52609D
gpg: key F76221572C52609D: public key "Docker Release Tool (releasedocker) <[email protected]>" imported
gpg: Total number processed: 1
gpg:               imported: 1
# apt-get update
# apt-get install docker-engine
# apt-get install docker-compose

Configuration

All Linux

Add your user to docker group to run docker without sudo:

$ sudo groupadd docker
$ sudo gpasswd -a yourusername docker
$ sudo service docker restart

Usage

To get cudami quickly up running, you can start all backend services using Docker Compose:

$ cd docker
$ docker-compose build
$ docker-compose up -d

Then PostgreSql is running in a container and everything is ready for running a local instance of cudami (see below).

To start cudami server webapp, you have to run:

$ cd dc-cudami-server/dc-cudami-server-webapp/target
$ java -jar dc-cudami-server-webapp-<VERSION>.jar

The cudami server webapp is now running under http://localhost:9000/.

To start cudami admin webapp, you have to run:

$ cd dc-cudami-admin/dc-cudami-admin-webapp/target
$ java -jar dc-cudami-admin-webapp-<VERSION>.jar

The cudami admin webapp is now running under http://localhost:9898/.

To stop the container run

$ cd dc-cudami-server
$ docker-compose stop

To delete the container and all data:

$ cd dc-cudami-server
$ docker-compose down

Migrations from 3.1.1 to 3.2.2

  • Stop 3.1.1 cudami backend server webapp, manually rename table "schema_version" to "flyway_schema_history":
alter table schema_version rename to flyway_schema_history;
  • Deploy cudami 3.2.2
  • Start 3.2.2
de.digitalcollections.cudami

Open Source at the Bayerische Staatsbibliothek

...from the MDZ Digital Library team at the Bavarian State Library

Versions

Version
2.2.1
2.2.0