file_id
stringlengths 4
10
| content
stringlengths 91
42.8k
| repo
stringlengths 7
108
| path
stringlengths 7
251
| token_length
int64 34
8.19k
| original_comment
stringlengths 11
11.5k
| comment_type
stringclasses 2
values | detected_lang
stringclasses 1
value | prompt
stringlengths 34
42.8k
|
|---|---|---|---|---|---|---|---|---|
201762_6 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/branches/v0.2.2-snapshot-technical-rework/business/src/main/java/nl/bzk/brp/business/handlers/bevraging/OpvragenPersoonBerichtUitvoerStap.java | 6,065 | // TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer<SUF>
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
|
201762_8 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/branches/v0.2.2-snapshot-technical-rework/business/src/main/java/nl/bzk/brp/business/handlers/bevraging/OpvragenPersoonBerichtUitvoerStap.java | 6,065 | // dummy statement ! voor sonar/findbugs/checktyle
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement<SUF>
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
|
201762_9 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/branches/v0.2.2-snapshot-technical-rework/business/src/main/java/nl/bzk/brp/business/handlers/bevraging/OpvragenPersoonBerichtUitvoerStap.java | 6,065 | // Alle null waardes er uit halen (kunnen voorkomen)
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null<SUF>
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
|
201762_10 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/branches/v0.2.2-snapshot-technical-rework/business/src/main/java/nl/bzk/brp/business/handlers/bevraging/OpvragenPersoonBerichtUitvoerStap.java | 6,065 | /**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/ | block_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een<SUF>*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
|
201762_11 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/branches/v0.2.2-snapshot-technical-rework/business/src/main/java/nl/bzk/brp/business/handlers/bevraging/OpvragenPersoonBerichtUitvoerStap.java | 6,065 | /**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/ | block_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont<SUF>*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
|
201762_12 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/branches/v0.2.2-snapshot-technical-rework/business/src/main/java/nl/bzk/brp/business/handlers/bevraging/OpvragenPersoonBerichtUitvoerStap.java | 6,065 | // loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door<SUF>
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
|
201762_13 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/branches/v0.2.2-snapshot-technical-rework/business/src/main/java/nl/bzk/brp/business/handlers/bevraging/OpvragenPersoonBerichtUitvoerStap.java | 6,065 | // We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten<SUF>
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
|
201762_14 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/branches/v0.2.2-snapshot-technical-rework/business/src/main/java/nl/bzk/brp/business/handlers/bevraging/OpvragenPersoonBerichtUitvoerStap.java | 6,065 | // altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de<SUF>
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
|
201762_16 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/branches/v0.2.2-snapshot-technical-rework/business/src/main/java/nl/bzk/brp/business/handlers/bevraging/OpvragenPersoonBerichtUitvoerStap.java | 6,065 | // relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met<SUF>
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
|
201762_17 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/branches/v0.2.2-snapshot-technical-rework/business/src/main/java/nl/bzk/brp/business/handlers/bevraging/OpvragenPersoonBerichtUitvoerStap.java | 6,065 | /**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/ | block_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle<SUF>*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
|
201762_18 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/branches/v0.2.2-snapshot-technical-rework/business/src/main/java/nl/bzk/brp/business/handlers/bevraging/OpvragenPersoonBerichtUitvoerStap.java | 6,065 | // deze validatie(s) zou eerder moeten gebeuren.
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s)<SUF>
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
|
201762_19 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/branches/v0.2.2-snapshot-technical-rework/business/src/main/java/nl/bzk/brp/business/handlers/bevraging/OpvragenPersoonBerichtUitvoerStap.java | 6,065 | // TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding<SUF>
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
|
201762_20 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/branches/v0.2.2-snapshot-technical-rework/business/src/main/java/nl/bzk/brp/business/handlers/bevraging/OpvragenPersoonBerichtUitvoerStap.java | 6,065 | // TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding<SUF>
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
|
201762_21 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/branches/v0.2.2-snapshot-technical-rework/business/src/main/java/nl/bzk/brp/business/handlers/bevraging/OpvragenPersoonBerichtUitvoerStap.java | 6,065 | // zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in<SUF>
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
|
201762_22 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/branches/v0.2.2-snapshot-technical-rework/business/src/main/java/nl/bzk/brp/business/handlers/bevraging/OpvragenPersoonBerichtUitvoerStap.java | 6,065 | // met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het<SUF>
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
|
201762_24 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/branches/v0.2.2-snapshot-technical-rework/business/src/main/java/nl/bzk/brp/business/handlers/bevraging/OpvragenPersoonBerichtUitvoerStap.java | 6,065 | /**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/ | block_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle<SUF>*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
|
201762_25 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/branches/v0.2.2-snapshot-technical-rework/business/src/main/java/nl/bzk/brp/business/handlers/bevraging/OpvragenPersoonBerichtUitvoerStap.java | 6,065 | // Zoek verder met de PersistentPersoonAdres
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder<SUF>
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
|
201762_26 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/branches/v0.2.2-snapshot-technical-rework/business/src/main/java/nl/bzk/brp/business/handlers/bevraging/OpvragenPersoonBerichtUitvoerStap.java | 6,065 | // Zoeken met IdentificatiecodeNummeraanduiding
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met<SUF>
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
|
201762_27 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/branches/v0.2.2-snapshot-technical-rework/business/src/main/java/nl/bzk/brp/business/handlers/bevraging/OpvragenPersoonBerichtUitvoerStap.java | 6,065 | // Resultaat moet op zijn minst de persoon zelf teruggeven.
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet<SUF>
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
|
201762_29 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/branches/v0.2.2-snapshot-technical-rework/business/src/main/java/nl/bzk/brp/business/handlers/bevraging/OpvragenPersoonBerichtUitvoerStap.java | 6,065 | // Zoeken met postcode huisnummer
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met<SUF>
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
|
201762_30 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/branches/v0.2.2-snapshot-technical-rework/business/src/main/java/nl/bzk/brp/business/handlers/bevraging/OpvragenPersoonBerichtUitvoerStap.java | 6,065 | // Zoeken met postcode huisnummer
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met<SUF>
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
|
201762_32 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/branches/v0.2.2-snapshot-technical-rework/business/src/main/java/nl/bzk/brp/business/handlers/bevraging/OpvragenPersoonBerichtUitvoerStap.java | 6,065 | // Zoeken met postcode huisnummer
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met<SUF>
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
|
201762_33 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/branches/v0.2.2-snapshot-technical-rework/business/src/main/java/nl/bzk/brp/business/handlers/bevraging/OpvragenPersoonBerichtUitvoerStap.java | 6,065 | // Zoeken met postcode huisnummer
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met<SUF>
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
|
201762_34 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/branches/v0.2.2-snapshot-technical-rework/business/src/main/java/nl/bzk/brp/business/handlers/bevraging/OpvragenPersoonBerichtUitvoerStap.java | 6,065 | /**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/ | block_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het<SUF>*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
|
201762_35 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/branches/v0.2.2-snapshot-technical-rework/business/src/main/java/nl/bzk/brp/business/handlers/bevraging/OpvragenPersoonBerichtUitvoerStap.java | 6,065 | /**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/ | block_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het<SUF>*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
|
201762_36 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/branches/v0.2.2-snapshot-technical-rework/business/src/main/java/nl/bzk/brp/business/handlers/bevraging/OpvragenPersoonBerichtUitvoerStap.java | 6,065 | /**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/ | block_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het<SUF>*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
|
201762_37 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/branches/v0.2.2-snapshot-technical-rework/business/src/main/java/nl/bzk/brp/business/handlers/bevraging/OpvragenPersoonBerichtUitvoerStap.java | 6,065 | /**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/ | block_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek<SUF>*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
|
201762_38 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/branches/v0.2.2-snapshot-technical-rework/business/src/main/java/nl/bzk/brp/business/handlers/bevraging/OpvragenPersoonBerichtUitvoerStap.java | 6,065 | /**
* Bepaalt of zoek opdracht met postcode en huisnummer uitgevoerd mag worden. Hier wordt gekeken naar postcode en
* huisnummer.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als postcode en huisnummer zijn ingevuld.
*/ | block_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.business.handlers.bevraging;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.inject.Inject;
import nl.bzk.brp.business.dto.BerichtContext;
import nl.bzk.brp.business.dto.bevraging.AbstractBevragingsBericht;
import nl.bzk.brp.business.dto.bevraging.OpvragenPersoonResultaat;
import nl.bzk.brp.business.dto.bevraging.VraagDetailsPersoonBericht;
import nl.bzk.brp.business.dto.bevraging.VraagKandidaatVaderBericht;
import nl.bzk.brp.business.dto.bevraging.VraagPersonenOpAdresInclusiefBetrokkenhedenBericht;
import nl.bzk.brp.business.dto.bevraging.zoekcriteria.ZoekCriteriaPersoonOpAdres;
import nl.bzk.brp.business.handlers.AbstractBerichtVerwerkingsStap;
import nl.bzk.brp.dataaccess.repository.PersoonRepository;
import nl.bzk.brp.dataaccess.repository.RelatieRepository;
import nl.bzk.brp.dataaccess.selectie.RelatieSelectieFilter;
import nl.bzk.brp.model.attribuuttype.Datum;
import nl.bzk.brp.model.attribuuttype.Huisletter;
import nl.bzk.brp.model.attribuuttype.Huisnummer;
import nl.bzk.brp.model.attribuuttype.Huisnummertoevoeging;
import nl.bzk.brp.model.attribuuttype.Ja;
import nl.bzk.brp.model.attribuuttype.Postcode;
import nl.bzk.brp.model.objecttype.operationeel.BetrokkenheidModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonAdresModel;
import nl.bzk.brp.model.objecttype.operationeel.PersoonModel;
import nl.bzk.brp.model.objecttype.operationeel.RelatieModel;
import nl.bzk.brp.model.objecttype.operationeel.statisch.Geslachtsaanduiding;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortBetrokkenheid;
import nl.bzk.brp.model.objecttype.operationeel.statisch.SoortMelding;
import nl.bzk.brp.model.validatie.Melding;
import nl.bzk.brp.model.validatie.MeldingCode;
import nl.bzk.brp.util.AttribuutTypeUtil;
import nl.bzk.brp.util.ObjectUtil;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
/** Uitvoer stap die het opvragen van een persoon afhandelt. De persoon wordt via de DAL laag opgehaald. */
public class OpvragenPersoonBerichtUitvoerStap extends
AbstractBerichtVerwerkingsStap<AbstractBevragingsBericht, OpvragenPersoonResultaat>
{
@Inject
private PersoonRepository persoonRepository;
@Inject
private RelatieRepository relatieRepository;
@Override
public boolean voerVerwerkingsStapUitVoorBericht(final AbstractBevragingsBericht bericht,
final BerichtContext context,
final OpvragenPersoonResultaat resultaat)
{
boolean verwerkingsResultaat;
if (bericht instanceof VraagDetailsPersoonBericht) {
verwerkingsResultaat = vraagOpDetailPersoon((VraagDetailsPersoonBericht) bericht, resultaat);
} else if (bericht instanceof VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) {
verwerkingsResultaat =
vraagOpPersonenOpAdresInclusiefBetrokkenheden(
(VraagPersonenOpAdresInclusiefBetrokkenhedenBericht) bericht, resultaat);
} else if (bericht instanceof VraagKandidaatVaderBericht) {
verwerkingsResultaat = vraagOpKandidaatVader((VraagKandidaatVaderBericht) bericht, resultaat);
} else {
verwerkingsResultaat = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
}
return verwerkingsResultaat;
}
/**
* Methode om persoon details op te halen.
*
* @param bericht het VraagDetailsPersoonBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpDetailPersoon(final VraagDetailsPersoonBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean metHistorie = false;
boolean inclFormeleHistorie = false;
if (bericht.getVraag().getVraagOpties() != null) {
if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieFormeel()) {
metHistorie = true;
inclFormeleHistorie = true;
} else if (Ja.Ja == bericht.getVraag().getVraagOpties().getHistorieMaterieel()) {
metHistorie = true;
}
}
final PersoonModel gevondenPersoon =
persoonRepository.haalPersoonOpMetBurgerservicenummer(bericht.getVraag()
.getZoekCriteria().getBurgerservicenummer());
if (gevondenPersoon != null) {
if (metHistorie) {
persoonRepository.vulaanAdresMetHistorie(gevondenPersoon, inclFormeleHistorie);
}
resultaat.setGevondenPersonen(new HashSet<PersoonModel>());
resultaat.getGevondenPersonen().add(gevondenPersoon);
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* Methode om alle personen op te halen die op het adres zijn ingeschreven op basis van de vraag in het bericht.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht.
* @param resultaat een set met gevonden personen.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpPersonenOpAdresInclusiefBetrokkenheden(
final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht, final OpvragenPersoonResultaat resultaat)
{
List<PersoonModel> gevondenPersonen = new ArrayList<PersoonModel>();
if (isBsnCriteria(bericht)) {
gevondenPersonen =
persoonRepository.haalPersonenMetWoonAdresOpViaBurgerservicenummer(bericht
.getVraag().getZoekCriteria().getBurgerservicenummer());
if (CollectionUtils.isNotEmpty(gevondenPersonen)
&& CollectionUtils.isNotEmpty(gevondenPersonen.get(0).getAdressen()))
{
// Uitgaande van dat er maar 1 persoon terugkomt met bsn zoek vraag.
// Uitgaande dat er er maar 1 woon adres aanwezig kan zijn.
PersoonAdresModel persoonAdres = gevondenPersonen.get(0).getAdressen().iterator().next();
gevondenPersonen = haalAllePersonenOpMetAdres(persoonAdres);
}
} else if (isPostcodeCriteria(bericht)) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
gevondenPersonen =
persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
new Postcode(zoekCriteria.getPostcode()), new Huisnummer(zoekCriteria.getHuisnummer()),
new Huisletter(zoekCriteria.getHuisletter()),
new Huisnummertoevoeging(zoekCriteria.getHuisnummertoevoeging()));
} else if (isGemCodeCriteria(bericht)) {
// TODO implementeer aanroep naar juiste methode om te zoeken met gemeente adres
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
} else {
// dummy statement ! voor sonar/findbugs/checktyle
gevondenPersonen.isEmpty();
}
// Alle null waardes er uit halen (kunnen voorkomen)
gevondenPersonen.removeAll(Collections.singletonList(null));
if (CollectionUtils.isNotEmpty(gevondenPersonen)) {
verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(gevondenPersonen);
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(gevondenPersonen));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Er zijn geen personen gevonden die voldoen aan de opgegeven criteria.",
bericht.getVraag().getZoekCriteria(), ""));
}
return AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
/**
* test of een persoon (betrokkene) in een list van personen bevindt. Er wordt alleen gekeken naar de persoon.id.
* We kunnen niet zo maar .contains(object) gebruiker, omdat de lijst is een 'simpel persoon' en de betrokkene
* een 'referentie persoon' is.
*
* @param gevondenPersonen de lijst van personen
* @param betrokkene de betrokkene
* @return true als deze in de lijst zit, false anders.
*/
private boolean isBetrokkeneInGevondenPersonen(final List<PersoonModel> gevondenPersonen,
final PersoonModel betrokkene)
{
boolean resultaat = false;
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getId().equals(betrokkene.getId())) {
resultaat = true;
break;
}
}
return resultaat;
}
/**
* Deze methode schoont alle betrokkene van de gevonden personen die niet op dit adres wonen.
*
* @param gevondenPersonen de lijst van gevonden personen.
*/
private void verwijderAlleBetrokkeneNietWondendOpZelfdeAdres(final List<PersoonModel> gevondenPersonen) {
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
for (BetrokkenheidModel betrokkenheid : persoon.getBetrokkenheden()) {
RelatieModel relatie = betrokkenheid.getRelatie();
// loop door een 'copy' omdat we anders een concurrent probleem hebben tijdens het verwijderen.
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(relatie.getBetrokkenheden());
for (BetrokkenheidModel bPartner : copy) {
if (!isBetrokkeneInGevondenPersonen(gevondenPersonen, bPartner.getBetrokkene())) {
relatie.getBetrokkenheden().remove(bPartner);
}
}
}
}
}
for (PersoonModel persoon : gevondenPersonen) {
if (persoon.getBetrokkenheden() != null) {
// We moeten nu opschonen, elk relatie dat slechts 1 'member' heeft gaat niet goed; want dat is
// altijd de persoon himself. Verwijder de realtie EN daarmee de betrokkenheid.
// for some reason, binding gaat fout met alleen 1-member link
List<BetrokkenheidModel> copy = new ArrayList<BetrokkenheidModel>(persoon.getBetrokkenheden());
for (BetrokkenheidModel betrokkenheid : copy) {
if (betrokkenheid.getRelatie().getBetrokkenheden().size() <= 1) {
// relatie met 1 of minder betrkkenheden is geen relatie. verwijder deze (dus ook de
// betrokkenheid.
persoon.getBetrokkenheden().remove(betrokkenheid);
}
}
}
}
}
/**
* Methode om alle personen op te halen die mogelijk de vader zou kunnen zijn .
*
* @param bericht het bericht
* @param resultaat de lijst van personen die potentieel vader kunnen zijn.
* @return een boolean die aangeeft of de stap succesvol is uitgevoerd (true) of niet (false).
*/
private boolean vraagOpKandidaatVader(final VraagKandidaatVaderBericht bericht,
final OpvragenPersoonResultaat resultaat)
{
boolean retval = AbstractBerichtVerwerkingsStap.STOP_VERWERKING;
PersoonModel moeder =
persoonRepository.findByBurgerservicenummer(bericht.getVraag().getZoekCriteria()
.getBurgerservicenummer());
// deze validatie(s) zou eerder moeten gebeuren.
if (moeder == null) {
// TODO Foutmelding 'BSN onbekend', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"BSN is onbekend.", bericht.getVraag().getZoekCriteria(), "burgerservicenummer"));
} else if (moeder.getGeslachtsaanduiding().getGeslachtsaanduiding() != Geslachtsaanduiding.VROUW) {
// TODO Foutmelding 'BSN is geen Vrouw', moet aangemaakt worden, voorlopg een generieke
resultaat.voegMeldingToe(new Melding(SoortMelding.FOUT, MeldingCode.ALG0001,
"De persoon is niet van het vrouwelijk geslacht.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
} else {
List<PersoonModel> kandidaatVaders = new ArrayList<PersoonModel>();
// zoek in de relaties, welke persone hebben een 'huwelijk' relatie met de moeder, rekening houdend
// met het geslacht van de partner (== man) en dat de relatie geldig is op het moment van de
// peilDatum (aka. geboorteDatumKind).
//
RelatieSelectieFilter filter = new RelatieSelectieFilter();
filter.setSoortRelaties();
filter.setSoortBetrokkenheden(SoortBetrokkenheid.PARTNER);
filter.setUitGeslachtsaanduidingen(Geslachtsaanduiding.MAN);
filter.setPeilDatum(new Datum(bericht.getVraag().getZoekCriteria().getGeboortedatumKind()));
List<Integer> persoonIds = relatieRepository.haalopPersoonIdsVanRelatiesVanPersoon(moeder.getId(), filter);
for (Integer id : persoonIds) {
kandidaatVaders.add(persoonRepository.haalPersoonMetAdres(id));
}
if (!kandidaatVaders.isEmpty()) {
resultaat.setGevondenPersonen(new HashSet<PersoonModel>(kandidaatVaders));
} else {
resultaat.voegMeldingToe(new Melding(SoortMelding.INFORMATIE, MeldingCode.ALG0001,
"Kandidaat-vader kan niet worden bepaald.", bericht.getVraag().getZoekCriteria(),
"burgerservicenummer"));
}
retval = AbstractBerichtVerwerkingsStap.DOORGAAN_MET_VERWERKING;
}
return retval;
}
/**
* Algoritme om alle personen op te halen die wonen op een adres.
* <p/>
* Zoekmethoden:
* 1. identificatiecodeNummeraanduiding
* 2. combinatie NaamOpenbareRuimte, Huisnummer, Huisletter, HuisnummerToevoeging, LocatieOmschrijving,
* LocatieTOVAdres en Woonplaats gelijk zijn, mits NaamOpenbareRuimte, Huisnummer en Woonplaats gevuld zijn
* 3. De combinatie Postcode, huisnummer, Huisletter en HuisnummerToevoeging gelijk zijn, mits postcode en huis
* gevuld zijn.
* <p/>
* Wanneer met de ene methode niks gevonden wordt dan wordt de volgende methode uitgeprobeerd.
*
* @param persoonAdres PersistentPersoonAdres waarmee gezocht moet worden.
* @return alle personen die op het adres wonen.
* @brp.bedrijfsregel BRPUC50121
*/
private List<PersoonModel> haalAllePersonenOpMetAdres(final PersoonAdresModel persoonAdres) {
List<PersoonModel> resultaat = new ArrayList<PersoonModel>();
if (persoonAdres != null) {
// Zoek verder met de PersistentPersoonAdres
if (AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getIdentificatiecodeNummeraanduiding())) {
// Zoeken met IdentificatiecodeNummeraanduiding
resultaat =
persoonRepository.haalPersonenMetWoonAdresOpViaIdentificatiecodeNummeraanduiding(persoonAdres
.getGegevens().getIdentificatiecodeNummeraanduiding());
// Resultaat moet op zijn minst de persoon zelf teruggeven.
if (resultaat.size() < 2) {
if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
}
} else if (isZoekbaarMetVolledigAdres(persoonAdres)) {
// Zoeken met volledige adres
resultaat = persoonRepository.haalPersonenMetWoonAdresOpViaVolledigAdres(
persoonAdres.getGegevens().getNaamOpenbareRuimte(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging(),
persoonAdres.getGegevens().getWoonplaats(),
persoonAdres.getGegevens().getGemeente());
if (resultaat.size() < 2 && isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
}
} else if (isZoekbaarMetOpPostcodeHuisnummer(persoonAdres)) {
// Zoeken met postcode huisnummer
resultaat = persoonRepository.haalPersonenOpMetAdresViaPostcodeHuisnummer(
persoonAdres.getGegevens().getPostcode(),
persoonAdres.getGegevens().getHuisnummer(),
persoonAdres.getGegevens().getHuisletter(),
persoonAdres.getGegevens().getHuisnummertoevoeging());
} else {
resultaat.add(persoonAdres.getPersoon());
}
}
return resultaat;
}
/**
* Controlleer of het om een bsn zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als alleen de BSN is ingevuld in het zoek bericht
*/
private boolean isBsnCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return AttribuutTypeUtil.isNotBlank(zoekCriteria.getBurgerservicenummer())
&& ObjectUtil.isAllEmpty(zoekCriteria.getPostcode(), zoekCriteria.getHuisnummer(),
zoekCriteria.getHuisletter(), zoekCriteria.getHuisnummertoevoeging(),
zoekCriteria.getNaamOpenbareRuimte(), zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een postcode zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om postcode huisnummer zoek criteria gaat
*/
private boolean isPostcodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return StringUtils.isNotBlank(zoekCriteria.getPostcode())
&& zoekCriteria.getHuisnummer() != null
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getNaamOpenbareRuimte(),
zoekCriteria.getGemeentecode());
}
/**
* Controlleer of het om een gemeente code zoek criteria gaat.
*
* @param bericht het VraagPersonenOpAdresInclusiefBetrokkenhedenBericht
* @return true als het gaat om plaats adres huisnummer zoek criteria gaat
*/
private boolean isGemCodeCriteria(final VraagPersonenOpAdresInclusiefBetrokkenhedenBericht bericht) {
ZoekCriteriaPersoonOpAdres zoekCriteria = bericht.getVraag().getZoekCriteria();
return zoekCriteria.getHuisnummer() != null
&& StringUtils.isNotBlank(zoekCriteria.getNaamOpenbareRuimte())
&& StringUtils.isNotBlank(zoekCriteria.getGemeentecode())
&& ObjectUtil.isAllEmpty(zoekCriteria.getBurgerservicenummer(), zoekCriteria.getPostcode());
}
/**
* Bepaalt of zoek opdracht met volledige adres uitgevoerd mag worden. Hier wordt gekeken of NaamOpenbareRuimte,
* huisnummer en woonplaats is ingevuld.
*
* @param persoonAdres adres dat gecontrolleerd moet worden.
* @return true als de genoemde velden gevuld zijn.
*/
private boolean isZoekbaarMetVolledigAdres(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getNaamOpenbareRuimte())
&& persoonAdres.getGegevens().getHuisnummer() != null
&& persoonAdres.getGegevens().getHuisnummer().getWaarde() != null
&& persoonAdres.getGegevens().getWoonplaats() != null;
}
/**
* Bepaalt of zoek<SUF>*/
private boolean isZoekbaarMetOpPostcodeHuisnummer(final PersoonAdresModel persoonAdres) {
return AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getPostcode())
&& AttribuutTypeUtil.isNotBlank(persoonAdres.getGegevens().getHuisnummer());
}
}
|
201763_2 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
*/
protected Node verzendBerichtNaarService(final String berichtBestand)
throws WSSecurityException, KeyStoreException, IOException, SOAPException, SAXException,
ParserConfigurationException, TransformerConfigurationException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream)
throws ParserConfigurationException, IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request)
throws WSSecurityException, KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate(
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init()
throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException, CertificateException
{
securityProperties = new Properties();
securityProperties.load(
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde {@link
* KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[]{
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs
* en/of Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden
* aan deze methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
final URL wsdl = new URL("http://localhost:8181/brp/services/bijhouding?wsdl");
// Definieer de service middels de betreffende NameSpace en de naam in de WSDL
QName serviceName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingService");
Service s = Service.create(wsdl, serviceName);
// Definieer de port middels de betreffende NameSpace en de naam in de WSDL
QName portName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingPort");
dispatcher = s.createDispatch(portName, SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore()
throws KeyStoreException, IOException, NoSuchAlgorithmException, CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream(
"/" + securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/tags/v0.0.3/webservice/src/test/java/nl/bzk/brp/web/AbstractIntegrationTest.java | 3,529 | /**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
*/ | block_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor<SUF>*/
protected Node verzendBerichtNaarService(final String berichtBestand)
throws WSSecurityException, KeyStoreException, IOException, SOAPException, SAXException,
ParserConfigurationException, TransformerConfigurationException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream)
throws ParserConfigurationException, IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request)
throws WSSecurityException, KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate(
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init()
throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException, CertificateException
{
securityProperties = new Properties();
securityProperties.load(
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde {@link
* KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[]{
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs
* en/of Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden
* aan deze methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
final URL wsdl = new URL("http://localhost:8181/brp/services/bijhouding?wsdl");
// Definieer de service middels de betreffende NameSpace en de naam in de WSDL
QName serviceName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingService");
Service s = Service.create(wsdl, serviceName);
// Definieer de port middels de betreffende NameSpace en de naam in de WSDL
QName portName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingPort");
dispatcher = s.createDispatch(portName, SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore()
throws KeyStoreException, IOException, NoSuchAlgorithmException, CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream(
"/" + securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
}
|
201763_3 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
*/
protected Node verzendBerichtNaarService(final String berichtBestand)
throws WSSecurityException, KeyStoreException, IOException, SOAPException, SAXException,
ParserConfigurationException, TransformerConfigurationException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream)
throws ParserConfigurationException, IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request)
throws WSSecurityException, KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate(
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init()
throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException, CertificateException
{
securityProperties = new Properties();
securityProperties.load(
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde {@link
* KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[]{
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs
* en/of Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden
* aan deze methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
final URL wsdl = new URL("http://localhost:8181/brp/services/bijhouding?wsdl");
// Definieer de service middels de betreffende NameSpace en de naam in de WSDL
QName serviceName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingService");
Service s = Service.create(wsdl, serviceName);
// Definieer de port middels de betreffende NameSpace en de naam in de WSDL
QName portName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingPort");
dispatcher = s.createDispatch(portName, SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore()
throws KeyStoreException, IOException, NoSuchAlgorithmException, CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream(
"/" + securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/tags/v0.0.3/webservice/src/test/java/nl/bzk/brp/web/AbstractIntegrationTest.java | 3,529 | // Lees het verhuis bericht uit een xml bestand
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
*/
protected Node verzendBerichtNaarService(final String berichtBestand)
throws WSSecurityException, KeyStoreException, IOException, SOAPException, SAXException,
ParserConfigurationException, TransformerConfigurationException
{
// Lees het<SUF>
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream)
throws ParserConfigurationException, IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request)
throws WSSecurityException, KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate(
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init()
throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException, CertificateException
{
securityProperties = new Properties();
securityProperties.load(
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde {@link
* KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[]{
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs
* en/of Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden
* aan deze methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
final URL wsdl = new URL("http://localhost:8181/brp/services/bijhouding?wsdl");
// Definieer de service middels de betreffende NameSpace en de naam in de WSDL
QName serviceName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingService");
Service s = Service.create(wsdl, serviceName);
// Definieer de port middels de betreffende NameSpace en de naam in de WSDL
QName portName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingPort");
dispatcher = s.createDispatch(portName, SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore()
throws KeyStoreException, IOException, NoSuchAlgorithmException, CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream(
"/" + securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
}
|
201763_4 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
*/
protected Node verzendBerichtNaarService(final String berichtBestand)
throws WSSecurityException, KeyStoreException, IOException, SOAPException, SAXException,
ParserConfigurationException, TransformerConfigurationException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream)
throws ParserConfigurationException, IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request)
throws WSSecurityException, KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate(
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init()
throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException, CertificateException
{
securityProperties = new Properties();
securityProperties.load(
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde {@link
* KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[]{
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs
* en/of Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden
* aan deze methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
final URL wsdl = new URL("http://localhost:8181/brp/services/bijhouding?wsdl");
// Definieer de service middels de betreffende NameSpace en de naam in de WSDL
QName serviceName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingService");
Service s = Service.create(wsdl, serviceName);
// Definieer de port middels de betreffende NameSpace en de naam in de WSDL
QName portName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingPort");
dispatcher = s.createDispatch(portName, SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore()
throws KeyStoreException, IOException, NoSuchAlgorithmException, CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream(
"/" + securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/tags/v0.0.3/webservice/src/test/java/nl/bzk/brp/web/AbstractIntegrationTest.java | 3,529 | // Bouw het initiele request bericht
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
*/
protected Node verzendBerichtNaarService(final String berichtBestand)
throws WSSecurityException, KeyStoreException, IOException, SOAPException, SAXException,
ParserConfigurationException, TransformerConfigurationException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het<SUF>
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream)
throws ParserConfigurationException, IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request)
throws WSSecurityException, KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate(
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init()
throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException, CertificateException
{
securityProperties = new Properties();
securityProperties.load(
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde {@link
* KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[]{
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs
* en/of Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden
* aan deze methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
final URL wsdl = new URL("http://localhost:8181/brp/services/bijhouding?wsdl");
// Definieer de service middels de betreffende NameSpace en de naam in de WSDL
QName serviceName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingService");
Service s = Service.create(wsdl, serviceName);
// Definieer de port middels de betreffende NameSpace en de naam in de WSDL
QName portName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingPort");
dispatcher = s.createDispatch(portName, SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore()
throws KeyStoreException, IOException, NoSuchAlgorithmException, CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream(
"/" + securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
}
|
201763_5 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
*/
protected Node verzendBerichtNaarService(final String berichtBestand)
throws WSSecurityException, KeyStoreException, IOException, SOAPException, SAXException,
ParserConfigurationException, TransformerConfigurationException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream)
throws ParserConfigurationException, IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request)
throws WSSecurityException, KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate(
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init()
throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException, CertificateException
{
securityProperties = new Properties();
securityProperties.load(
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde {@link
* KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[]{
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs
* en/of Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden
* aan deze methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
final URL wsdl = new URL("http://localhost:8181/brp/services/bijhouding?wsdl");
// Definieer de service middels de betreffende NameSpace en de naam in de WSDL
QName serviceName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingService");
Service s = Service.create(wsdl, serviceName);
// Definieer de port middels de betreffende NameSpace en de naam in de WSDL
QName portName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingPort");
dispatcher = s.createDispatch(portName, SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore()
throws KeyStoreException, IOException, NoSuchAlgorithmException, CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream(
"/" + securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/tags/v0.0.3/webservice/src/test/java/nl/bzk/brp/web/AbstractIntegrationTest.java | 3,529 | // Voeg de benodigde security headers toe aan het bericht
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
*/
protected Node verzendBerichtNaarService(final String berichtBestand)
throws WSSecurityException, KeyStoreException, IOException, SOAPException, SAXException,
ParserConfigurationException, TransformerConfigurationException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de<SUF>
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream)
throws ParserConfigurationException, IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request)
throws WSSecurityException, KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate(
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init()
throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException, CertificateException
{
securityProperties = new Properties();
securityProperties.load(
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde {@link
* KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[]{
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs
* en/of Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden
* aan deze methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
final URL wsdl = new URL("http://localhost:8181/brp/services/bijhouding?wsdl");
// Definieer de service middels de betreffende NameSpace en de naam in de WSDL
QName serviceName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingService");
Service s = Service.create(wsdl, serviceName);
// Definieer de port middels de betreffende NameSpace en de naam in de WSDL
QName portName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingPort");
dispatcher = s.createDispatch(portName, SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore()
throws KeyStoreException, IOException, NoSuchAlgorithmException, CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream(
"/" + securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
}
|
201763_6 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
*/
protected Node verzendBerichtNaarService(final String berichtBestand)
throws WSSecurityException, KeyStoreException, IOException, SOAPException, SAXException,
ParserConfigurationException, TransformerConfigurationException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream)
throws ParserConfigurationException, IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request)
throws WSSecurityException, KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate(
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init()
throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException, CertificateException
{
securityProperties = new Properties();
securityProperties.load(
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde {@link
* KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[]{
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs
* en/of Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden
* aan deze methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
final URL wsdl = new URL("http://localhost:8181/brp/services/bijhouding?wsdl");
// Definieer de service middels de betreffende NameSpace en de naam in de WSDL
QName serviceName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingService");
Service s = Service.create(wsdl, serviceName);
// Definieer de port middels de betreffende NameSpace en de naam in de WSDL
QName portName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingPort");
dispatcher = s.createDispatch(portName, SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore()
throws KeyStoreException, IOException, NoSuchAlgorithmException, CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream(
"/" + securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/tags/v0.0.3/webservice/src/test/java/nl/bzk/brp/web/AbstractIntegrationTest.java | 3,529 | // Haal het antwoord op
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
*/
protected Node verzendBerichtNaarService(final String berichtBestand)
throws WSSecurityException, KeyStoreException, IOException, SOAPException, SAXException,
ParserConfigurationException, TransformerConfigurationException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het<SUF>
SOAPMessage response = dispatcher.invoke(request);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream)
throws ParserConfigurationException, IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request)
throws WSSecurityException, KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate(
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init()
throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException, CertificateException
{
securityProperties = new Properties();
securityProperties.load(
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde {@link
* KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[]{
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs
* en/of Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden
* aan deze methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
final URL wsdl = new URL("http://localhost:8181/brp/services/bijhouding?wsdl");
// Definieer de service middels de betreffende NameSpace en de naam in de WSDL
QName serviceName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingService");
Service s = Service.create(wsdl, serviceName);
// Definieer de port middels de betreffende NameSpace en de naam in de WSDL
QName portName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingPort");
dispatcher = s.createDispatch(portName, SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore()
throws KeyStoreException, IOException, NoSuchAlgorithmException, CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream(
"/" + securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
}
|
201763_7 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
*/
protected Node verzendBerichtNaarService(final String berichtBestand)
throws WSSecurityException, KeyStoreException, IOException, SOAPException, SAXException,
ParserConfigurationException, TransformerConfigurationException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream)
throws ParserConfigurationException, IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request)
throws WSSecurityException, KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate(
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init()
throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException, CertificateException
{
securityProperties = new Properties();
securityProperties.load(
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde {@link
* KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[]{
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs
* en/of Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden
* aan deze methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
final URL wsdl = new URL("http://localhost:8181/brp/services/bijhouding?wsdl");
// Definieer de service middels de betreffende NameSpace en de naam in de WSDL
QName serviceName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingService");
Service s = Service.create(wsdl, serviceName);
// Definieer de port middels de betreffende NameSpace en de naam in de WSDL
QName portName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingPort");
dispatcher = s.createDispatch(portName, SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore()
throws KeyStoreException, IOException, NoSuchAlgorithmException, CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream(
"/" + securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/tags/v0.0.3/webservice/src/test/java/nl/bzk/brp/web/AbstractIntegrationTest.java | 3,529 | // Extraheer de content uit het antwoord en retourneer deze.
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
*/
protected Node verzendBerichtNaarService(final String berichtBestand)
throws WSSecurityException, KeyStoreException, IOException, SOAPException, SAXException,
ParserConfigurationException, TransformerConfigurationException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Extraheer de<SUF>
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream)
throws ParserConfigurationException, IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request)
throws WSSecurityException, KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate(
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init()
throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException, CertificateException
{
securityProperties = new Properties();
securityProperties.load(
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde {@link
* KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[]{
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs
* en/of Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden
* aan deze methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
final URL wsdl = new URL("http://localhost:8181/brp/services/bijhouding?wsdl");
// Definieer de service middels de betreffende NameSpace en de naam in de WSDL
QName serviceName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingService");
Service s = Service.create(wsdl, serviceName);
// Definieer de port middels de betreffende NameSpace en de naam in de WSDL
QName portName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingPort");
dispatcher = s.createDispatch(portName, SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore()
throws KeyStoreException, IOException, NoSuchAlgorithmException, CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream(
"/" + securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
}
|
201763_8 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
*/
protected Node verzendBerichtNaarService(final String berichtBestand)
throws WSSecurityException, KeyStoreException, IOException, SOAPException, SAXException,
ParserConfigurationException, TransformerConfigurationException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream)
throws ParserConfigurationException, IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request)
throws WSSecurityException, KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate(
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init()
throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException, CertificateException
{
securityProperties = new Properties();
securityProperties.load(
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde {@link
* KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[]{
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs
* en/of Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden
* aan deze methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
final URL wsdl = new URL("http://localhost:8181/brp/services/bijhouding?wsdl");
// Definieer de service middels de betreffende NameSpace en de naam in de WSDL
QName serviceName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingService");
Service s = Service.create(wsdl, serviceName);
// Definieer de port middels de betreffende NameSpace en de naam in de WSDL
QName portName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingPort");
dispatcher = s.createDispatch(portName, SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore()
throws KeyStoreException, IOException, NoSuchAlgorithmException, CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream(
"/" + securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/tags/v0.0.3/webservice/src/test/java/nl/bzk/brp/web/AbstractIntegrationTest.java | 3,529 | /**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/ | block_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
*/
protected Node verzendBerichtNaarService(final String berichtBestand)
throws WSSecurityException, KeyStoreException, IOException, SOAPException, SAXException,
ParserConfigurationException, TransformerConfigurationException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele<SUF>*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream)
throws ParserConfigurationException, IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request)
throws WSSecurityException, KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate(
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init()
throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException, CertificateException
{
securityProperties = new Properties();
securityProperties.load(
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde {@link
* KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[]{
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs
* en/of Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden
* aan deze methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
final URL wsdl = new URL("http://localhost:8181/brp/services/bijhouding?wsdl");
// Definieer de service middels de betreffende NameSpace en de naam in de WSDL
QName serviceName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingService");
Service s = Service.create(wsdl, serviceName);
// Definieer de port middels de betreffende NameSpace en de naam in de WSDL
QName portName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingPort");
dispatcher = s.createDispatch(portName, SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore()
throws KeyStoreException, IOException, NoSuchAlgorithmException, CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream(
"/" + securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
}
|
201763_9 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
*/
protected Node verzendBerichtNaarService(final String berichtBestand)
throws WSSecurityException, KeyStoreException, IOException, SOAPException, SAXException,
ParserConfigurationException, TransformerConfigurationException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream)
throws ParserConfigurationException, IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request)
throws WSSecurityException, KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate(
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init()
throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException, CertificateException
{
securityProperties = new Properties();
securityProperties.load(
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde {@link
* KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[]{
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs
* en/of Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden
* aan deze methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
final URL wsdl = new URL("http://localhost:8181/brp/services/bijhouding?wsdl");
// Definieer de service middels de betreffende NameSpace en de naam in de WSDL
QName serviceName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingService");
Service s = Service.create(wsdl, serviceName);
// Definieer de port middels de betreffende NameSpace en de naam in de WSDL
QName portName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingPort");
dispatcher = s.createDispatch(portName, SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore()
throws KeyStoreException, IOException, NoSuchAlgorithmException, CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream(
"/" + securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/tags/v0.0.3/webservice/src/test/java/nl/bzk/brp/web/AbstractIntegrationTest.java | 3,529 | /**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/ | block_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
*/
protected Node verzendBerichtNaarService(final String berichtBestand)
throws WSSecurityException, KeyStoreException, IOException, SOAPException, SAXException,
ParserConfigurationException, TransformerConfigurationException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream)
throws ParserConfigurationException, IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past<SUF>*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request)
throws WSSecurityException, KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate(
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init()
throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException, CertificateException
{
securityProperties = new Properties();
securityProperties.load(
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde {@link
* KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[]{
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs
* en/of Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden
* aan deze methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
final URL wsdl = new URL("http://localhost:8181/brp/services/bijhouding?wsdl");
// Definieer de service middels de betreffende NameSpace en de naam in de WSDL
QName serviceName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingService");
Service s = Service.create(wsdl, serviceName);
// Definieer de port middels de betreffende NameSpace en de naam in de WSDL
QName portName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingPort");
dispatcher = s.createDispatch(portName, SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore()
throws KeyStoreException, IOException, NoSuchAlgorithmException, CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream(
"/" + securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
}
|
201763_11 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
*/
protected Node verzendBerichtNaarService(final String berichtBestand)
throws WSSecurityException, KeyStoreException, IOException, SOAPException, SAXException,
ParserConfigurationException, TransformerConfigurationException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream)
throws ParserConfigurationException, IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request)
throws WSSecurityException, KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate(
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init()
throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException, CertificateException
{
securityProperties = new Properties();
securityProperties.load(
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde {@link
* KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[]{
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs
* en/of Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden
* aan deze methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
final URL wsdl = new URL("http://localhost:8181/brp/services/bijhouding?wsdl");
// Definieer de service middels de betreffende NameSpace en de naam in de WSDL
QName serviceName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingService");
Service s = Service.create(wsdl, serviceName);
// Definieer de port middels de betreffende NameSpace en de naam in de WSDL
QName portName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingPort");
dispatcher = s.createDispatch(portName, SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore()
throws KeyStoreException, IOException, NoSuchAlgorithmException, CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream(
"/" + securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/tags/v0.0.3/webservice/src/test/java/nl/bzk/brp/web/AbstractIntegrationTest.java | 3,529 | // Voeg de digital signature toe aan het bericht
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
*/
protected Node verzendBerichtNaarService(final String berichtBestand)
throws WSSecurityException, KeyStoreException, IOException, SOAPException, SAXException,
ParserConfigurationException, TransformerConfigurationException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream)
throws ParserConfigurationException, IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request)
throws WSSecurityException, KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de<SUF>
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate(
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init()
throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException, CertificateException
{
securityProperties = new Properties();
securityProperties.load(
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde {@link
* KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[]{
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs
* en/of Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden
* aan deze methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
final URL wsdl = new URL("http://localhost:8181/brp/services/bijhouding?wsdl");
// Definieer de service middels de betreffende NameSpace en de naam in de WSDL
QName serviceName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingService");
Service s = Service.create(wsdl, serviceName);
// Definieer de port middels de betreffende NameSpace en de naam in de WSDL
QName portName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingPort");
dispatcher = s.createDispatch(portName, SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore()
throws KeyStoreException, IOException, NoSuchAlgorithmException, CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream(
"/" + securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
}
|
201763_12 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
*/
protected Node verzendBerichtNaarService(final String berichtBestand)
throws WSSecurityException, KeyStoreException, IOException, SOAPException, SAXException,
ParserConfigurationException, TransformerConfigurationException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream)
throws ParserConfigurationException, IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request)
throws WSSecurityException, KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate(
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init()
throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException, CertificateException
{
securityProperties = new Properties();
securityProperties.load(
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde {@link
* KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[]{
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs
* en/of Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden
* aan deze methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
final URL wsdl = new URL("http://localhost:8181/brp/services/bijhouding?wsdl");
// Definieer de service middels de betreffende NameSpace en de naam in de WSDL
QName serviceName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingService");
Service s = Service.create(wsdl, serviceName);
// Definieer de port middels de betreffende NameSpace en de naam in de WSDL
QName portName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingPort");
dispatcher = s.createDispatch(portName, SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore()
throws KeyStoreException, IOException, NoSuchAlgorithmException, CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream(
"/" + securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/tags/v0.0.3/webservice/src/test/java/nl/bzk/brp/web/AbstractIntegrationTest.java | 3,529 | /**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/ | block_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
*/
protected Node verzendBerichtNaarService(final String berichtBestand)
throws WSSecurityException, KeyStoreException, IOException, SOAPException, SAXException,
ParserConfigurationException, TransformerConfigurationException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream)
throws ParserConfigurationException, IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request)
throws WSSecurityException, KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate(
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert<SUF>*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init()
throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException, CertificateException
{
securityProperties = new Properties();
securityProperties.load(
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde {@link
* KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[]{
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs
* en/of Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden
* aan deze methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
final URL wsdl = new URL("http://localhost:8181/brp/services/bijhouding?wsdl");
// Definieer de service middels de betreffende NameSpace en de naam in de WSDL
QName serviceName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingService");
Service s = Service.create(wsdl, serviceName);
// Definieer de port middels de betreffende NameSpace en de naam in de WSDL
QName portName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingPort");
dispatcher = s.createDispatch(portName, SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore()
throws KeyStoreException, IOException, NoSuchAlgorithmException, CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream(
"/" + securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
}
|
201763_13 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
*/
protected Node verzendBerichtNaarService(final String berichtBestand)
throws WSSecurityException, KeyStoreException, IOException, SOAPException, SAXException,
ParserConfigurationException, TransformerConfigurationException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream)
throws ParserConfigurationException, IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request)
throws WSSecurityException, KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate(
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init()
throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException, CertificateException
{
securityProperties = new Properties();
securityProperties.load(
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde {@link
* KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[]{
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs
* en/of Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden
* aan deze methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
final URL wsdl = new URL("http://localhost:8181/brp/services/bijhouding?wsdl");
// Definieer de service middels de betreffende NameSpace en de naam in de WSDL
QName serviceName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingService");
Service s = Service.create(wsdl, serviceName);
// Definieer de port middels de betreffende NameSpace en de naam in de WSDL
QName portName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingPort");
dispatcher = s.createDispatch(portName, SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore()
throws KeyStoreException, IOException, NoSuchAlgorithmException, CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream(
"/" + securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/tags/v0.0.3/webservice/src/test/java/nl/bzk/brp/web/AbstractIntegrationTest.java | 3,529 | /**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/ | block_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
*/
protected Node verzendBerichtNaarService(final String berichtBestand)
throws WSSecurityException, KeyStoreException, IOException, SOAPException, SAXException,
ParserConfigurationException, TransformerConfigurationException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream)
throws ParserConfigurationException, IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request)
throws WSSecurityException, KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate(
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor<SUF>*/
@BeforeClass
public static void init()
throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException, CertificateException
{
securityProperties = new Properties();
securityProperties.load(
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde {@link
* KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[]{
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs
* en/of Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden
* aan deze methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
final URL wsdl = new URL("http://localhost:8181/brp/services/bijhouding?wsdl");
// Definieer de service middels de betreffende NameSpace en de naam in de WSDL
QName serviceName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingService");
Service s = Service.create(wsdl, serviceName);
// Definieer de port middels de betreffende NameSpace en de naam in de WSDL
QName portName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingPort");
dispatcher = s.createDispatch(portName, SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore()
throws KeyStoreException, IOException, NoSuchAlgorithmException, CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream(
"/" + securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
}
|
201763_14 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
*/
protected Node verzendBerichtNaarService(final String berichtBestand)
throws WSSecurityException, KeyStoreException, IOException, SOAPException, SAXException,
ParserConfigurationException, TransformerConfigurationException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream)
throws ParserConfigurationException, IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request)
throws WSSecurityException, KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate(
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init()
throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException, CertificateException
{
securityProperties = new Properties();
securityProperties.load(
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde {@link
* KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[]{
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs
* en/of Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden
* aan deze methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
final URL wsdl = new URL("http://localhost:8181/brp/services/bijhouding?wsdl");
// Definieer de service middels de betreffende NameSpace en de naam in de WSDL
QName serviceName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingService");
Service s = Service.create(wsdl, serviceName);
// Definieer de port middels de betreffende NameSpace en de naam in de WSDL
QName portName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingPort");
dispatcher = s.createDispatch(portName, SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore()
throws KeyStoreException, IOException, NoSuchAlgorithmException, CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream(
"/" + securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/tags/v0.0.3/webservice/src/test/java/nl/bzk/brp/web/AbstractIntegrationTest.java | 3,529 | /**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde {@link
* KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/ | block_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
*/
protected Node verzendBerichtNaarService(final String berichtBestand)
throws WSSecurityException, KeyStoreException, IOException, SOAPException, SAXException,
ParserConfigurationException, TransformerConfigurationException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream)
throws ParserConfigurationException, IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request)
throws WSSecurityException, KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate(
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init()
throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException, CertificateException
{
securityProperties = new Properties();
securityProperties.load(
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method<SUF>*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[]{
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs
* en/of Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden
* aan deze methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
final URL wsdl = new URL("http://localhost:8181/brp/services/bijhouding?wsdl");
// Definieer de service middels de betreffende NameSpace en de naam in de WSDL
QName serviceName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingService");
Service s = Service.create(wsdl, serviceName);
// Definieer de port middels de betreffende NameSpace en de naam in de WSDL
QName portName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingPort");
dispatcher = s.createDispatch(portName, SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore()
throws KeyStoreException, IOException, NoSuchAlgorithmException, CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream(
"/" + securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
}
|
201763_15 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
*/
protected Node verzendBerichtNaarService(final String berichtBestand)
throws WSSecurityException, KeyStoreException, IOException, SOAPException, SAXException,
ParserConfigurationException, TransformerConfigurationException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream)
throws ParserConfigurationException, IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request)
throws WSSecurityException, KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate(
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init()
throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException, CertificateException
{
securityProperties = new Properties();
securityProperties.load(
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde {@link
* KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[]{
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs
* en/of Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden
* aan deze methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
final URL wsdl = new URL("http://localhost:8181/brp/services/bijhouding?wsdl");
// Definieer de service middels de betreffende NameSpace en de naam in de WSDL
QName serviceName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingService");
Service s = Service.create(wsdl, serviceName);
// Definieer de port middels de betreffende NameSpace en de naam in de WSDL
QName portName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingPort");
dispatcher = s.createDispatch(portName, SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore()
throws KeyStoreException, IOException, NoSuchAlgorithmException, CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream(
"/" + securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/tags/v0.0.3/webservice/src/test/java/nl/bzk/brp/web/AbstractIntegrationTest.java | 3,529 | /**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/ | block_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
*/
protected Node verzendBerichtNaarService(final String berichtBestand)
throws WSSecurityException, KeyStoreException, IOException, SOAPException, SAXException,
ParserConfigurationException, TransformerConfigurationException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream)
throws ParserConfigurationException, IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request)
throws WSSecurityException, KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate(
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init()
throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException, CertificateException
{
securityProperties = new Properties();
securityProperties.load(
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde {@link
* KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database<SUF>*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[]{
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs
* en/of Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden
* aan deze methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
final URL wsdl = new URL("http://localhost:8181/brp/services/bijhouding?wsdl");
// Definieer de service middels de betreffende NameSpace en de naam in de WSDL
QName serviceName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingService");
Service s = Service.create(wsdl, serviceName);
// Definieer de port middels de betreffende NameSpace en de naam in de WSDL
QName portName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingPort");
dispatcher = s.createDispatch(portName, SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore()
throws KeyStoreException, IOException, NoSuchAlgorithmException, CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream(
"/" + securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
}
|
201763_16 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
*/
protected Node verzendBerichtNaarService(final String berichtBestand)
throws WSSecurityException, KeyStoreException, IOException, SOAPException, SAXException,
ParserConfigurationException, TransformerConfigurationException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream)
throws ParserConfigurationException, IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request)
throws WSSecurityException, KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate(
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init()
throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException, CertificateException
{
securityProperties = new Properties();
securityProperties.load(
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde {@link
* KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[]{
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs
* en/of Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden
* aan deze methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
final URL wsdl = new URL("http://localhost:8181/brp/services/bijhouding?wsdl");
// Definieer de service middels de betreffende NameSpace en de naam in de WSDL
QName serviceName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingService");
Service s = Service.create(wsdl, serviceName);
// Definieer de port middels de betreffende NameSpace en de naam in de WSDL
QName portName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingPort");
dispatcher = s.createDispatch(portName, SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore()
throws KeyStoreException, IOException, NoSuchAlgorithmException, CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream(
"/" + securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/tags/v0.0.3/webservice/src/test/java/nl/bzk/brp/web/AbstractIntegrationTest.java | 3,529 | /**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs
* en/of Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden
* aan deze methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/ | block_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
*/
protected Node verzendBerichtNaarService(final String berichtBestand)
throws WSSecurityException, KeyStoreException, IOException, SOAPException, SAXException,
ParserConfigurationException, TransformerConfigurationException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream)
throws ParserConfigurationException, IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request)
throws WSSecurityException, KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate(
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init()
throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException, CertificateException
{
securityProperties = new Properties();
securityProperties.load(
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde {@link
* KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[]{
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Initialiseert de standaard<SUF>*/
private void initDispatcher() throws MalformedURLException {
final URL wsdl = new URL("http://localhost:8181/brp/services/bijhouding?wsdl");
// Definieer de service middels de betreffende NameSpace en de naam in de WSDL
QName serviceName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingService");
Service s = Service.create(wsdl, serviceName);
// Definieer de port middels de betreffende NameSpace en de naam in de WSDL
QName portName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingPort");
dispatcher = s.createDispatch(portName, SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore()
throws KeyStoreException, IOException, NoSuchAlgorithmException, CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream(
"/" + securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
}
|
201763_17 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
*/
protected Node verzendBerichtNaarService(final String berichtBestand)
throws WSSecurityException, KeyStoreException, IOException, SOAPException, SAXException,
ParserConfigurationException, TransformerConfigurationException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream)
throws ParserConfigurationException, IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request)
throws WSSecurityException, KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate(
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init()
throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException, CertificateException
{
securityProperties = new Properties();
securityProperties.load(
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde {@link
* KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[]{
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs
* en/of Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden
* aan deze methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
final URL wsdl = new URL("http://localhost:8181/brp/services/bijhouding?wsdl");
// Definieer de service middels de betreffende NameSpace en de naam in de WSDL
QName serviceName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingService");
Service s = Service.create(wsdl, serviceName);
// Definieer de port middels de betreffende NameSpace en de naam in de WSDL
QName portName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingPort");
dispatcher = s.createDispatch(portName, SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore()
throws KeyStoreException, IOException, NoSuchAlgorithmException, CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream(
"/" + securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/tags/v0.0.3/webservice/src/test/java/nl/bzk/brp/web/AbstractIntegrationTest.java | 3,529 | // Definieer de service middels de betreffende NameSpace en de naam in de WSDL
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
*/
protected Node verzendBerichtNaarService(final String berichtBestand)
throws WSSecurityException, KeyStoreException, IOException, SOAPException, SAXException,
ParserConfigurationException, TransformerConfigurationException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream)
throws ParserConfigurationException, IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request)
throws WSSecurityException, KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate(
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init()
throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException, CertificateException
{
securityProperties = new Properties();
securityProperties.load(
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde {@link
* KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[]{
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs
* en/of Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden
* aan deze methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
final URL wsdl = new URL("http://localhost:8181/brp/services/bijhouding?wsdl");
// Definieer de<SUF>
QName serviceName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingService");
Service s = Service.create(wsdl, serviceName);
// Definieer de port middels de betreffende NameSpace en de naam in de WSDL
QName portName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingPort");
dispatcher = s.createDispatch(portName, SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore()
throws KeyStoreException, IOException, NoSuchAlgorithmException, CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream(
"/" + securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
}
|
201763_18 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
*/
protected Node verzendBerichtNaarService(final String berichtBestand)
throws WSSecurityException, KeyStoreException, IOException, SOAPException, SAXException,
ParserConfigurationException, TransformerConfigurationException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream)
throws ParserConfigurationException, IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request)
throws WSSecurityException, KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate(
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init()
throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException, CertificateException
{
securityProperties = new Properties();
securityProperties.load(
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde {@link
* KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[]{
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs
* en/of Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden
* aan deze methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
final URL wsdl = new URL("http://localhost:8181/brp/services/bijhouding?wsdl");
// Definieer de service middels de betreffende NameSpace en de naam in de WSDL
QName serviceName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingService");
Service s = Service.create(wsdl, serviceName);
// Definieer de port middels de betreffende NameSpace en de naam in de WSDL
QName portName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingPort");
dispatcher = s.createDispatch(portName, SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore()
throws KeyStoreException, IOException, NoSuchAlgorithmException, CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream(
"/" + securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/tags/v0.0.3/webservice/src/test/java/nl/bzk/brp/web/AbstractIntegrationTest.java | 3,529 | // Definieer de port middels de betreffende NameSpace en de naam in de WSDL
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
*/
protected Node verzendBerichtNaarService(final String berichtBestand)
throws WSSecurityException, KeyStoreException, IOException, SOAPException, SAXException,
ParserConfigurationException, TransformerConfigurationException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream)
throws ParserConfigurationException, IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request)
throws WSSecurityException, KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate(
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init()
throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException, CertificateException
{
securityProperties = new Properties();
securityProperties.load(
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde {@link
* KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[]{
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs
* en/of Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden
* aan deze methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
final URL wsdl = new URL("http://localhost:8181/brp/services/bijhouding?wsdl");
// Definieer de service middels de betreffende NameSpace en de naam in de WSDL
QName serviceName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingService");
Service s = Service.create(wsdl, serviceName);
// Definieer de<SUF>
QName portName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingPort");
dispatcher = s.createDispatch(portName, SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore()
throws KeyStoreException, IOException, NoSuchAlgorithmException, CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream(
"/" + securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
}
|
201763_20 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
*/
protected Node verzendBerichtNaarService(final String berichtBestand)
throws WSSecurityException, KeyStoreException, IOException, SOAPException, SAXException,
ParserConfigurationException, TransformerConfigurationException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream)
throws ParserConfigurationException, IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request)
throws WSSecurityException, KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate(
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init()
throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException, CertificateException
{
securityProperties = new Properties();
securityProperties.load(
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde {@link
* KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[]{
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs
* en/of Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden
* aan deze methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
final URL wsdl = new URL("http://localhost:8181/brp/services/bijhouding?wsdl");
// Definieer de service middels de betreffende NameSpace en de naam in de WSDL
QName serviceName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingService");
Service s = Service.create(wsdl, serviceName);
// Definieer de port middels de betreffende NameSpace en de naam in de WSDL
QName portName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingPort");
dispatcher = s.createDispatch(portName, SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore()
throws KeyStoreException, IOException, NoSuchAlgorithmException, CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream(
"/" + securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/tags/v0.0.3/webservice/src/test/java/nl/bzk/brp/web/AbstractIntegrationTest.java | 3,529 | /**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/ | block_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
*/
protected Node verzendBerichtNaarService(final String berichtBestand)
throws WSSecurityException, KeyStoreException, IOException, SOAPException, SAXException,
ParserConfigurationException, TransformerConfigurationException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream)
throws ParserConfigurationException, IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request)
throws WSSecurityException, KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate(
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init()
throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException, CertificateException
{
securityProperties = new Properties();
securityProperties.load(
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde {@link
* KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[]{
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs
* en/of Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden
* aan deze methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
final URL wsdl = new URL("http://localhost:8181/brp/services/bijhouding?wsdl");
// Definieer de service middels de betreffende NameSpace en de naam in de WSDL
QName serviceName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingService");
Service s = Service.create(wsdl, serviceName);
// Definieer de port middels de betreffende NameSpace en de naam in de WSDL
QName portName = new QName("http://www.brp.bzk.nl/bijhouding/ws/service", "BijhoudingPort");
dispatcher = s.createDispatch(portName, SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore()
throws KeyStoreException, IOException, NoSuchAlgorithmException, CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream(
"/" + securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link<SUF>*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
}
|
201764_2 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/tags/v0.0.6/webservice/src/test/java/nl/bzk/brp/web/AbstractIntegrationTest.java | 4,170 | /**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/ | block_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor<SUF>*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201764_3 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/tags/v0.0.6/webservice/src/test/java/nl/bzk/brp/web/AbstractIntegrationTest.java | 4,170 | // Lees het verhuis bericht uit een xml bestand
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het<SUF>
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201764_4 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/tags/v0.0.6/webservice/src/test/java/nl/bzk/brp/web/AbstractIntegrationTest.java | 4,170 | // Bouw het initiele request bericht
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het<SUF>
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201764_5 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/tags/v0.0.6/webservice/src/test/java/nl/bzk/brp/web/AbstractIntegrationTest.java | 4,170 | // Voeg de benodigde security headers toe aan het bericht
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de<SUF>
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201764_6 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/tags/v0.0.6/webservice/src/test/java/nl/bzk/brp/web/AbstractIntegrationTest.java | 4,170 | // Haal het antwoord op
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het<SUF>
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201764_7 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/tags/v0.0.6/webservice/src/test/java/nl/bzk/brp/web/AbstractIntegrationTest.java | 4,170 | // Valideer de signature van het antwoord
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de<SUF>
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201764_8 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/tags/v0.0.6/webservice/src/test/java/nl/bzk/brp/web/AbstractIntegrationTest.java | 4,170 | // Extraheer de content uit het antwoord en retourneer deze.
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de<SUF>
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201764_9 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/tags/v0.0.6/webservice/src/test/java/nl/bzk/brp/web/AbstractIntegrationTest.java | 4,170 | /**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/ | block_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele<SUF>*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201764_10 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/tags/v0.0.6/webservice/src/test/java/nl/bzk/brp/web/AbstractIntegrationTest.java | 4,170 | /**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/ | block_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past<SUF>*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201764_12 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/tags/v0.0.6/webservice/src/test/java/nl/bzk/brp/web/AbstractIntegrationTest.java | 4,170 | // Voeg de digital signature toe aan het bericht
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de<SUF>
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201764_13 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/tags/v0.0.6/webservice/src/test/java/nl/bzk/brp/web/AbstractIntegrationTest.java | 4,170 | /**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/ | block_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert<SUF>*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201764_14 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/tags/v0.0.6/webservice/src/test/java/nl/bzk/brp/web/AbstractIntegrationTest.java | 4,170 | /**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/ | block_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor<SUF>*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201764_15 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/tags/v0.0.6/webservice/src/test/java/nl/bzk/brp/web/AbstractIntegrationTest.java | 4,170 | /**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/ | block_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method<SUF>*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201764_16 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/tags/v0.0.6/webservice/src/test/java/nl/bzk/brp/web/AbstractIntegrationTest.java | 4,170 | /**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/ | block_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database<SUF>*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201764_17 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/tags/v0.0.6/webservice/src/test/java/nl/bzk/brp/web/AbstractIntegrationTest.java | 4,170 | /**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/ | block_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL<SUF>*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201764_18 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/tags/v0.0.6/webservice/src/test/java/nl/bzk/brp/web/AbstractIntegrationTest.java | 4,170 | /**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/ | block_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service<SUF>*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201764_19 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/tags/v0.0.6/webservice/src/test/java/nl/bzk/brp/web/AbstractIntegrationTest.java | 4,170 | /**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/ | block_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port<SUF>*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201764_20 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/tags/v0.0.6/webservice/src/test/java/nl/bzk/brp/web/AbstractIntegrationTest.java | 4,170 | /**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/ | block_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard<SUF>*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201764_21 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/tags/v0.0.6/webservice/src/test/java/nl/bzk/brp/web/AbstractIntegrationTest.java | 4,170 | /** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */ | block_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link<SUF>*/
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201764_22 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/tags/v0.0.6/webservice/src/test/java/nl/bzk/brp/web/AbstractIntegrationTest.java | 4,170 | /**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/ | block_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link<SUF>*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201764_24 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/tags/v0.0.6/webservice/src/test/java/nl/bzk/brp/web/AbstractIntegrationTest.java | 4,170 | // Haal de Signature element op
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de<SUF>
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201764_25 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/tags/v0.0.6/webservice/src/test/java/nl/bzk/brp/web/AbstractIntegrationTest.java | 4,170 | // Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een<SUF>
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201764_26 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/tags/v0.0.6/webservice/src/test/java/nl/bzk/brp/web/AbstractIntegrationTest.java | 4,170 | // Maak een DOMValidateContext
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een<SUF>
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201764_28 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/tags/v0.0.6/webservice/src/test/java/nl/bzk/brp/web/AbstractIntegrationTest.java | 4,170 | // Valideer de XMLSignature.
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de<SUF>
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201765_2 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek het id veld van de Timestamp node
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/trunk/webservice/src/test/java/nl/bzk/brp/web/service/AbstractIntegrationTest.java | 4,620 | // Lees het verhuis bericht uit een xml bestand
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het<SUF>
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek het id veld van de Timestamp node
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201765_3 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek het id veld van de Timestamp node
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/trunk/webservice/src/test/java/nl/bzk/brp/web/service/AbstractIntegrationTest.java | 4,620 | /**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/ | block_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor<SUF>*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek het id veld van de Timestamp node
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201765_4 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek het id veld van de Timestamp node
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/trunk/webservice/src/test/java/nl/bzk/brp/web/service/AbstractIntegrationTest.java | 4,620 | // Bouw het initiele request bericht
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het<SUF>
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek het id veld van de Timestamp node
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201765_5 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek het id veld van de Timestamp node
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/trunk/webservice/src/test/java/nl/bzk/brp/web/service/AbstractIntegrationTest.java | 4,620 | // Voeg de benodigde security headers toe aan het bericht
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de<SUF>
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek het id veld van de Timestamp node
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201765_6 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek het id veld van de Timestamp node
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/trunk/webservice/src/test/java/nl/bzk/brp/web/service/AbstractIntegrationTest.java | 4,620 | // Haal het antwoord op
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het<SUF>
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek het id veld van de Timestamp node
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201765_7 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek het id veld van de Timestamp node
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/trunk/webservice/src/test/java/nl/bzk/brp/web/service/AbstractIntegrationTest.java | 4,620 | // Valideer de signature van het antwoord
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de<SUF>
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek het id veld van de Timestamp node
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201765_8 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek het id veld van de Timestamp node
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/trunk/webservice/src/test/java/nl/bzk/brp/web/service/AbstractIntegrationTest.java | 4,620 | // Extraheer de content uit het antwoord en retourneer deze.
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de<SUF>
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek het id veld van de Timestamp node
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201765_9 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek het id veld van de Timestamp node
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/trunk/webservice/src/test/java/nl/bzk/brp/web/service/AbstractIntegrationTest.java | 4,620 | /**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/ | block_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele<SUF>*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek het id veld van de Timestamp node
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201765_10 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek het id veld van de Timestamp node
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/trunk/webservice/src/test/java/nl/bzk/brp/web/service/AbstractIntegrationTest.java | 4,620 | /**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/ | block_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past<SUF>*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek het id veld van de Timestamp node
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201765_12 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek het id veld van de Timestamp node
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/trunk/webservice/src/test/java/nl/bzk/brp/web/service/AbstractIntegrationTest.java | 4,620 | // Voeg de digital signature toe aan het bericht
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de<SUF>
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek het id veld van de Timestamp node
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201765_13 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek het id veld van de Timestamp node
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/trunk/webservice/src/test/java/nl/bzk/brp/web/service/AbstractIntegrationTest.java | 4,620 | /**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/ | block_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert<SUF>*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek het id veld van de Timestamp node
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201765_14 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek het id veld van de Timestamp node
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/trunk/webservice/src/test/java/nl/bzk/brp/web/service/AbstractIntegrationTest.java | 4,620 | /**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/ | block_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor<SUF>*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek het id veld van de Timestamp node
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201765_15 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek het id veld van de Timestamp node
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/trunk/webservice/src/test/java/nl/bzk/brp/web/service/AbstractIntegrationTest.java | 4,620 | /**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/ | block_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method<SUF>*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek het id veld van de Timestamp node
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201765_16 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek het id veld van de Timestamp node
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/trunk/webservice/src/test/java/nl/bzk/brp/web/service/AbstractIntegrationTest.java | 4,620 | /**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/ | block_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database<SUF>*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek het id veld van de Timestamp node
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201765_17 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek het id veld van de Timestamp node
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/trunk/webservice/src/test/java/nl/bzk/brp/web/service/AbstractIntegrationTest.java | 4,620 | // Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen<SUF>
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek het id veld van de Timestamp node
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201765_18 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek het id veld van de Timestamp node
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/trunk/webservice/src/test/java/nl/bzk/brp/web/service/AbstractIntegrationTest.java | 4,620 | /**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/ | block_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL<SUF>*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek het id veld van de Timestamp node
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201765_19 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek het id veld van de Timestamp node
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/trunk/webservice/src/test/java/nl/bzk/brp/web/service/AbstractIntegrationTest.java | 4,620 | /**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/ | block_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service<SUF>*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek het id veld van de Timestamp node
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201765_20 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek het id veld van de Timestamp node
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/trunk/webservice/src/test/java/nl/bzk/brp/web/service/AbstractIntegrationTest.java | 4,620 | /**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/ | block_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port<SUF>*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek het id veld van de Timestamp node
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201765_21 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek het id veld van de Timestamp node
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/trunk/webservice/src/test/java/nl/bzk/brp/web/service/AbstractIntegrationTest.java | 4,620 | /**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/ | block_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard<SUF>*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek het id veld van de Timestamp node
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201765_22 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek het id veld van de Timestamp node
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/trunk/webservice/src/test/java/nl/bzk/brp/web/service/AbstractIntegrationTest.java | 4,620 | /**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/ | block_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist<SUF>*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek het id veld van de Timestamp node
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201765_24 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek het id veld van de Timestamp node
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/trunk/webservice/src/test/java/nl/bzk/brp/web/service/AbstractIntegrationTest.java | 4,620 | /**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/ | block_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link<SUF>*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek het id veld van de Timestamp node
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201765_26 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek het id veld van de Timestamp node
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/trunk/webservice/src/test/java/nl/bzk/brp/web/service/AbstractIntegrationTest.java | 4,620 | // Haal de PubliekeSleutel element op
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de<SUF>
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek het id veld van de Timestamp node
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201765_27 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek het id veld van de Timestamp node
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/trunk/webservice/src/test/java/nl/bzk/brp/web/service/AbstractIntegrationTest.java | 4,620 | // Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een<SUF>
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek het id veld van de Timestamp node
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201765_28 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek het id veld van de Timestamp node
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/trunk/webservice/src/test/java/nl/bzk/brp/web/service/AbstractIntegrationTest.java | 4,620 | // Maak een DOMValidateContext
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een<SUF>
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek het id veld van de Timestamp node
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201765_29 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek het id veld van de Timestamp node
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/trunk/webservice/src/test/java/nl/bzk/brp/web/service/AbstractIntegrationTest.java | 4,620 | // Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat<SUF>
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek het id veld van de Timestamp node
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201765_30 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek het id veld van de Timestamp node
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/trunk/webservice/src/test/java/nl/bzk/brp/web/service/AbstractIntegrationTest.java | 4,620 | // Markeer specifiek het id veld van de Timestamp node
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.sql.Statement;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.cxf.helpers.IOUtils;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
@Named("dataSourceSpecial")
private DataSource dataSrc;
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
if (null == is) {
throw new IOException("Kan bestand " + berichtBestand + " niet vinden in de classpath.");
}
return is;
}
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage)
throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensNationaliteit.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
Statement st = databaseTester.getConnection().getConnection().createStatement();
String myString = IOUtils.toString(getClass().getResourceAsStream("/data/afterburner.sql"), "UTF-8");
st.execute(myString);
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
*
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
*
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), publiekeSleutelNode.item(0));
// Markeer dat de juiste attributen als XML ID worden gezien (nodig daar XML niet eerst reeds is gevalideerd)
validatieContext.setIdAttributeNS(message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Markeer specifiek<SUF>
NodeList nodes = message.getSOAPPart().getElementsByTagName("wsu:Timestamp");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
element.setIdAttribute("wsu:Id", true);
}
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201766_2 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/tags/v0.0.7/webservice/src/test/java/nl/bzk/brp/web/service/AbstractIntegrationTest.java | 4,296 | /**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/ | block_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor<SUF>*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201766_3 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/tags/v0.0.7/webservice/src/test/java/nl/bzk/brp/web/service/AbstractIntegrationTest.java | 4,296 | // Lees het verhuis bericht uit een xml bestand
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het<SUF>
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201766_4 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/tags/v0.0.7/webservice/src/test/java/nl/bzk/brp/web/service/AbstractIntegrationTest.java | 4,296 | // Bouw het initiele request bericht
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het<SUF>
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201766_5 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/tags/v0.0.7/webservice/src/test/java/nl/bzk/brp/web/service/AbstractIntegrationTest.java | 4,296 | // Voeg de benodigde security headers toe aan het bericht
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de<SUF>
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|
201766_6 | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het antwoord op
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
| MinBZK/OperatieBRP | 2013/brp 2013-02-07/BRP/tags/v0.0.7/webservice/src/test/java/nl/bzk/brp/web/service/AbstractIntegrationTest.java | 4,296 | // Haal het antwoord op
| line_comment | nl | /**
* This file is copyright 2017 State of the Netherlands (Ministry of Interior Affairs and Kingdom Relations).
* It is made available under the terms of the GNU Affero General Public License, version 3 as published by the Free Software Foundation.
* The project of which this file is part, may be found at https://github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.web.service;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import javax.inject.Inject;
import javax.sql.DataSource;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.ws.soap.AddressingFeature;
import org.apache.ws.security.WSConstants;
import org.apache.ws.security.WSEncryptionPart;
import org.apache.ws.security.WSSConfig;
import org.apache.ws.security.WSSecurityException;
import org.apache.ws.security.components.crypto.Crypto;
import org.apache.ws.security.components.crypto.CryptoFactory;
import org.apache.ws.security.message.WSSecHeader;
import org.apache.ws.security.message.WSSecSignature;
import org.apache.ws.security.message.WSSecTimestamp;
import org.apache.xml.security.signature.XMLSignature;
import org.dbunit.DataSourceDatabaseTester;
import org.dbunit.IDatabaseTester;
import org.dbunit.IOperationListener;
import org.dbunit.database.DatabaseConfig;
import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.CompositeDataSet;
import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.ext.postgresql.PostgresqlDataTypeFactory;
import org.dbunit.operation.DatabaseOperation;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/** Abstracte superclass voor repository (persistence) testcases. */
@ContextConfiguration(locations = { "/config/integratieTest-context.xml" })
public abstract class AbstractIntegrationTest extends AbstractTransactionalJUnit4SpringContextTests {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractIntegrationTest.class);
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Inject
private DataSource dataSrc;
/**
* Standaard methode voor het verzenden van een bericht naar de WebService in een integratietest. De opgegeven
* naam van het bericht bestand zal worden ingelezen en als de body van het verzoek naar de webservice worden
* verstuurd, waarbij deze methode tevens voor het toevoegen van de benodigde SOAP headers etc. zorgt. Uit het
* antwoord dat terugkomt van de service wordt de body geextraheerd en als {@link Node} geretourneerd door deze
* methode.
*
* @param berichtBestand de bestandsnaam die verwijst naar een bestand met daarin de content die moet worden
* verstuurd.
* @return de body van het antwoord, ontzien van allerlei niet direct relevante SOAP zaken.
* @throws XMLSignatureException
* @throws MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws WSSecurityException,
KeyStoreException, IOException, SOAPException, SAXException, ParserConfigurationException,
TransformerConfigurationException, MarshalException, XMLSignatureException
{
// Lees het verhuis bericht uit een xml bestand
InputStream is = getClass().getResourceAsStream(berichtBestand);
// Bouw het initiele request bericht
SOAPMessage request = bouwInitieleRequestBericht(is);
// Voeg de benodigde security headers toe aan het bericht
voegSecurityHeadersToeAanBericht(request);
// Haal het<SUF>
SOAPMessage response = dispatcher.invoke(request);
// Valideer de signature van het antwoord
valideerSignature(response);
// Extraheer de content uit het antwoord en retourneer deze.
return extraheerAntwoordUitSoapBericht(response);
}
/**
* Bouwt de initiele request op basis van de opgegeven {@link java.io.InputStream}. De inputstream bevat de
* content, waarbij deze methode de content omzet naar een geldige {@link javax.xml.soap.SOAPMessage} request.
*
* @param inputStream de inpustream naar de content voor de request.
* @return een {@link javax.xml.soap.SOAPMessage} met daarin de opgegeven content uit de inputstream.
*/
private SOAPMessage bouwInitieleRequestBericht(final InputStream inputStream) throws ParserConfigurationException,
IOException, SAXException, SOAPException
{
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Deze methode past de opgegeven {@link SOAPMessage} aan door de benodigde security zaken aan het bericht (en dan
* met name de SOAP envelope) toe te voegen. Het gaat hierbij om de Timestamp en de digital signature.
*
* @param request het SOAP request bericht dat voorzien dient te worden van de security zaken.
*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request) throws WSSecurityException,
KeyStoreException
{
Document requestDoc = request.getSOAPPart();
WSSecHeader secHeader = new WSSecHeader();
secHeader.insertSecurityHeader(requestDoc);
// Voeg de timestamp toe en de maximale "time-to-live" in secondes
WSSecTimestamp secTimestamp = new WSSecTimestamp();
secTimestamp.setTimeToLive(300);
secTimestamp.prepare(requestDoc);
secTimestamp.prependToHeader(secHeader);
// Voeg de digital signature toe aan het bericht
WSSecSignature sign = new WSSecSignature();
Vector<WSEncryptionPart> signParts = new Vector<WSEncryptionPart>();
WSEncryptionPart part = new WSEncryptionPart("Body", "http://schemas.xmlsoap.org/soap/envelope/", "Content");
signParts.add(part);
sign.setParts(signParts);
sign.setX509Certificate((X509Certificate) keyStore.getCertificate((String) securityProperties
.get("org.apache.ws.security.crypto.merlin.keystore.alias")));
sign.setKeyIdentifierType(WSConstants.ISSUER_SERIAL);
sign.setSignatureAlgorithm(XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
sign.setUserInfo((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.alias"),
(String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"));
sign.build(requestDoc, crypto, secHeader);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws TransformerConfigurationException, SOAPException
{
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Initialiseer de voor de integratie test benodigde zaken, zoals de keystore, security properties en de crypto
* configuratie.
*/
@BeforeClass
public static void init() throws IOException, WSSecurityException, NoSuchAlgorithmException, KeyStoreException,
CertificateException
{
securityProperties = new Properties();
securityProperties.load(BijhoudingServiceIntegrationTest.class
.getResourceAsStream("/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("client_sigpropfile.properties");
initKeyStore();
}
/**
* Deze Before method wordt gebruikt om de zaken die nodig zijn voor elke integratietest te initialiseren. Zo
* wordt de database hier geinitialiseerd, maar ook de standaard {@link Dispatch} instantie en de benodigde
* {@link KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
initKeyStore();
LOGGER.debug("exiting setUp() normaal");
}
@After
public void tearDown() throws Exception {
databaseTester.onTearDown();
}
/**
* Initialiseert de database middels dbunit.
*
* @throws Exception indien er geen connectie met de database gevonden kan worden of er een andere database
* probleem is opgetreden.
*/
private void initDatabase() throws Exception {
try {
databaseTester = new DataSourceDatabaseTester(dataSrc);
databaseTester.setOperationListener(operationListener);
databaseTester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
IDataSet dataset = null;
try {
Class<? extends AbstractIntegrationTest> clazz = getClass();
dataset =
new CompositeDataSet(new IDataSet[] {
builder.build(clazz.getResourceAsStream("/data/stamgegevensStatisch.xml")),
builder.build(clazz.getResourceAsStream("/data/stamgegevensLand.xml")),
builder.build(clazz.getResourceAsStream("/data/partij.xml")),
builder.build(clazz.getResourceAsStream("/data/testdata.xml")) });
} catch (DataSetException ex) {
throw new RuntimeException(ex);
}
databaseTester.setDataSet(dataset);
databaseTester.onSetup();
} catch (Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Definieert de URL naar de webservice.
* @return URL naar de webservice.
* @throws MalformedURLException Indien de URL niet valide is.
*/
abstract URL getWsdlUrl() throws MalformedURLException;
/**
* Definieer de service middels de betreffende NameSpace en de naam in de WSDL.
* @return Service namespace en name in de QName wrapper.
*/
abstract QName getServiceQName();
/**
* Definieer de port middels de betreffende NameSpace en de naam in de WSDL.
* @return Portname namespace en name in de QName wrapper.
*/
abstract QName getPortName();
/**
* Initialiseert de standaard {@link Dispatch} instantie die gebruikt wordt om de BRP Service aan te roepen.
* <p/>
* Merk op dat hier nog hard-coded WSDL locatie en Service en Port namen gebruikt wordt. Als er meerdere WSDLs en/of
* Ports gebruikt gaan worden, dan zullen deze zaken geextraheerd moeten worden en meegegeven moeten worden aan deze
* methode als parameters.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher() throws MalformedURLException {
Service s = Service.create(getWsdlUrl(), getServiceQName());
dispatcher = s.createDispatch(getPortName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
}
/**
* Zet de juist (SOAP) actie voor de dispatcher.
* @param actie de actie die aangeroepen dient te worden.
*/
protected void zetActieVoorBericht(final String actie) {
Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/** Initialiseert de {@link KeyStore} die gebruikt wordt voor het maken van de vereiste digital signature. */
private static void initKeyStore() throws KeyStoreException, IOException, NoSuchAlgorithmException,
CertificateException
{
keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream fis =
BijhoudingServiceIntegrationTest.class.getResourceAsStream("/"
+ securityProperties.get("org.apache.ws.security.crypto.merlin.file"));
keyStore.load(fis, ((String) securityProperties.get("org.apache.ws.security.crypto.merlin.keystore.password"))
.toCharArray());
fis.close();
}
/**
* Private, lokale {@link IOperationListener} implementatie die database connectie voor de unit tests configureerd.
* Tevens kunnen hier overige features en properties voor dbunit gezet worden.
*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
DatabaseConfig config = connection.getConfig();
config.setProperty(DatabaseConfig.PROPERTY_DATATYPE_FACTORY, new PostgresqlDataTypeFactory());
config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
}
@Override
public void operationSetUpFinished(final IDatabaseConnection connection) {
}
@Override
public void operationTearDownFinished(final IDatabaseConnection connection) {
}
}
/**
* Controlleert de message signature met de public key van de server.
*
* @param message bericht met de signature
* @throws KeyStoreException
* @throws SOAPException
* @throws MarshalException
* @throws XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException
{
PublicKey publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
// Haal de Signature element op
NodeList signatureNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
Assert.assertEquals("De response bevat geen Signature element", 1, signatureNode.getLength());
// Maak een DOM XMLSignatureFactory dat wordt gebruikt om de document met de XMLSignature te unmarshallen
XMLSignatureFactory signatureFactory = XMLSignatureFactory.getInstance();
// Maak een DOMValidateContext
DOMValidateContext validatieContext =
new DOMValidateContext(KeySelector.singletonKeySelector(publicKey), signatureNode.item(0));
validatieContext.setIdAttributeNS((Element) message.getSOAPBody(),
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd", "Id");
// Unmarshal de XMLSignature.
javax.xml.crypto.dsig.XMLSignature signature = signatureFactory.unmarshalXMLSignature(validatieContext);
// Valideer de XMLSignature.
Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext));
}
}
|