CoSys Integration

Integration for creating documents with coSys. Uses s3-integration for file handling.

Modules

The modules follow the default naming convention.

Dependency graph

The following graph shows the relationships between the various modules and how they interact and rely on each other.

Usage

<dependencies>
    <dependency>
        <groupId>de.muenchen.refarch</groupId>
        <artifactId>refarch-cosys-integration-starter</artifactId>
        <version>...</version>
    </dependency>
</dependencies>

Additionally, a specific s3-integration-*-client-starter is required as dependency, because S3 is used for file handling. See according documentation.

Configuration

Following are the properties to configure the different modules. Some of them are custom defined and others are synonyms for spring package properties. Whether a property is an alias can be checked in the corresponding application.yml of each module.

refarch-cosys-integration-starter

Property	Description	Example
refarch.cosys.url	Url of the CoSys service
refarch.cosys.merge.datafile		/root/multi
refarch.cosys.merge.inputLanguage	incoming language	Deutsch
refarch.cosys.merge.outputLanguage	outgoing language	Deutsch
refarch.cosys.merge.keepFields		unresolved-ref

For authentication against cosys a OAuth2 registration with the name cosys needs to be provided. See following example or the according Spring documentation.

spring:
  security:
    oauth2:
      client:
        provider:
          sso:
            issuer-uri: https://sso.example.com/auth/realms/refarch
            user-info-uri: ${spring.security.oauth2.client.provider.sso.issuer-uri}/protocol/openid-connect/userinfo
            jwk-set-uri: ${spring.security.oauth2.client.provider.sso.issuer-uri}/protocol/openid-connect/certs
            # used for RequestResponseLoggingFilter in s3-rest-service
            # only required if filter is explicitly enabled
            user-name-attribute: user_name
        registration:
          cosys:
            provider: sso
            authorization-grant-type: client_credentials
            client-id: refarch_client
            client-secret: client_secret_123
            # profile required for username used in s3-rest-service RequestResponseLoggingFilter
            # openid required for user info endpoint used in s3-rest-service JwtUserInfoAuthenticationConverter
            # both scopes are only required if the according functions are explicitly used
            scope: profile, openid