Page History
...
Dette dokument er rettet mod systemadministratorer og driftspersoner, som skal kunne håndtere driftsmæssige aspekter af komponenten.
Driftsvejledningen indeholder information om Napnap-reference-web og Nap-reference facade implementation med hensyn til logning, konfiguration og eksterne afhængigheder, standard placering af logfiler og konfigurationsfiler.
Nap-reference-web
Hvordan fungerer servicen
Single page application med 3 routes:
...
Viser en patientaftaleoversigt ved lave et kald til til nap-reference-facade.
I tilfælde af http fejl vises dette til brugeren.
...
.
Sammenhæng med øvrige dokumenter
Dette dokument er en del af den samlede dokumentation for NAP SDK.
Dokumentet er udformet, så det i videst muligt omfang opfylder sit formål uafhængigt af de øvrige dokumenter.
Ønskes mere information omkring arkitektur og design findes dette på NAP Ref.Impl. - Design og Arkitektur beskrivelse.
Ønskes mere information omkring installationsvejledning til anvender kan findes på NAP Ref.Impl. - Installationsvejledning.
Ønskes mere information omkring anvendelse kan dette findes på NAP Ref.Impl. - Guide til anvendere.
Service snitflade
Nap-refence overskriver kontekstroden i jboss-web.xml og forventer derfor, at være udstillet på /reference. se eventuelt https://svn.nspop.dk/src/components/nap/nap-compose/trunk/haproxy/nap-haproxy.cfg for at se hvordan en ha-proxy konfigureres.
Konfiguration
configurations.json mappes til /pack/webapp/assets/
...
Key
...
Value
...
Konfigurationen kan ændres runtime, men skal matche loadbalancer indstillingerne.
Håndtering af fejlsituationer og logning
Da nap reference web er en stateless webapplikation, som bliver statisk serviceret fra wildfly foregår der ingen logning i denne komponent.
I tilfælde af http fejl bliver kliententen præsenteret med en fejl.
Nap-reference-facade
Hvordan fungerer servicen
Endpoints | Funktionalitet |
---|---|
/aftaler/{cpr} | Validerer den indkommende SAMLassertion efterfølgende CPR samt SOR. |
Overvågning snitflade
Endpoints | Funktionalitet |
---|---|
/isAlive | Bruges af loadbalanceren for at tjekke at servicen er deployet. Returnerer en html side med deployment info. Da denne service ikke er afhængige af database eller andre interne services, returnere den altid 200, hvis applikationen kører. |
Login / logout (OIOSAML)
Endpoints | Funktionalitet |
---|---|
/saml/SAMLAssertionConsumer | Validerer den indkommende OIOSAML token. |
/saml/Logout | Brugeres til at validere autentifikations requests og registrere en brugers assertion i en threadlocal session. |
Konfiguration
Konfiguration
...
af NAP-reference sker i filerne "compose/configuration" mappen som er beskrevet i NAP Ref.Impl. - Installationsvejledning. I det følgende gennemgåes konfigurationsfilernes detaljer.
Følgende konfigurationsfiler Følgende konfigurations filer skal være tilgængelige i classpath under deployment (loades fra applikationsserverens modules/dk/sds/nsp/nap/reference/facade/main).
Konfigurationsfiler | |
---|---|
Filnavn |
Beskrivelse |
log4j-nap-reference-facade.xml |
log4j configuration for applikations log
<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
<log4j:configuration debug="false">
<!-- ================================= -->
<!-- Preserve messages in a local file -->
<!-- ================================= -->
<appender name="FILE" class="org.apache.log4j.RollingFileAppender">
<errorHandler class="org.apache.log4j.helpers.OnlyOnceErrorHandler"/>
<param name="File" value="${jboss.server.log.dir}/nap-ref-facade.log"/>
<param name="Append" value="true"/>
<param name="MaxFileSize" value="${dk.nsp.log.MaxFileSize}"/>
<param name="MaxBackupIndex" value="${dk.nsp.log.MaxBackupIndex}"/>
<layout class="org.apache.log4j.PatternLayout">
<param name="ConversionPattern" value="timestamp="%d" threadId="%t" priority="%p" category="%c" requestId="%X{RequestId}" message="%m"%n"/>
</layout>
</appender>
<!-- ========== -->
<!-- Categories -->
<!-- ========== -->
<category name="dk.sds.nsp">
<priority value="DEBUG"/>
</category>
<category name="ca.uhn">
<priority value="ERROR"/>
</category>
<!-- ======================= -->
<!-- Setup the Root category -->
<!-- ======================= -->
<root>
<priority value="INFO"/>
<appender-ref ref="FILE"/>
</root>
</log4j:configuration>
Applikation properties
# Sti til nap certifikatkeystorePath=nap.jks
# Password to the service provider certificate
keystorePassword=Test1234
# Path where public certificates of trusted STS services are stored
trustedStsCert=trusted-sts-certs.jks
# Password for the trusted sts certifikate keystore
trustedStsCertPassword=password
# Max clock skew
allowedClockDrift=3
# The audience, SAML-tokens are required to have
expectedAudience=https://audience.nspop.dk/nap
# XDS
xdsIti18Wsdl=wsdl/iti18.wsdl
xdsIti18Endpoint=http://test1-cnsp.ekstern-test.nspop.dk:8080/ddsregistry/services/xds-iti18
xdIti43Wsdl=wsdl/iti43.wsdl
xdsIti43Endpoint=http://test1-cnsp.ekstern-test.nspop.dk:8080/ddsrepository/services/xds-iti43
Håndtering af fejlsituationer og logning
Log4j konfigurationen skal findes i log4j-nap-reference-facade.xml på classpath.
Log4j opsætninger der følger gængs standard på NSP. | |
log4j-nspslalog.properties | SLALog opsætninger der følger gængs standard på NSP. |
nap-facade.properties | Applikation properties # Path to the service provider certificate
|
napref-test.jks | JKS fil indeholdende Sundhedsdatastyrelsen nap reference funktionscertifikat certifikat. Skal være samme navn som keystore path i nap-facade.properties |
Konfiguration af oiosaml sker i filerne "compose/configuration/oiosaml".
Der findes en konfiguration til localhost-development, localhost-test1 og test (release til test1 miljøet). De forskellige konfigurationer adskiller sig primært i logout url og service provider url.
Oiosaml konfigurationerne skal ligeledes være tilgængelig i oiosaml.home (oiosaml.home sættes med JAVA_OPTS i compose filerne og er sat til /pack/oiosaml) under deployment.
Konfigurationsfiler | |
---|---|
oiosaml-sp.log4j.xml | lndeholder Log4j opsætninger der følger gængs standard på NSP. |
oiosaml-sp.properties | # Properties used by oiosaml-j oiosaml-sp.certificate.location=
|
napref-test.jks | JKS fil indeholdende Sundhedsdatastyrelsen reference funktionscertifikat certifikat. Skal være samme navn som oiosaml-sp.certificate.location i oiosaml-sp.properties så fx ./certificate/napref-test.jks |
metadata/idP/IdPMetadata.xml | OIOSAML identity provider metadata til konfiguration af OIOSAML filteret |
metadata/SP/SPMetadata.xml | OIOSAML service provider metadata til konfiguration af OIOSAML filteret |
Hele oiosaml-konfigurations-mappen skal udskiftes til de forskellige miljøer. Så fx for local host og test1 ser mapning således ud :
- ../configuration/oiosaml/localhost-development:/pack/oiosaml # localhost
- ../configuration/oiosaml/test1:/pack/oiosaml # test1
Logning
Alle logfiler er at finde i log/ under WildFly. Herunder findes en liste over alle logfiler med en beskrivelse af hvilke komponenter der skriver til dem.
Logfilnavn | Komponenter der skriver til denne |
---|---|
nap-ref-facade.log | nap facade applikationen |
nap-ref-sla.log | nap facade aftale sla-log |
oiosaml-sp.log | OIOSAML log |
oiosaml-sp-audit.log | OIOSAML audit log |
Ved default konfiguration findes applikations loggen i nap-ref-facade.log.
Fejlhåndtering
Applikationsfejl bliver logget ved hjælp af log4j, med type ERROR, INFO, DEBUG alt efter hvor alvorlig fejlen erVed default konfiguration findes applikations loggen i nap-ref-facade.log.