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
|
|---|---|---|---|---|---|---|---|---|
201774_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.sql.Statement;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.bind.JAXBException;
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 nl.bzk.brp.util.AutorisatieOffloadGegevens;
import nl.bzk.brp.utils.XmlUtils;
import org.apache.cxf.helpers.IOUtils;
import org.apache.cxf.message.Message;
import org.apache.wss4j.common.ext.WSSecurityException;
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.ReplacementDataSet;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.springframework.transaction.annotation.Transactional;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/**
* Abstracte superclass voor repository (persistence) testcases.
*/
@Transactional(transactionManager = "lezenSchrijvenTransactionManager")
@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";
protected static final String NODE_RESULTAAT = "//brp:resultaat";
protected static final String NODE_VERWERKING = NODE_RESULTAAT + "/brp:verwerking";
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Value("${jetty.port}")
protected String jettyPort;
private DataSource dataSrc;
@Inject
@Named("lezenSchrijvenDataSource")
public void setDataSource(final DataSource dataSource) {
super.setDataSource(dataSource);
this.dataSrc = dataSource;
}
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
final 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 org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
return verzendBerichtNaarService(berichtBestand, null, null);
}
protected Node verzendBerichtNaarService(final String berichtBestand, String ondertekenaar, String transporteur)
throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
// Bouw het initiele request bericht
final SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
if (ondertekenaar != null && transporteur != null) {
voegSecurityHeadersToeAanBericht(request, ondertekenaar, transporteur);
}
// Haal het antwoord op
final 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
{
final DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
final Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
// Eventuele post processing van het Document voordat het bericht naar de server gaat.
bewerkRequestDocumentVoorVerzending(request);
final SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Pas het Document aan voordat het naar de server wordt gestuurd. Dit is een functie voor post-processing van het
* document. Bij bijhouding worden bijvoorbeeld hier de objectSleutels ingevuld.
* @param request het request document.
*/
protected abstract void bewerkRequestDocumentVoorVerzending(final Document request);
/**
* Deze methode past de opgegeven {@link javax.xml.soap.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, String ondertekenaar, String transporteur) throws WSSecurityException,
KeyStoreException, JAXBException
{
// List<Header> headersList = new ArrayList<>();
// final Map<String, Object> requestContext = dispatcher.getRequestContext();
// Header testSoapHeader1 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_ONDERTEKENAAR), "1234", new JAXBDataBinding(String.class));
// Header testSoapHeader2 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_TRANSPORTEUR), "5678", new JAXBDataBinding(String.class));
// headersList.add(testSoapHeader1);
// headersList.add(testSoapHeader2);
// requestContext.put(Header.HEADER_LIST, headersList);
Map<String, List<String>> headers = new HashMap<>();
headers.put(AutorisatieOffloadGegevens.OIN_ONDERTEKENAAR, Collections.singletonList(ondertekenaar));
headers.put(AutorisatieOffloadGegevens.OIN_TRANSPORTEUR, Collections.singletonList(transporteur));
dispatcher.getRequestContext().put(Message.PROTOCOL_HEADERS, headers);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link org.w3c.dom.Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws
TransformerConfigurationException, SOAPException
{
final Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
final DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* 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 javax.xml.ws.Dispatch} instantie en de
* benodigde {@link java.security.KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
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);
final FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
final IDataSet dataset;
try {
final Class<? extends AbstractIntegrationTest> clazz = getClass();
final IDataSet[] dataSets = new IDataSet[getDataBestanden().size()];
int index = 0;
for (final String dataBestand : getDataBestanden()) {
dataSets[index++] = builder.build(clazz.getResourceAsStream(dataBestand));
}
dataset = new CompositeDataSet(dataSets);
} catch (final DataSetException ex) {
throw new IllegalStateException("DBUnit dataset kan niet ingeladen worden", ex);
}
final ReplacementDataSet filteredDataSet = new ReplacementDataSet(dataset);
filteredDataSet.addReplacementObject("[NULL]", null);
databaseTester.setDataSet(filteredDataSet);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
final Statement st = databaseTester.getConnection().getConnection().createStatement();
final InputStream afterburnerInputStream = getClass().getResourceAsStream("/data/afterburner.sql");
if (afterburnerInputStream != null) {
final String myString = IOUtils.toString(afterburnerInputStream, "UTF-8");
st.execute(myString);
}
} catch (final Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Retourneert de data bestanden die (middels DBUnit) voor elke test in deze class geladen moeten worden in de
* database.
*
* @return een lijst van data bestanden die ingeladen moeten worden.
*/
private List<String> getDataBestanden() {
final List<String> dataBestanden = getInitieleDataBestanden();
final List<String> additioneleDataBestanden = getAdditioneleDataBestanden();
if (additioneleDataBestanden != null && !additioneleDataBestanden.isEmpty()) {
dataBestanden.addAll(additioneleDataBestanden);
}
return dataBestanden;
}
/**
* Geeft de bestanden die bij de intitialisatie van de database gebruikt worden.
*
* @return de lijst met intitiele data bestanden
*/
protected List<String> getInitieleDataBestanden() {
final List<String> dataBestanden = new ArrayList<>();
dataBestanden.addAll(Arrays.asList(
"/data/stamgegevensStatisch.xml",
"/data/stamgegevensNationaliteit.xml",
"/data/stamgegevensLandGebied.xml",
"/data/partijEnGemeente.xml",
"/data/stamgegevensAbonnement.xml",
"/data/testdata.xml"
));
return dataBestanden;
}
/**
* Lijst van eventueel nog additionele data bestanden die ingelezen moeten worden.
*
* @return een lijst van additionele data bestanden.
* @see AbstractIntegrationTest#getDataBestanden()
*/
protected List<String> getAdditioneleDataBestanden() {
return Collections.emptyList();
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws java.net.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 javax.xml.ws.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 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) {
final Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/**
* Private, lokale {@link org.dbunit.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) {
final 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) {
}
}
protected void printResponse(final Document document) throws
Exception
{
final String xml = XmlUtils.toXmlString(document.getDocumentElement());
LOGGER.info("XML Bericht:\n{}", xml);
}
}
| MinBZK/OperatieBRP | 2016/brp 2016-02-09/algemeen/algemeen-webservice/webservice-basis/src/test/java/nl/bzk/brp/web/service/AbstractIntegrationTest.java | 4,408 | /**
* 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.sql.Statement;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.bind.JAXBException;
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 nl.bzk.brp.util.AutorisatieOffloadGegevens;
import nl.bzk.brp.utils.XmlUtils;
import org.apache.cxf.helpers.IOUtils;
import org.apache.cxf.message.Message;
import org.apache.wss4j.common.ext.WSSecurityException;
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.ReplacementDataSet;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.springframework.transaction.annotation.Transactional;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/**
* Abstracte superclass voor repository (persistence) testcases.
*/
@Transactional(transactionManager = "lezenSchrijvenTransactionManager")
@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";
protected static final String NODE_RESULTAAT = "//brp:resultaat";
protected static final String NODE_VERWERKING = NODE_RESULTAAT + "/brp:verwerking";
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Value("${jetty.port}")
protected String jettyPort;
private DataSource dataSrc;
@Inject
@Named("lezenSchrijvenDataSource")
public void setDataSource(final DataSource dataSource) {
super.setDataSource(dataSource);
this.dataSrc = dataSource;
}
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
final 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 org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
return verzendBerichtNaarService(berichtBestand, null, null);
}
protected Node verzendBerichtNaarService(final String berichtBestand, String ondertekenaar, String transporteur)
throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
// Bouw het initiele request bericht
final SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
if (ondertekenaar != null && transporteur != null) {
voegSecurityHeadersToeAanBericht(request, ondertekenaar, transporteur);
}
// Haal het antwoord op
final 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
{
final DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
final Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
// Eventuele post processing van het Document voordat het bericht naar de server gaat.
bewerkRequestDocumentVoorVerzending(request);
final SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Pas het Document aan voordat het naar de server wordt gestuurd. Dit is een functie voor post-processing van het
* document. Bij bijhouding worden bijvoorbeeld hier de objectSleutels ingevuld.
* @param request het request document.
*/
protected abstract void bewerkRequestDocumentVoorVerzending(final Document request);
/**
* Deze methode past de opgegeven {@link javax.xml.soap.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, String ondertekenaar, String transporteur) throws WSSecurityException,
KeyStoreException, JAXBException
{
// List<Header> headersList = new ArrayList<>();
// final Map<String, Object> requestContext = dispatcher.getRequestContext();
// Header testSoapHeader1 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_ONDERTEKENAAR), "1234", new JAXBDataBinding(String.class));
// Header testSoapHeader2 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_TRANSPORTEUR), "5678", new JAXBDataBinding(String.class));
// headersList.add(testSoapHeader1);
// headersList.add(testSoapHeader2);
// requestContext.put(Header.HEADER_LIST, headersList);
Map<String, List<String>> headers = new HashMap<>();
headers.put(AutorisatieOffloadGegevens.OIN_ONDERTEKENAAR, Collections.singletonList(ondertekenaar));
headers.put(AutorisatieOffloadGegevens.OIN_TRANSPORTEUR, Collections.singletonList(transporteur));
dispatcher.getRequestContext().put(Message.PROTOCOL_HEADERS, headers);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link org.w3c.dom.Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws
TransformerConfigurationException, SOAPException
{
final Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
final DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* 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 javax.xml.ws.Dispatch} instantie en de
* benodigde {@link java.security.KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
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);
final FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
final IDataSet dataset;
try {
final Class<? extends AbstractIntegrationTest> clazz = getClass();
final IDataSet[] dataSets = new IDataSet[getDataBestanden().size()];
int index = 0;
for (final String dataBestand : getDataBestanden()) {
dataSets[index++] = builder.build(clazz.getResourceAsStream(dataBestand));
}
dataset = new CompositeDataSet(dataSets);
} catch (final DataSetException ex) {
throw new IllegalStateException("DBUnit dataset kan niet ingeladen worden", ex);
}
final ReplacementDataSet filteredDataSet = new ReplacementDataSet(dataset);
filteredDataSet.addReplacementObject("[NULL]", null);
databaseTester.setDataSet(filteredDataSet);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
final Statement st = databaseTester.getConnection().getConnection().createStatement();
final InputStream afterburnerInputStream = getClass().getResourceAsStream("/data/afterburner.sql");
if (afterburnerInputStream != null) {
final String myString = IOUtils.toString(afterburnerInputStream, "UTF-8");
st.execute(myString);
}
} catch (final Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Retourneert de data bestanden die (middels DBUnit) voor elke test in deze class geladen moeten worden in de
* database.
*
* @return een lijst van data bestanden die ingeladen moeten worden.
*/
private List<String> getDataBestanden() {
final List<String> dataBestanden = getInitieleDataBestanden();
final List<String> additioneleDataBestanden = getAdditioneleDataBestanden();
if (additioneleDataBestanden != null && !additioneleDataBestanden.isEmpty()) {
dataBestanden.addAll(additioneleDataBestanden);
}
return dataBestanden;
}
/**
* Geeft de bestanden die bij de intitialisatie van de database gebruikt worden.
*
* @return de lijst met intitiele data bestanden
*/
protected List<String> getInitieleDataBestanden() {
final List<String> dataBestanden = new ArrayList<>();
dataBestanden.addAll(Arrays.asList(
"/data/stamgegevensStatisch.xml",
"/data/stamgegevensNationaliteit.xml",
"/data/stamgegevensLandGebied.xml",
"/data/partijEnGemeente.xml",
"/data/stamgegevensAbonnement.xml",
"/data/testdata.xml"
));
return dataBestanden;
}
/**
* Lijst van eventueel nog additionele data bestanden die ingelezen moeten worden.
*
* @return een lijst van additionele data bestanden.
* @see AbstractIntegrationTest#getDataBestanden()
*/
protected List<String> getAdditioneleDataBestanden() {
return Collections.emptyList();
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws java.net.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 javax.xml.ws.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 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) {
final Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/**
* Private, lokale {@link org.dbunit.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) {
final 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) {
}
}
protected void printResponse(final Document document) throws
Exception
{
final String xml = XmlUtils.toXmlString(document.getDocumentElement());
LOGGER.info("XML Bericht:\n{}", xml);
}
}
|
201774_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.sql.Statement;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.bind.JAXBException;
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 nl.bzk.brp.util.AutorisatieOffloadGegevens;
import nl.bzk.brp.utils.XmlUtils;
import org.apache.cxf.helpers.IOUtils;
import org.apache.cxf.message.Message;
import org.apache.wss4j.common.ext.WSSecurityException;
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.ReplacementDataSet;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.springframework.transaction.annotation.Transactional;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/**
* Abstracte superclass voor repository (persistence) testcases.
*/
@Transactional(transactionManager = "lezenSchrijvenTransactionManager")
@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";
protected static final String NODE_RESULTAAT = "//brp:resultaat";
protected static final String NODE_VERWERKING = NODE_RESULTAAT + "/brp:verwerking";
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Value("${jetty.port}")
protected String jettyPort;
private DataSource dataSrc;
@Inject
@Named("lezenSchrijvenDataSource")
public void setDataSource(final DataSource dataSource) {
super.setDataSource(dataSource);
this.dataSrc = dataSource;
}
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
final 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 org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
return verzendBerichtNaarService(berichtBestand, null, null);
}
protected Node verzendBerichtNaarService(final String berichtBestand, String ondertekenaar, String transporteur)
throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
// Bouw het initiele request bericht
final SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
if (ondertekenaar != null && transporteur != null) {
voegSecurityHeadersToeAanBericht(request, ondertekenaar, transporteur);
}
// Haal het antwoord op
final 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
{
final DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
final Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
// Eventuele post processing van het Document voordat het bericht naar de server gaat.
bewerkRequestDocumentVoorVerzending(request);
final SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Pas het Document aan voordat het naar de server wordt gestuurd. Dit is een functie voor post-processing van het
* document. Bij bijhouding worden bijvoorbeeld hier de objectSleutels ingevuld.
* @param request het request document.
*/
protected abstract void bewerkRequestDocumentVoorVerzending(final Document request);
/**
* Deze methode past de opgegeven {@link javax.xml.soap.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, String ondertekenaar, String transporteur) throws WSSecurityException,
KeyStoreException, JAXBException
{
// List<Header> headersList = new ArrayList<>();
// final Map<String, Object> requestContext = dispatcher.getRequestContext();
// Header testSoapHeader1 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_ONDERTEKENAAR), "1234", new JAXBDataBinding(String.class));
// Header testSoapHeader2 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_TRANSPORTEUR), "5678", new JAXBDataBinding(String.class));
// headersList.add(testSoapHeader1);
// headersList.add(testSoapHeader2);
// requestContext.put(Header.HEADER_LIST, headersList);
Map<String, List<String>> headers = new HashMap<>();
headers.put(AutorisatieOffloadGegevens.OIN_ONDERTEKENAAR, Collections.singletonList(ondertekenaar));
headers.put(AutorisatieOffloadGegevens.OIN_TRANSPORTEUR, Collections.singletonList(transporteur));
dispatcher.getRequestContext().put(Message.PROTOCOL_HEADERS, headers);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link org.w3c.dom.Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws
TransformerConfigurationException, SOAPException
{
final Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
final DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* 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 javax.xml.ws.Dispatch} instantie en de
* benodigde {@link java.security.KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
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);
final FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
final IDataSet dataset;
try {
final Class<? extends AbstractIntegrationTest> clazz = getClass();
final IDataSet[] dataSets = new IDataSet[getDataBestanden().size()];
int index = 0;
for (final String dataBestand : getDataBestanden()) {
dataSets[index++] = builder.build(clazz.getResourceAsStream(dataBestand));
}
dataset = new CompositeDataSet(dataSets);
} catch (final DataSetException ex) {
throw new IllegalStateException("DBUnit dataset kan niet ingeladen worden", ex);
}
final ReplacementDataSet filteredDataSet = new ReplacementDataSet(dataset);
filteredDataSet.addReplacementObject("[NULL]", null);
databaseTester.setDataSet(filteredDataSet);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
final Statement st = databaseTester.getConnection().getConnection().createStatement();
final InputStream afterburnerInputStream = getClass().getResourceAsStream("/data/afterburner.sql");
if (afterburnerInputStream != null) {
final String myString = IOUtils.toString(afterburnerInputStream, "UTF-8");
st.execute(myString);
}
} catch (final Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Retourneert de data bestanden die (middels DBUnit) voor elke test in deze class geladen moeten worden in de
* database.
*
* @return een lijst van data bestanden die ingeladen moeten worden.
*/
private List<String> getDataBestanden() {
final List<String> dataBestanden = getInitieleDataBestanden();
final List<String> additioneleDataBestanden = getAdditioneleDataBestanden();
if (additioneleDataBestanden != null && !additioneleDataBestanden.isEmpty()) {
dataBestanden.addAll(additioneleDataBestanden);
}
return dataBestanden;
}
/**
* Geeft de bestanden die bij de intitialisatie van de database gebruikt worden.
*
* @return de lijst met intitiele data bestanden
*/
protected List<String> getInitieleDataBestanden() {
final List<String> dataBestanden = new ArrayList<>();
dataBestanden.addAll(Arrays.asList(
"/data/stamgegevensStatisch.xml",
"/data/stamgegevensNationaliteit.xml",
"/data/stamgegevensLandGebied.xml",
"/data/partijEnGemeente.xml",
"/data/stamgegevensAbonnement.xml",
"/data/testdata.xml"
));
return dataBestanden;
}
/**
* Lijst van eventueel nog additionele data bestanden die ingelezen moeten worden.
*
* @return een lijst van additionele data bestanden.
* @see AbstractIntegrationTest#getDataBestanden()
*/
protected List<String> getAdditioneleDataBestanden() {
return Collections.emptyList();
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws java.net.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 javax.xml.ws.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 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) {
final Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/**
* Private, lokale {@link org.dbunit.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) {
final 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) {
}
}
protected void printResponse(final Document document) throws
Exception
{
final String xml = XmlUtils.toXmlString(document.getDocumentElement());
LOGGER.info("XML Bericht:\n{}", xml);
}
}
| MinBZK/OperatieBRP | 2016/brp 2016-02-09/algemeen/algemeen-webservice/webservice-basis/src/test/java/nl/bzk/brp/web/service/AbstractIntegrationTest.java | 4,408 | // Eventuele post processing van het Document voordat het bericht naar de server gaat.
| 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.sql.Statement;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.bind.JAXBException;
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 nl.bzk.brp.util.AutorisatieOffloadGegevens;
import nl.bzk.brp.utils.XmlUtils;
import org.apache.cxf.helpers.IOUtils;
import org.apache.cxf.message.Message;
import org.apache.wss4j.common.ext.WSSecurityException;
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.ReplacementDataSet;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.springframework.transaction.annotation.Transactional;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/**
* Abstracte superclass voor repository (persistence) testcases.
*/
@Transactional(transactionManager = "lezenSchrijvenTransactionManager")
@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";
protected static final String NODE_RESULTAAT = "//brp:resultaat";
protected static final String NODE_VERWERKING = NODE_RESULTAAT + "/brp:verwerking";
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Value("${jetty.port}")
protected String jettyPort;
private DataSource dataSrc;
@Inject
@Named("lezenSchrijvenDataSource")
public void setDataSource(final DataSource dataSource) {
super.setDataSource(dataSource);
this.dataSrc = dataSource;
}
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
final 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 org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
return verzendBerichtNaarService(berichtBestand, null, null);
}
protected Node verzendBerichtNaarService(final String berichtBestand, String ondertekenaar, String transporteur)
throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
// Bouw het initiele request bericht
final SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
if (ondertekenaar != null && transporteur != null) {
voegSecurityHeadersToeAanBericht(request, ondertekenaar, transporteur);
}
// Haal het antwoord op
final 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
{
final DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
final Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
// Eventuele post<SUF>
bewerkRequestDocumentVoorVerzending(request);
final SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Pas het Document aan voordat het naar de server wordt gestuurd. Dit is een functie voor post-processing van het
* document. Bij bijhouding worden bijvoorbeeld hier de objectSleutels ingevuld.
* @param request het request document.
*/
protected abstract void bewerkRequestDocumentVoorVerzending(final Document request);
/**
* Deze methode past de opgegeven {@link javax.xml.soap.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, String ondertekenaar, String transporteur) throws WSSecurityException,
KeyStoreException, JAXBException
{
// List<Header> headersList = new ArrayList<>();
// final Map<String, Object> requestContext = dispatcher.getRequestContext();
// Header testSoapHeader1 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_ONDERTEKENAAR), "1234", new JAXBDataBinding(String.class));
// Header testSoapHeader2 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_TRANSPORTEUR), "5678", new JAXBDataBinding(String.class));
// headersList.add(testSoapHeader1);
// headersList.add(testSoapHeader2);
// requestContext.put(Header.HEADER_LIST, headersList);
Map<String, List<String>> headers = new HashMap<>();
headers.put(AutorisatieOffloadGegevens.OIN_ONDERTEKENAAR, Collections.singletonList(ondertekenaar));
headers.put(AutorisatieOffloadGegevens.OIN_TRANSPORTEUR, Collections.singletonList(transporteur));
dispatcher.getRequestContext().put(Message.PROTOCOL_HEADERS, headers);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link org.w3c.dom.Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws
TransformerConfigurationException, SOAPException
{
final Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
final DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* 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 javax.xml.ws.Dispatch} instantie en de
* benodigde {@link java.security.KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
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);
final FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
final IDataSet dataset;
try {
final Class<? extends AbstractIntegrationTest> clazz = getClass();
final IDataSet[] dataSets = new IDataSet[getDataBestanden().size()];
int index = 0;
for (final String dataBestand : getDataBestanden()) {
dataSets[index++] = builder.build(clazz.getResourceAsStream(dataBestand));
}
dataset = new CompositeDataSet(dataSets);
} catch (final DataSetException ex) {
throw new IllegalStateException("DBUnit dataset kan niet ingeladen worden", ex);
}
final ReplacementDataSet filteredDataSet = new ReplacementDataSet(dataset);
filteredDataSet.addReplacementObject("[NULL]", null);
databaseTester.setDataSet(filteredDataSet);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
final Statement st = databaseTester.getConnection().getConnection().createStatement();
final InputStream afterburnerInputStream = getClass().getResourceAsStream("/data/afterburner.sql");
if (afterburnerInputStream != null) {
final String myString = IOUtils.toString(afterburnerInputStream, "UTF-8");
st.execute(myString);
}
} catch (final Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Retourneert de data bestanden die (middels DBUnit) voor elke test in deze class geladen moeten worden in de
* database.
*
* @return een lijst van data bestanden die ingeladen moeten worden.
*/
private List<String> getDataBestanden() {
final List<String> dataBestanden = getInitieleDataBestanden();
final List<String> additioneleDataBestanden = getAdditioneleDataBestanden();
if (additioneleDataBestanden != null && !additioneleDataBestanden.isEmpty()) {
dataBestanden.addAll(additioneleDataBestanden);
}
return dataBestanden;
}
/**
* Geeft de bestanden die bij de intitialisatie van de database gebruikt worden.
*
* @return de lijst met intitiele data bestanden
*/
protected List<String> getInitieleDataBestanden() {
final List<String> dataBestanden = new ArrayList<>();
dataBestanden.addAll(Arrays.asList(
"/data/stamgegevensStatisch.xml",
"/data/stamgegevensNationaliteit.xml",
"/data/stamgegevensLandGebied.xml",
"/data/partijEnGemeente.xml",
"/data/stamgegevensAbonnement.xml",
"/data/testdata.xml"
));
return dataBestanden;
}
/**
* Lijst van eventueel nog additionele data bestanden die ingelezen moeten worden.
*
* @return een lijst van additionele data bestanden.
* @see AbstractIntegrationTest#getDataBestanden()
*/
protected List<String> getAdditioneleDataBestanden() {
return Collections.emptyList();
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws java.net.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 javax.xml.ws.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 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) {
final Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/**
* Private, lokale {@link org.dbunit.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) {
final 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) {
}
}
protected void printResponse(final Document document) throws
Exception
{
final String xml = XmlUtils.toXmlString(document.getDocumentElement());
LOGGER.info("XML Bericht:\n{}", xml);
}
}
|
201774_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.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.sql.Statement;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.bind.JAXBException;
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 nl.bzk.brp.util.AutorisatieOffloadGegevens;
import nl.bzk.brp.utils.XmlUtils;
import org.apache.cxf.helpers.IOUtils;
import org.apache.cxf.message.Message;
import org.apache.wss4j.common.ext.WSSecurityException;
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.ReplacementDataSet;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.springframework.transaction.annotation.Transactional;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/**
* Abstracte superclass voor repository (persistence) testcases.
*/
@Transactional(transactionManager = "lezenSchrijvenTransactionManager")
@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";
protected static final String NODE_RESULTAAT = "//brp:resultaat";
protected static final String NODE_VERWERKING = NODE_RESULTAAT + "/brp:verwerking";
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Value("${jetty.port}")
protected String jettyPort;
private DataSource dataSrc;
@Inject
@Named("lezenSchrijvenDataSource")
public void setDataSource(final DataSource dataSource) {
super.setDataSource(dataSource);
this.dataSrc = dataSource;
}
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
final 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 org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
return verzendBerichtNaarService(berichtBestand, null, null);
}
protected Node verzendBerichtNaarService(final String berichtBestand, String ondertekenaar, String transporteur)
throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
// Bouw het initiele request bericht
final SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
if (ondertekenaar != null && transporteur != null) {
voegSecurityHeadersToeAanBericht(request, ondertekenaar, transporteur);
}
// Haal het antwoord op
final 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
{
final DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
final Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
// Eventuele post processing van het Document voordat het bericht naar de server gaat.
bewerkRequestDocumentVoorVerzending(request);
final SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Pas het Document aan voordat het naar de server wordt gestuurd. Dit is een functie voor post-processing van het
* document. Bij bijhouding worden bijvoorbeeld hier de objectSleutels ingevuld.
* @param request het request document.
*/
protected abstract void bewerkRequestDocumentVoorVerzending(final Document request);
/**
* Deze methode past de opgegeven {@link javax.xml.soap.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, String ondertekenaar, String transporteur) throws WSSecurityException,
KeyStoreException, JAXBException
{
// List<Header> headersList = new ArrayList<>();
// final Map<String, Object> requestContext = dispatcher.getRequestContext();
// Header testSoapHeader1 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_ONDERTEKENAAR), "1234", new JAXBDataBinding(String.class));
// Header testSoapHeader2 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_TRANSPORTEUR), "5678", new JAXBDataBinding(String.class));
// headersList.add(testSoapHeader1);
// headersList.add(testSoapHeader2);
// requestContext.put(Header.HEADER_LIST, headersList);
Map<String, List<String>> headers = new HashMap<>();
headers.put(AutorisatieOffloadGegevens.OIN_ONDERTEKENAAR, Collections.singletonList(ondertekenaar));
headers.put(AutorisatieOffloadGegevens.OIN_TRANSPORTEUR, Collections.singletonList(transporteur));
dispatcher.getRequestContext().put(Message.PROTOCOL_HEADERS, headers);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link org.w3c.dom.Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws
TransformerConfigurationException, SOAPException
{
final Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
final DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* 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 javax.xml.ws.Dispatch} instantie en de
* benodigde {@link java.security.KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
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);
final FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
final IDataSet dataset;
try {
final Class<? extends AbstractIntegrationTest> clazz = getClass();
final IDataSet[] dataSets = new IDataSet[getDataBestanden().size()];
int index = 0;
for (final String dataBestand : getDataBestanden()) {
dataSets[index++] = builder.build(clazz.getResourceAsStream(dataBestand));
}
dataset = new CompositeDataSet(dataSets);
} catch (final DataSetException ex) {
throw new IllegalStateException("DBUnit dataset kan niet ingeladen worden", ex);
}
final ReplacementDataSet filteredDataSet = new ReplacementDataSet(dataset);
filteredDataSet.addReplacementObject("[NULL]", null);
databaseTester.setDataSet(filteredDataSet);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
final Statement st = databaseTester.getConnection().getConnection().createStatement();
final InputStream afterburnerInputStream = getClass().getResourceAsStream("/data/afterburner.sql");
if (afterburnerInputStream != null) {
final String myString = IOUtils.toString(afterburnerInputStream, "UTF-8");
st.execute(myString);
}
} catch (final Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Retourneert de data bestanden die (middels DBUnit) voor elke test in deze class geladen moeten worden in de
* database.
*
* @return een lijst van data bestanden die ingeladen moeten worden.
*/
private List<String> getDataBestanden() {
final List<String> dataBestanden = getInitieleDataBestanden();
final List<String> additioneleDataBestanden = getAdditioneleDataBestanden();
if (additioneleDataBestanden != null && !additioneleDataBestanden.isEmpty()) {
dataBestanden.addAll(additioneleDataBestanden);
}
return dataBestanden;
}
/**
* Geeft de bestanden die bij de intitialisatie van de database gebruikt worden.
*
* @return de lijst met intitiele data bestanden
*/
protected List<String> getInitieleDataBestanden() {
final List<String> dataBestanden = new ArrayList<>();
dataBestanden.addAll(Arrays.asList(
"/data/stamgegevensStatisch.xml",
"/data/stamgegevensNationaliteit.xml",
"/data/stamgegevensLandGebied.xml",
"/data/partijEnGemeente.xml",
"/data/stamgegevensAbonnement.xml",
"/data/testdata.xml"
));
return dataBestanden;
}
/**
* Lijst van eventueel nog additionele data bestanden die ingelezen moeten worden.
*
* @return een lijst van additionele data bestanden.
* @see AbstractIntegrationTest#getDataBestanden()
*/
protected List<String> getAdditioneleDataBestanden() {
return Collections.emptyList();
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws java.net.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 javax.xml.ws.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 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) {
final Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/**
* Private, lokale {@link org.dbunit.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) {
final 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) {
}
}
protected void printResponse(final Document document) throws
Exception
{
final String xml = XmlUtils.toXmlString(document.getDocumentElement());
LOGGER.info("XML Bericht:\n{}", xml);
}
}
| MinBZK/OperatieBRP | 2016/brp 2016-02-09/algemeen/algemeen-webservice/webservice-basis/src/test/java/nl/bzk/brp/web/service/AbstractIntegrationTest.java | 4,408 | /**
* Pas het Document aan voordat het naar de server wordt gestuurd. Dit is een functie voor post-processing van het
* document. Bij bijhouding worden bijvoorbeeld hier de objectSleutels ingevuld.
* @param request het request document.
*/ | 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.sql.Statement;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.bind.JAXBException;
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 nl.bzk.brp.util.AutorisatieOffloadGegevens;
import nl.bzk.brp.utils.XmlUtils;
import org.apache.cxf.helpers.IOUtils;
import org.apache.cxf.message.Message;
import org.apache.wss4j.common.ext.WSSecurityException;
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.ReplacementDataSet;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.springframework.transaction.annotation.Transactional;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/**
* Abstracte superclass voor repository (persistence) testcases.
*/
@Transactional(transactionManager = "lezenSchrijvenTransactionManager")
@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";
protected static final String NODE_RESULTAAT = "//brp:resultaat";
protected static final String NODE_VERWERKING = NODE_RESULTAAT + "/brp:verwerking";
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Value("${jetty.port}")
protected String jettyPort;
private DataSource dataSrc;
@Inject
@Named("lezenSchrijvenDataSource")
public void setDataSource(final DataSource dataSource) {
super.setDataSource(dataSource);
this.dataSrc = dataSource;
}
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
final 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 org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
return verzendBerichtNaarService(berichtBestand, null, null);
}
protected Node verzendBerichtNaarService(final String berichtBestand, String ondertekenaar, String transporteur)
throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
// Bouw het initiele request bericht
final SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
if (ondertekenaar != null && transporteur != null) {
voegSecurityHeadersToeAanBericht(request, ondertekenaar, transporteur);
}
// Haal het antwoord op
final 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
{
final DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
final Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
// Eventuele post processing van het Document voordat het bericht naar de server gaat.
bewerkRequestDocumentVoorVerzending(request);
final SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Pas het Document<SUF>*/
protected abstract void bewerkRequestDocumentVoorVerzending(final Document request);
/**
* Deze methode past de opgegeven {@link javax.xml.soap.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, String ondertekenaar, String transporteur) throws WSSecurityException,
KeyStoreException, JAXBException
{
// List<Header> headersList = new ArrayList<>();
// final Map<String, Object> requestContext = dispatcher.getRequestContext();
// Header testSoapHeader1 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_ONDERTEKENAAR), "1234", new JAXBDataBinding(String.class));
// Header testSoapHeader2 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_TRANSPORTEUR), "5678", new JAXBDataBinding(String.class));
// headersList.add(testSoapHeader1);
// headersList.add(testSoapHeader2);
// requestContext.put(Header.HEADER_LIST, headersList);
Map<String, List<String>> headers = new HashMap<>();
headers.put(AutorisatieOffloadGegevens.OIN_ONDERTEKENAAR, Collections.singletonList(ondertekenaar));
headers.put(AutorisatieOffloadGegevens.OIN_TRANSPORTEUR, Collections.singletonList(transporteur));
dispatcher.getRequestContext().put(Message.PROTOCOL_HEADERS, headers);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link org.w3c.dom.Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws
TransformerConfigurationException, SOAPException
{
final Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
final DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* 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 javax.xml.ws.Dispatch} instantie en de
* benodigde {@link java.security.KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
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);
final FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
final IDataSet dataset;
try {
final Class<? extends AbstractIntegrationTest> clazz = getClass();
final IDataSet[] dataSets = new IDataSet[getDataBestanden().size()];
int index = 0;
for (final String dataBestand : getDataBestanden()) {
dataSets[index++] = builder.build(clazz.getResourceAsStream(dataBestand));
}
dataset = new CompositeDataSet(dataSets);
} catch (final DataSetException ex) {
throw new IllegalStateException("DBUnit dataset kan niet ingeladen worden", ex);
}
final ReplacementDataSet filteredDataSet = new ReplacementDataSet(dataset);
filteredDataSet.addReplacementObject("[NULL]", null);
databaseTester.setDataSet(filteredDataSet);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
final Statement st = databaseTester.getConnection().getConnection().createStatement();
final InputStream afterburnerInputStream = getClass().getResourceAsStream("/data/afterburner.sql");
if (afterburnerInputStream != null) {
final String myString = IOUtils.toString(afterburnerInputStream, "UTF-8");
st.execute(myString);
}
} catch (final Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Retourneert de data bestanden die (middels DBUnit) voor elke test in deze class geladen moeten worden in de
* database.
*
* @return een lijst van data bestanden die ingeladen moeten worden.
*/
private List<String> getDataBestanden() {
final List<String> dataBestanden = getInitieleDataBestanden();
final List<String> additioneleDataBestanden = getAdditioneleDataBestanden();
if (additioneleDataBestanden != null && !additioneleDataBestanden.isEmpty()) {
dataBestanden.addAll(additioneleDataBestanden);
}
return dataBestanden;
}
/**
* Geeft de bestanden die bij de intitialisatie van de database gebruikt worden.
*
* @return de lijst met intitiele data bestanden
*/
protected List<String> getInitieleDataBestanden() {
final List<String> dataBestanden = new ArrayList<>();
dataBestanden.addAll(Arrays.asList(
"/data/stamgegevensStatisch.xml",
"/data/stamgegevensNationaliteit.xml",
"/data/stamgegevensLandGebied.xml",
"/data/partijEnGemeente.xml",
"/data/stamgegevensAbonnement.xml",
"/data/testdata.xml"
));
return dataBestanden;
}
/**
* Lijst van eventueel nog additionele data bestanden die ingelezen moeten worden.
*
* @return een lijst van additionele data bestanden.
* @see AbstractIntegrationTest#getDataBestanden()
*/
protected List<String> getAdditioneleDataBestanden() {
return Collections.emptyList();
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws java.net.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 javax.xml.ws.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 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) {
final Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/**
* Private, lokale {@link org.dbunit.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) {
final 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) {
}
}
protected void printResponse(final Document document) throws
Exception
{
final String xml = XmlUtils.toXmlString(document.getDocumentElement());
LOGGER.info("XML Bericht:\n{}", xml);
}
}
|
201774_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.sql.Statement;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.bind.JAXBException;
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 nl.bzk.brp.util.AutorisatieOffloadGegevens;
import nl.bzk.brp.utils.XmlUtils;
import org.apache.cxf.helpers.IOUtils;
import org.apache.cxf.message.Message;
import org.apache.wss4j.common.ext.WSSecurityException;
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.ReplacementDataSet;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.springframework.transaction.annotation.Transactional;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/**
* Abstracte superclass voor repository (persistence) testcases.
*/
@Transactional(transactionManager = "lezenSchrijvenTransactionManager")
@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";
protected static final String NODE_RESULTAAT = "//brp:resultaat";
protected static final String NODE_VERWERKING = NODE_RESULTAAT + "/brp:verwerking";
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Value("${jetty.port}")
protected String jettyPort;
private DataSource dataSrc;
@Inject
@Named("lezenSchrijvenDataSource")
public void setDataSource(final DataSource dataSource) {
super.setDataSource(dataSource);
this.dataSrc = dataSource;
}
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
final 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 org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
return verzendBerichtNaarService(berichtBestand, null, null);
}
protected Node verzendBerichtNaarService(final String berichtBestand, String ondertekenaar, String transporteur)
throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
// Bouw het initiele request bericht
final SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
if (ondertekenaar != null && transporteur != null) {
voegSecurityHeadersToeAanBericht(request, ondertekenaar, transporteur);
}
// Haal het antwoord op
final 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
{
final DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
final Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
// Eventuele post processing van het Document voordat het bericht naar de server gaat.
bewerkRequestDocumentVoorVerzending(request);
final SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Pas het Document aan voordat het naar de server wordt gestuurd. Dit is een functie voor post-processing van het
* document. Bij bijhouding worden bijvoorbeeld hier de objectSleutels ingevuld.
* @param request het request document.
*/
protected abstract void bewerkRequestDocumentVoorVerzending(final Document request);
/**
* Deze methode past de opgegeven {@link javax.xml.soap.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, String ondertekenaar, String transporteur) throws WSSecurityException,
KeyStoreException, JAXBException
{
// List<Header> headersList = new ArrayList<>();
// final Map<String, Object> requestContext = dispatcher.getRequestContext();
// Header testSoapHeader1 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_ONDERTEKENAAR), "1234", new JAXBDataBinding(String.class));
// Header testSoapHeader2 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_TRANSPORTEUR), "5678", new JAXBDataBinding(String.class));
// headersList.add(testSoapHeader1);
// headersList.add(testSoapHeader2);
// requestContext.put(Header.HEADER_LIST, headersList);
Map<String, List<String>> headers = new HashMap<>();
headers.put(AutorisatieOffloadGegevens.OIN_ONDERTEKENAAR, Collections.singletonList(ondertekenaar));
headers.put(AutorisatieOffloadGegevens.OIN_TRANSPORTEUR, Collections.singletonList(transporteur));
dispatcher.getRequestContext().put(Message.PROTOCOL_HEADERS, headers);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link org.w3c.dom.Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws
TransformerConfigurationException, SOAPException
{
final Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
final DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* 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 javax.xml.ws.Dispatch} instantie en de
* benodigde {@link java.security.KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
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);
final FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
final IDataSet dataset;
try {
final Class<? extends AbstractIntegrationTest> clazz = getClass();
final IDataSet[] dataSets = new IDataSet[getDataBestanden().size()];
int index = 0;
for (final String dataBestand : getDataBestanden()) {
dataSets[index++] = builder.build(clazz.getResourceAsStream(dataBestand));
}
dataset = new CompositeDataSet(dataSets);
} catch (final DataSetException ex) {
throw new IllegalStateException("DBUnit dataset kan niet ingeladen worden", ex);
}
final ReplacementDataSet filteredDataSet = new ReplacementDataSet(dataset);
filteredDataSet.addReplacementObject("[NULL]", null);
databaseTester.setDataSet(filteredDataSet);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
final Statement st = databaseTester.getConnection().getConnection().createStatement();
final InputStream afterburnerInputStream = getClass().getResourceAsStream("/data/afterburner.sql");
if (afterburnerInputStream != null) {
final String myString = IOUtils.toString(afterburnerInputStream, "UTF-8");
st.execute(myString);
}
} catch (final Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Retourneert de data bestanden die (middels DBUnit) voor elke test in deze class geladen moeten worden in de
* database.
*
* @return een lijst van data bestanden die ingeladen moeten worden.
*/
private List<String> getDataBestanden() {
final List<String> dataBestanden = getInitieleDataBestanden();
final List<String> additioneleDataBestanden = getAdditioneleDataBestanden();
if (additioneleDataBestanden != null && !additioneleDataBestanden.isEmpty()) {
dataBestanden.addAll(additioneleDataBestanden);
}
return dataBestanden;
}
/**
* Geeft de bestanden die bij de intitialisatie van de database gebruikt worden.
*
* @return de lijst met intitiele data bestanden
*/
protected List<String> getInitieleDataBestanden() {
final List<String> dataBestanden = new ArrayList<>();
dataBestanden.addAll(Arrays.asList(
"/data/stamgegevensStatisch.xml",
"/data/stamgegevensNationaliteit.xml",
"/data/stamgegevensLandGebied.xml",
"/data/partijEnGemeente.xml",
"/data/stamgegevensAbonnement.xml",
"/data/testdata.xml"
));
return dataBestanden;
}
/**
* Lijst van eventueel nog additionele data bestanden die ingelezen moeten worden.
*
* @return een lijst van additionele data bestanden.
* @see AbstractIntegrationTest#getDataBestanden()
*/
protected List<String> getAdditioneleDataBestanden() {
return Collections.emptyList();
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws java.net.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 javax.xml.ws.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 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) {
final Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/**
* Private, lokale {@link org.dbunit.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) {
final 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) {
}
}
protected void printResponse(final Document document) throws
Exception
{
final String xml = XmlUtils.toXmlString(document.getDocumentElement());
LOGGER.info("XML Bericht:\n{}", xml);
}
}
| MinBZK/OperatieBRP | 2016/brp 2016-02-09/algemeen/algemeen-webservice/webservice-basis/src/test/java/nl/bzk/brp/web/service/AbstractIntegrationTest.java | 4,408 | /**
* Deze methode past de opgegeven {@link javax.xml.soap.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.sql.Statement;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.bind.JAXBException;
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 nl.bzk.brp.util.AutorisatieOffloadGegevens;
import nl.bzk.brp.utils.XmlUtils;
import org.apache.cxf.helpers.IOUtils;
import org.apache.cxf.message.Message;
import org.apache.wss4j.common.ext.WSSecurityException;
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.ReplacementDataSet;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.springframework.transaction.annotation.Transactional;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/**
* Abstracte superclass voor repository (persistence) testcases.
*/
@Transactional(transactionManager = "lezenSchrijvenTransactionManager")
@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";
protected static final String NODE_RESULTAAT = "//brp:resultaat";
protected static final String NODE_VERWERKING = NODE_RESULTAAT + "/brp:verwerking";
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Value("${jetty.port}")
protected String jettyPort;
private DataSource dataSrc;
@Inject
@Named("lezenSchrijvenDataSource")
public void setDataSource(final DataSource dataSource) {
super.setDataSource(dataSource);
this.dataSrc = dataSource;
}
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
final 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 org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
return verzendBerichtNaarService(berichtBestand, null, null);
}
protected Node verzendBerichtNaarService(final String berichtBestand, String ondertekenaar, String transporteur)
throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
// Bouw het initiele request bericht
final SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
if (ondertekenaar != null && transporteur != null) {
voegSecurityHeadersToeAanBericht(request, ondertekenaar, transporteur);
}
// Haal het antwoord op
final 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
{
final DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
final Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
// Eventuele post processing van het Document voordat het bericht naar de server gaat.
bewerkRequestDocumentVoorVerzending(request);
final SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Pas het Document aan voordat het naar de server wordt gestuurd. Dit is een functie voor post-processing van het
* document. Bij bijhouding worden bijvoorbeeld hier de objectSleutels ingevuld.
* @param request het request document.
*/
protected abstract void bewerkRequestDocumentVoorVerzending(final Document request);
/**
* Deze methode past<SUF>*/
private void voegSecurityHeadersToeAanBericht(final SOAPMessage request, String ondertekenaar, String transporteur) throws WSSecurityException,
KeyStoreException, JAXBException
{
// List<Header> headersList = new ArrayList<>();
// final Map<String, Object> requestContext = dispatcher.getRequestContext();
// Header testSoapHeader1 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_ONDERTEKENAAR), "1234", new JAXBDataBinding(String.class));
// Header testSoapHeader2 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_TRANSPORTEUR), "5678", new JAXBDataBinding(String.class));
// headersList.add(testSoapHeader1);
// headersList.add(testSoapHeader2);
// requestContext.put(Header.HEADER_LIST, headersList);
Map<String, List<String>> headers = new HashMap<>();
headers.put(AutorisatieOffloadGegevens.OIN_ONDERTEKENAAR, Collections.singletonList(ondertekenaar));
headers.put(AutorisatieOffloadGegevens.OIN_TRANSPORTEUR, Collections.singletonList(transporteur));
dispatcher.getRequestContext().put(Message.PROTOCOL_HEADERS, headers);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link org.w3c.dom.Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws
TransformerConfigurationException, SOAPException
{
final Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
final DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* 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 javax.xml.ws.Dispatch} instantie en de
* benodigde {@link java.security.KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
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);
final FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
final IDataSet dataset;
try {
final Class<? extends AbstractIntegrationTest> clazz = getClass();
final IDataSet[] dataSets = new IDataSet[getDataBestanden().size()];
int index = 0;
for (final String dataBestand : getDataBestanden()) {
dataSets[index++] = builder.build(clazz.getResourceAsStream(dataBestand));
}
dataset = new CompositeDataSet(dataSets);
} catch (final DataSetException ex) {
throw new IllegalStateException("DBUnit dataset kan niet ingeladen worden", ex);
}
final ReplacementDataSet filteredDataSet = new ReplacementDataSet(dataset);
filteredDataSet.addReplacementObject("[NULL]", null);
databaseTester.setDataSet(filteredDataSet);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
final Statement st = databaseTester.getConnection().getConnection().createStatement();
final InputStream afterburnerInputStream = getClass().getResourceAsStream("/data/afterburner.sql");
if (afterburnerInputStream != null) {
final String myString = IOUtils.toString(afterburnerInputStream, "UTF-8");
st.execute(myString);
}
} catch (final Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Retourneert de data bestanden die (middels DBUnit) voor elke test in deze class geladen moeten worden in de
* database.
*
* @return een lijst van data bestanden die ingeladen moeten worden.
*/
private List<String> getDataBestanden() {
final List<String> dataBestanden = getInitieleDataBestanden();
final List<String> additioneleDataBestanden = getAdditioneleDataBestanden();
if (additioneleDataBestanden != null && !additioneleDataBestanden.isEmpty()) {
dataBestanden.addAll(additioneleDataBestanden);
}
return dataBestanden;
}
/**
* Geeft de bestanden die bij de intitialisatie van de database gebruikt worden.
*
* @return de lijst met intitiele data bestanden
*/
protected List<String> getInitieleDataBestanden() {
final List<String> dataBestanden = new ArrayList<>();
dataBestanden.addAll(Arrays.asList(
"/data/stamgegevensStatisch.xml",
"/data/stamgegevensNationaliteit.xml",
"/data/stamgegevensLandGebied.xml",
"/data/partijEnGemeente.xml",
"/data/stamgegevensAbonnement.xml",
"/data/testdata.xml"
));
return dataBestanden;
}
/**
* Lijst van eventueel nog additionele data bestanden die ingelezen moeten worden.
*
* @return een lijst van additionele data bestanden.
* @see AbstractIntegrationTest#getDataBestanden()
*/
protected List<String> getAdditioneleDataBestanden() {
return Collections.emptyList();
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws java.net.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 javax.xml.ws.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 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) {
final Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/**
* Private, lokale {@link org.dbunit.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) {
final 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) {
}
}
protected void printResponse(final Document document) throws
Exception
{
final String xml = XmlUtils.toXmlString(document.getDocumentElement());
LOGGER.info("XML Bericht:\n{}", xml);
}
}
|
201774_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.sql.Statement;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.bind.JAXBException;
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 nl.bzk.brp.util.AutorisatieOffloadGegevens;
import nl.bzk.brp.utils.XmlUtils;
import org.apache.cxf.helpers.IOUtils;
import org.apache.cxf.message.Message;
import org.apache.wss4j.common.ext.WSSecurityException;
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.ReplacementDataSet;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.springframework.transaction.annotation.Transactional;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/**
* Abstracte superclass voor repository (persistence) testcases.
*/
@Transactional(transactionManager = "lezenSchrijvenTransactionManager")
@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";
protected static final String NODE_RESULTAAT = "//brp:resultaat";
protected static final String NODE_VERWERKING = NODE_RESULTAAT + "/brp:verwerking";
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Value("${jetty.port}")
protected String jettyPort;
private DataSource dataSrc;
@Inject
@Named("lezenSchrijvenDataSource")
public void setDataSource(final DataSource dataSource) {
super.setDataSource(dataSource);
this.dataSrc = dataSource;
}
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
final 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 org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
return verzendBerichtNaarService(berichtBestand, null, null);
}
protected Node verzendBerichtNaarService(final String berichtBestand, String ondertekenaar, String transporteur)
throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
// Bouw het initiele request bericht
final SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
if (ondertekenaar != null && transporteur != null) {
voegSecurityHeadersToeAanBericht(request, ondertekenaar, transporteur);
}
// Haal het antwoord op
final 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
{
final DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
final Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
// Eventuele post processing van het Document voordat het bericht naar de server gaat.
bewerkRequestDocumentVoorVerzending(request);
final SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Pas het Document aan voordat het naar de server wordt gestuurd. Dit is een functie voor post-processing van het
* document. Bij bijhouding worden bijvoorbeeld hier de objectSleutels ingevuld.
* @param request het request document.
*/
protected abstract void bewerkRequestDocumentVoorVerzending(final Document request);
/**
* Deze methode past de opgegeven {@link javax.xml.soap.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, String ondertekenaar, String transporteur) throws WSSecurityException,
KeyStoreException, JAXBException
{
// List<Header> headersList = new ArrayList<>();
// final Map<String, Object> requestContext = dispatcher.getRequestContext();
// Header testSoapHeader1 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_ONDERTEKENAAR), "1234", new JAXBDataBinding(String.class));
// Header testSoapHeader2 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_TRANSPORTEUR), "5678", new JAXBDataBinding(String.class));
// headersList.add(testSoapHeader1);
// headersList.add(testSoapHeader2);
// requestContext.put(Header.HEADER_LIST, headersList);
Map<String, List<String>> headers = new HashMap<>();
headers.put(AutorisatieOffloadGegevens.OIN_ONDERTEKENAAR, Collections.singletonList(ondertekenaar));
headers.put(AutorisatieOffloadGegevens.OIN_TRANSPORTEUR, Collections.singletonList(transporteur));
dispatcher.getRequestContext().put(Message.PROTOCOL_HEADERS, headers);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link org.w3c.dom.Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws
TransformerConfigurationException, SOAPException
{
final Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
final DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* 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 javax.xml.ws.Dispatch} instantie en de
* benodigde {@link java.security.KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
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);
final FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
final IDataSet dataset;
try {
final Class<? extends AbstractIntegrationTest> clazz = getClass();
final IDataSet[] dataSets = new IDataSet[getDataBestanden().size()];
int index = 0;
for (final String dataBestand : getDataBestanden()) {
dataSets[index++] = builder.build(clazz.getResourceAsStream(dataBestand));
}
dataset = new CompositeDataSet(dataSets);
} catch (final DataSetException ex) {
throw new IllegalStateException("DBUnit dataset kan niet ingeladen worden", ex);
}
final ReplacementDataSet filteredDataSet = new ReplacementDataSet(dataset);
filteredDataSet.addReplacementObject("[NULL]", null);
databaseTester.setDataSet(filteredDataSet);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
final Statement st = databaseTester.getConnection().getConnection().createStatement();
final InputStream afterburnerInputStream = getClass().getResourceAsStream("/data/afterburner.sql");
if (afterburnerInputStream != null) {
final String myString = IOUtils.toString(afterburnerInputStream, "UTF-8");
st.execute(myString);
}
} catch (final Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Retourneert de data bestanden die (middels DBUnit) voor elke test in deze class geladen moeten worden in de
* database.
*
* @return een lijst van data bestanden die ingeladen moeten worden.
*/
private List<String> getDataBestanden() {
final List<String> dataBestanden = getInitieleDataBestanden();
final List<String> additioneleDataBestanden = getAdditioneleDataBestanden();
if (additioneleDataBestanden != null && !additioneleDataBestanden.isEmpty()) {
dataBestanden.addAll(additioneleDataBestanden);
}
return dataBestanden;
}
/**
* Geeft de bestanden die bij de intitialisatie van de database gebruikt worden.
*
* @return de lijst met intitiele data bestanden
*/
protected List<String> getInitieleDataBestanden() {
final List<String> dataBestanden = new ArrayList<>();
dataBestanden.addAll(Arrays.asList(
"/data/stamgegevensStatisch.xml",
"/data/stamgegevensNationaliteit.xml",
"/data/stamgegevensLandGebied.xml",
"/data/partijEnGemeente.xml",
"/data/stamgegevensAbonnement.xml",
"/data/testdata.xml"
));
return dataBestanden;
}
/**
* Lijst van eventueel nog additionele data bestanden die ingelezen moeten worden.
*
* @return een lijst van additionele data bestanden.
* @see AbstractIntegrationTest#getDataBestanden()
*/
protected List<String> getAdditioneleDataBestanden() {
return Collections.emptyList();
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws java.net.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 javax.xml.ws.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 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) {
final Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/**
* Private, lokale {@link org.dbunit.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) {
final 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) {
}
}
protected void printResponse(final Document document) throws
Exception
{
final String xml = XmlUtils.toXmlString(document.getDocumentElement());
LOGGER.info("XML Bericht:\n{}", xml);
}
}
| MinBZK/OperatieBRP | 2016/brp 2016-02-09/algemeen/algemeen-webservice/webservice-basis/src/test/java/nl/bzk/brp/web/service/AbstractIntegrationTest.java | 4,408 | /**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link org.w3c.dom.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.sql.Statement;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.bind.JAXBException;
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 nl.bzk.brp.util.AutorisatieOffloadGegevens;
import nl.bzk.brp.utils.XmlUtils;
import org.apache.cxf.helpers.IOUtils;
import org.apache.cxf.message.Message;
import org.apache.wss4j.common.ext.WSSecurityException;
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.ReplacementDataSet;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.springframework.transaction.annotation.Transactional;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/**
* Abstracte superclass voor repository (persistence) testcases.
*/
@Transactional(transactionManager = "lezenSchrijvenTransactionManager")
@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";
protected static final String NODE_RESULTAAT = "//brp:resultaat";
protected static final String NODE_VERWERKING = NODE_RESULTAAT + "/brp:verwerking";
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Value("${jetty.port}")
protected String jettyPort;
private DataSource dataSrc;
@Inject
@Named("lezenSchrijvenDataSource")
public void setDataSource(final DataSource dataSource) {
super.setDataSource(dataSource);
this.dataSrc = dataSource;
}
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
final 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 org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
return verzendBerichtNaarService(berichtBestand, null, null);
}
protected Node verzendBerichtNaarService(final String berichtBestand, String ondertekenaar, String transporteur)
throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
// Bouw het initiele request bericht
final SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
if (ondertekenaar != null && transporteur != null) {
voegSecurityHeadersToeAanBericht(request, ondertekenaar, transporteur);
}
// Haal het antwoord op
final 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
{
final DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
final Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
// Eventuele post processing van het Document voordat het bericht naar de server gaat.
bewerkRequestDocumentVoorVerzending(request);
final SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Pas het Document aan voordat het naar de server wordt gestuurd. Dit is een functie voor post-processing van het
* document. Bij bijhouding worden bijvoorbeeld hier de objectSleutels ingevuld.
* @param request het request document.
*/
protected abstract void bewerkRequestDocumentVoorVerzending(final Document request);
/**
* Deze methode past de opgegeven {@link javax.xml.soap.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, String ondertekenaar, String transporteur) throws WSSecurityException,
KeyStoreException, JAXBException
{
// List<Header> headersList = new ArrayList<>();
// final Map<String, Object> requestContext = dispatcher.getRequestContext();
// Header testSoapHeader1 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_ONDERTEKENAAR), "1234", new JAXBDataBinding(String.class));
// Header testSoapHeader2 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_TRANSPORTEUR), "5678", new JAXBDataBinding(String.class));
// headersList.add(testSoapHeader1);
// headersList.add(testSoapHeader2);
// requestContext.put(Header.HEADER_LIST, headersList);
Map<String, List<String>> headers = new HashMap<>();
headers.put(AutorisatieOffloadGegevens.OIN_ONDERTEKENAAR, Collections.singletonList(ondertekenaar));
headers.put(AutorisatieOffloadGegevens.OIN_TRANSPORTEUR, Collections.singletonList(transporteur));
dispatcher.getRequestContext().put(Message.PROTOCOL_HEADERS, headers);
}
/**
* Deze methode extraheert<SUF>*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws
TransformerConfigurationException, SOAPException
{
final Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
final DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* 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 javax.xml.ws.Dispatch} instantie en de
* benodigde {@link java.security.KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
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);
final FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
final IDataSet dataset;
try {
final Class<? extends AbstractIntegrationTest> clazz = getClass();
final IDataSet[] dataSets = new IDataSet[getDataBestanden().size()];
int index = 0;
for (final String dataBestand : getDataBestanden()) {
dataSets[index++] = builder.build(clazz.getResourceAsStream(dataBestand));
}
dataset = new CompositeDataSet(dataSets);
} catch (final DataSetException ex) {
throw new IllegalStateException("DBUnit dataset kan niet ingeladen worden", ex);
}
final ReplacementDataSet filteredDataSet = new ReplacementDataSet(dataset);
filteredDataSet.addReplacementObject("[NULL]", null);
databaseTester.setDataSet(filteredDataSet);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
final Statement st = databaseTester.getConnection().getConnection().createStatement();
final InputStream afterburnerInputStream = getClass().getResourceAsStream("/data/afterburner.sql");
if (afterburnerInputStream != null) {
final String myString = IOUtils.toString(afterburnerInputStream, "UTF-8");
st.execute(myString);
}
} catch (final Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Retourneert de data bestanden die (middels DBUnit) voor elke test in deze class geladen moeten worden in de
* database.
*
* @return een lijst van data bestanden die ingeladen moeten worden.
*/
private List<String> getDataBestanden() {
final List<String> dataBestanden = getInitieleDataBestanden();
final List<String> additioneleDataBestanden = getAdditioneleDataBestanden();
if (additioneleDataBestanden != null && !additioneleDataBestanden.isEmpty()) {
dataBestanden.addAll(additioneleDataBestanden);
}
return dataBestanden;
}
/**
* Geeft de bestanden die bij de intitialisatie van de database gebruikt worden.
*
* @return de lijst met intitiele data bestanden
*/
protected List<String> getInitieleDataBestanden() {
final List<String> dataBestanden = new ArrayList<>();
dataBestanden.addAll(Arrays.asList(
"/data/stamgegevensStatisch.xml",
"/data/stamgegevensNationaliteit.xml",
"/data/stamgegevensLandGebied.xml",
"/data/partijEnGemeente.xml",
"/data/stamgegevensAbonnement.xml",
"/data/testdata.xml"
));
return dataBestanden;
}
/**
* Lijst van eventueel nog additionele data bestanden die ingelezen moeten worden.
*
* @return een lijst van additionele data bestanden.
* @see AbstractIntegrationTest#getDataBestanden()
*/
protected List<String> getAdditioneleDataBestanden() {
return Collections.emptyList();
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws java.net.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 javax.xml.ws.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 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) {
final Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/**
* Private, lokale {@link org.dbunit.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) {
final 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) {
}
}
protected void printResponse(final Document document) throws
Exception
{
final String xml = XmlUtils.toXmlString(document.getDocumentElement());
LOGGER.info("XML Bericht:\n{}", xml);
}
}
|
201774_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.sql.Statement;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.bind.JAXBException;
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 nl.bzk.brp.util.AutorisatieOffloadGegevens;
import nl.bzk.brp.utils.XmlUtils;
import org.apache.cxf.helpers.IOUtils;
import org.apache.cxf.message.Message;
import org.apache.wss4j.common.ext.WSSecurityException;
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.ReplacementDataSet;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.springframework.transaction.annotation.Transactional;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/**
* Abstracte superclass voor repository (persistence) testcases.
*/
@Transactional(transactionManager = "lezenSchrijvenTransactionManager")
@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";
protected static final String NODE_RESULTAAT = "//brp:resultaat";
protected static final String NODE_VERWERKING = NODE_RESULTAAT + "/brp:verwerking";
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Value("${jetty.port}")
protected String jettyPort;
private DataSource dataSrc;
@Inject
@Named("lezenSchrijvenDataSource")
public void setDataSource(final DataSource dataSource) {
super.setDataSource(dataSource);
this.dataSrc = dataSource;
}
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
final 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 org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
return verzendBerichtNaarService(berichtBestand, null, null);
}
protected Node verzendBerichtNaarService(final String berichtBestand, String ondertekenaar, String transporteur)
throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
// Bouw het initiele request bericht
final SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
if (ondertekenaar != null && transporteur != null) {
voegSecurityHeadersToeAanBericht(request, ondertekenaar, transporteur);
}
// Haal het antwoord op
final 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
{
final DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
final Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
// Eventuele post processing van het Document voordat het bericht naar de server gaat.
bewerkRequestDocumentVoorVerzending(request);
final SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Pas het Document aan voordat het naar de server wordt gestuurd. Dit is een functie voor post-processing van het
* document. Bij bijhouding worden bijvoorbeeld hier de objectSleutels ingevuld.
* @param request het request document.
*/
protected abstract void bewerkRequestDocumentVoorVerzending(final Document request);
/**
* Deze methode past de opgegeven {@link javax.xml.soap.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, String ondertekenaar, String transporteur) throws WSSecurityException,
KeyStoreException, JAXBException
{
// List<Header> headersList = new ArrayList<>();
// final Map<String, Object> requestContext = dispatcher.getRequestContext();
// Header testSoapHeader1 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_ONDERTEKENAAR), "1234", new JAXBDataBinding(String.class));
// Header testSoapHeader2 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_TRANSPORTEUR), "5678", new JAXBDataBinding(String.class));
// headersList.add(testSoapHeader1);
// headersList.add(testSoapHeader2);
// requestContext.put(Header.HEADER_LIST, headersList);
Map<String, List<String>> headers = new HashMap<>();
headers.put(AutorisatieOffloadGegevens.OIN_ONDERTEKENAAR, Collections.singletonList(ondertekenaar));
headers.put(AutorisatieOffloadGegevens.OIN_TRANSPORTEUR, Collections.singletonList(transporteur));
dispatcher.getRequestContext().put(Message.PROTOCOL_HEADERS, headers);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link org.w3c.dom.Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws
TransformerConfigurationException, SOAPException
{
final Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
final DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* 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 javax.xml.ws.Dispatch} instantie en de
* benodigde {@link java.security.KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
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);
final FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
final IDataSet dataset;
try {
final Class<? extends AbstractIntegrationTest> clazz = getClass();
final IDataSet[] dataSets = new IDataSet[getDataBestanden().size()];
int index = 0;
for (final String dataBestand : getDataBestanden()) {
dataSets[index++] = builder.build(clazz.getResourceAsStream(dataBestand));
}
dataset = new CompositeDataSet(dataSets);
} catch (final DataSetException ex) {
throw new IllegalStateException("DBUnit dataset kan niet ingeladen worden", ex);
}
final ReplacementDataSet filteredDataSet = new ReplacementDataSet(dataset);
filteredDataSet.addReplacementObject("[NULL]", null);
databaseTester.setDataSet(filteredDataSet);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
final Statement st = databaseTester.getConnection().getConnection().createStatement();
final InputStream afterburnerInputStream = getClass().getResourceAsStream("/data/afterburner.sql");
if (afterburnerInputStream != null) {
final String myString = IOUtils.toString(afterburnerInputStream, "UTF-8");
st.execute(myString);
}
} catch (final Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Retourneert de data bestanden die (middels DBUnit) voor elke test in deze class geladen moeten worden in de
* database.
*
* @return een lijst van data bestanden die ingeladen moeten worden.
*/
private List<String> getDataBestanden() {
final List<String> dataBestanden = getInitieleDataBestanden();
final List<String> additioneleDataBestanden = getAdditioneleDataBestanden();
if (additioneleDataBestanden != null && !additioneleDataBestanden.isEmpty()) {
dataBestanden.addAll(additioneleDataBestanden);
}
return dataBestanden;
}
/**
* Geeft de bestanden die bij de intitialisatie van de database gebruikt worden.
*
* @return de lijst met intitiele data bestanden
*/
protected List<String> getInitieleDataBestanden() {
final List<String> dataBestanden = new ArrayList<>();
dataBestanden.addAll(Arrays.asList(
"/data/stamgegevensStatisch.xml",
"/data/stamgegevensNationaliteit.xml",
"/data/stamgegevensLandGebied.xml",
"/data/partijEnGemeente.xml",
"/data/stamgegevensAbonnement.xml",
"/data/testdata.xml"
));
return dataBestanden;
}
/**
* Lijst van eventueel nog additionele data bestanden die ingelezen moeten worden.
*
* @return een lijst van additionele data bestanden.
* @see AbstractIntegrationTest#getDataBestanden()
*/
protected List<String> getAdditioneleDataBestanden() {
return Collections.emptyList();
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws java.net.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 javax.xml.ws.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 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) {
final Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/**
* Private, lokale {@link org.dbunit.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) {
final 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) {
}
}
protected void printResponse(final Document document) throws
Exception
{
final String xml = XmlUtils.toXmlString(document.getDocumentElement());
LOGGER.info("XML Bericht:\n{}", xml);
}
}
| MinBZK/OperatieBRP | 2016/brp 2016-02-09/algemeen/algemeen-webservice/webservice-basis/src/test/java/nl/bzk/brp/web/service/AbstractIntegrationTest.java | 4,408 | /**
* 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 javax.xml.ws.Dispatch} instantie en de
* benodigde {@link java.security.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.sql.Statement;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.bind.JAXBException;
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 nl.bzk.brp.util.AutorisatieOffloadGegevens;
import nl.bzk.brp.utils.XmlUtils;
import org.apache.cxf.helpers.IOUtils;
import org.apache.cxf.message.Message;
import org.apache.wss4j.common.ext.WSSecurityException;
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.ReplacementDataSet;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.springframework.transaction.annotation.Transactional;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/**
* Abstracte superclass voor repository (persistence) testcases.
*/
@Transactional(transactionManager = "lezenSchrijvenTransactionManager")
@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";
protected static final String NODE_RESULTAAT = "//brp:resultaat";
protected static final String NODE_VERWERKING = NODE_RESULTAAT + "/brp:verwerking";
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Value("${jetty.port}")
protected String jettyPort;
private DataSource dataSrc;
@Inject
@Named("lezenSchrijvenDataSource")
public void setDataSource(final DataSource dataSource) {
super.setDataSource(dataSource);
this.dataSrc = dataSource;
}
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
final 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 org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
return verzendBerichtNaarService(berichtBestand, null, null);
}
protected Node verzendBerichtNaarService(final String berichtBestand, String ondertekenaar, String transporteur)
throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
// Bouw het initiele request bericht
final SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
if (ondertekenaar != null && transporteur != null) {
voegSecurityHeadersToeAanBericht(request, ondertekenaar, transporteur);
}
// Haal het antwoord op
final 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
{
final DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
final Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
// Eventuele post processing van het Document voordat het bericht naar de server gaat.
bewerkRequestDocumentVoorVerzending(request);
final SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Pas het Document aan voordat het naar de server wordt gestuurd. Dit is een functie voor post-processing van het
* document. Bij bijhouding worden bijvoorbeeld hier de objectSleutels ingevuld.
* @param request het request document.
*/
protected abstract void bewerkRequestDocumentVoorVerzending(final Document request);
/**
* Deze methode past de opgegeven {@link javax.xml.soap.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, String ondertekenaar, String transporteur) throws WSSecurityException,
KeyStoreException, JAXBException
{
// List<Header> headersList = new ArrayList<>();
// final Map<String, Object> requestContext = dispatcher.getRequestContext();
// Header testSoapHeader1 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_ONDERTEKENAAR), "1234", new JAXBDataBinding(String.class));
// Header testSoapHeader2 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_TRANSPORTEUR), "5678", new JAXBDataBinding(String.class));
// headersList.add(testSoapHeader1);
// headersList.add(testSoapHeader2);
// requestContext.put(Header.HEADER_LIST, headersList);
Map<String, List<String>> headers = new HashMap<>();
headers.put(AutorisatieOffloadGegevens.OIN_ONDERTEKENAAR, Collections.singletonList(ondertekenaar));
headers.put(AutorisatieOffloadGegevens.OIN_TRANSPORTEUR, Collections.singletonList(transporteur));
dispatcher.getRequestContext().put(Message.PROTOCOL_HEADERS, headers);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link org.w3c.dom.Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws
TransformerConfigurationException, SOAPException
{
final Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
final DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* Deze Before method<SUF>*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
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);
final FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
final IDataSet dataset;
try {
final Class<? extends AbstractIntegrationTest> clazz = getClass();
final IDataSet[] dataSets = new IDataSet[getDataBestanden().size()];
int index = 0;
for (final String dataBestand : getDataBestanden()) {
dataSets[index++] = builder.build(clazz.getResourceAsStream(dataBestand));
}
dataset = new CompositeDataSet(dataSets);
} catch (final DataSetException ex) {
throw new IllegalStateException("DBUnit dataset kan niet ingeladen worden", ex);
}
final ReplacementDataSet filteredDataSet = new ReplacementDataSet(dataset);
filteredDataSet.addReplacementObject("[NULL]", null);
databaseTester.setDataSet(filteredDataSet);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
final Statement st = databaseTester.getConnection().getConnection().createStatement();
final InputStream afterburnerInputStream = getClass().getResourceAsStream("/data/afterburner.sql");
if (afterburnerInputStream != null) {
final String myString = IOUtils.toString(afterburnerInputStream, "UTF-8");
st.execute(myString);
}
} catch (final Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Retourneert de data bestanden die (middels DBUnit) voor elke test in deze class geladen moeten worden in de
* database.
*
* @return een lijst van data bestanden die ingeladen moeten worden.
*/
private List<String> getDataBestanden() {
final List<String> dataBestanden = getInitieleDataBestanden();
final List<String> additioneleDataBestanden = getAdditioneleDataBestanden();
if (additioneleDataBestanden != null && !additioneleDataBestanden.isEmpty()) {
dataBestanden.addAll(additioneleDataBestanden);
}
return dataBestanden;
}
/**
* Geeft de bestanden die bij de intitialisatie van de database gebruikt worden.
*
* @return de lijst met intitiele data bestanden
*/
protected List<String> getInitieleDataBestanden() {
final List<String> dataBestanden = new ArrayList<>();
dataBestanden.addAll(Arrays.asList(
"/data/stamgegevensStatisch.xml",
"/data/stamgegevensNationaliteit.xml",
"/data/stamgegevensLandGebied.xml",
"/data/partijEnGemeente.xml",
"/data/stamgegevensAbonnement.xml",
"/data/testdata.xml"
));
return dataBestanden;
}
/**
* Lijst van eventueel nog additionele data bestanden die ingelezen moeten worden.
*
* @return een lijst van additionele data bestanden.
* @see AbstractIntegrationTest#getDataBestanden()
*/
protected List<String> getAdditioneleDataBestanden() {
return Collections.emptyList();
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws java.net.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 javax.xml.ws.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 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) {
final Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/**
* Private, lokale {@link org.dbunit.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) {
final 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) {
}
}
protected void printResponse(final Document document) throws
Exception
{
final String xml = XmlUtils.toXmlString(document.getDocumentElement());
LOGGER.info("XML Bericht:\n{}", xml);
}
}
|
201774_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.sql.Statement;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.bind.JAXBException;
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 nl.bzk.brp.util.AutorisatieOffloadGegevens;
import nl.bzk.brp.utils.XmlUtils;
import org.apache.cxf.helpers.IOUtils;
import org.apache.cxf.message.Message;
import org.apache.wss4j.common.ext.WSSecurityException;
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.ReplacementDataSet;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.springframework.transaction.annotation.Transactional;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/**
* Abstracte superclass voor repository (persistence) testcases.
*/
@Transactional(transactionManager = "lezenSchrijvenTransactionManager")
@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";
protected static final String NODE_RESULTAAT = "//brp:resultaat";
protected static final String NODE_VERWERKING = NODE_RESULTAAT + "/brp:verwerking";
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Value("${jetty.port}")
protected String jettyPort;
private DataSource dataSrc;
@Inject
@Named("lezenSchrijvenDataSource")
public void setDataSource(final DataSource dataSource) {
super.setDataSource(dataSource);
this.dataSrc = dataSource;
}
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
final 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 org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
return verzendBerichtNaarService(berichtBestand, null, null);
}
protected Node verzendBerichtNaarService(final String berichtBestand, String ondertekenaar, String transporteur)
throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
// Bouw het initiele request bericht
final SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
if (ondertekenaar != null && transporteur != null) {
voegSecurityHeadersToeAanBericht(request, ondertekenaar, transporteur);
}
// Haal het antwoord op
final 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
{
final DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
final Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
// Eventuele post processing van het Document voordat het bericht naar de server gaat.
bewerkRequestDocumentVoorVerzending(request);
final SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Pas het Document aan voordat het naar de server wordt gestuurd. Dit is een functie voor post-processing van het
* document. Bij bijhouding worden bijvoorbeeld hier de objectSleutels ingevuld.
* @param request het request document.
*/
protected abstract void bewerkRequestDocumentVoorVerzending(final Document request);
/**
* Deze methode past de opgegeven {@link javax.xml.soap.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, String ondertekenaar, String transporteur) throws WSSecurityException,
KeyStoreException, JAXBException
{
// List<Header> headersList = new ArrayList<>();
// final Map<String, Object> requestContext = dispatcher.getRequestContext();
// Header testSoapHeader1 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_ONDERTEKENAAR), "1234", new JAXBDataBinding(String.class));
// Header testSoapHeader2 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_TRANSPORTEUR), "5678", new JAXBDataBinding(String.class));
// headersList.add(testSoapHeader1);
// headersList.add(testSoapHeader2);
// requestContext.put(Header.HEADER_LIST, headersList);
Map<String, List<String>> headers = new HashMap<>();
headers.put(AutorisatieOffloadGegevens.OIN_ONDERTEKENAAR, Collections.singletonList(ondertekenaar));
headers.put(AutorisatieOffloadGegevens.OIN_TRANSPORTEUR, Collections.singletonList(transporteur));
dispatcher.getRequestContext().put(Message.PROTOCOL_HEADERS, headers);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link org.w3c.dom.Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws
TransformerConfigurationException, SOAPException
{
final Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
final DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* 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 javax.xml.ws.Dispatch} instantie en de
* benodigde {@link java.security.KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
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);
final FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
final IDataSet dataset;
try {
final Class<? extends AbstractIntegrationTest> clazz = getClass();
final IDataSet[] dataSets = new IDataSet[getDataBestanden().size()];
int index = 0;
for (final String dataBestand : getDataBestanden()) {
dataSets[index++] = builder.build(clazz.getResourceAsStream(dataBestand));
}
dataset = new CompositeDataSet(dataSets);
} catch (final DataSetException ex) {
throw new IllegalStateException("DBUnit dataset kan niet ingeladen worden", ex);
}
final ReplacementDataSet filteredDataSet = new ReplacementDataSet(dataset);
filteredDataSet.addReplacementObject("[NULL]", null);
databaseTester.setDataSet(filteredDataSet);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
final Statement st = databaseTester.getConnection().getConnection().createStatement();
final InputStream afterburnerInputStream = getClass().getResourceAsStream("/data/afterburner.sql");
if (afterburnerInputStream != null) {
final String myString = IOUtils.toString(afterburnerInputStream, "UTF-8");
st.execute(myString);
}
} catch (final Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Retourneert de data bestanden die (middels DBUnit) voor elke test in deze class geladen moeten worden in de
* database.
*
* @return een lijst van data bestanden die ingeladen moeten worden.
*/
private List<String> getDataBestanden() {
final List<String> dataBestanden = getInitieleDataBestanden();
final List<String> additioneleDataBestanden = getAdditioneleDataBestanden();
if (additioneleDataBestanden != null && !additioneleDataBestanden.isEmpty()) {
dataBestanden.addAll(additioneleDataBestanden);
}
return dataBestanden;
}
/**
* Geeft de bestanden die bij de intitialisatie van de database gebruikt worden.
*
* @return de lijst met intitiele data bestanden
*/
protected List<String> getInitieleDataBestanden() {
final List<String> dataBestanden = new ArrayList<>();
dataBestanden.addAll(Arrays.asList(
"/data/stamgegevensStatisch.xml",
"/data/stamgegevensNationaliteit.xml",
"/data/stamgegevensLandGebied.xml",
"/data/partijEnGemeente.xml",
"/data/stamgegevensAbonnement.xml",
"/data/testdata.xml"
));
return dataBestanden;
}
/**
* Lijst van eventueel nog additionele data bestanden die ingelezen moeten worden.
*
* @return een lijst van additionele data bestanden.
* @see AbstractIntegrationTest#getDataBestanden()
*/
protected List<String> getAdditioneleDataBestanden() {
return Collections.emptyList();
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws java.net.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 javax.xml.ws.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 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) {
final Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/**
* Private, lokale {@link org.dbunit.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) {
final 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) {
}
}
protected void printResponse(final Document document) throws
Exception
{
final String xml = XmlUtils.toXmlString(document.getDocumentElement());
LOGGER.info("XML Bericht:\n{}", xml);
}
}
| MinBZK/OperatieBRP | 2016/brp 2016-02-09/algemeen/algemeen-webservice/webservice-basis/src/test/java/nl/bzk/brp/web/service/AbstractIntegrationTest.java | 4,408 | /**
* 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.sql.Statement;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.bind.JAXBException;
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 nl.bzk.brp.util.AutorisatieOffloadGegevens;
import nl.bzk.brp.utils.XmlUtils;
import org.apache.cxf.helpers.IOUtils;
import org.apache.cxf.message.Message;
import org.apache.wss4j.common.ext.WSSecurityException;
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.ReplacementDataSet;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.springframework.transaction.annotation.Transactional;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/**
* Abstracte superclass voor repository (persistence) testcases.
*/
@Transactional(transactionManager = "lezenSchrijvenTransactionManager")
@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";
protected static final String NODE_RESULTAAT = "//brp:resultaat";
protected static final String NODE_VERWERKING = NODE_RESULTAAT + "/brp:verwerking";
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Value("${jetty.port}")
protected String jettyPort;
private DataSource dataSrc;
@Inject
@Named("lezenSchrijvenDataSource")
public void setDataSource(final DataSource dataSource) {
super.setDataSource(dataSource);
this.dataSrc = dataSource;
}
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
final 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 org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
return verzendBerichtNaarService(berichtBestand, null, null);
}
protected Node verzendBerichtNaarService(final String berichtBestand, String ondertekenaar, String transporteur)
throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
// Bouw het initiele request bericht
final SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
if (ondertekenaar != null && transporteur != null) {
voegSecurityHeadersToeAanBericht(request, ondertekenaar, transporteur);
}
// Haal het antwoord op
final 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
{
final DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
final Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
// Eventuele post processing van het Document voordat het bericht naar de server gaat.
bewerkRequestDocumentVoorVerzending(request);
final SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Pas het Document aan voordat het naar de server wordt gestuurd. Dit is een functie voor post-processing van het
* document. Bij bijhouding worden bijvoorbeeld hier de objectSleutels ingevuld.
* @param request het request document.
*/
protected abstract void bewerkRequestDocumentVoorVerzending(final Document request);
/**
* Deze methode past de opgegeven {@link javax.xml.soap.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, String ondertekenaar, String transporteur) throws WSSecurityException,
KeyStoreException, JAXBException
{
// List<Header> headersList = new ArrayList<>();
// final Map<String, Object> requestContext = dispatcher.getRequestContext();
// Header testSoapHeader1 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_ONDERTEKENAAR), "1234", new JAXBDataBinding(String.class));
// Header testSoapHeader2 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_TRANSPORTEUR), "5678", new JAXBDataBinding(String.class));
// headersList.add(testSoapHeader1);
// headersList.add(testSoapHeader2);
// requestContext.put(Header.HEADER_LIST, headersList);
Map<String, List<String>> headers = new HashMap<>();
headers.put(AutorisatieOffloadGegevens.OIN_ONDERTEKENAAR, Collections.singletonList(ondertekenaar));
headers.put(AutorisatieOffloadGegevens.OIN_TRANSPORTEUR, Collections.singletonList(transporteur));
dispatcher.getRequestContext().put(Message.PROTOCOL_HEADERS, headers);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link org.w3c.dom.Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws
TransformerConfigurationException, SOAPException
{
final Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
final DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* 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 javax.xml.ws.Dispatch} instantie en de
* benodigde {@link java.security.KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
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);
final FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
final IDataSet dataset;
try {
final Class<? extends AbstractIntegrationTest> clazz = getClass();
final IDataSet[] dataSets = new IDataSet[getDataBestanden().size()];
int index = 0;
for (final String dataBestand : getDataBestanden()) {
dataSets[index++] = builder.build(clazz.getResourceAsStream(dataBestand));
}
dataset = new CompositeDataSet(dataSets);
} catch (final DataSetException ex) {
throw new IllegalStateException("DBUnit dataset kan niet ingeladen worden", ex);
}
final ReplacementDataSet filteredDataSet = new ReplacementDataSet(dataset);
filteredDataSet.addReplacementObject("[NULL]", null);
databaseTester.setDataSet(filteredDataSet);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
final Statement st = databaseTester.getConnection().getConnection().createStatement();
final InputStream afterburnerInputStream = getClass().getResourceAsStream("/data/afterburner.sql");
if (afterburnerInputStream != null) {
final String myString = IOUtils.toString(afterburnerInputStream, "UTF-8");
st.execute(myString);
}
} catch (final Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Retourneert de data bestanden die (middels DBUnit) voor elke test in deze class geladen moeten worden in de
* database.
*
* @return een lijst van data bestanden die ingeladen moeten worden.
*/
private List<String> getDataBestanden() {
final List<String> dataBestanden = getInitieleDataBestanden();
final List<String> additioneleDataBestanden = getAdditioneleDataBestanden();
if (additioneleDataBestanden != null && !additioneleDataBestanden.isEmpty()) {
dataBestanden.addAll(additioneleDataBestanden);
}
return dataBestanden;
}
/**
* Geeft de bestanden die bij de intitialisatie van de database gebruikt worden.
*
* @return de lijst met intitiele data bestanden
*/
protected List<String> getInitieleDataBestanden() {
final List<String> dataBestanden = new ArrayList<>();
dataBestanden.addAll(Arrays.asList(
"/data/stamgegevensStatisch.xml",
"/data/stamgegevensNationaliteit.xml",
"/data/stamgegevensLandGebied.xml",
"/data/partijEnGemeente.xml",
"/data/stamgegevensAbonnement.xml",
"/data/testdata.xml"
));
return dataBestanden;
}
/**
* Lijst van eventueel nog additionele data bestanden die ingelezen moeten worden.
*
* @return een lijst van additionele data bestanden.
* @see AbstractIntegrationTest#getDataBestanden()
*/
protected List<String> getAdditioneleDataBestanden() {
return Collections.emptyList();
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws java.net.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 javax.xml.ws.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 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) {
final Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/**
* Private, lokale {@link org.dbunit.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) {
final 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) {
}
}
protected void printResponse(final Document document) throws
Exception
{
final String xml = XmlUtils.toXmlString(document.getDocumentElement());
LOGGER.info("XML Bericht:\n{}", xml);
}
}
|
201774_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.sql.Statement;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.bind.JAXBException;
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 nl.bzk.brp.util.AutorisatieOffloadGegevens;
import nl.bzk.brp.utils.XmlUtils;
import org.apache.cxf.helpers.IOUtils;
import org.apache.cxf.message.Message;
import org.apache.wss4j.common.ext.WSSecurityException;
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.ReplacementDataSet;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.springframework.transaction.annotation.Transactional;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/**
* Abstracte superclass voor repository (persistence) testcases.
*/
@Transactional(transactionManager = "lezenSchrijvenTransactionManager")
@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";
protected static final String NODE_RESULTAAT = "//brp:resultaat";
protected static final String NODE_VERWERKING = NODE_RESULTAAT + "/brp:verwerking";
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Value("${jetty.port}")
protected String jettyPort;
private DataSource dataSrc;
@Inject
@Named("lezenSchrijvenDataSource")
public void setDataSource(final DataSource dataSource) {
super.setDataSource(dataSource);
this.dataSrc = dataSource;
}
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
final 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 org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
return verzendBerichtNaarService(berichtBestand, null, null);
}
protected Node verzendBerichtNaarService(final String berichtBestand, String ondertekenaar, String transporteur)
throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
// Bouw het initiele request bericht
final SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
if (ondertekenaar != null && transporteur != null) {
voegSecurityHeadersToeAanBericht(request, ondertekenaar, transporteur);
}
// Haal het antwoord op
final 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
{
final DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
final Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
// Eventuele post processing van het Document voordat het bericht naar de server gaat.
bewerkRequestDocumentVoorVerzending(request);
final SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Pas het Document aan voordat het naar de server wordt gestuurd. Dit is een functie voor post-processing van het
* document. Bij bijhouding worden bijvoorbeeld hier de objectSleutels ingevuld.
* @param request het request document.
*/
protected abstract void bewerkRequestDocumentVoorVerzending(final Document request);
/**
* Deze methode past de opgegeven {@link javax.xml.soap.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, String ondertekenaar, String transporteur) throws WSSecurityException,
KeyStoreException, JAXBException
{
// List<Header> headersList = new ArrayList<>();
// final Map<String, Object> requestContext = dispatcher.getRequestContext();
// Header testSoapHeader1 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_ONDERTEKENAAR), "1234", new JAXBDataBinding(String.class));
// Header testSoapHeader2 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_TRANSPORTEUR), "5678", new JAXBDataBinding(String.class));
// headersList.add(testSoapHeader1);
// headersList.add(testSoapHeader2);
// requestContext.put(Header.HEADER_LIST, headersList);
Map<String, List<String>> headers = new HashMap<>();
headers.put(AutorisatieOffloadGegevens.OIN_ONDERTEKENAAR, Collections.singletonList(ondertekenaar));
headers.put(AutorisatieOffloadGegevens.OIN_TRANSPORTEUR, Collections.singletonList(transporteur));
dispatcher.getRequestContext().put(Message.PROTOCOL_HEADERS, headers);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link org.w3c.dom.Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws
TransformerConfigurationException, SOAPException
{
final Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
final DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* 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 javax.xml.ws.Dispatch} instantie en de
* benodigde {@link java.security.KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
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);
final FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
final IDataSet dataset;
try {
final Class<? extends AbstractIntegrationTest> clazz = getClass();
final IDataSet[] dataSets = new IDataSet[getDataBestanden().size()];
int index = 0;
for (final String dataBestand : getDataBestanden()) {
dataSets[index++] = builder.build(clazz.getResourceAsStream(dataBestand));
}
dataset = new CompositeDataSet(dataSets);
} catch (final DataSetException ex) {
throw new IllegalStateException("DBUnit dataset kan niet ingeladen worden", ex);
}
final ReplacementDataSet filteredDataSet = new ReplacementDataSet(dataset);
filteredDataSet.addReplacementObject("[NULL]", null);
databaseTester.setDataSet(filteredDataSet);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
final Statement st = databaseTester.getConnection().getConnection().createStatement();
final InputStream afterburnerInputStream = getClass().getResourceAsStream("/data/afterburner.sql");
if (afterburnerInputStream != null) {
final String myString = IOUtils.toString(afterburnerInputStream, "UTF-8");
st.execute(myString);
}
} catch (final Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Retourneert de data bestanden die (middels DBUnit) voor elke test in deze class geladen moeten worden in de
* database.
*
* @return een lijst van data bestanden die ingeladen moeten worden.
*/
private List<String> getDataBestanden() {
final List<String> dataBestanden = getInitieleDataBestanden();
final List<String> additioneleDataBestanden = getAdditioneleDataBestanden();
if (additioneleDataBestanden != null && !additioneleDataBestanden.isEmpty()) {
dataBestanden.addAll(additioneleDataBestanden);
}
return dataBestanden;
}
/**
* Geeft de bestanden die bij de intitialisatie van de database gebruikt worden.
*
* @return de lijst met intitiele data bestanden
*/
protected List<String> getInitieleDataBestanden() {
final List<String> dataBestanden = new ArrayList<>();
dataBestanden.addAll(Arrays.asList(
"/data/stamgegevensStatisch.xml",
"/data/stamgegevensNationaliteit.xml",
"/data/stamgegevensLandGebied.xml",
"/data/partijEnGemeente.xml",
"/data/stamgegevensAbonnement.xml",
"/data/testdata.xml"
));
return dataBestanden;
}
/**
* Lijst van eventueel nog additionele data bestanden die ingelezen moeten worden.
*
* @return een lijst van additionele data bestanden.
* @see AbstractIntegrationTest#getDataBestanden()
*/
protected List<String> getAdditioneleDataBestanden() {
return Collections.emptyList();
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws java.net.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 javax.xml.ws.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 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) {
final Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/**
* Private, lokale {@link org.dbunit.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) {
final 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) {
}
}
protected void printResponse(final Document document) throws
Exception
{
final String xml = XmlUtils.toXmlString(document.getDocumentElement());
LOGGER.info("XML Bericht:\n{}", xml);
}
}
| MinBZK/OperatieBRP | 2016/brp 2016-02-09/algemeen/algemeen-webservice/webservice-basis/src/test/java/nl/bzk/brp/web/service/AbstractIntegrationTest.java | 4,408 | // 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.sql.Statement;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.bind.JAXBException;
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 nl.bzk.brp.util.AutorisatieOffloadGegevens;
import nl.bzk.brp.utils.XmlUtils;
import org.apache.cxf.helpers.IOUtils;
import org.apache.cxf.message.Message;
import org.apache.wss4j.common.ext.WSSecurityException;
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.ReplacementDataSet;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.springframework.transaction.annotation.Transactional;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/**
* Abstracte superclass voor repository (persistence) testcases.
*/
@Transactional(transactionManager = "lezenSchrijvenTransactionManager")
@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";
protected static final String NODE_RESULTAAT = "//brp:resultaat";
protected static final String NODE_VERWERKING = NODE_RESULTAAT + "/brp:verwerking";
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Value("${jetty.port}")
protected String jettyPort;
private DataSource dataSrc;
@Inject
@Named("lezenSchrijvenDataSource")
public void setDataSource(final DataSource dataSource) {
super.setDataSource(dataSource);
this.dataSrc = dataSource;
}
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
final 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 org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
return verzendBerichtNaarService(berichtBestand, null, null);
}
protected Node verzendBerichtNaarService(final String berichtBestand, String ondertekenaar, String transporteur)
throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
// Bouw het initiele request bericht
final SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
if (ondertekenaar != null && transporteur != null) {
voegSecurityHeadersToeAanBericht(request, ondertekenaar, transporteur);
}
// Haal het antwoord op
final 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
{
final DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
final Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
// Eventuele post processing van het Document voordat het bericht naar de server gaat.
bewerkRequestDocumentVoorVerzending(request);
final SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Pas het Document aan voordat het naar de server wordt gestuurd. Dit is een functie voor post-processing van het
* document. Bij bijhouding worden bijvoorbeeld hier de objectSleutels ingevuld.
* @param request het request document.
*/
protected abstract void bewerkRequestDocumentVoorVerzending(final Document request);
/**
* Deze methode past de opgegeven {@link javax.xml.soap.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, String ondertekenaar, String transporteur) throws WSSecurityException,
KeyStoreException, JAXBException
{
// List<Header> headersList = new ArrayList<>();
// final Map<String, Object> requestContext = dispatcher.getRequestContext();
// Header testSoapHeader1 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_ONDERTEKENAAR), "1234", new JAXBDataBinding(String.class));
// Header testSoapHeader2 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_TRANSPORTEUR), "5678", new JAXBDataBinding(String.class));
// headersList.add(testSoapHeader1);
// headersList.add(testSoapHeader2);
// requestContext.put(Header.HEADER_LIST, headersList);
Map<String, List<String>> headers = new HashMap<>();
headers.put(AutorisatieOffloadGegevens.OIN_ONDERTEKENAAR, Collections.singletonList(ondertekenaar));
headers.put(AutorisatieOffloadGegevens.OIN_TRANSPORTEUR, Collections.singletonList(transporteur));
dispatcher.getRequestContext().put(Message.PROTOCOL_HEADERS, headers);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link org.w3c.dom.Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws
TransformerConfigurationException, SOAPException
{
final Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
final DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* 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 javax.xml.ws.Dispatch} instantie en de
* benodigde {@link java.security.KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
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);
final FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
final IDataSet dataset;
try {
final Class<? extends AbstractIntegrationTest> clazz = getClass();
final IDataSet[] dataSets = new IDataSet[getDataBestanden().size()];
int index = 0;
for (final String dataBestand : getDataBestanden()) {
dataSets[index++] = builder.build(clazz.getResourceAsStream(dataBestand));
}
dataset = new CompositeDataSet(dataSets);
} catch (final DataSetException ex) {
throw new IllegalStateException("DBUnit dataset kan niet ingeladen worden", ex);
}
final ReplacementDataSet filteredDataSet = new ReplacementDataSet(dataset);
filteredDataSet.addReplacementObject("[NULL]", null);
databaseTester.setDataSet(filteredDataSet);
databaseTester.onSetup();
// Sequence ophogen<SUF>
final Statement st = databaseTester.getConnection().getConnection().createStatement();
final InputStream afterburnerInputStream = getClass().getResourceAsStream("/data/afterburner.sql");
if (afterburnerInputStream != null) {
final String myString = IOUtils.toString(afterburnerInputStream, "UTF-8");
st.execute(myString);
}
} catch (final Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Retourneert de data bestanden die (middels DBUnit) voor elke test in deze class geladen moeten worden in de
* database.
*
* @return een lijst van data bestanden die ingeladen moeten worden.
*/
private List<String> getDataBestanden() {
final List<String> dataBestanden = getInitieleDataBestanden();
final List<String> additioneleDataBestanden = getAdditioneleDataBestanden();
if (additioneleDataBestanden != null && !additioneleDataBestanden.isEmpty()) {
dataBestanden.addAll(additioneleDataBestanden);
}
return dataBestanden;
}
/**
* Geeft de bestanden die bij de intitialisatie van de database gebruikt worden.
*
* @return de lijst met intitiele data bestanden
*/
protected List<String> getInitieleDataBestanden() {
final List<String> dataBestanden = new ArrayList<>();
dataBestanden.addAll(Arrays.asList(
"/data/stamgegevensStatisch.xml",
"/data/stamgegevensNationaliteit.xml",
"/data/stamgegevensLandGebied.xml",
"/data/partijEnGemeente.xml",
"/data/stamgegevensAbonnement.xml",
"/data/testdata.xml"
));
return dataBestanden;
}
/**
* Lijst van eventueel nog additionele data bestanden die ingelezen moeten worden.
*
* @return een lijst van additionele data bestanden.
* @see AbstractIntegrationTest#getDataBestanden()
*/
protected List<String> getAdditioneleDataBestanden() {
return Collections.emptyList();
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws java.net.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 javax.xml.ws.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 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) {
final Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/**
* Private, lokale {@link org.dbunit.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) {
final 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) {
}
}
protected void printResponse(final Document document) throws
Exception
{
final String xml = XmlUtils.toXmlString(document.getDocumentElement());
LOGGER.info("XML Bericht:\n{}", xml);
}
}
|
201774_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.sql.Statement;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.bind.JAXBException;
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 nl.bzk.brp.util.AutorisatieOffloadGegevens;
import nl.bzk.brp.utils.XmlUtils;
import org.apache.cxf.helpers.IOUtils;
import org.apache.cxf.message.Message;
import org.apache.wss4j.common.ext.WSSecurityException;
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.ReplacementDataSet;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.springframework.transaction.annotation.Transactional;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/**
* Abstracte superclass voor repository (persistence) testcases.
*/
@Transactional(transactionManager = "lezenSchrijvenTransactionManager")
@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";
protected static final String NODE_RESULTAAT = "//brp:resultaat";
protected static final String NODE_VERWERKING = NODE_RESULTAAT + "/brp:verwerking";
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Value("${jetty.port}")
protected String jettyPort;
private DataSource dataSrc;
@Inject
@Named("lezenSchrijvenDataSource")
public void setDataSource(final DataSource dataSource) {
super.setDataSource(dataSource);
this.dataSrc = dataSource;
}
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
final 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 org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
return verzendBerichtNaarService(berichtBestand, null, null);
}
protected Node verzendBerichtNaarService(final String berichtBestand, String ondertekenaar, String transporteur)
throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
// Bouw het initiele request bericht
final SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
if (ondertekenaar != null && transporteur != null) {
voegSecurityHeadersToeAanBericht(request, ondertekenaar, transporteur);
}
// Haal het antwoord op
final 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
{
final DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
final Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
// Eventuele post processing van het Document voordat het bericht naar de server gaat.
bewerkRequestDocumentVoorVerzending(request);
final SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Pas het Document aan voordat het naar de server wordt gestuurd. Dit is een functie voor post-processing van het
* document. Bij bijhouding worden bijvoorbeeld hier de objectSleutels ingevuld.
* @param request het request document.
*/
protected abstract void bewerkRequestDocumentVoorVerzending(final Document request);
/**
* Deze methode past de opgegeven {@link javax.xml.soap.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, String ondertekenaar, String transporteur) throws WSSecurityException,
KeyStoreException, JAXBException
{
// List<Header> headersList = new ArrayList<>();
// final Map<String, Object> requestContext = dispatcher.getRequestContext();
// Header testSoapHeader1 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_ONDERTEKENAAR), "1234", new JAXBDataBinding(String.class));
// Header testSoapHeader2 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_TRANSPORTEUR), "5678", new JAXBDataBinding(String.class));
// headersList.add(testSoapHeader1);
// headersList.add(testSoapHeader2);
// requestContext.put(Header.HEADER_LIST, headersList);
Map<String, List<String>> headers = new HashMap<>();
headers.put(AutorisatieOffloadGegevens.OIN_ONDERTEKENAAR, Collections.singletonList(ondertekenaar));
headers.put(AutorisatieOffloadGegevens.OIN_TRANSPORTEUR, Collections.singletonList(transporteur));
dispatcher.getRequestContext().put(Message.PROTOCOL_HEADERS, headers);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link org.w3c.dom.Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws
TransformerConfigurationException, SOAPException
{
final Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
final DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* 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 javax.xml.ws.Dispatch} instantie en de
* benodigde {@link java.security.KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
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);
final FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
final IDataSet dataset;
try {
final Class<? extends AbstractIntegrationTest> clazz = getClass();
final IDataSet[] dataSets = new IDataSet[getDataBestanden().size()];
int index = 0;
for (final String dataBestand : getDataBestanden()) {
dataSets[index++] = builder.build(clazz.getResourceAsStream(dataBestand));
}
dataset = new CompositeDataSet(dataSets);
} catch (final DataSetException ex) {
throw new IllegalStateException("DBUnit dataset kan niet ingeladen worden", ex);
}
final ReplacementDataSet filteredDataSet = new ReplacementDataSet(dataset);
filteredDataSet.addReplacementObject("[NULL]", null);
databaseTester.setDataSet(filteredDataSet);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
final Statement st = databaseTester.getConnection().getConnection().createStatement();
final InputStream afterburnerInputStream = getClass().getResourceAsStream("/data/afterburner.sql");
if (afterburnerInputStream != null) {
final String myString = IOUtils.toString(afterburnerInputStream, "UTF-8");
st.execute(myString);
}
} catch (final Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Retourneert de data bestanden die (middels DBUnit) voor elke test in deze class geladen moeten worden in de
* database.
*
* @return een lijst van data bestanden die ingeladen moeten worden.
*/
private List<String> getDataBestanden() {
final List<String> dataBestanden = getInitieleDataBestanden();
final List<String> additioneleDataBestanden = getAdditioneleDataBestanden();
if (additioneleDataBestanden != null && !additioneleDataBestanden.isEmpty()) {
dataBestanden.addAll(additioneleDataBestanden);
}
return dataBestanden;
}
/**
* Geeft de bestanden die bij de intitialisatie van de database gebruikt worden.
*
* @return de lijst met intitiele data bestanden
*/
protected List<String> getInitieleDataBestanden() {
final List<String> dataBestanden = new ArrayList<>();
dataBestanden.addAll(Arrays.asList(
"/data/stamgegevensStatisch.xml",
"/data/stamgegevensNationaliteit.xml",
"/data/stamgegevensLandGebied.xml",
"/data/partijEnGemeente.xml",
"/data/stamgegevensAbonnement.xml",
"/data/testdata.xml"
));
return dataBestanden;
}
/**
* Lijst van eventueel nog additionele data bestanden die ingelezen moeten worden.
*
* @return een lijst van additionele data bestanden.
* @see AbstractIntegrationTest#getDataBestanden()
*/
protected List<String> getAdditioneleDataBestanden() {
return Collections.emptyList();
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws java.net.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 javax.xml.ws.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 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) {
final Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/**
* Private, lokale {@link org.dbunit.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) {
final 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) {
}
}
protected void printResponse(final Document document) throws
Exception
{
final String xml = XmlUtils.toXmlString(document.getDocumentElement());
LOGGER.info("XML Bericht:\n{}", xml);
}
}
| MinBZK/OperatieBRP | 2016/brp 2016-02-09/algemeen/algemeen-webservice/webservice-basis/src/test/java/nl/bzk/brp/web/service/AbstractIntegrationTest.java | 4,408 | /**
* Retourneert de data bestanden die (middels DBUnit) voor elke test in deze class geladen moeten worden in de
* database.
*
* @return een lijst van data bestanden die ingeladen moeten 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.sql.Statement;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.bind.JAXBException;
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 nl.bzk.brp.util.AutorisatieOffloadGegevens;
import nl.bzk.brp.utils.XmlUtils;
import org.apache.cxf.helpers.IOUtils;
import org.apache.cxf.message.Message;
import org.apache.wss4j.common.ext.WSSecurityException;
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.ReplacementDataSet;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.springframework.transaction.annotation.Transactional;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/**
* Abstracte superclass voor repository (persistence) testcases.
*/
@Transactional(transactionManager = "lezenSchrijvenTransactionManager")
@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";
protected static final String NODE_RESULTAAT = "//brp:resultaat";
protected static final String NODE_VERWERKING = NODE_RESULTAAT + "/brp:verwerking";
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Value("${jetty.port}")
protected String jettyPort;
private DataSource dataSrc;
@Inject
@Named("lezenSchrijvenDataSource")
public void setDataSource(final DataSource dataSource) {
super.setDataSource(dataSource);
this.dataSrc = dataSource;
}
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
final 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 org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
return verzendBerichtNaarService(berichtBestand, null, null);
}
protected Node verzendBerichtNaarService(final String berichtBestand, String ondertekenaar, String transporteur)
throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
// Bouw het initiele request bericht
final SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
if (ondertekenaar != null && transporteur != null) {
voegSecurityHeadersToeAanBericht(request, ondertekenaar, transporteur);
}
// Haal het antwoord op
final 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
{
final DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
final Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
// Eventuele post processing van het Document voordat het bericht naar de server gaat.
bewerkRequestDocumentVoorVerzending(request);
final SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Pas het Document aan voordat het naar de server wordt gestuurd. Dit is een functie voor post-processing van het
* document. Bij bijhouding worden bijvoorbeeld hier de objectSleutels ingevuld.
* @param request het request document.
*/
protected abstract void bewerkRequestDocumentVoorVerzending(final Document request);
/**
* Deze methode past de opgegeven {@link javax.xml.soap.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, String ondertekenaar, String transporteur) throws WSSecurityException,
KeyStoreException, JAXBException
{
// List<Header> headersList = new ArrayList<>();
// final Map<String, Object> requestContext = dispatcher.getRequestContext();
// Header testSoapHeader1 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_ONDERTEKENAAR), "1234", new JAXBDataBinding(String.class));
// Header testSoapHeader2 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_TRANSPORTEUR), "5678", new JAXBDataBinding(String.class));
// headersList.add(testSoapHeader1);
// headersList.add(testSoapHeader2);
// requestContext.put(Header.HEADER_LIST, headersList);
Map<String, List<String>> headers = new HashMap<>();
headers.put(AutorisatieOffloadGegevens.OIN_ONDERTEKENAAR, Collections.singletonList(ondertekenaar));
headers.put(AutorisatieOffloadGegevens.OIN_TRANSPORTEUR, Collections.singletonList(transporteur));
dispatcher.getRequestContext().put(Message.PROTOCOL_HEADERS, headers);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link org.w3c.dom.Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws
TransformerConfigurationException, SOAPException
{
final Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
final DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* 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 javax.xml.ws.Dispatch} instantie en de
* benodigde {@link java.security.KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
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);
final FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
final IDataSet dataset;
try {
final Class<? extends AbstractIntegrationTest> clazz = getClass();
final IDataSet[] dataSets = new IDataSet[getDataBestanden().size()];
int index = 0;
for (final String dataBestand : getDataBestanden()) {
dataSets[index++] = builder.build(clazz.getResourceAsStream(dataBestand));
}
dataset = new CompositeDataSet(dataSets);
} catch (final DataSetException ex) {
throw new IllegalStateException("DBUnit dataset kan niet ingeladen worden", ex);
}
final ReplacementDataSet filteredDataSet = new ReplacementDataSet(dataset);
filteredDataSet.addReplacementObject("[NULL]", null);
databaseTester.setDataSet(filteredDataSet);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
final Statement st = databaseTester.getConnection().getConnection().createStatement();
final InputStream afterburnerInputStream = getClass().getResourceAsStream("/data/afterburner.sql");
if (afterburnerInputStream != null) {
final String myString = IOUtils.toString(afterburnerInputStream, "UTF-8");
st.execute(myString);
}
} catch (final Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Retourneert de data<SUF>*/
private List<String> getDataBestanden() {
final List<String> dataBestanden = getInitieleDataBestanden();
final List<String> additioneleDataBestanden = getAdditioneleDataBestanden();
if (additioneleDataBestanden != null && !additioneleDataBestanden.isEmpty()) {
dataBestanden.addAll(additioneleDataBestanden);
}
return dataBestanden;
}
/**
* Geeft de bestanden die bij de intitialisatie van de database gebruikt worden.
*
* @return de lijst met intitiele data bestanden
*/
protected List<String> getInitieleDataBestanden() {
final List<String> dataBestanden = new ArrayList<>();
dataBestanden.addAll(Arrays.asList(
"/data/stamgegevensStatisch.xml",
"/data/stamgegevensNationaliteit.xml",
"/data/stamgegevensLandGebied.xml",
"/data/partijEnGemeente.xml",
"/data/stamgegevensAbonnement.xml",
"/data/testdata.xml"
));
return dataBestanden;
}
/**
* Lijst van eventueel nog additionele data bestanden die ingelezen moeten worden.
*
* @return een lijst van additionele data bestanden.
* @see AbstractIntegrationTest#getDataBestanden()
*/
protected List<String> getAdditioneleDataBestanden() {
return Collections.emptyList();
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws java.net.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 javax.xml.ws.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 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) {
final Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/**
* Private, lokale {@link org.dbunit.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) {
final 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) {
}
}
protected void printResponse(final Document document) throws
Exception
{
final String xml = XmlUtils.toXmlString(document.getDocumentElement());
LOGGER.info("XML Bericht:\n{}", xml);
}
}
|
201774_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.sql.Statement;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.bind.JAXBException;
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 nl.bzk.brp.util.AutorisatieOffloadGegevens;
import nl.bzk.brp.utils.XmlUtils;
import org.apache.cxf.helpers.IOUtils;
import org.apache.cxf.message.Message;
import org.apache.wss4j.common.ext.WSSecurityException;
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.ReplacementDataSet;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.springframework.transaction.annotation.Transactional;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/**
* Abstracte superclass voor repository (persistence) testcases.
*/
@Transactional(transactionManager = "lezenSchrijvenTransactionManager")
@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";
protected static final String NODE_RESULTAAT = "//brp:resultaat";
protected static final String NODE_VERWERKING = NODE_RESULTAAT + "/brp:verwerking";
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Value("${jetty.port}")
protected String jettyPort;
private DataSource dataSrc;
@Inject
@Named("lezenSchrijvenDataSource")
public void setDataSource(final DataSource dataSource) {
super.setDataSource(dataSource);
this.dataSrc = dataSource;
}
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
final 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 org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
return verzendBerichtNaarService(berichtBestand, null, null);
}
protected Node verzendBerichtNaarService(final String berichtBestand, String ondertekenaar, String transporteur)
throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
// Bouw het initiele request bericht
final SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
if (ondertekenaar != null && transporteur != null) {
voegSecurityHeadersToeAanBericht(request, ondertekenaar, transporteur);
}
// Haal het antwoord op
final 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
{
final DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
final Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
// Eventuele post processing van het Document voordat het bericht naar de server gaat.
bewerkRequestDocumentVoorVerzending(request);
final SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Pas het Document aan voordat het naar de server wordt gestuurd. Dit is een functie voor post-processing van het
* document. Bij bijhouding worden bijvoorbeeld hier de objectSleutels ingevuld.
* @param request het request document.
*/
protected abstract void bewerkRequestDocumentVoorVerzending(final Document request);
/**
* Deze methode past de opgegeven {@link javax.xml.soap.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, String ondertekenaar, String transporteur) throws WSSecurityException,
KeyStoreException, JAXBException
{
// List<Header> headersList = new ArrayList<>();
// final Map<String, Object> requestContext = dispatcher.getRequestContext();
// Header testSoapHeader1 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_ONDERTEKENAAR), "1234", new JAXBDataBinding(String.class));
// Header testSoapHeader2 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_TRANSPORTEUR), "5678", new JAXBDataBinding(String.class));
// headersList.add(testSoapHeader1);
// headersList.add(testSoapHeader2);
// requestContext.put(Header.HEADER_LIST, headersList);
Map<String, List<String>> headers = new HashMap<>();
headers.put(AutorisatieOffloadGegevens.OIN_ONDERTEKENAAR, Collections.singletonList(ondertekenaar));
headers.put(AutorisatieOffloadGegevens.OIN_TRANSPORTEUR, Collections.singletonList(transporteur));
dispatcher.getRequestContext().put(Message.PROTOCOL_HEADERS, headers);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link org.w3c.dom.Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws
TransformerConfigurationException, SOAPException
{
final Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
final DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* 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 javax.xml.ws.Dispatch} instantie en de
* benodigde {@link java.security.KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
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);
final FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
final IDataSet dataset;
try {
final Class<? extends AbstractIntegrationTest> clazz = getClass();
final IDataSet[] dataSets = new IDataSet[getDataBestanden().size()];
int index = 0;
for (final String dataBestand : getDataBestanden()) {
dataSets[index++] = builder.build(clazz.getResourceAsStream(dataBestand));
}
dataset = new CompositeDataSet(dataSets);
} catch (final DataSetException ex) {
throw new IllegalStateException("DBUnit dataset kan niet ingeladen worden", ex);
}
final ReplacementDataSet filteredDataSet = new ReplacementDataSet(dataset);
filteredDataSet.addReplacementObject("[NULL]", null);
databaseTester.setDataSet(filteredDataSet);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
final Statement st = databaseTester.getConnection().getConnection().createStatement();
final InputStream afterburnerInputStream = getClass().getResourceAsStream("/data/afterburner.sql");
if (afterburnerInputStream != null) {
final String myString = IOUtils.toString(afterburnerInputStream, "UTF-8");
st.execute(myString);
}
} catch (final Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Retourneert de data bestanden die (middels DBUnit) voor elke test in deze class geladen moeten worden in de
* database.
*
* @return een lijst van data bestanden die ingeladen moeten worden.
*/
private List<String> getDataBestanden() {
final List<String> dataBestanden = getInitieleDataBestanden();
final List<String> additioneleDataBestanden = getAdditioneleDataBestanden();
if (additioneleDataBestanden != null && !additioneleDataBestanden.isEmpty()) {
dataBestanden.addAll(additioneleDataBestanden);
}
return dataBestanden;
}
/**
* Geeft de bestanden die bij de intitialisatie van de database gebruikt worden.
*
* @return de lijst met intitiele data bestanden
*/
protected List<String> getInitieleDataBestanden() {
final List<String> dataBestanden = new ArrayList<>();
dataBestanden.addAll(Arrays.asList(
"/data/stamgegevensStatisch.xml",
"/data/stamgegevensNationaliteit.xml",
"/data/stamgegevensLandGebied.xml",
"/data/partijEnGemeente.xml",
"/data/stamgegevensAbonnement.xml",
"/data/testdata.xml"
));
return dataBestanden;
}
/**
* Lijst van eventueel nog additionele data bestanden die ingelezen moeten worden.
*
* @return een lijst van additionele data bestanden.
* @see AbstractIntegrationTest#getDataBestanden()
*/
protected List<String> getAdditioneleDataBestanden() {
return Collections.emptyList();
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws java.net.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 javax.xml.ws.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 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) {
final Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/**
* Private, lokale {@link org.dbunit.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) {
final 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) {
}
}
protected void printResponse(final Document document) throws
Exception
{
final String xml = XmlUtils.toXmlString(document.getDocumentElement());
LOGGER.info("XML Bericht:\n{}", xml);
}
}
| MinBZK/OperatieBRP | 2016/brp 2016-02-09/algemeen/algemeen-webservice/webservice-basis/src/test/java/nl/bzk/brp/web/service/AbstractIntegrationTest.java | 4,408 | /**
* Geeft de bestanden die bij de intitialisatie van de database gebruikt worden.
*
* @return de lijst met intitiele data bestanden
*/ | 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.sql.Statement;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.bind.JAXBException;
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 nl.bzk.brp.util.AutorisatieOffloadGegevens;
import nl.bzk.brp.utils.XmlUtils;
import org.apache.cxf.helpers.IOUtils;
import org.apache.cxf.message.Message;
import org.apache.wss4j.common.ext.WSSecurityException;
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.ReplacementDataSet;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.springframework.transaction.annotation.Transactional;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/**
* Abstracte superclass voor repository (persistence) testcases.
*/
@Transactional(transactionManager = "lezenSchrijvenTransactionManager")
@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";
protected static final String NODE_RESULTAAT = "//brp:resultaat";
protected static final String NODE_VERWERKING = NODE_RESULTAAT + "/brp:verwerking";
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Value("${jetty.port}")
protected String jettyPort;
private DataSource dataSrc;
@Inject
@Named("lezenSchrijvenDataSource")
public void setDataSource(final DataSource dataSource) {
super.setDataSource(dataSource);
this.dataSrc = dataSource;
}
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
final 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 org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
return verzendBerichtNaarService(berichtBestand, null, null);
}
protected Node verzendBerichtNaarService(final String berichtBestand, String ondertekenaar, String transporteur)
throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
// Bouw het initiele request bericht
final SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
if (ondertekenaar != null && transporteur != null) {
voegSecurityHeadersToeAanBericht(request, ondertekenaar, transporteur);
}
// Haal het antwoord op
final 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
{
final DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
final Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
// Eventuele post processing van het Document voordat het bericht naar de server gaat.
bewerkRequestDocumentVoorVerzending(request);
final SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Pas het Document aan voordat het naar de server wordt gestuurd. Dit is een functie voor post-processing van het
* document. Bij bijhouding worden bijvoorbeeld hier de objectSleutels ingevuld.
* @param request het request document.
*/
protected abstract void bewerkRequestDocumentVoorVerzending(final Document request);
/**
* Deze methode past de opgegeven {@link javax.xml.soap.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, String ondertekenaar, String transporteur) throws WSSecurityException,
KeyStoreException, JAXBException
{
// List<Header> headersList = new ArrayList<>();
// final Map<String, Object> requestContext = dispatcher.getRequestContext();
// Header testSoapHeader1 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_ONDERTEKENAAR), "1234", new JAXBDataBinding(String.class));
// Header testSoapHeader2 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_TRANSPORTEUR), "5678", new JAXBDataBinding(String.class));
// headersList.add(testSoapHeader1);
// headersList.add(testSoapHeader2);
// requestContext.put(Header.HEADER_LIST, headersList);
Map<String, List<String>> headers = new HashMap<>();
headers.put(AutorisatieOffloadGegevens.OIN_ONDERTEKENAAR, Collections.singletonList(ondertekenaar));
headers.put(AutorisatieOffloadGegevens.OIN_TRANSPORTEUR, Collections.singletonList(transporteur));
dispatcher.getRequestContext().put(Message.PROTOCOL_HEADERS, headers);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link org.w3c.dom.Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws
TransformerConfigurationException, SOAPException
{
final Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
final DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* 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 javax.xml.ws.Dispatch} instantie en de
* benodigde {@link java.security.KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
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);
final FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
final IDataSet dataset;
try {
final Class<? extends AbstractIntegrationTest> clazz = getClass();
final IDataSet[] dataSets = new IDataSet[getDataBestanden().size()];
int index = 0;
for (final String dataBestand : getDataBestanden()) {
dataSets[index++] = builder.build(clazz.getResourceAsStream(dataBestand));
}
dataset = new CompositeDataSet(dataSets);
} catch (final DataSetException ex) {
throw new IllegalStateException("DBUnit dataset kan niet ingeladen worden", ex);
}
final ReplacementDataSet filteredDataSet = new ReplacementDataSet(dataset);
filteredDataSet.addReplacementObject("[NULL]", null);
databaseTester.setDataSet(filteredDataSet);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
final Statement st = databaseTester.getConnection().getConnection().createStatement();
final InputStream afterburnerInputStream = getClass().getResourceAsStream("/data/afterburner.sql");
if (afterburnerInputStream != null) {
final String myString = IOUtils.toString(afterburnerInputStream, "UTF-8");
st.execute(myString);
}
} catch (final Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Retourneert de data bestanden die (middels DBUnit) voor elke test in deze class geladen moeten worden in de
* database.
*
* @return een lijst van data bestanden die ingeladen moeten worden.
*/
private List<String> getDataBestanden() {
final List<String> dataBestanden = getInitieleDataBestanden();
final List<String> additioneleDataBestanden = getAdditioneleDataBestanden();
if (additioneleDataBestanden != null && !additioneleDataBestanden.isEmpty()) {
dataBestanden.addAll(additioneleDataBestanden);
}
return dataBestanden;
}
/**
* Geeft de bestanden<SUF>*/
protected List<String> getInitieleDataBestanden() {
final List<String> dataBestanden = new ArrayList<>();
dataBestanden.addAll(Arrays.asList(
"/data/stamgegevensStatisch.xml",
"/data/stamgegevensNationaliteit.xml",
"/data/stamgegevensLandGebied.xml",
"/data/partijEnGemeente.xml",
"/data/stamgegevensAbonnement.xml",
"/data/testdata.xml"
));
return dataBestanden;
}
/**
* Lijst van eventueel nog additionele data bestanden die ingelezen moeten worden.
*
* @return een lijst van additionele data bestanden.
* @see AbstractIntegrationTest#getDataBestanden()
*/
protected List<String> getAdditioneleDataBestanden() {
return Collections.emptyList();
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws java.net.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 javax.xml.ws.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 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) {
final Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/**
* Private, lokale {@link org.dbunit.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) {
final 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) {
}
}
protected void printResponse(final Document document) throws
Exception
{
final String xml = XmlUtils.toXmlString(document.getDocumentElement());
LOGGER.info("XML Bericht:\n{}", xml);
}
}
|
201774_23 | /**
* 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.sql.Statement;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.bind.JAXBException;
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 nl.bzk.brp.util.AutorisatieOffloadGegevens;
import nl.bzk.brp.utils.XmlUtils;
import org.apache.cxf.helpers.IOUtils;
import org.apache.cxf.message.Message;
import org.apache.wss4j.common.ext.WSSecurityException;
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.ReplacementDataSet;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.springframework.transaction.annotation.Transactional;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/**
* Abstracte superclass voor repository (persistence) testcases.
*/
@Transactional(transactionManager = "lezenSchrijvenTransactionManager")
@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";
protected static final String NODE_RESULTAAT = "//brp:resultaat";
protected static final String NODE_VERWERKING = NODE_RESULTAAT + "/brp:verwerking";
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Value("${jetty.port}")
protected String jettyPort;
private DataSource dataSrc;
@Inject
@Named("lezenSchrijvenDataSource")
public void setDataSource(final DataSource dataSource) {
super.setDataSource(dataSource);
this.dataSrc = dataSource;
}
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
final 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 org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
return verzendBerichtNaarService(berichtBestand, null, null);
}
protected Node verzendBerichtNaarService(final String berichtBestand, String ondertekenaar, String transporteur)
throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
// Bouw het initiele request bericht
final SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
if (ondertekenaar != null && transporteur != null) {
voegSecurityHeadersToeAanBericht(request, ondertekenaar, transporteur);
}
// Haal het antwoord op
final 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
{
final DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
final Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
// Eventuele post processing van het Document voordat het bericht naar de server gaat.
bewerkRequestDocumentVoorVerzending(request);
final SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Pas het Document aan voordat het naar de server wordt gestuurd. Dit is een functie voor post-processing van het
* document. Bij bijhouding worden bijvoorbeeld hier de objectSleutels ingevuld.
* @param request het request document.
*/
protected abstract void bewerkRequestDocumentVoorVerzending(final Document request);
/**
* Deze methode past de opgegeven {@link javax.xml.soap.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, String ondertekenaar, String transporteur) throws WSSecurityException,
KeyStoreException, JAXBException
{
// List<Header> headersList = new ArrayList<>();
// final Map<String, Object> requestContext = dispatcher.getRequestContext();
// Header testSoapHeader1 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_ONDERTEKENAAR), "1234", new JAXBDataBinding(String.class));
// Header testSoapHeader2 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_TRANSPORTEUR), "5678", new JAXBDataBinding(String.class));
// headersList.add(testSoapHeader1);
// headersList.add(testSoapHeader2);
// requestContext.put(Header.HEADER_LIST, headersList);
Map<String, List<String>> headers = new HashMap<>();
headers.put(AutorisatieOffloadGegevens.OIN_ONDERTEKENAAR, Collections.singletonList(ondertekenaar));
headers.put(AutorisatieOffloadGegevens.OIN_TRANSPORTEUR, Collections.singletonList(transporteur));
dispatcher.getRequestContext().put(Message.PROTOCOL_HEADERS, headers);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link org.w3c.dom.Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws
TransformerConfigurationException, SOAPException
{
final Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
final DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* 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 javax.xml.ws.Dispatch} instantie en de
* benodigde {@link java.security.KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
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);
final FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
final IDataSet dataset;
try {
final Class<? extends AbstractIntegrationTest> clazz = getClass();
final IDataSet[] dataSets = new IDataSet[getDataBestanden().size()];
int index = 0;
for (final String dataBestand : getDataBestanden()) {
dataSets[index++] = builder.build(clazz.getResourceAsStream(dataBestand));
}
dataset = new CompositeDataSet(dataSets);
} catch (final DataSetException ex) {
throw new IllegalStateException("DBUnit dataset kan niet ingeladen worden", ex);
}
final ReplacementDataSet filteredDataSet = new ReplacementDataSet(dataset);
filteredDataSet.addReplacementObject("[NULL]", null);
databaseTester.setDataSet(filteredDataSet);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
final Statement st = databaseTester.getConnection().getConnection().createStatement();
final InputStream afterburnerInputStream = getClass().getResourceAsStream("/data/afterburner.sql");
if (afterburnerInputStream != null) {
final String myString = IOUtils.toString(afterburnerInputStream, "UTF-8");
st.execute(myString);
}
} catch (final Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Retourneert de data bestanden die (middels DBUnit) voor elke test in deze class geladen moeten worden in de
* database.
*
* @return een lijst van data bestanden die ingeladen moeten worden.
*/
private List<String> getDataBestanden() {
final List<String> dataBestanden = getInitieleDataBestanden();
final List<String> additioneleDataBestanden = getAdditioneleDataBestanden();
if (additioneleDataBestanden != null && !additioneleDataBestanden.isEmpty()) {
dataBestanden.addAll(additioneleDataBestanden);
}
return dataBestanden;
}
/**
* Geeft de bestanden die bij de intitialisatie van de database gebruikt worden.
*
* @return de lijst met intitiele data bestanden
*/
protected List<String> getInitieleDataBestanden() {
final List<String> dataBestanden = new ArrayList<>();
dataBestanden.addAll(Arrays.asList(
"/data/stamgegevensStatisch.xml",
"/data/stamgegevensNationaliteit.xml",
"/data/stamgegevensLandGebied.xml",
"/data/partijEnGemeente.xml",
"/data/stamgegevensAbonnement.xml",
"/data/testdata.xml"
));
return dataBestanden;
}
/**
* Lijst van eventueel nog additionele data bestanden die ingelezen moeten worden.
*
* @return een lijst van additionele data bestanden.
* @see AbstractIntegrationTest#getDataBestanden()
*/
protected List<String> getAdditioneleDataBestanden() {
return Collections.emptyList();
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws java.net.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 javax.xml.ws.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 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) {
final Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/**
* Private, lokale {@link org.dbunit.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) {
final 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) {
}
}
protected void printResponse(final Document document) throws
Exception
{
final String xml = XmlUtils.toXmlString(document.getDocumentElement());
LOGGER.info("XML Bericht:\n{}", xml);
}
}
| MinBZK/OperatieBRP | 2016/brp 2016-02-09/algemeen/algemeen-webservice/webservice-basis/src/test/java/nl/bzk/brp/web/service/AbstractIntegrationTest.java | 4,408 | /**
* Lijst van eventueel nog additionele data bestanden die ingelezen moeten worden.
*
* @return een lijst van additionele data bestanden.
* @see AbstractIntegrationTest#getDataBestanden()
*/ | 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.sql.Statement;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.bind.JAXBException;
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 nl.bzk.brp.util.AutorisatieOffloadGegevens;
import nl.bzk.brp.utils.XmlUtils;
import org.apache.cxf.helpers.IOUtils;
import org.apache.cxf.message.Message;
import org.apache.wss4j.common.ext.WSSecurityException;
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.ReplacementDataSet;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.springframework.transaction.annotation.Transactional;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/**
* Abstracte superclass voor repository (persistence) testcases.
*/
@Transactional(transactionManager = "lezenSchrijvenTransactionManager")
@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";
protected static final String NODE_RESULTAAT = "//brp:resultaat";
protected static final String NODE_VERWERKING = NODE_RESULTAAT + "/brp:verwerking";
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Value("${jetty.port}")
protected String jettyPort;
private DataSource dataSrc;
@Inject
@Named("lezenSchrijvenDataSource")
public void setDataSource(final DataSource dataSource) {
super.setDataSource(dataSource);
this.dataSrc = dataSource;
}
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
final 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 org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
return verzendBerichtNaarService(berichtBestand, null, null);
}
protected Node verzendBerichtNaarService(final String berichtBestand, String ondertekenaar, String transporteur)
throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
// Bouw het initiele request bericht
final SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
if (ondertekenaar != null && transporteur != null) {
voegSecurityHeadersToeAanBericht(request, ondertekenaar, transporteur);
}
// Haal het antwoord op
final 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
{
final DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
final Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
// Eventuele post processing van het Document voordat het bericht naar de server gaat.
bewerkRequestDocumentVoorVerzending(request);
final SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Pas het Document aan voordat het naar de server wordt gestuurd. Dit is een functie voor post-processing van het
* document. Bij bijhouding worden bijvoorbeeld hier de objectSleutels ingevuld.
* @param request het request document.
*/
protected abstract void bewerkRequestDocumentVoorVerzending(final Document request);
/**
* Deze methode past de opgegeven {@link javax.xml.soap.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, String ondertekenaar, String transporteur) throws WSSecurityException,
KeyStoreException, JAXBException
{
// List<Header> headersList = new ArrayList<>();
// final Map<String, Object> requestContext = dispatcher.getRequestContext();
// Header testSoapHeader1 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_ONDERTEKENAAR), "1234", new JAXBDataBinding(String.class));
// Header testSoapHeader2 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_TRANSPORTEUR), "5678", new JAXBDataBinding(String.class));
// headersList.add(testSoapHeader1);
// headersList.add(testSoapHeader2);
// requestContext.put(Header.HEADER_LIST, headersList);
Map<String, List<String>> headers = new HashMap<>();
headers.put(AutorisatieOffloadGegevens.OIN_ONDERTEKENAAR, Collections.singletonList(ondertekenaar));
headers.put(AutorisatieOffloadGegevens.OIN_TRANSPORTEUR, Collections.singletonList(transporteur));
dispatcher.getRequestContext().put(Message.PROTOCOL_HEADERS, headers);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link org.w3c.dom.Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws
TransformerConfigurationException, SOAPException
{
final Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
final DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* 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 javax.xml.ws.Dispatch} instantie en de
* benodigde {@link java.security.KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
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);
final FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
final IDataSet dataset;
try {
final Class<? extends AbstractIntegrationTest> clazz = getClass();
final IDataSet[] dataSets = new IDataSet[getDataBestanden().size()];
int index = 0;
for (final String dataBestand : getDataBestanden()) {
dataSets[index++] = builder.build(clazz.getResourceAsStream(dataBestand));
}
dataset = new CompositeDataSet(dataSets);
} catch (final DataSetException ex) {
throw new IllegalStateException("DBUnit dataset kan niet ingeladen worden", ex);
}
final ReplacementDataSet filteredDataSet = new ReplacementDataSet(dataset);
filteredDataSet.addReplacementObject("[NULL]", null);
databaseTester.setDataSet(filteredDataSet);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
final Statement st = databaseTester.getConnection().getConnection().createStatement();
final InputStream afterburnerInputStream = getClass().getResourceAsStream("/data/afterburner.sql");
if (afterburnerInputStream != null) {
final String myString = IOUtils.toString(afterburnerInputStream, "UTF-8");
st.execute(myString);
}
} catch (final Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Retourneert de data bestanden die (middels DBUnit) voor elke test in deze class geladen moeten worden in de
* database.
*
* @return een lijst van data bestanden die ingeladen moeten worden.
*/
private List<String> getDataBestanden() {
final List<String> dataBestanden = getInitieleDataBestanden();
final List<String> additioneleDataBestanden = getAdditioneleDataBestanden();
if (additioneleDataBestanden != null && !additioneleDataBestanden.isEmpty()) {
dataBestanden.addAll(additioneleDataBestanden);
}
return dataBestanden;
}
/**
* Geeft de bestanden die bij de intitialisatie van de database gebruikt worden.
*
* @return de lijst met intitiele data bestanden
*/
protected List<String> getInitieleDataBestanden() {
final List<String> dataBestanden = new ArrayList<>();
dataBestanden.addAll(Arrays.asList(
"/data/stamgegevensStatisch.xml",
"/data/stamgegevensNationaliteit.xml",
"/data/stamgegevensLandGebied.xml",
"/data/partijEnGemeente.xml",
"/data/stamgegevensAbonnement.xml",
"/data/testdata.xml"
));
return dataBestanden;
}
/**
* Lijst van eventueel<SUF>*/
protected List<String> getAdditioneleDataBestanden() {
return Collections.emptyList();
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws java.net.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 javax.xml.ws.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 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) {
final Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/**
* Private, lokale {@link org.dbunit.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) {
final 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) {
}
}
protected void printResponse(final Document document) throws
Exception
{
final String xml = XmlUtils.toXmlString(document.getDocumentElement());
LOGGER.info("XML Bericht:\n{}", xml);
}
}
|
201774_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.sql.Statement;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.bind.JAXBException;
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 nl.bzk.brp.util.AutorisatieOffloadGegevens;
import nl.bzk.brp.utils.XmlUtils;
import org.apache.cxf.helpers.IOUtils;
import org.apache.cxf.message.Message;
import org.apache.wss4j.common.ext.WSSecurityException;
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.ReplacementDataSet;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.springframework.transaction.annotation.Transactional;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/**
* Abstracte superclass voor repository (persistence) testcases.
*/
@Transactional(transactionManager = "lezenSchrijvenTransactionManager")
@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";
protected static final String NODE_RESULTAAT = "//brp:resultaat";
protected static final String NODE_VERWERKING = NODE_RESULTAAT + "/brp:verwerking";
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Value("${jetty.port}")
protected String jettyPort;
private DataSource dataSrc;
@Inject
@Named("lezenSchrijvenDataSource")
public void setDataSource(final DataSource dataSource) {
super.setDataSource(dataSource);
this.dataSrc = dataSource;
}
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
final 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 org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
return verzendBerichtNaarService(berichtBestand, null, null);
}
protected Node verzendBerichtNaarService(final String berichtBestand, String ondertekenaar, String transporteur)
throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
// Bouw het initiele request bericht
final SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
if (ondertekenaar != null && transporteur != null) {
voegSecurityHeadersToeAanBericht(request, ondertekenaar, transporteur);
}
// Haal het antwoord op
final 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
{
final DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
final Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
// Eventuele post processing van het Document voordat het bericht naar de server gaat.
bewerkRequestDocumentVoorVerzending(request);
final SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Pas het Document aan voordat het naar de server wordt gestuurd. Dit is een functie voor post-processing van het
* document. Bij bijhouding worden bijvoorbeeld hier de objectSleutels ingevuld.
* @param request het request document.
*/
protected abstract void bewerkRequestDocumentVoorVerzending(final Document request);
/**
* Deze methode past de opgegeven {@link javax.xml.soap.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, String ondertekenaar, String transporteur) throws WSSecurityException,
KeyStoreException, JAXBException
{
// List<Header> headersList = new ArrayList<>();
// final Map<String, Object> requestContext = dispatcher.getRequestContext();
// Header testSoapHeader1 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_ONDERTEKENAAR), "1234", new JAXBDataBinding(String.class));
// Header testSoapHeader2 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_TRANSPORTEUR), "5678", new JAXBDataBinding(String.class));
// headersList.add(testSoapHeader1);
// headersList.add(testSoapHeader2);
// requestContext.put(Header.HEADER_LIST, headersList);
Map<String, List<String>> headers = new HashMap<>();
headers.put(AutorisatieOffloadGegevens.OIN_ONDERTEKENAAR, Collections.singletonList(ondertekenaar));
headers.put(AutorisatieOffloadGegevens.OIN_TRANSPORTEUR, Collections.singletonList(transporteur));
dispatcher.getRequestContext().put(Message.PROTOCOL_HEADERS, headers);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link org.w3c.dom.Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws
TransformerConfigurationException, SOAPException
{
final Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
final DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* 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 javax.xml.ws.Dispatch} instantie en de
* benodigde {@link java.security.KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
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);
final FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
final IDataSet dataset;
try {
final Class<? extends AbstractIntegrationTest> clazz = getClass();
final IDataSet[] dataSets = new IDataSet[getDataBestanden().size()];
int index = 0;
for (final String dataBestand : getDataBestanden()) {
dataSets[index++] = builder.build(clazz.getResourceAsStream(dataBestand));
}
dataset = new CompositeDataSet(dataSets);
} catch (final DataSetException ex) {
throw new IllegalStateException("DBUnit dataset kan niet ingeladen worden", ex);
}
final ReplacementDataSet filteredDataSet = new ReplacementDataSet(dataset);
filteredDataSet.addReplacementObject("[NULL]", null);
databaseTester.setDataSet(filteredDataSet);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
final Statement st = databaseTester.getConnection().getConnection().createStatement();
final InputStream afterburnerInputStream = getClass().getResourceAsStream("/data/afterburner.sql");
if (afterburnerInputStream != null) {
final String myString = IOUtils.toString(afterburnerInputStream, "UTF-8");
st.execute(myString);
}
} catch (final Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Retourneert de data bestanden die (middels DBUnit) voor elke test in deze class geladen moeten worden in de
* database.
*
* @return een lijst van data bestanden die ingeladen moeten worden.
*/
private List<String> getDataBestanden() {
final List<String> dataBestanden = getInitieleDataBestanden();
final List<String> additioneleDataBestanden = getAdditioneleDataBestanden();
if (additioneleDataBestanden != null && !additioneleDataBestanden.isEmpty()) {
dataBestanden.addAll(additioneleDataBestanden);
}
return dataBestanden;
}
/**
* Geeft de bestanden die bij de intitialisatie van de database gebruikt worden.
*
* @return de lijst met intitiele data bestanden
*/
protected List<String> getInitieleDataBestanden() {
final List<String> dataBestanden = new ArrayList<>();
dataBestanden.addAll(Arrays.asList(
"/data/stamgegevensStatisch.xml",
"/data/stamgegevensNationaliteit.xml",
"/data/stamgegevensLandGebied.xml",
"/data/partijEnGemeente.xml",
"/data/stamgegevensAbonnement.xml",
"/data/testdata.xml"
));
return dataBestanden;
}
/**
* Lijst van eventueel nog additionele data bestanden die ingelezen moeten worden.
*
* @return een lijst van additionele data bestanden.
* @see AbstractIntegrationTest#getDataBestanden()
*/
protected List<String> getAdditioneleDataBestanden() {
return Collections.emptyList();
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws java.net.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 javax.xml.ws.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 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) {
final Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/**
* Private, lokale {@link org.dbunit.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) {
final 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) {
}
}
protected void printResponse(final Document document) throws
Exception
{
final String xml = XmlUtils.toXmlString(document.getDocumentElement());
LOGGER.info("XML Bericht:\n{}", xml);
}
}
| MinBZK/OperatieBRP | 2016/brp 2016-02-09/algemeen/algemeen-webservice/webservice-basis/src/test/java/nl/bzk/brp/web/service/AbstractIntegrationTest.java | 4,408 | /**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws java.net.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.sql.Statement;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.bind.JAXBException;
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 nl.bzk.brp.util.AutorisatieOffloadGegevens;
import nl.bzk.brp.utils.XmlUtils;
import org.apache.cxf.helpers.IOUtils;
import org.apache.cxf.message.Message;
import org.apache.wss4j.common.ext.WSSecurityException;
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.ReplacementDataSet;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.springframework.transaction.annotation.Transactional;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/**
* Abstracte superclass voor repository (persistence) testcases.
*/
@Transactional(transactionManager = "lezenSchrijvenTransactionManager")
@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";
protected static final String NODE_RESULTAAT = "//brp:resultaat";
protected static final String NODE_VERWERKING = NODE_RESULTAAT + "/brp:verwerking";
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Value("${jetty.port}")
protected String jettyPort;
private DataSource dataSrc;
@Inject
@Named("lezenSchrijvenDataSource")
public void setDataSource(final DataSource dataSource) {
super.setDataSource(dataSource);
this.dataSrc = dataSource;
}
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
final 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 org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
return verzendBerichtNaarService(berichtBestand, null, null);
}
protected Node verzendBerichtNaarService(final String berichtBestand, String ondertekenaar, String transporteur)
throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
// Bouw het initiele request bericht
final SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
if (ondertekenaar != null && transporteur != null) {
voegSecurityHeadersToeAanBericht(request, ondertekenaar, transporteur);
}
// Haal het antwoord op
final 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
{
final DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
final Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
// Eventuele post processing van het Document voordat het bericht naar de server gaat.
bewerkRequestDocumentVoorVerzending(request);
final SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Pas het Document aan voordat het naar de server wordt gestuurd. Dit is een functie voor post-processing van het
* document. Bij bijhouding worden bijvoorbeeld hier de objectSleutels ingevuld.
* @param request het request document.
*/
protected abstract void bewerkRequestDocumentVoorVerzending(final Document request);
/**
* Deze methode past de opgegeven {@link javax.xml.soap.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, String ondertekenaar, String transporteur) throws WSSecurityException,
KeyStoreException, JAXBException
{
// List<Header> headersList = new ArrayList<>();
// final Map<String, Object> requestContext = dispatcher.getRequestContext();
// Header testSoapHeader1 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_ONDERTEKENAAR), "1234", new JAXBDataBinding(String.class));
// Header testSoapHeader2 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_TRANSPORTEUR), "5678", new JAXBDataBinding(String.class));
// headersList.add(testSoapHeader1);
// headersList.add(testSoapHeader2);
// requestContext.put(Header.HEADER_LIST, headersList);
Map<String, List<String>> headers = new HashMap<>();
headers.put(AutorisatieOffloadGegevens.OIN_ONDERTEKENAAR, Collections.singletonList(ondertekenaar));
headers.put(AutorisatieOffloadGegevens.OIN_TRANSPORTEUR, Collections.singletonList(transporteur));
dispatcher.getRequestContext().put(Message.PROTOCOL_HEADERS, headers);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link org.w3c.dom.Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws
TransformerConfigurationException, SOAPException
{
final Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
final DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* 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 javax.xml.ws.Dispatch} instantie en de
* benodigde {@link java.security.KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
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);
final FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
final IDataSet dataset;
try {
final Class<? extends AbstractIntegrationTest> clazz = getClass();
final IDataSet[] dataSets = new IDataSet[getDataBestanden().size()];
int index = 0;
for (final String dataBestand : getDataBestanden()) {
dataSets[index++] = builder.build(clazz.getResourceAsStream(dataBestand));
}
dataset = new CompositeDataSet(dataSets);
} catch (final DataSetException ex) {
throw new IllegalStateException("DBUnit dataset kan niet ingeladen worden", ex);
}
final ReplacementDataSet filteredDataSet = new ReplacementDataSet(dataset);
filteredDataSet.addReplacementObject("[NULL]", null);
databaseTester.setDataSet(filteredDataSet);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
final Statement st = databaseTester.getConnection().getConnection().createStatement();
final InputStream afterburnerInputStream = getClass().getResourceAsStream("/data/afterburner.sql");
if (afterburnerInputStream != null) {
final String myString = IOUtils.toString(afterburnerInputStream, "UTF-8");
st.execute(myString);
}
} catch (final Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Retourneert de data bestanden die (middels DBUnit) voor elke test in deze class geladen moeten worden in de
* database.
*
* @return een lijst van data bestanden die ingeladen moeten worden.
*/
private List<String> getDataBestanden() {
final List<String> dataBestanden = getInitieleDataBestanden();
final List<String> additioneleDataBestanden = getAdditioneleDataBestanden();
if (additioneleDataBestanden != null && !additioneleDataBestanden.isEmpty()) {
dataBestanden.addAll(additioneleDataBestanden);
}
return dataBestanden;
}
/**
* Geeft de bestanden die bij de intitialisatie van de database gebruikt worden.
*
* @return de lijst met intitiele data bestanden
*/
protected List<String> getInitieleDataBestanden() {
final List<String> dataBestanden = new ArrayList<>();
dataBestanden.addAll(Arrays.asList(
"/data/stamgegevensStatisch.xml",
"/data/stamgegevensNationaliteit.xml",
"/data/stamgegevensLandGebied.xml",
"/data/partijEnGemeente.xml",
"/data/stamgegevensAbonnement.xml",
"/data/testdata.xml"
));
return dataBestanden;
}
/**
* Lijst van eventueel nog additionele data bestanden die ingelezen moeten worden.
*
* @return een lijst van additionele data bestanden.
* @see AbstractIntegrationTest#getDataBestanden()
*/
protected List<String> getAdditioneleDataBestanden() {
return Collections.emptyList();
}
/**
* 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 javax.xml.ws.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 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) {
final Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/**
* Private, lokale {@link org.dbunit.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) {
final 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) {
}
}
protected void printResponse(final Document document) throws
Exception
{
final String xml = XmlUtils.toXmlString(document.getDocumentElement());
LOGGER.info("XML Bericht:\n{}", xml);
}
}
|
201774_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.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.sql.Statement;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.bind.JAXBException;
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 nl.bzk.brp.util.AutorisatieOffloadGegevens;
import nl.bzk.brp.utils.XmlUtils;
import org.apache.cxf.helpers.IOUtils;
import org.apache.cxf.message.Message;
import org.apache.wss4j.common.ext.WSSecurityException;
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.ReplacementDataSet;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.springframework.transaction.annotation.Transactional;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/**
* Abstracte superclass voor repository (persistence) testcases.
*/
@Transactional(transactionManager = "lezenSchrijvenTransactionManager")
@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";
protected static final String NODE_RESULTAAT = "//brp:resultaat";
protected static final String NODE_VERWERKING = NODE_RESULTAAT + "/brp:verwerking";
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Value("${jetty.port}")
protected String jettyPort;
private DataSource dataSrc;
@Inject
@Named("lezenSchrijvenDataSource")
public void setDataSource(final DataSource dataSource) {
super.setDataSource(dataSource);
this.dataSrc = dataSource;
}
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
final 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 org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
return verzendBerichtNaarService(berichtBestand, null, null);
}
protected Node verzendBerichtNaarService(final String berichtBestand, String ondertekenaar, String transporteur)
throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
// Bouw het initiele request bericht
final SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
if (ondertekenaar != null && transporteur != null) {
voegSecurityHeadersToeAanBericht(request, ondertekenaar, transporteur);
}
// Haal het antwoord op
final 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
{
final DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
final Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
// Eventuele post processing van het Document voordat het bericht naar de server gaat.
bewerkRequestDocumentVoorVerzending(request);
final SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Pas het Document aan voordat het naar de server wordt gestuurd. Dit is een functie voor post-processing van het
* document. Bij bijhouding worden bijvoorbeeld hier de objectSleutels ingevuld.
* @param request het request document.
*/
protected abstract void bewerkRequestDocumentVoorVerzending(final Document request);
/**
* Deze methode past de opgegeven {@link javax.xml.soap.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, String ondertekenaar, String transporteur) throws WSSecurityException,
KeyStoreException, JAXBException
{
// List<Header> headersList = new ArrayList<>();
// final Map<String, Object> requestContext = dispatcher.getRequestContext();
// Header testSoapHeader1 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_ONDERTEKENAAR), "1234", new JAXBDataBinding(String.class));
// Header testSoapHeader2 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_TRANSPORTEUR), "5678", new JAXBDataBinding(String.class));
// headersList.add(testSoapHeader1);
// headersList.add(testSoapHeader2);
// requestContext.put(Header.HEADER_LIST, headersList);
Map<String, List<String>> headers = new HashMap<>();
headers.put(AutorisatieOffloadGegevens.OIN_ONDERTEKENAAR, Collections.singletonList(ondertekenaar));
headers.put(AutorisatieOffloadGegevens.OIN_TRANSPORTEUR, Collections.singletonList(transporteur));
dispatcher.getRequestContext().put(Message.PROTOCOL_HEADERS, headers);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link org.w3c.dom.Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws
TransformerConfigurationException, SOAPException
{
final Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
final DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* 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 javax.xml.ws.Dispatch} instantie en de
* benodigde {@link java.security.KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
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);
final FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
final IDataSet dataset;
try {
final Class<? extends AbstractIntegrationTest> clazz = getClass();
final IDataSet[] dataSets = new IDataSet[getDataBestanden().size()];
int index = 0;
for (final String dataBestand : getDataBestanden()) {
dataSets[index++] = builder.build(clazz.getResourceAsStream(dataBestand));
}
dataset = new CompositeDataSet(dataSets);
} catch (final DataSetException ex) {
throw new IllegalStateException("DBUnit dataset kan niet ingeladen worden", ex);
}
final ReplacementDataSet filteredDataSet = new ReplacementDataSet(dataset);
filteredDataSet.addReplacementObject("[NULL]", null);
databaseTester.setDataSet(filteredDataSet);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
final Statement st = databaseTester.getConnection().getConnection().createStatement();
final InputStream afterburnerInputStream = getClass().getResourceAsStream("/data/afterburner.sql");
if (afterburnerInputStream != null) {
final String myString = IOUtils.toString(afterburnerInputStream, "UTF-8");
st.execute(myString);
}
} catch (final Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Retourneert de data bestanden die (middels DBUnit) voor elke test in deze class geladen moeten worden in de
* database.
*
* @return een lijst van data bestanden die ingeladen moeten worden.
*/
private List<String> getDataBestanden() {
final List<String> dataBestanden = getInitieleDataBestanden();
final List<String> additioneleDataBestanden = getAdditioneleDataBestanden();
if (additioneleDataBestanden != null && !additioneleDataBestanden.isEmpty()) {
dataBestanden.addAll(additioneleDataBestanden);
}
return dataBestanden;
}
/**
* Geeft de bestanden die bij de intitialisatie van de database gebruikt worden.
*
* @return de lijst met intitiele data bestanden
*/
protected List<String> getInitieleDataBestanden() {
final List<String> dataBestanden = new ArrayList<>();
dataBestanden.addAll(Arrays.asList(
"/data/stamgegevensStatisch.xml",
"/data/stamgegevensNationaliteit.xml",
"/data/stamgegevensLandGebied.xml",
"/data/partijEnGemeente.xml",
"/data/stamgegevensAbonnement.xml",
"/data/testdata.xml"
));
return dataBestanden;
}
/**
* Lijst van eventueel nog additionele data bestanden die ingelezen moeten worden.
*
* @return een lijst van additionele data bestanden.
* @see AbstractIntegrationTest#getDataBestanden()
*/
protected List<String> getAdditioneleDataBestanden() {
return Collections.emptyList();
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws java.net.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 javax.xml.ws.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 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) {
final Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/**
* Private, lokale {@link org.dbunit.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) {
final 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) {
}
}
protected void printResponse(final Document document) throws
Exception
{
final String xml = XmlUtils.toXmlString(document.getDocumentElement());
LOGGER.info("XML Bericht:\n{}", xml);
}
}
| MinBZK/OperatieBRP | 2016/brp 2016-02-09/algemeen/algemeen-webservice/webservice-basis/src/test/java/nl/bzk/brp/web/service/AbstractIntegrationTest.java | 4,408 | /**
* 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.sql.Statement;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.bind.JAXBException;
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 nl.bzk.brp.util.AutorisatieOffloadGegevens;
import nl.bzk.brp.utils.XmlUtils;
import org.apache.cxf.helpers.IOUtils;
import org.apache.cxf.message.Message;
import org.apache.wss4j.common.ext.WSSecurityException;
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.ReplacementDataSet;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.springframework.transaction.annotation.Transactional;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/**
* Abstracte superclass voor repository (persistence) testcases.
*/
@Transactional(transactionManager = "lezenSchrijvenTransactionManager")
@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";
protected static final String NODE_RESULTAAT = "//brp:resultaat";
protected static final String NODE_VERWERKING = NODE_RESULTAAT + "/brp:verwerking";
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Value("${jetty.port}")
protected String jettyPort;
private DataSource dataSrc;
@Inject
@Named("lezenSchrijvenDataSource")
public void setDataSource(final DataSource dataSource) {
super.setDataSource(dataSource);
this.dataSrc = dataSource;
}
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
final 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 org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
return verzendBerichtNaarService(berichtBestand, null, null);
}
protected Node verzendBerichtNaarService(final String berichtBestand, String ondertekenaar, String transporteur)
throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
// Bouw het initiele request bericht
final SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
if (ondertekenaar != null && transporteur != null) {
voegSecurityHeadersToeAanBericht(request, ondertekenaar, transporteur);
}
// Haal het antwoord op
final 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
{
final DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
final Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
// Eventuele post processing van het Document voordat het bericht naar de server gaat.
bewerkRequestDocumentVoorVerzending(request);
final SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Pas het Document aan voordat het naar de server wordt gestuurd. Dit is een functie voor post-processing van het
* document. Bij bijhouding worden bijvoorbeeld hier de objectSleutels ingevuld.
* @param request het request document.
*/
protected abstract void bewerkRequestDocumentVoorVerzending(final Document request);
/**
* Deze methode past de opgegeven {@link javax.xml.soap.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, String ondertekenaar, String transporteur) throws WSSecurityException,
KeyStoreException, JAXBException
{
// List<Header> headersList = new ArrayList<>();
// final Map<String, Object> requestContext = dispatcher.getRequestContext();
// Header testSoapHeader1 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_ONDERTEKENAAR), "1234", new JAXBDataBinding(String.class));
// Header testSoapHeader2 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_TRANSPORTEUR), "5678", new JAXBDataBinding(String.class));
// headersList.add(testSoapHeader1);
// headersList.add(testSoapHeader2);
// requestContext.put(Header.HEADER_LIST, headersList);
Map<String, List<String>> headers = new HashMap<>();
headers.put(AutorisatieOffloadGegevens.OIN_ONDERTEKENAAR, Collections.singletonList(ondertekenaar));
headers.put(AutorisatieOffloadGegevens.OIN_TRANSPORTEUR, Collections.singletonList(transporteur));
dispatcher.getRequestContext().put(Message.PROTOCOL_HEADERS, headers);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link org.w3c.dom.Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws
TransformerConfigurationException, SOAPException
{
final Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
final DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* 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 javax.xml.ws.Dispatch} instantie en de
* benodigde {@link java.security.KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
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);
final FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
final IDataSet dataset;
try {
final Class<? extends AbstractIntegrationTest> clazz = getClass();
final IDataSet[] dataSets = new IDataSet[getDataBestanden().size()];
int index = 0;
for (final String dataBestand : getDataBestanden()) {
dataSets[index++] = builder.build(clazz.getResourceAsStream(dataBestand));
}
dataset = new CompositeDataSet(dataSets);
} catch (final DataSetException ex) {
throw new IllegalStateException("DBUnit dataset kan niet ingeladen worden", ex);
}
final ReplacementDataSet filteredDataSet = new ReplacementDataSet(dataset);
filteredDataSet.addReplacementObject("[NULL]", null);
databaseTester.setDataSet(filteredDataSet);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
final Statement st = databaseTester.getConnection().getConnection().createStatement();
final InputStream afterburnerInputStream = getClass().getResourceAsStream("/data/afterburner.sql");
if (afterburnerInputStream != null) {
final String myString = IOUtils.toString(afterburnerInputStream, "UTF-8");
st.execute(myString);
}
} catch (final Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Retourneert de data bestanden die (middels DBUnit) voor elke test in deze class geladen moeten worden in de
* database.
*
* @return een lijst van data bestanden die ingeladen moeten worden.
*/
private List<String> getDataBestanden() {
final List<String> dataBestanden = getInitieleDataBestanden();
final List<String> additioneleDataBestanden = getAdditioneleDataBestanden();
if (additioneleDataBestanden != null && !additioneleDataBestanden.isEmpty()) {
dataBestanden.addAll(additioneleDataBestanden);
}
return dataBestanden;
}
/**
* Geeft de bestanden die bij de intitialisatie van de database gebruikt worden.
*
* @return de lijst met intitiele data bestanden
*/
protected List<String> getInitieleDataBestanden() {
final List<String> dataBestanden = new ArrayList<>();
dataBestanden.addAll(Arrays.asList(
"/data/stamgegevensStatisch.xml",
"/data/stamgegevensNationaliteit.xml",
"/data/stamgegevensLandGebied.xml",
"/data/partijEnGemeente.xml",
"/data/stamgegevensAbonnement.xml",
"/data/testdata.xml"
));
return dataBestanden;
}
/**
* Lijst van eventueel nog additionele data bestanden die ingelezen moeten worden.
*
* @return een lijst van additionele data bestanden.
* @see AbstractIntegrationTest#getDataBestanden()
*/
protected List<String> getAdditioneleDataBestanden() {
return Collections.emptyList();
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws java.net.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 javax.xml.ws.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 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) {
final Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/**
* Private, lokale {@link org.dbunit.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) {
final 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) {
}
}
protected void printResponse(final Document document) throws
Exception
{
final String xml = XmlUtils.toXmlString(document.getDocumentElement());
LOGGER.info("XML Bericht:\n{}", xml);
}
}
|
201774_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.sql.Statement;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.bind.JAXBException;
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 nl.bzk.brp.util.AutorisatieOffloadGegevens;
import nl.bzk.brp.utils.XmlUtils;
import org.apache.cxf.helpers.IOUtils;
import org.apache.cxf.message.Message;
import org.apache.wss4j.common.ext.WSSecurityException;
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.ReplacementDataSet;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.springframework.transaction.annotation.Transactional;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/**
* Abstracte superclass voor repository (persistence) testcases.
*/
@Transactional(transactionManager = "lezenSchrijvenTransactionManager")
@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";
protected static final String NODE_RESULTAAT = "//brp:resultaat";
protected static final String NODE_VERWERKING = NODE_RESULTAAT + "/brp:verwerking";
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Value("${jetty.port}")
protected String jettyPort;
private DataSource dataSrc;
@Inject
@Named("lezenSchrijvenDataSource")
public void setDataSource(final DataSource dataSource) {
super.setDataSource(dataSource);
this.dataSrc = dataSource;
}
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
final 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 org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
return verzendBerichtNaarService(berichtBestand, null, null);
}
protected Node verzendBerichtNaarService(final String berichtBestand, String ondertekenaar, String transporteur)
throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
// Bouw het initiele request bericht
final SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
if (ondertekenaar != null && transporteur != null) {
voegSecurityHeadersToeAanBericht(request, ondertekenaar, transporteur);
}
// Haal het antwoord op
final 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
{
final DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
final Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
// Eventuele post processing van het Document voordat het bericht naar de server gaat.
bewerkRequestDocumentVoorVerzending(request);
final SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Pas het Document aan voordat het naar de server wordt gestuurd. Dit is een functie voor post-processing van het
* document. Bij bijhouding worden bijvoorbeeld hier de objectSleutels ingevuld.
* @param request het request document.
*/
protected abstract void bewerkRequestDocumentVoorVerzending(final Document request);
/**
* Deze methode past de opgegeven {@link javax.xml.soap.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, String ondertekenaar, String transporteur) throws WSSecurityException,
KeyStoreException, JAXBException
{
// List<Header> headersList = new ArrayList<>();
// final Map<String, Object> requestContext = dispatcher.getRequestContext();
// Header testSoapHeader1 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_ONDERTEKENAAR), "1234", new JAXBDataBinding(String.class));
// Header testSoapHeader2 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_TRANSPORTEUR), "5678", new JAXBDataBinding(String.class));
// headersList.add(testSoapHeader1);
// headersList.add(testSoapHeader2);
// requestContext.put(Header.HEADER_LIST, headersList);
Map<String, List<String>> headers = new HashMap<>();
headers.put(AutorisatieOffloadGegevens.OIN_ONDERTEKENAAR, Collections.singletonList(ondertekenaar));
headers.put(AutorisatieOffloadGegevens.OIN_TRANSPORTEUR, Collections.singletonList(transporteur));
dispatcher.getRequestContext().put(Message.PROTOCOL_HEADERS, headers);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link org.w3c.dom.Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws
TransformerConfigurationException, SOAPException
{
final Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
final DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* 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 javax.xml.ws.Dispatch} instantie en de
* benodigde {@link java.security.KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
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);
final FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
final IDataSet dataset;
try {
final Class<? extends AbstractIntegrationTest> clazz = getClass();
final IDataSet[] dataSets = new IDataSet[getDataBestanden().size()];
int index = 0;
for (final String dataBestand : getDataBestanden()) {
dataSets[index++] = builder.build(clazz.getResourceAsStream(dataBestand));
}
dataset = new CompositeDataSet(dataSets);
} catch (final DataSetException ex) {
throw new IllegalStateException("DBUnit dataset kan niet ingeladen worden", ex);
}
final ReplacementDataSet filteredDataSet = new ReplacementDataSet(dataset);
filteredDataSet.addReplacementObject("[NULL]", null);
databaseTester.setDataSet(filteredDataSet);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
final Statement st = databaseTester.getConnection().getConnection().createStatement();
final InputStream afterburnerInputStream = getClass().getResourceAsStream("/data/afterburner.sql");
if (afterburnerInputStream != null) {
final String myString = IOUtils.toString(afterburnerInputStream, "UTF-8");
st.execute(myString);
}
} catch (final Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Retourneert de data bestanden die (middels DBUnit) voor elke test in deze class geladen moeten worden in de
* database.
*
* @return een lijst van data bestanden die ingeladen moeten worden.
*/
private List<String> getDataBestanden() {
final List<String> dataBestanden = getInitieleDataBestanden();
final List<String> additioneleDataBestanden = getAdditioneleDataBestanden();
if (additioneleDataBestanden != null && !additioneleDataBestanden.isEmpty()) {
dataBestanden.addAll(additioneleDataBestanden);
}
return dataBestanden;
}
/**
* Geeft de bestanden die bij de intitialisatie van de database gebruikt worden.
*
* @return de lijst met intitiele data bestanden
*/
protected List<String> getInitieleDataBestanden() {
final List<String> dataBestanden = new ArrayList<>();
dataBestanden.addAll(Arrays.asList(
"/data/stamgegevensStatisch.xml",
"/data/stamgegevensNationaliteit.xml",
"/data/stamgegevensLandGebied.xml",
"/data/partijEnGemeente.xml",
"/data/stamgegevensAbonnement.xml",
"/data/testdata.xml"
));
return dataBestanden;
}
/**
* Lijst van eventueel nog additionele data bestanden die ingelezen moeten worden.
*
* @return een lijst van additionele data bestanden.
* @see AbstractIntegrationTest#getDataBestanden()
*/
protected List<String> getAdditioneleDataBestanden() {
return Collections.emptyList();
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws java.net.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 javax.xml.ws.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 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) {
final Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/**
* Private, lokale {@link org.dbunit.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) {
final 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) {
}
}
protected void printResponse(final Document document) throws
Exception
{
final String xml = XmlUtils.toXmlString(document.getDocumentElement());
LOGGER.info("XML Bericht:\n{}", xml);
}
}
| MinBZK/OperatieBRP | 2016/brp 2016-02-09/algemeen/algemeen-webservice/webservice-basis/src/test/java/nl/bzk/brp/web/service/AbstractIntegrationTest.java | 4,408 | /**
* 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.sql.Statement;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.bind.JAXBException;
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 nl.bzk.brp.util.AutorisatieOffloadGegevens;
import nl.bzk.brp.utils.XmlUtils;
import org.apache.cxf.helpers.IOUtils;
import org.apache.cxf.message.Message;
import org.apache.wss4j.common.ext.WSSecurityException;
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.ReplacementDataSet;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.springframework.transaction.annotation.Transactional;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/**
* Abstracte superclass voor repository (persistence) testcases.
*/
@Transactional(transactionManager = "lezenSchrijvenTransactionManager")
@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";
protected static final String NODE_RESULTAAT = "//brp:resultaat";
protected static final String NODE_VERWERKING = NODE_RESULTAAT + "/brp:verwerking";
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Value("${jetty.port}")
protected String jettyPort;
private DataSource dataSrc;
@Inject
@Named("lezenSchrijvenDataSource")
public void setDataSource(final DataSource dataSource) {
super.setDataSource(dataSource);
this.dataSrc = dataSource;
}
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
final 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 org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
return verzendBerichtNaarService(berichtBestand, null, null);
}
protected Node verzendBerichtNaarService(final String berichtBestand, String ondertekenaar, String transporteur)
throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
// Bouw het initiele request bericht
final SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
if (ondertekenaar != null && transporteur != null) {
voegSecurityHeadersToeAanBericht(request, ondertekenaar, transporteur);
}
// Haal het antwoord op
final 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
{
final DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
final Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
// Eventuele post processing van het Document voordat het bericht naar de server gaat.
bewerkRequestDocumentVoorVerzending(request);
final SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Pas het Document aan voordat het naar de server wordt gestuurd. Dit is een functie voor post-processing van het
* document. Bij bijhouding worden bijvoorbeeld hier de objectSleutels ingevuld.
* @param request het request document.
*/
protected abstract void bewerkRequestDocumentVoorVerzending(final Document request);
/**
* Deze methode past de opgegeven {@link javax.xml.soap.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, String ondertekenaar, String transporteur) throws WSSecurityException,
KeyStoreException, JAXBException
{
// List<Header> headersList = new ArrayList<>();
// final Map<String, Object> requestContext = dispatcher.getRequestContext();
// Header testSoapHeader1 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_ONDERTEKENAAR), "1234", new JAXBDataBinding(String.class));
// Header testSoapHeader2 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_TRANSPORTEUR), "5678", new JAXBDataBinding(String.class));
// headersList.add(testSoapHeader1);
// headersList.add(testSoapHeader2);
// requestContext.put(Header.HEADER_LIST, headersList);
Map<String, List<String>> headers = new HashMap<>();
headers.put(AutorisatieOffloadGegevens.OIN_ONDERTEKENAAR, Collections.singletonList(ondertekenaar));
headers.put(AutorisatieOffloadGegevens.OIN_TRANSPORTEUR, Collections.singletonList(transporteur));
dispatcher.getRequestContext().put(Message.PROTOCOL_HEADERS, headers);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link org.w3c.dom.Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws
TransformerConfigurationException, SOAPException
{
final Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
final DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* 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 javax.xml.ws.Dispatch} instantie en de
* benodigde {@link java.security.KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
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);
final FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
final IDataSet dataset;
try {
final Class<? extends AbstractIntegrationTest> clazz = getClass();
final IDataSet[] dataSets = new IDataSet[getDataBestanden().size()];
int index = 0;
for (final String dataBestand : getDataBestanden()) {
dataSets[index++] = builder.build(clazz.getResourceAsStream(dataBestand));
}
dataset = new CompositeDataSet(dataSets);
} catch (final DataSetException ex) {
throw new IllegalStateException("DBUnit dataset kan niet ingeladen worden", ex);
}
final ReplacementDataSet filteredDataSet = new ReplacementDataSet(dataset);
filteredDataSet.addReplacementObject("[NULL]", null);
databaseTester.setDataSet(filteredDataSet);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
final Statement st = databaseTester.getConnection().getConnection().createStatement();
final InputStream afterburnerInputStream = getClass().getResourceAsStream("/data/afterburner.sql");
if (afterburnerInputStream != null) {
final String myString = IOUtils.toString(afterburnerInputStream, "UTF-8");
st.execute(myString);
}
} catch (final Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Retourneert de data bestanden die (middels DBUnit) voor elke test in deze class geladen moeten worden in de
* database.
*
* @return een lijst van data bestanden die ingeladen moeten worden.
*/
private List<String> getDataBestanden() {
final List<String> dataBestanden = getInitieleDataBestanden();
final List<String> additioneleDataBestanden = getAdditioneleDataBestanden();
if (additioneleDataBestanden != null && !additioneleDataBestanden.isEmpty()) {
dataBestanden.addAll(additioneleDataBestanden);
}
return dataBestanden;
}
/**
* Geeft de bestanden die bij de intitialisatie van de database gebruikt worden.
*
* @return de lijst met intitiele data bestanden
*/
protected List<String> getInitieleDataBestanden() {
final List<String> dataBestanden = new ArrayList<>();
dataBestanden.addAll(Arrays.asList(
"/data/stamgegevensStatisch.xml",
"/data/stamgegevensNationaliteit.xml",
"/data/stamgegevensLandGebied.xml",
"/data/partijEnGemeente.xml",
"/data/stamgegevensAbonnement.xml",
"/data/testdata.xml"
));
return dataBestanden;
}
/**
* Lijst van eventueel nog additionele data bestanden die ingelezen moeten worden.
*
* @return een lijst van additionele data bestanden.
* @see AbstractIntegrationTest#getDataBestanden()
*/
protected List<String> getAdditioneleDataBestanden() {
return Collections.emptyList();
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws java.net.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 javax.xml.ws.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 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) {
final Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/**
* Private, lokale {@link org.dbunit.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) {
final 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) {
}
}
protected void printResponse(final Document document) throws
Exception
{
final String xml = XmlUtils.toXmlString(document.getDocumentElement());
LOGGER.info("XML Bericht:\n{}", xml);
}
}
|
201774_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.sql.Statement;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.bind.JAXBException;
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 nl.bzk.brp.util.AutorisatieOffloadGegevens;
import nl.bzk.brp.utils.XmlUtils;
import org.apache.cxf.helpers.IOUtils;
import org.apache.cxf.message.Message;
import org.apache.wss4j.common.ext.WSSecurityException;
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.ReplacementDataSet;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.springframework.transaction.annotation.Transactional;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/**
* Abstracte superclass voor repository (persistence) testcases.
*/
@Transactional(transactionManager = "lezenSchrijvenTransactionManager")
@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";
protected static final String NODE_RESULTAAT = "//brp:resultaat";
protected static final String NODE_VERWERKING = NODE_RESULTAAT + "/brp:verwerking";
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Value("${jetty.port}")
protected String jettyPort;
private DataSource dataSrc;
@Inject
@Named("lezenSchrijvenDataSource")
public void setDataSource(final DataSource dataSource) {
super.setDataSource(dataSource);
this.dataSrc = dataSource;
}
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
final 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 org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
return verzendBerichtNaarService(berichtBestand, null, null);
}
protected Node verzendBerichtNaarService(final String berichtBestand, String ondertekenaar, String transporteur)
throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
// Bouw het initiele request bericht
final SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
if (ondertekenaar != null && transporteur != null) {
voegSecurityHeadersToeAanBericht(request, ondertekenaar, transporteur);
}
// Haal het antwoord op
final 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
{
final DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
final Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
// Eventuele post processing van het Document voordat het bericht naar de server gaat.
bewerkRequestDocumentVoorVerzending(request);
final SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Pas het Document aan voordat het naar de server wordt gestuurd. Dit is een functie voor post-processing van het
* document. Bij bijhouding worden bijvoorbeeld hier de objectSleutels ingevuld.
* @param request het request document.
*/
protected abstract void bewerkRequestDocumentVoorVerzending(final Document request);
/**
* Deze methode past de opgegeven {@link javax.xml.soap.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, String ondertekenaar, String transporteur) throws WSSecurityException,
KeyStoreException, JAXBException
{
// List<Header> headersList = new ArrayList<>();
// final Map<String, Object> requestContext = dispatcher.getRequestContext();
// Header testSoapHeader1 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_ONDERTEKENAAR), "1234", new JAXBDataBinding(String.class));
// Header testSoapHeader2 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_TRANSPORTEUR), "5678", new JAXBDataBinding(String.class));
// headersList.add(testSoapHeader1);
// headersList.add(testSoapHeader2);
// requestContext.put(Header.HEADER_LIST, headersList);
Map<String, List<String>> headers = new HashMap<>();
headers.put(AutorisatieOffloadGegevens.OIN_ONDERTEKENAAR, Collections.singletonList(ondertekenaar));
headers.put(AutorisatieOffloadGegevens.OIN_TRANSPORTEUR, Collections.singletonList(transporteur));
dispatcher.getRequestContext().put(Message.PROTOCOL_HEADERS, headers);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link org.w3c.dom.Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws
TransformerConfigurationException, SOAPException
{
final Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
final DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* 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 javax.xml.ws.Dispatch} instantie en de
* benodigde {@link java.security.KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
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);
final FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
final IDataSet dataset;
try {
final Class<? extends AbstractIntegrationTest> clazz = getClass();
final IDataSet[] dataSets = new IDataSet[getDataBestanden().size()];
int index = 0;
for (final String dataBestand : getDataBestanden()) {
dataSets[index++] = builder.build(clazz.getResourceAsStream(dataBestand));
}
dataset = new CompositeDataSet(dataSets);
} catch (final DataSetException ex) {
throw new IllegalStateException("DBUnit dataset kan niet ingeladen worden", ex);
}
final ReplacementDataSet filteredDataSet = new ReplacementDataSet(dataset);
filteredDataSet.addReplacementObject("[NULL]", null);
databaseTester.setDataSet(filteredDataSet);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
final Statement st = databaseTester.getConnection().getConnection().createStatement();
final InputStream afterburnerInputStream = getClass().getResourceAsStream("/data/afterburner.sql");
if (afterburnerInputStream != null) {
final String myString = IOUtils.toString(afterburnerInputStream, "UTF-8");
st.execute(myString);
}
} catch (final Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Retourneert de data bestanden die (middels DBUnit) voor elke test in deze class geladen moeten worden in de
* database.
*
* @return een lijst van data bestanden die ingeladen moeten worden.
*/
private List<String> getDataBestanden() {
final List<String> dataBestanden = getInitieleDataBestanden();
final List<String> additioneleDataBestanden = getAdditioneleDataBestanden();
if (additioneleDataBestanden != null && !additioneleDataBestanden.isEmpty()) {
dataBestanden.addAll(additioneleDataBestanden);
}
return dataBestanden;
}
/**
* Geeft de bestanden die bij de intitialisatie van de database gebruikt worden.
*
* @return de lijst met intitiele data bestanden
*/
protected List<String> getInitieleDataBestanden() {
final List<String> dataBestanden = new ArrayList<>();
dataBestanden.addAll(Arrays.asList(
"/data/stamgegevensStatisch.xml",
"/data/stamgegevensNationaliteit.xml",
"/data/stamgegevensLandGebied.xml",
"/data/partijEnGemeente.xml",
"/data/stamgegevensAbonnement.xml",
"/data/testdata.xml"
));
return dataBestanden;
}
/**
* Lijst van eventueel nog additionele data bestanden die ingelezen moeten worden.
*
* @return een lijst van additionele data bestanden.
* @see AbstractIntegrationTest#getDataBestanden()
*/
protected List<String> getAdditioneleDataBestanden() {
return Collections.emptyList();
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws java.net.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 javax.xml.ws.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 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) {
final Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/**
* Private, lokale {@link org.dbunit.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) {
final 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) {
}
}
protected void printResponse(final Document document) throws
Exception
{
final String xml = XmlUtils.toXmlString(document.getDocumentElement());
LOGGER.info("XML Bericht:\n{}", xml);
}
}
| MinBZK/OperatieBRP | 2016/brp 2016-02-09/algemeen/algemeen-webservice/webservice-basis/src/test/java/nl/bzk/brp/web/service/AbstractIntegrationTest.java | 4,408 | /**
* Initialiseert de standaard {@link javax.xml.ws.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.sql.Statement;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.bind.JAXBException;
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 nl.bzk.brp.util.AutorisatieOffloadGegevens;
import nl.bzk.brp.utils.XmlUtils;
import org.apache.cxf.helpers.IOUtils;
import org.apache.cxf.message.Message;
import org.apache.wss4j.common.ext.WSSecurityException;
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.ReplacementDataSet;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.springframework.transaction.annotation.Transactional;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/**
* Abstracte superclass voor repository (persistence) testcases.
*/
@Transactional(transactionManager = "lezenSchrijvenTransactionManager")
@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";
protected static final String NODE_RESULTAAT = "//brp:resultaat";
protected static final String NODE_VERWERKING = NODE_RESULTAAT + "/brp:verwerking";
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Value("${jetty.port}")
protected String jettyPort;
private DataSource dataSrc;
@Inject
@Named("lezenSchrijvenDataSource")
public void setDataSource(final DataSource dataSource) {
super.setDataSource(dataSource);
this.dataSrc = dataSource;
}
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
final 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 org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
return verzendBerichtNaarService(berichtBestand, null, null);
}
protected Node verzendBerichtNaarService(final String berichtBestand, String ondertekenaar, String transporteur)
throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
// Bouw het initiele request bericht
final SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
if (ondertekenaar != null && transporteur != null) {
voegSecurityHeadersToeAanBericht(request, ondertekenaar, transporteur);
}
// Haal het antwoord op
final 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
{
final DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
final Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
// Eventuele post processing van het Document voordat het bericht naar de server gaat.
bewerkRequestDocumentVoorVerzending(request);
final SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Pas het Document aan voordat het naar de server wordt gestuurd. Dit is een functie voor post-processing van het
* document. Bij bijhouding worden bijvoorbeeld hier de objectSleutels ingevuld.
* @param request het request document.
*/
protected abstract void bewerkRequestDocumentVoorVerzending(final Document request);
/**
* Deze methode past de opgegeven {@link javax.xml.soap.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, String ondertekenaar, String transporteur) throws WSSecurityException,
KeyStoreException, JAXBException
{
// List<Header> headersList = new ArrayList<>();
// final Map<String, Object> requestContext = dispatcher.getRequestContext();
// Header testSoapHeader1 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_ONDERTEKENAAR), "1234", new JAXBDataBinding(String.class));
// Header testSoapHeader2 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_TRANSPORTEUR), "5678", new JAXBDataBinding(String.class));
// headersList.add(testSoapHeader1);
// headersList.add(testSoapHeader2);
// requestContext.put(Header.HEADER_LIST, headersList);
Map<String, List<String>> headers = new HashMap<>();
headers.put(AutorisatieOffloadGegevens.OIN_ONDERTEKENAAR, Collections.singletonList(ondertekenaar));
headers.put(AutorisatieOffloadGegevens.OIN_TRANSPORTEUR, Collections.singletonList(transporteur));
dispatcher.getRequestContext().put(Message.PROTOCOL_HEADERS, headers);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link org.w3c.dom.Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws
TransformerConfigurationException, SOAPException
{
final Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
final DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* 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 javax.xml.ws.Dispatch} instantie en de
* benodigde {@link java.security.KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
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);
final FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
final IDataSet dataset;
try {
final Class<? extends AbstractIntegrationTest> clazz = getClass();
final IDataSet[] dataSets = new IDataSet[getDataBestanden().size()];
int index = 0;
for (final String dataBestand : getDataBestanden()) {
dataSets[index++] = builder.build(clazz.getResourceAsStream(dataBestand));
}
dataset = new CompositeDataSet(dataSets);
} catch (final DataSetException ex) {
throw new IllegalStateException("DBUnit dataset kan niet ingeladen worden", ex);
}
final ReplacementDataSet filteredDataSet = new ReplacementDataSet(dataset);
filteredDataSet.addReplacementObject("[NULL]", null);
databaseTester.setDataSet(filteredDataSet);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
final Statement st = databaseTester.getConnection().getConnection().createStatement();
final InputStream afterburnerInputStream = getClass().getResourceAsStream("/data/afterburner.sql");
if (afterburnerInputStream != null) {
final String myString = IOUtils.toString(afterburnerInputStream, "UTF-8");
st.execute(myString);
}
} catch (final Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Retourneert de data bestanden die (middels DBUnit) voor elke test in deze class geladen moeten worden in de
* database.
*
* @return een lijst van data bestanden die ingeladen moeten worden.
*/
private List<String> getDataBestanden() {
final List<String> dataBestanden = getInitieleDataBestanden();
final List<String> additioneleDataBestanden = getAdditioneleDataBestanden();
if (additioneleDataBestanden != null && !additioneleDataBestanden.isEmpty()) {
dataBestanden.addAll(additioneleDataBestanden);
}
return dataBestanden;
}
/**
* Geeft de bestanden die bij de intitialisatie van de database gebruikt worden.
*
* @return de lijst met intitiele data bestanden
*/
protected List<String> getInitieleDataBestanden() {
final List<String> dataBestanden = new ArrayList<>();
dataBestanden.addAll(Arrays.asList(
"/data/stamgegevensStatisch.xml",
"/data/stamgegevensNationaliteit.xml",
"/data/stamgegevensLandGebied.xml",
"/data/partijEnGemeente.xml",
"/data/stamgegevensAbonnement.xml",
"/data/testdata.xml"
));
return dataBestanden;
}
/**
* Lijst van eventueel nog additionele data bestanden die ingelezen moeten worden.
*
* @return een lijst van additionele data bestanden.
* @see AbstractIntegrationTest#getDataBestanden()
*/
protected List<String> getAdditioneleDataBestanden() {
return Collections.emptyList();
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws java.net.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 {
final 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) {
final Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/**
* Private, lokale {@link org.dbunit.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) {
final 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) {
}
}
protected void printResponse(final Document document) throws
Exception
{
final String xml = XmlUtils.toXmlString(document.getDocumentElement());
LOGGER.info("XML Bericht:\n{}", xml);
}
}
|
201774_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.sql.Statement;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.bind.JAXBException;
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 nl.bzk.brp.util.AutorisatieOffloadGegevens;
import nl.bzk.brp.utils.XmlUtils;
import org.apache.cxf.helpers.IOUtils;
import org.apache.cxf.message.Message;
import org.apache.wss4j.common.ext.WSSecurityException;
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.ReplacementDataSet;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.springframework.transaction.annotation.Transactional;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/**
* Abstracte superclass voor repository (persistence) testcases.
*/
@Transactional(transactionManager = "lezenSchrijvenTransactionManager")
@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";
protected static final String NODE_RESULTAAT = "//brp:resultaat";
protected static final String NODE_VERWERKING = NODE_RESULTAAT + "/brp:verwerking";
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Value("${jetty.port}")
protected String jettyPort;
private DataSource dataSrc;
@Inject
@Named("lezenSchrijvenDataSource")
public void setDataSource(final DataSource dataSource) {
super.setDataSource(dataSource);
this.dataSrc = dataSource;
}
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
final 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 org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
return verzendBerichtNaarService(berichtBestand, null, null);
}
protected Node verzendBerichtNaarService(final String berichtBestand, String ondertekenaar, String transporteur)
throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
// Bouw het initiele request bericht
final SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
if (ondertekenaar != null && transporteur != null) {
voegSecurityHeadersToeAanBericht(request, ondertekenaar, transporteur);
}
// Haal het antwoord op
final 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
{
final DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
final Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
// Eventuele post processing van het Document voordat het bericht naar de server gaat.
bewerkRequestDocumentVoorVerzending(request);
final SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Pas het Document aan voordat het naar de server wordt gestuurd. Dit is een functie voor post-processing van het
* document. Bij bijhouding worden bijvoorbeeld hier de objectSleutels ingevuld.
* @param request het request document.
*/
protected abstract void bewerkRequestDocumentVoorVerzending(final Document request);
/**
* Deze methode past de opgegeven {@link javax.xml.soap.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, String ondertekenaar, String transporteur) throws WSSecurityException,
KeyStoreException, JAXBException
{
// List<Header> headersList = new ArrayList<>();
// final Map<String, Object> requestContext = dispatcher.getRequestContext();
// Header testSoapHeader1 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_ONDERTEKENAAR), "1234", new JAXBDataBinding(String.class));
// Header testSoapHeader2 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_TRANSPORTEUR), "5678", new JAXBDataBinding(String.class));
// headersList.add(testSoapHeader1);
// headersList.add(testSoapHeader2);
// requestContext.put(Header.HEADER_LIST, headersList);
Map<String, List<String>> headers = new HashMap<>();
headers.put(AutorisatieOffloadGegevens.OIN_ONDERTEKENAAR, Collections.singletonList(ondertekenaar));
headers.put(AutorisatieOffloadGegevens.OIN_TRANSPORTEUR, Collections.singletonList(transporteur));
dispatcher.getRequestContext().put(Message.PROTOCOL_HEADERS, headers);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link org.w3c.dom.Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws
TransformerConfigurationException, SOAPException
{
final Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
final DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* 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 javax.xml.ws.Dispatch} instantie en de
* benodigde {@link java.security.KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
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);
final FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
final IDataSet dataset;
try {
final Class<? extends AbstractIntegrationTest> clazz = getClass();
final IDataSet[] dataSets = new IDataSet[getDataBestanden().size()];
int index = 0;
for (final String dataBestand : getDataBestanden()) {
dataSets[index++] = builder.build(clazz.getResourceAsStream(dataBestand));
}
dataset = new CompositeDataSet(dataSets);
} catch (final DataSetException ex) {
throw new IllegalStateException("DBUnit dataset kan niet ingeladen worden", ex);
}
final ReplacementDataSet filteredDataSet = new ReplacementDataSet(dataset);
filteredDataSet.addReplacementObject("[NULL]", null);
databaseTester.setDataSet(filteredDataSet);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
final Statement st = databaseTester.getConnection().getConnection().createStatement();
final InputStream afterburnerInputStream = getClass().getResourceAsStream("/data/afterburner.sql");
if (afterburnerInputStream != null) {
final String myString = IOUtils.toString(afterburnerInputStream, "UTF-8");
st.execute(myString);
}
} catch (final Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Retourneert de data bestanden die (middels DBUnit) voor elke test in deze class geladen moeten worden in de
* database.
*
* @return een lijst van data bestanden die ingeladen moeten worden.
*/
private List<String> getDataBestanden() {
final List<String> dataBestanden = getInitieleDataBestanden();
final List<String> additioneleDataBestanden = getAdditioneleDataBestanden();
if (additioneleDataBestanden != null && !additioneleDataBestanden.isEmpty()) {
dataBestanden.addAll(additioneleDataBestanden);
}
return dataBestanden;
}
/**
* Geeft de bestanden die bij de intitialisatie van de database gebruikt worden.
*
* @return de lijst met intitiele data bestanden
*/
protected List<String> getInitieleDataBestanden() {
final List<String> dataBestanden = new ArrayList<>();
dataBestanden.addAll(Arrays.asList(
"/data/stamgegevensStatisch.xml",
"/data/stamgegevensNationaliteit.xml",
"/data/stamgegevensLandGebied.xml",
"/data/partijEnGemeente.xml",
"/data/stamgegevensAbonnement.xml",
"/data/testdata.xml"
));
return dataBestanden;
}
/**
* Lijst van eventueel nog additionele data bestanden die ingelezen moeten worden.
*
* @return een lijst van additionele data bestanden.
* @see AbstractIntegrationTest#getDataBestanden()
*/
protected List<String> getAdditioneleDataBestanden() {
return Collections.emptyList();
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws java.net.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 javax.xml.ws.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 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) {
final Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/**
* Private, lokale {@link org.dbunit.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) {
final 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) {
}
}
protected void printResponse(final Document document) throws
Exception
{
final String xml = XmlUtils.toXmlString(document.getDocumentElement());
LOGGER.info("XML Bericht:\n{}", xml);
}
}
| MinBZK/OperatieBRP | 2016/brp 2016-02-09/algemeen/algemeen-webservice/webservice-basis/src/test/java/nl/bzk/brp/web/service/AbstractIntegrationTest.java | 4,408 | /**
* 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.sql.Statement;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.bind.JAXBException;
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 nl.bzk.brp.util.AutorisatieOffloadGegevens;
import nl.bzk.brp.utils.XmlUtils;
import org.apache.cxf.helpers.IOUtils;
import org.apache.cxf.message.Message;
import org.apache.wss4j.common.ext.WSSecurityException;
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.ReplacementDataSet;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.springframework.transaction.annotation.Transactional;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/**
* Abstracte superclass voor repository (persistence) testcases.
*/
@Transactional(transactionManager = "lezenSchrijvenTransactionManager")
@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";
protected static final String NODE_RESULTAAT = "//brp:resultaat";
protected static final String NODE_VERWERKING = NODE_RESULTAAT + "/brp:verwerking";
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Value("${jetty.port}")
protected String jettyPort;
private DataSource dataSrc;
@Inject
@Named("lezenSchrijvenDataSource")
public void setDataSource(final DataSource dataSource) {
super.setDataSource(dataSource);
this.dataSrc = dataSource;
}
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
final 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 org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
return verzendBerichtNaarService(berichtBestand, null, null);
}
protected Node verzendBerichtNaarService(final String berichtBestand, String ondertekenaar, String transporteur)
throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
// Bouw het initiele request bericht
final SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
if (ondertekenaar != null && transporteur != null) {
voegSecurityHeadersToeAanBericht(request, ondertekenaar, transporteur);
}
// Haal het antwoord op
final 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
{
final DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
final Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
// Eventuele post processing van het Document voordat het bericht naar de server gaat.
bewerkRequestDocumentVoorVerzending(request);
final SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Pas het Document aan voordat het naar de server wordt gestuurd. Dit is een functie voor post-processing van het
* document. Bij bijhouding worden bijvoorbeeld hier de objectSleutels ingevuld.
* @param request het request document.
*/
protected abstract void bewerkRequestDocumentVoorVerzending(final Document request);
/**
* Deze methode past de opgegeven {@link javax.xml.soap.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, String ondertekenaar, String transporteur) throws WSSecurityException,
KeyStoreException, JAXBException
{
// List<Header> headersList = new ArrayList<>();
// final Map<String, Object> requestContext = dispatcher.getRequestContext();
// Header testSoapHeader1 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_ONDERTEKENAAR), "1234", new JAXBDataBinding(String.class));
// Header testSoapHeader2 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_TRANSPORTEUR), "5678", new JAXBDataBinding(String.class));
// headersList.add(testSoapHeader1);
// headersList.add(testSoapHeader2);
// requestContext.put(Header.HEADER_LIST, headersList);
Map<String, List<String>> headers = new HashMap<>();
headers.put(AutorisatieOffloadGegevens.OIN_ONDERTEKENAAR, Collections.singletonList(ondertekenaar));
headers.put(AutorisatieOffloadGegevens.OIN_TRANSPORTEUR, Collections.singletonList(transporteur));
dispatcher.getRequestContext().put(Message.PROTOCOL_HEADERS, headers);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link org.w3c.dom.Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws
TransformerConfigurationException, SOAPException
{
final Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
final DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* 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 javax.xml.ws.Dispatch} instantie en de
* benodigde {@link java.security.KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
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);
final FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
final IDataSet dataset;
try {
final Class<? extends AbstractIntegrationTest> clazz = getClass();
final IDataSet[] dataSets = new IDataSet[getDataBestanden().size()];
int index = 0;
for (final String dataBestand : getDataBestanden()) {
dataSets[index++] = builder.build(clazz.getResourceAsStream(dataBestand));
}
dataset = new CompositeDataSet(dataSets);
} catch (final DataSetException ex) {
throw new IllegalStateException("DBUnit dataset kan niet ingeladen worden", ex);
}
final ReplacementDataSet filteredDataSet = new ReplacementDataSet(dataset);
filteredDataSet.addReplacementObject("[NULL]", null);
databaseTester.setDataSet(filteredDataSet);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
final Statement st = databaseTester.getConnection().getConnection().createStatement();
final InputStream afterburnerInputStream = getClass().getResourceAsStream("/data/afterburner.sql");
if (afterburnerInputStream != null) {
final String myString = IOUtils.toString(afterburnerInputStream, "UTF-8");
st.execute(myString);
}
} catch (final Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Retourneert de data bestanden die (middels DBUnit) voor elke test in deze class geladen moeten worden in de
* database.
*
* @return een lijst van data bestanden die ingeladen moeten worden.
*/
private List<String> getDataBestanden() {
final List<String> dataBestanden = getInitieleDataBestanden();
final List<String> additioneleDataBestanden = getAdditioneleDataBestanden();
if (additioneleDataBestanden != null && !additioneleDataBestanden.isEmpty()) {
dataBestanden.addAll(additioneleDataBestanden);
}
return dataBestanden;
}
/**
* Geeft de bestanden die bij de intitialisatie van de database gebruikt worden.
*
* @return de lijst met intitiele data bestanden
*/
protected List<String> getInitieleDataBestanden() {
final List<String> dataBestanden = new ArrayList<>();
dataBestanden.addAll(Arrays.asList(
"/data/stamgegevensStatisch.xml",
"/data/stamgegevensNationaliteit.xml",
"/data/stamgegevensLandGebied.xml",
"/data/partijEnGemeente.xml",
"/data/stamgegevensAbonnement.xml",
"/data/testdata.xml"
));
return dataBestanden;
}
/**
* Lijst van eventueel nog additionele data bestanden die ingelezen moeten worden.
*
* @return een lijst van additionele data bestanden.
* @see AbstractIntegrationTest#getDataBestanden()
*/
protected List<String> getAdditioneleDataBestanden() {
return Collections.emptyList();
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws java.net.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 javax.xml.ws.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 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) {
final Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/**
* Private, lokale {@link org.dbunit.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) {
final 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) {
}
}
protected void printResponse(final Document document) throws
Exception
{
final String xml = XmlUtils.toXmlString(document.getDocumentElement());
LOGGER.info("XML Bericht:\n{}", xml);
}
}
|
201774_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.sql.Statement;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.bind.JAXBException;
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 nl.bzk.brp.util.AutorisatieOffloadGegevens;
import nl.bzk.brp.utils.XmlUtils;
import org.apache.cxf.helpers.IOUtils;
import org.apache.cxf.message.Message;
import org.apache.wss4j.common.ext.WSSecurityException;
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.ReplacementDataSet;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.springframework.transaction.annotation.Transactional;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/**
* Abstracte superclass voor repository (persistence) testcases.
*/
@Transactional(transactionManager = "lezenSchrijvenTransactionManager")
@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";
protected static final String NODE_RESULTAAT = "//brp:resultaat";
protected static final String NODE_VERWERKING = NODE_RESULTAAT + "/brp:verwerking";
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Value("${jetty.port}")
protected String jettyPort;
private DataSource dataSrc;
@Inject
@Named("lezenSchrijvenDataSource")
public void setDataSource(final DataSource dataSource) {
super.setDataSource(dataSource);
this.dataSrc = dataSource;
}
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
final 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 org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
return verzendBerichtNaarService(berichtBestand, null, null);
}
protected Node verzendBerichtNaarService(final String berichtBestand, String ondertekenaar, String transporteur)
throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
// Bouw het initiele request bericht
final SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
if (ondertekenaar != null && transporteur != null) {
voegSecurityHeadersToeAanBericht(request, ondertekenaar, transporteur);
}
// Haal het antwoord op
final 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
{
final DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
final Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
// Eventuele post processing van het Document voordat het bericht naar de server gaat.
bewerkRequestDocumentVoorVerzending(request);
final SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Pas het Document aan voordat het naar de server wordt gestuurd. Dit is een functie voor post-processing van het
* document. Bij bijhouding worden bijvoorbeeld hier de objectSleutels ingevuld.
* @param request het request document.
*/
protected abstract void bewerkRequestDocumentVoorVerzending(final Document request);
/**
* Deze methode past de opgegeven {@link javax.xml.soap.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, String ondertekenaar, String transporteur) throws WSSecurityException,
KeyStoreException, JAXBException
{
// List<Header> headersList = new ArrayList<>();
// final Map<String, Object> requestContext = dispatcher.getRequestContext();
// Header testSoapHeader1 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_ONDERTEKENAAR), "1234", new JAXBDataBinding(String.class));
// Header testSoapHeader2 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_TRANSPORTEUR), "5678", new JAXBDataBinding(String.class));
// headersList.add(testSoapHeader1);
// headersList.add(testSoapHeader2);
// requestContext.put(Header.HEADER_LIST, headersList);
Map<String, List<String>> headers = new HashMap<>();
headers.put(AutorisatieOffloadGegevens.OIN_ONDERTEKENAAR, Collections.singletonList(ondertekenaar));
headers.put(AutorisatieOffloadGegevens.OIN_TRANSPORTEUR, Collections.singletonList(transporteur));
dispatcher.getRequestContext().put(Message.PROTOCOL_HEADERS, headers);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link org.w3c.dom.Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws
TransformerConfigurationException, SOAPException
{
final Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
final DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* 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 javax.xml.ws.Dispatch} instantie en de
* benodigde {@link java.security.KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
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);
final FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
final IDataSet dataset;
try {
final Class<? extends AbstractIntegrationTest> clazz = getClass();
final IDataSet[] dataSets = new IDataSet[getDataBestanden().size()];
int index = 0;
for (final String dataBestand : getDataBestanden()) {
dataSets[index++] = builder.build(clazz.getResourceAsStream(dataBestand));
}
dataset = new CompositeDataSet(dataSets);
} catch (final DataSetException ex) {
throw new IllegalStateException("DBUnit dataset kan niet ingeladen worden", ex);
}
final ReplacementDataSet filteredDataSet = new ReplacementDataSet(dataset);
filteredDataSet.addReplacementObject("[NULL]", null);
databaseTester.setDataSet(filteredDataSet);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
final Statement st = databaseTester.getConnection().getConnection().createStatement();
final InputStream afterburnerInputStream = getClass().getResourceAsStream("/data/afterburner.sql");
if (afterburnerInputStream != null) {
final String myString = IOUtils.toString(afterburnerInputStream, "UTF-8");
st.execute(myString);
}
} catch (final Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Retourneert de data bestanden die (middels DBUnit) voor elke test in deze class geladen moeten worden in de
* database.
*
* @return een lijst van data bestanden die ingeladen moeten worden.
*/
private List<String> getDataBestanden() {
final List<String> dataBestanden = getInitieleDataBestanden();
final List<String> additioneleDataBestanden = getAdditioneleDataBestanden();
if (additioneleDataBestanden != null && !additioneleDataBestanden.isEmpty()) {
dataBestanden.addAll(additioneleDataBestanden);
}
return dataBestanden;
}
/**
* Geeft de bestanden die bij de intitialisatie van de database gebruikt worden.
*
* @return de lijst met intitiele data bestanden
*/
protected List<String> getInitieleDataBestanden() {
final List<String> dataBestanden = new ArrayList<>();
dataBestanden.addAll(Arrays.asList(
"/data/stamgegevensStatisch.xml",
"/data/stamgegevensNationaliteit.xml",
"/data/stamgegevensLandGebied.xml",
"/data/partijEnGemeente.xml",
"/data/stamgegevensAbonnement.xml",
"/data/testdata.xml"
));
return dataBestanden;
}
/**
* Lijst van eventueel nog additionele data bestanden die ingelezen moeten worden.
*
* @return een lijst van additionele data bestanden.
* @see AbstractIntegrationTest#getDataBestanden()
*/
protected List<String> getAdditioneleDataBestanden() {
return Collections.emptyList();
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws java.net.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 javax.xml.ws.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 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) {
final Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/**
* Private, lokale {@link org.dbunit.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) {
final 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) {
}
}
protected void printResponse(final Document document) throws
Exception
{
final String xml = XmlUtils.toXmlString(document.getDocumentElement());
LOGGER.info("XML Bericht:\n{}", xml);
}
}
| MinBZK/OperatieBRP | 2016/brp 2016-02-09/algemeen/algemeen-webservice/webservice-basis/src/test/java/nl/bzk/brp/web/service/AbstractIntegrationTest.java | 4,408 | /**
* Private, lokale {@link org.dbunit.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.sql.Statement;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import javax.inject.Named;
import javax.sql.DataSource;
import javax.xml.bind.JAXBException;
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 nl.bzk.brp.util.AutorisatieOffloadGegevens;
import nl.bzk.brp.utils.XmlUtils;
import org.apache.cxf.helpers.IOUtils;
import org.apache.cxf.message.Message;
import org.apache.wss4j.common.ext.WSSecurityException;
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.ReplacementDataSet;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests;
import org.springframework.transaction.annotation.Transactional;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;
/**
* Abstracte superclass voor repository (persistence) testcases.
*/
@Transactional(transactionManager = "lezenSchrijvenTransactionManager")
@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";
protected static final String NODE_RESULTAAT = "//brp:resultaat";
protected static final String NODE_VERWERKING = NODE_RESULTAAT + "/brp:verwerking";
private static KeyStore keyStore;
private final IOperationListener operationListener = new MyOperationListener();
private IDatabaseTester databaseTester;
private Dispatch<SOAPMessage> dispatcher;
@Value("${jetty.port}")
protected String jettyPort;
private DataSource dataSrc;
@Inject
@Named("lezenSchrijvenDataSource")
public void setDataSource(final DataSource dataSource) {
super.setDataSource(dataSource);
this.dataSrc = dataSource;
}
protected InputStream getInputStream(final String berichtBestand) throws IOException {
// Lees het verhuis bericht uit een xml bestand
final 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 org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
protected Node verzendBerichtNaarService(final String berichtBestand) throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
return verzendBerichtNaarService(berichtBestand, null, null);
}
protected Node verzendBerichtNaarService(final String berichtBestand, String ondertekenaar, String transporteur)
throws IOException, JAXBException, KeyStoreException, WSSecurityException, SOAPException, TransformerConfigurationException,
ParserConfigurationException, SAXException
{
// Bouw het initiele request bericht
final SOAPMessage request = bouwInitieleRequestBericht(getInputStream(berichtBestand));
// Voeg de benodigde security headers toe aan het bericht
if (ondertekenaar != null && transporteur != null) {
voegSecurityHeadersToeAanBericht(request, ondertekenaar, transporteur);
}
// Haal het antwoord op
final 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
{
final DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
final Document request = documentBuilderFactory.newDocumentBuilder().parse(inputStream);
// Eventuele post processing van het Document voordat het bericht naar de server gaat.
bewerkRequestDocumentVoorVerzending(request);
final SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
soapMessage.getSOAPBody().addDocument(request);
return soapMessage;
}
/**
* Pas het Document aan voordat het naar de server wordt gestuurd. Dit is een functie voor post-processing van het
* document. Bij bijhouding worden bijvoorbeeld hier de objectSleutels ingevuld.
* @param request het request document.
*/
protected abstract void bewerkRequestDocumentVoorVerzending(final Document request);
/**
* Deze methode past de opgegeven {@link javax.xml.soap.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, String ondertekenaar, String transporteur) throws WSSecurityException,
KeyStoreException, JAXBException
{
// List<Header> headersList = new ArrayList<>();
// final Map<String, Object> requestContext = dispatcher.getRequestContext();
// Header testSoapHeader1 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_ONDERTEKENAAR), "1234", new JAXBDataBinding(String.class));
// Header testSoapHeader2 = new Header(new QName(AuthenticatieOffloadGegevens.OIN_TRANSPORTEUR), "5678", new JAXBDataBinding(String.class));
// headersList.add(testSoapHeader1);
// headersList.add(testSoapHeader2);
// requestContext.put(Header.HEADER_LIST, headersList);
Map<String, List<String>> headers = new HashMap<>();
headers.put(AutorisatieOffloadGegevens.OIN_ONDERTEKENAAR, Collections.singletonList(ondertekenaar));
headers.put(AutorisatieOffloadGegevens.OIN_TRANSPORTEUR, Collections.singletonList(transporteur));
dispatcher.getRequestContext().put(Message.PROTOCOL_HEADERS, headers);
}
/**
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link org.w3c.dom.Node} met de werkelijke uit het bericht gehaalde content.
*/
private Node extraheerAntwoordUitSoapBericht(final SOAPMessage soapMessage) throws
TransformerConfigurationException, SOAPException
{
final Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
final DOMSource source = new DOMSource(soapMessage.getSOAPBody());
return source.getNode();
}
/**
* 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 javax.xml.ws.Dispatch} instantie en de
* benodigde {@link java.security.KeyStore}.
*
* @throws Exception indien er een fout is opgetreden tijdens de setup.
*/
@Before
public void setUp() throws Exception {
LOGGER.debug("entering setUp()");
initDatabase();
initDispatcher();
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);
final FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
builder.setColumnSensing(true);
final IDataSet dataset;
try {
final Class<? extends AbstractIntegrationTest> clazz = getClass();
final IDataSet[] dataSets = new IDataSet[getDataBestanden().size()];
int index = 0;
for (final String dataBestand : getDataBestanden()) {
dataSets[index++] = builder.build(clazz.getResourceAsStream(dataBestand));
}
dataset = new CompositeDataSet(dataSets);
} catch (final DataSetException ex) {
throw new IllegalStateException("DBUnit dataset kan niet ingeladen worden", ex);
}
final ReplacementDataSet filteredDataSet = new ReplacementDataSet(dataset);
filteredDataSet.addReplacementObject("[NULL]", null);
databaseTester.setDataSet(filteredDataSet);
databaseTester.onSetup();
// Sequence ophogen om te voorkomen dat de new toegevoegde data in conflict komt met data in testdata.xml
final Statement st = databaseTester.getConnection().getConnection().createStatement();
final InputStream afterburnerInputStream = getClass().getResourceAsStream("/data/afterburner.sql");
if (afterburnerInputStream != null) {
final String myString = IOUtils.toString(afterburnerInputStream, "UTF-8");
st.execute(myString);
}
} catch (final Exception e) {
LOGGER.debug("exiting setUp() onverwachts vanwege probleem met de database setup", e);
throw e;
}
}
/**
* Retourneert de data bestanden die (middels DBUnit) voor elke test in deze class geladen moeten worden in de
* database.
*
* @return een lijst van data bestanden die ingeladen moeten worden.
*/
private List<String> getDataBestanden() {
final List<String> dataBestanden = getInitieleDataBestanden();
final List<String> additioneleDataBestanden = getAdditioneleDataBestanden();
if (additioneleDataBestanden != null && !additioneleDataBestanden.isEmpty()) {
dataBestanden.addAll(additioneleDataBestanden);
}
return dataBestanden;
}
/**
* Geeft de bestanden die bij de intitialisatie van de database gebruikt worden.
*
* @return de lijst met intitiele data bestanden
*/
protected List<String> getInitieleDataBestanden() {
final List<String> dataBestanden = new ArrayList<>();
dataBestanden.addAll(Arrays.asList(
"/data/stamgegevensStatisch.xml",
"/data/stamgegevensNationaliteit.xml",
"/data/stamgegevensLandGebied.xml",
"/data/partijEnGemeente.xml",
"/data/stamgegevensAbonnement.xml",
"/data/testdata.xml"
));
return dataBestanden;
}
/**
* Lijst van eventueel nog additionele data bestanden die ingelezen moeten worden.
*
* @return een lijst van additionele data bestanden.
* @see AbstractIntegrationTest#getDataBestanden()
*/
protected List<String> getAdditioneleDataBestanden() {
return Collections.emptyList();
}
/**
* Definieert de URL naar de webservice.
*
* @return URL naar de webservice.
* @throws java.net.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 javax.xml.ws.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 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) {
final Map<String, Object> map = dispatcher.getRequestContext();
map.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
map.put(BindingProvider.SOAPACTION_URI_PROPERTY, actie);
}
/**
* Private, lokale {@link<SUF>*/
private final class MyOperationListener implements IOperationListener {
@Override
public void connectionRetrieved(final IDatabaseConnection connection) {
final 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) {
}
}
protected void printResponse(final Document document) throws
Exception
{
final String xml = XmlUtils.toXmlString(document.getDocumentElement());
LOGGER.info("XML Bericht:\n{}", xml);
}
}
|
201782_1 | /**
* 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.testrunner.component.services.soap;
import com.sun.org.apache.xml.internal.security.signature.XMLSignature;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
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.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.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.WebServiceException;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
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;
/**
* SoapClient voor het versturen van soap berichten.
*/
public class SoapClient {
private static final Logger LOGGER = LoggerFactory.getLogger(SoapClient.class);
private static final int SOAP_REQUEST_TIMEOUT_IN_MILLIS = 5 * 60 * 1000;
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private static PublicKey publicKey;
private Dispatch<SOAPMessage> dispatcher;
static {
try {
securityProperties = new Properties();
securityProperties.load(SoapClient.class.getResourceAsStream("/security/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("/security/client_sigpropfile.properties");
initKeyStore();
} catch (WSSecurityException | WebServiceException | CertificateException | NoSuchAlgorithmException | KeyStoreException | IOException e) {
//LOGGER.error 'Fout bij init SoapClient: {}', e.message
throw new RuntimeException("Fout bij init SoapClient", e);
}
}
/**
* Constructor.
* @param params parameters voor het ophalen van WSDL en sturen van de requests
*/
public SoapClient(final SoapParameters params) {
try {
initDispatcher(params);
} catch (MalformedURLException | ServicesNietBereikbaarException e) {
LOGGER.error("Exception creating SoapClient: {}", e.getMessage());
throw new ServicesNietBereikbaarException("Kan geen SoapClient creeren naar ${params.wsdlURL}", e);
}
}
protected InputStream getInputStream(final String bericht) throws IOException {
return new ByteArrayInputStream(bericht.getBytes("UTF-8"));
}
/**
* 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 nl.sandersmee.testtool.ontvanger wordt de body geextraheerd en als {@link org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
public 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);
request.writeTo(System.err);
// 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 javax.xml.soap.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 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 org.w3c.dom.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();
}
/*
* Initialiseert de standaard {@link javax.xml.ws.Dispatch} instantie die gebruikt wordt om de KERN Service aan te
* roepen.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher(final SoapParameters params) throws MalformedURLException {
try {
LOGGER.debug("SoapClient dispatcher initialiseren");
Service s = Service.create(params.getWsdlURL(), params.getServiceQName());
dispatcher = s.createDispatch(params.getPortQName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
Map<String, Object> map = dispatcher.getRequestContext();
map.put("com.sun.xml.internal.ws.request.timeout", SOAP_REQUEST_TIMEOUT_IN_MILLIS);
LOGGER.debug("SoapClient dispatcher initialiseren - KLAAR");
} catch (Throwable e) {
LOGGER.error("Fout bij creeren SOAPClient:", e);
throw new ServicesNietBereikbaarException("Fout bij creeren SOAPClient", e);
}
}
/**
* 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 java.security.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 =
SoapClient.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();
publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
}
/*
* Controleert de message signature met de public key van de ontvanger.
*
* @param message bericht met de signature
* @throws java.security.KeyStoreException
* @throws javax.xml.soap.SOAPException
* @throws javax.xml.crypto.MarshalException
* @throws javax.xml.crypto.dsig.XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException {
// 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));
}
protected void printResponse(final Document document) throws Exception {
//String xml = XmlUtils.toXmlString(document.getDocumentElement());
//LOGGER.info "xml:\n $xml"
}
}
| MinBZK/OperatieBRP | 2016/brp 2016-02-09/test/component-test/src/main/java/nl/bzk/brp/testrunner/component/services/soap/SoapClient.java | 3,534 | /**
* SoapClient voor het versturen van soap berichten.
*/ | 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.testrunner.component.services.soap;
import com.sun.org.apache.xml.internal.security.signature.XMLSignature;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
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.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.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.WebServiceException;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
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;
/**
* SoapClient voor het<SUF>*/
public class SoapClient {
private static final Logger LOGGER = LoggerFactory.getLogger(SoapClient.class);
private static final int SOAP_REQUEST_TIMEOUT_IN_MILLIS = 5 * 60 * 1000;
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private static PublicKey publicKey;
private Dispatch<SOAPMessage> dispatcher;
static {
try {
securityProperties = new Properties();
securityProperties.load(SoapClient.class.getResourceAsStream("/security/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("/security/client_sigpropfile.properties");
initKeyStore();
} catch (WSSecurityException | WebServiceException | CertificateException | NoSuchAlgorithmException | KeyStoreException | IOException e) {
//LOGGER.error 'Fout bij init SoapClient: {}', e.message
throw new RuntimeException("Fout bij init SoapClient", e);
}
}
/**
* Constructor.
* @param params parameters voor het ophalen van WSDL en sturen van de requests
*/
public SoapClient(final SoapParameters params) {
try {
initDispatcher(params);
} catch (MalformedURLException | ServicesNietBereikbaarException e) {
LOGGER.error("Exception creating SoapClient: {}", e.getMessage());
throw new ServicesNietBereikbaarException("Kan geen SoapClient creeren naar ${params.wsdlURL}", e);
}
}
protected InputStream getInputStream(final String bericht) throws IOException {
return new ByteArrayInputStream(bericht.getBytes("UTF-8"));
}
/**
* 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 nl.sandersmee.testtool.ontvanger wordt de body geextraheerd en als {@link org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
public 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);
request.writeTo(System.err);
// 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 javax.xml.soap.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 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 org.w3c.dom.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();
}
/*
* Initialiseert de standaard {@link javax.xml.ws.Dispatch} instantie die gebruikt wordt om de KERN Service aan te
* roepen.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher(final SoapParameters params) throws MalformedURLException {
try {
LOGGER.debug("SoapClient dispatcher initialiseren");
Service s = Service.create(params.getWsdlURL(), params.getServiceQName());
dispatcher = s.createDispatch(params.getPortQName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
Map<String, Object> map = dispatcher.getRequestContext();
map.put("com.sun.xml.internal.ws.request.timeout", SOAP_REQUEST_TIMEOUT_IN_MILLIS);
LOGGER.debug("SoapClient dispatcher initialiseren - KLAAR");
} catch (Throwable e) {
LOGGER.error("Fout bij creeren SOAPClient:", e);
throw new ServicesNietBereikbaarException("Fout bij creeren SOAPClient", e);
}
}
/**
* 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 java.security.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 =
SoapClient.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();
publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
}
/*
* Controleert de message signature met de public key van de ontvanger.
*
* @param message bericht met de signature
* @throws java.security.KeyStoreException
* @throws javax.xml.soap.SOAPException
* @throws javax.xml.crypto.MarshalException
* @throws javax.xml.crypto.dsig.XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException {
// 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));
}
protected void printResponse(final Document document) throws Exception {
//String xml = XmlUtils.toXmlString(document.getDocumentElement());
//LOGGER.info "xml:\n $xml"
}
}
|
201782_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.testrunner.component.services.soap;
import com.sun.org.apache.xml.internal.security.signature.XMLSignature;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
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.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.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.WebServiceException;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
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;
/**
* SoapClient voor het versturen van soap berichten.
*/
public class SoapClient {
private static final Logger LOGGER = LoggerFactory.getLogger(SoapClient.class);
private static final int SOAP_REQUEST_TIMEOUT_IN_MILLIS = 5 * 60 * 1000;
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private static PublicKey publicKey;
private Dispatch<SOAPMessage> dispatcher;
static {
try {
securityProperties = new Properties();
securityProperties.load(SoapClient.class.getResourceAsStream("/security/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("/security/client_sigpropfile.properties");
initKeyStore();
} catch (WSSecurityException | WebServiceException | CertificateException | NoSuchAlgorithmException | KeyStoreException | IOException e) {
//LOGGER.error 'Fout bij init SoapClient: {}', e.message
throw new RuntimeException("Fout bij init SoapClient", e);
}
}
/**
* Constructor.
* @param params parameters voor het ophalen van WSDL en sturen van de requests
*/
public SoapClient(final SoapParameters params) {
try {
initDispatcher(params);
} catch (MalformedURLException | ServicesNietBereikbaarException e) {
LOGGER.error("Exception creating SoapClient: {}", e.getMessage());
throw new ServicesNietBereikbaarException("Kan geen SoapClient creeren naar ${params.wsdlURL}", e);
}
}
protected InputStream getInputStream(final String bericht) throws IOException {
return new ByteArrayInputStream(bericht.getBytes("UTF-8"));
}
/**
* 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 nl.sandersmee.testtool.ontvanger wordt de body geextraheerd en als {@link org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
public 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);
request.writeTo(System.err);
// 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 javax.xml.soap.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 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 org.w3c.dom.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();
}
/*
* Initialiseert de standaard {@link javax.xml.ws.Dispatch} instantie die gebruikt wordt om de KERN Service aan te
* roepen.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher(final SoapParameters params) throws MalformedURLException {
try {
LOGGER.debug("SoapClient dispatcher initialiseren");
Service s = Service.create(params.getWsdlURL(), params.getServiceQName());
dispatcher = s.createDispatch(params.getPortQName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
Map<String, Object> map = dispatcher.getRequestContext();
map.put("com.sun.xml.internal.ws.request.timeout", SOAP_REQUEST_TIMEOUT_IN_MILLIS);
LOGGER.debug("SoapClient dispatcher initialiseren - KLAAR");
} catch (Throwable e) {
LOGGER.error("Fout bij creeren SOAPClient:", e);
throw new ServicesNietBereikbaarException("Fout bij creeren SOAPClient", e);
}
}
/**
* 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 java.security.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 =
SoapClient.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();
publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
}
/*
* Controleert de message signature met de public key van de ontvanger.
*
* @param message bericht met de signature
* @throws java.security.KeyStoreException
* @throws javax.xml.soap.SOAPException
* @throws javax.xml.crypto.MarshalException
* @throws javax.xml.crypto.dsig.XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException {
// 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));
}
protected void printResponse(final Document document) throws Exception {
//String xml = XmlUtils.toXmlString(document.getDocumentElement());
//LOGGER.info "xml:\n $xml"
}
}
| MinBZK/OperatieBRP | 2016/brp 2016-02-09/test/component-test/src/main/java/nl/bzk/brp/testrunner/component/services/soap/SoapClient.java | 3,534 | //LOGGER.error 'Fout bij init SoapClient: {}', e.message | 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.testrunner.component.services.soap;
import com.sun.org.apache.xml.internal.security.signature.XMLSignature;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
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.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.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.WebServiceException;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
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;
/**
* SoapClient voor het versturen van soap berichten.
*/
public class SoapClient {
private static final Logger LOGGER = LoggerFactory.getLogger(SoapClient.class);
private static final int SOAP_REQUEST_TIMEOUT_IN_MILLIS = 5 * 60 * 1000;
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private static PublicKey publicKey;
private Dispatch<SOAPMessage> dispatcher;
static {
try {
securityProperties = new Properties();
securityProperties.load(SoapClient.class.getResourceAsStream("/security/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("/security/client_sigpropfile.properties");
initKeyStore();
} catch (WSSecurityException | WebServiceException | CertificateException | NoSuchAlgorithmException | KeyStoreException | IOException e) {
//LOGGER.error 'Fout<SUF>
throw new RuntimeException("Fout bij init SoapClient", e);
}
}
/**
* Constructor.
* @param params parameters voor het ophalen van WSDL en sturen van de requests
*/
public SoapClient(final SoapParameters params) {
try {
initDispatcher(params);
} catch (MalformedURLException | ServicesNietBereikbaarException e) {
LOGGER.error("Exception creating SoapClient: {}", e.getMessage());
throw new ServicesNietBereikbaarException("Kan geen SoapClient creeren naar ${params.wsdlURL}", e);
}
}
protected InputStream getInputStream(final String bericht) throws IOException {
return new ByteArrayInputStream(bericht.getBytes("UTF-8"));
}
/**
* 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 nl.sandersmee.testtool.ontvanger wordt de body geextraheerd en als {@link org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
public 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);
request.writeTo(System.err);
// 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 javax.xml.soap.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 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 org.w3c.dom.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();
}
/*
* Initialiseert de standaard {@link javax.xml.ws.Dispatch} instantie die gebruikt wordt om de KERN Service aan te
* roepen.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher(final SoapParameters params) throws MalformedURLException {
try {
LOGGER.debug("SoapClient dispatcher initialiseren");
Service s = Service.create(params.getWsdlURL(), params.getServiceQName());
dispatcher = s.createDispatch(params.getPortQName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
Map<String, Object> map = dispatcher.getRequestContext();
map.put("com.sun.xml.internal.ws.request.timeout", SOAP_REQUEST_TIMEOUT_IN_MILLIS);
LOGGER.debug("SoapClient dispatcher initialiseren - KLAAR");
} catch (Throwable e) {
LOGGER.error("Fout bij creeren SOAPClient:", e);
throw new ServicesNietBereikbaarException("Fout bij creeren SOAPClient", e);
}
}
/**
* 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 java.security.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 =
SoapClient.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();
publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
}
/*
* Controleert de message signature met de public key van de ontvanger.
*
* @param message bericht met de signature
* @throws java.security.KeyStoreException
* @throws javax.xml.soap.SOAPException
* @throws javax.xml.crypto.MarshalException
* @throws javax.xml.crypto.dsig.XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException {
// 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));
}
protected void printResponse(final Document document) throws Exception {
//String xml = XmlUtils.toXmlString(document.getDocumentElement());
//LOGGER.info "xml:\n $xml"
}
}
|
201782_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.testrunner.component.services.soap;
import com.sun.org.apache.xml.internal.security.signature.XMLSignature;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
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.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.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.WebServiceException;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
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;
/**
* SoapClient voor het versturen van soap berichten.
*/
public class SoapClient {
private static final Logger LOGGER = LoggerFactory.getLogger(SoapClient.class);
private static final int SOAP_REQUEST_TIMEOUT_IN_MILLIS = 5 * 60 * 1000;
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private static PublicKey publicKey;
private Dispatch<SOAPMessage> dispatcher;
static {
try {
securityProperties = new Properties();
securityProperties.load(SoapClient.class.getResourceAsStream("/security/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("/security/client_sigpropfile.properties");
initKeyStore();
} catch (WSSecurityException | WebServiceException | CertificateException | NoSuchAlgorithmException | KeyStoreException | IOException e) {
//LOGGER.error 'Fout bij init SoapClient: {}', e.message
throw new RuntimeException("Fout bij init SoapClient", e);
}
}
/**
* Constructor.
* @param params parameters voor het ophalen van WSDL en sturen van de requests
*/
public SoapClient(final SoapParameters params) {
try {
initDispatcher(params);
} catch (MalformedURLException | ServicesNietBereikbaarException e) {
LOGGER.error("Exception creating SoapClient: {}", e.getMessage());
throw new ServicesNietBereikbaarException("Kan geen SoapClient creeren naar ${params.wsdlURL}", e);
}
}
protected InputStream getInputStream(final String bericht) throws IOException {
return new ByteArrayInputStream(bericht.getBytes("UTF-8"));
}
/**
* 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 nl.sandersmee.testtool.ontvanger wordt de body geextraheerd en als {@link org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
public 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);
request.writeTo(System.err);
// 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 javax.xml.soap.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 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 org.w3c.dom.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();
}
/*
* Initialiseert de standaard {@link javax.xml.ws.Dispatch} instantie die gebruikt wordt om de KERN Service aan te
* roepen.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher(final SoapParameters params) throws MalformedURLException {
try {
LOGGER.debug("SoapClient dispatcher initialiseren");
Service s = Service.create(params.getWsdlURL(), params.getServiceQName());
dispatcher = s.createDispatch(params.getPortQName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
Map<String, Object> map = dispatcher.getRequestContext();
map.put("com.sun.xml.internal.ws.request.timeout", SOAP_REQUEST_TIMEOUT_IN_MILLIS);
LOGGER.debug("SoapClient dispatcher initialiseren - KLAAR");
} catch (Throwable e) {
LOGGER.error("Fout bij creeren SOAPClient:", e);
throw new ServicesNietBereikbaarException("Fout bij creeren SOAPClient", e);
}
}
/**
* 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 java.security.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 =
SoapClient.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();
publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
}
/*
* Controleert de message signature met de public key van de ontvanger.
*
* @param message bericht met de signature
* @throws java.security.KeyStoreException
* @throws javax.xml.soap.SOAPException
* @throws javax.xml.crypto.MarshalException
* @throws javax.xml.crypto.dsig.XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException {
// 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));
}
protected void printResponse(final Document document) throws Exception {
//String xml = XmlUtils.toXmlString(document.getDocumentElement());
//LOGGER.info "xml:\n $xml"
}
}
| MinBZK/OperatieBRP | 2016/brp 2016-02-09/test/component-test/src/main/java/nl/bzk/brp/testrunner/component/services/soap/SoapClient.java | 3,534 | /**
* Constructor.
* @param params parameters voor het ophalen van WSDL en sturen van de requests
*/ | 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.testrunner.component.services.soap;
import com.sun.org.apache.xml.internal.security.signature.XMLSignature;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
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.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.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.WebServiceException;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
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;
/**
* SoapClient voor het versturen van soap berichten.
*/
public class SoapClient {
private static final Logger LOGGER = LoggerFactory.getLogger(SoapClient.class);
private static final int SOAP_REQUEST_TIMEOUT_IN_MILLIS = 5 * 60 * 1000;
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private static PublicKey publicKey;
private Dispatch<SOAPMessage> dispatcher;
static {
try {
securityProperties = new Properties();
securityProperties.load(SoapClient.class.getResourceAsStream("/security/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("/security/client_sigpropfile.properties");
initKeyStore();
} catch (WSSecurityException | WebServiceException | CertificateException | NoSuchAlgorithmException | KeyStoreException | IOException e) {
//LOGGER.error 'Fout bij init SoapClient: {}', e.message
throw new RuntimeException("Fout bij init SoapClient", e);
}
}
/**
* Constructor.
<SUF>*/
public SoapClient(final SoapParameters params) {
try {
initDispatcher(params);
} catch (MalformedURLException | ServicesNietBereikbaarException e) {
LOGGER.error("Exception creating SoapClient: {}", e.getMessage());
throw new ServicesNietBereikbaarException("Kan geen SoapClient creeren naar ${params.wsdlURL}", e);
}
}
protected InputStream getInputStream(final String bericht) throws IOException {
return new ByteArrayInputStream(bericht.getBytes("UTF-8"));
}
/**
* 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 nl.sandersmee.testtool.ontvanger wordt de body geextraheerd en als {@link org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
public 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);
request.writeTo(System.err);
// 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 javax.xml.soap.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 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 org.w3c.dom.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();
}
/*
* Initialiseert de standaard {@link javax.xml.ws.Dispatch} instantie die gebruikt wordt om de KERN Service aan te
* roepen.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher(final SoapParameters params) throws MalformedURLException {
try {
LOGGER.debug("SoapClient dispatcher initialiseren");
Service s = Service.create(params.getWsdlURL(), params.getServiceQName());
dispatcher = s.createDispatch(params.getPortQName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
Map<String, Object> map = dispatcher.getRequestContext();
map.put("com.sun.xml.internal.ws.request.timeout", SOAP_REQUEST_TIMEOUT_IN_MILLIS);
LOGGER.debug("SoapClient dispatcher initialiseren - KLAAR");
} catch (Throwable e) {
LOGGER.error("Fout bij creeren SOAPClient:", e);
throw new ServicesNietBereikbaarException("Fout bij creeren SOAPClient", e);
}
}
/**
* 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 java.security.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 =
SoapClient.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();
publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
}
/*
* Controleert de message signature met de public key van de ontvanger.
*
* @param message bericht met de signature
* @throws java.security.KeyStoreException
* @throws javax.xml.soap.SOAPException
* @throws javax.xml.crypto.MarshalException
* @throws javax.xml.crypto.dsig.XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException {
// 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));
}
protected void printResponse(final Document document) throws Exception {
//String xml = XmlUtils.toXmlString(document.getDocumentElement());
//LOGGER.info "xml:\n $xml"
}
}
|
201782_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.testrunner.component.services.soap;
import com.sun.org.apache.xml.internal.security.signature.XMLSignature;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
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.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.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.WebServiceException;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
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;
/**
* SoapClient voor het versturen van soap berichten.
*/
public class SoapClient {
private static final Logger LOGGER = LoggerFactory.getLogger(SoapClient.class);
private static final int SOAP_REQUEST_TIMEOUT_IN_MILLIS = 5 * 60 * 1000;
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private static PublicKey publicKey;
private Dispatch<SOAPMessage> dispatcher;
static {
try {
securityProperties = new Properties();
securityProperties.load(SoapClient.class.getResourceAsStream("/security/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("/security/client_sigpropfile.properties");
initKeyStore();
} catch (WSSecurityException | WebServiceException | CertificateException | NoSuchAlgorithmException | KeyStoreException | IOException e) {
//LOGGER.error 'Fout bij init SoapClient: {}', e.message
throw new RuntimeException("Fout bij init SoapClient", e);
}
}
/**
* Constructor.
* @param params parameters voor het ophalen van WSDL en sturen van de requests
*/
public SoapClient(final SoapParameters params) {
try {
initDispatcher(params);
} catch (MalformedURLException | ServicesNietBereikbaarException e) {
LOGGER.error("Exception creating SoapClient: {}", e.getMessage());
throw new ServicesNietBereikbaarException("Kan geen SoapClient creeren naar ${params.wsdlURL}", e);
}
}
protected InputStream getInputStream(final String bericht) throws IOException {
return new ByteArrayInputStream(bericht.getBytes("UTF-8"));
}
/**
* 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 nl.sandersmee.testtool.ontvanger wordt de body geextraheerd en als {@link org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
public 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);
request.writeTo(System.err);
// 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 javax.xml.soap.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 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 org.w3c.dom.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();
}
/*
* Initialiseert de standaard {@link javax.xml.ws.Dispatch} instantie die gebruikt wordt om de KERN Service aan te
* roepen.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher(final SoapParameters params) throws MalformedURLException {
try {
LOGGER.debug("SoapClient dispatcher initialiseren");
Service s = Service.create(params.getWsdlURL(), params.getServiceQName());
dispatcher = s.createDispatch(params.getPortQName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
Map<String, Object> map = dispatcher.getRequestContext();
map.put("com.sun.xml.internal.ws.request.timeout", SOAP_REQUEST_TIMEOUT_IN_MILLIS);
LOGGER.debug("SoapClient dispatcher initialiseren - KLAAR");
} catch (Throwable e) {
LOGGER.error("Fout bij creeren SOAPClient:", e);
throw new ServicesNietBereikbaarException("Fout bij creeren SOAPClient", e);
}
}
/**
* 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 java.security.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 =
SoapClient.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();
publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
}
/*
* Controleert de message signature met de public key van de ontvanger.
*
* @param message bericht met de signature
* @throws java.security.KeyStoreException
* @throws javax.xml.soap.SOAPException
* @throws javax.xml.crypto.MarshalException
* @throws javax.xml.crypto.dsig.XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException {
// 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));
}
protected void printResponse(final Document document) throws Exception {
//String xml = XmlUtils.toXmlString(document.getDocumentElement());
//LOGGER.info "xml:\n $xml"
}
}
| MinBZK/OperatieBRP | 2016/brp 2016-02-09/test/component-test/src/main/java/nl/bzk/brp/testrunner/component/services/soap/SoapClient.java | 3,534 | /**
* 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 nl.sandersmee.testtool.ontvanger wordt de body geextraheerd en als {@link org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.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.testrunner.component.services.soap;
import com.sun.org.apache.xml.internal.security.signature.XMLSignature;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
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.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.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.WebServiceException;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
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;
/**
* SoapClient voor het versturen van soap berichten.
*/
public class SoapClient {
private static final Logger LOGGER = LoggerFactory.getLogger(SoapClient.class);
private static final int SOAP_REQUEST_TIMEOUT_IN_MILLIS = 5 * 60 * 1000;
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private static PublicKey publicKey;
private Dispatch<SOAPMessage> dispatcher;
static {
try {
securityProperties = new Properties();
securityProperties.load(SoapClient.class.getResourceAsStream("/security/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("/security/client_sigpropfile.properties");
initKeyStore();
} catch (WSSecurityException | WebServiceException | CertificateException | NoSuchAlgorithmException | KeyStoreException | IOException e) {
//LOGGER.error 'Fout bij init SoapClient: {}', e.message
throw new RuntimeException("Fout bij init SoapClient", e);
}
}
/**
* Constructor.
* @param params parameters voor het ophalen van WSDL en sturen van de requests
*/
public SoapClient(final SoapParameters params) {
try {
initDispatcher(params);
} catch (MalformedURLException | ServicesNietBereikbaarException e) {
LOGGER.error("Exception creating SoapClient: {}", e.getMessage());
throw new ServicesNietBereikbaarException("Kan geen SoapClient creeren naar ${params.wsdlURL}", e);
}
}
protected InputStream getInputStream(final String bericht) throws IOException {
return new ByteArrayInputStream(bericht.getBytes("UTF-8"));
}
/**
* Standaard methode voor<SUF>*/
public 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);
request.writeTo(System.err);
// 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 javax.xml.soap.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 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 org.w3c.dom.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();
}
/*
* Initialiseert de standaard {@link javax.xml.ws.Dispatch} instantie die gebruikt wordt om de KERN Service aan te
* roepen.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher(final SoapParameters params) throws MalformedURLException {
try {
LOGGER.debug("SoapClient dispatcher initialiseren");
Service s = Service.create(params.getWsdlURL(), params.getServiceQName());
dispatcher = s.createDispatch(params.getPortQName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
Map<String, Object> map = dispatcher.getRequestContext();
map.put("com.sun.xml.internal.ws.request.timeout", SOAP_REQUEST_TIMEOUT_IN_MILLIS);
LOGGER.debug("SoapClient dispatcher initialiseren - KLAAR");
} catch (Throwable e) {
LOGGER.error("Fout bij creeren SOAPClient:", e);
throw new ServicesNietBereikbaarException("Fout bij creeren SOAPClient", e);
}
}
/**
* 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 java.security.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 =
SoapClient.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();
publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
}
/*
* Controleert de message signature met de public key van de ontvanger.
*
* @param message bericht met de signature
* @throws java.security.KeyStoreException
* @throws javax.xml.soap.SOAPException
* @throws javax.xml.crypto.MarshalException
* @throws javax.xml.crypto.dsig.XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException {
// 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));
}
protected void printResponse(final Document document) throws Exception {
//String xml = XmlUtils.toXmlString(document.getDocumentElement());
//LOGGER.info "xml:\n $xml"
}
}
|
201782_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.testrunner.component.services.soap;
import com.sun.org.apache.xml.internal.security.signature.XMLSignature;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
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.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.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.WebServiceException;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
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;
/**
* SoapClient voor het versturen van soap berichten.
*/
public class SoapClient {
private static final Logger LOGGER = LoggerFactory.getLogger(SoapClient.class);
private static final int SOAP_REQUEST_TIMEOUT_IN_MILLIS = 5 * 60 * 1000;
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private static PublicKey publicKey;
private Dispatch<SOAPMessage> dispatcher;
static {
try {
securityProperties = new Properties();
securityProperties.load(SoapClient.class.getResourceAsStream("/security/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("/security/client_sigpropfile.properties");
initKeyStore();
} catch (WSSecurityException | WebServiceException | CertificateException | NoSuchAlgorithmException | KeyStoreException | IOException e) {
//LOGGER.error 'Fout bij init SoapClient: {}', e.message
throw new RuntimeException("Fout bij init SoapClient", e);
}
}
/**
* Constructor.
* @param params parameters voor het ophalen van WSDL en sturen van de requests
*/
public SoapClient(final SoapParameters params) {
try {
initDispatcher(params);
} catch (MalformedURLException | ServicesNietBereikbaarException e) {
LOGGER.error("Exception creating SoapClient: {}", e.getMessage());
throw new ServicesNietBereikbaarException("Kan geen SoapClient creeren naar ${params.wsdlURL}", e);
}
}
protected InputStream getInputStream(final String bericht) throws IOException {
return new ByteArrayInputStream(bericht.getBytes("UTF-8"));
}
/**
* 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 nl.sandersmee.testtool.ontvanger wordt de body geextraheerd en als {@link org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
public 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);
request.writeTo(System.err);
// 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 javax.xml.soap.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 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 org.w3c.dom.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();
}
/*
* Initialiseert de standaard {@link javax.xml.ws.Dispatch} instantie die gebruikt wordt om de KERN Service aan te
* roepen.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher(final SoapParameters params) throws MalformedURLException {
try {
LOGGER.debug("SoapClient dispatcher initialiseren");
Service s = Service.create(params.getWsdlURL(), params.getServiceQName());
dispatcher = s.createDispatch(params.getPortQName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
Map<String, Object> map = dispatcher.getRequestContext();
map.put("com.sun.xml.internal.ws.request.timeout", SOAP_REQUEST_TIMEOUT_IN_MILLIS);
LOGGER.debug("SoapClient dispatcher initialiseren - KLAAR");
} catch (Throwable e) {
LOGGER.error("Fout bij creeren SOAPClient:", e);
throw new ServicesNietBereikbaarException("Fout bij creeren SOAPClient", e);
}
}
/**
* 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 java.security.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 =
SoapClient.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();
publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
}
/*
* Controleert de message signature met de public key van de ontvanger.
*
* @param message bericht met de signature
* @throws java.security.KeyStoreException
* @throws javax.xml.soap.SOAPException
* @throws javax.xml.crypto.MarshalException
* @throws javax.xml.crypto.dsig.XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException {
// 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));
}
protected void printResponse(final Document document) throws Exception {
//String xml = XmlUtils.toXmlString(document.getDocumentElement());
//LOGGER.info "xml:\n $xml"
}
}
| MinBZK/OperatieBRP | 2016/brp 2016-02-09/test/component-test/src/main/java/nl/bzk/brp/testrunner/component/services/soap/SoapClient.java | 3,534 | // 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.testrunner.component.services.soap;
import com.sun.org.apache.xml.internal.security.signature.XMLSignature;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
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.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.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.WebServiceException;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
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;
/**
* SoapClient voor het versturen van soap berichten.
*/
public class SoapClient {
private static final Logger LOGGER = LoggerFactory.getLogger(SoapClient.class);
private static final int SOAP_REQUEST_TIMEOUT_IN_MILLIS = 5 * 60 * 1000;
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private static PublicKey publicKey;
private Dispatch<SOAPMessage> dispatcher;
static {
try {
securityProperties = new Properties();
securityProperties.load(SoapClient.class.getResourceAsStream("/security/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("/security/client_sigpropfile.properties");
initKeyStore();
} catch (WSSecurityException | WebServiceException | CertificateException | NoSuchAlgorithmException | KeyStoreException | IOException e) {
//LOGGER.error 'Fout bij init SoapClient: {}', e.message
throw new RuntimeException("Fout bij init SoapClient", e);
}
}
/**
* Constructor.
* @param params parameters voor het ophalen van WSDL en sturen van de requests
*/
public SoapClient(final SoapParameters params) {
try {
initDispatcher(params);
} catch (MalformedURLException | ServicesNietBereikbaarException e) {
LOGGER.error("Exception creating SoapClient: {}", e.getMessage());
throw new ServicesNietBereikbaarException("Kan geen SoapClient creeren naar ${params.wsdlURL}", e);
}
}
protected InputStream getInputStream(final String bericht) throws IOException {
return new ByteArrayInputStream(bericht.getBytes("UTF-8"));
}
/**
* 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 nl.sandersmee.testtool.ontvanger wordt de body geextraheerd en als {@link org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
public 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);
request.writeTo(System.err);
// 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 javax.xml.soap.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 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 org.w3c.dom.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();
}
/*
* Initialiseert de standaard {@link javax.xml.ws.Dispatch} instantie die gebruikt wordt om de KERN Service aan te
* roepen.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher(final SoapParameters params) throws MalformedURLException {
try {
LOGGER.debug("SoapClient dispatcher initialiseren");
Service s = Service.create(params.getWsdlURL(), params.getServiceQName());
dispatcher = s.createDispatch(params.getPortQName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
Map<String, Object> map = dispatcher.getRequestContext();
map.put("com.sun.xml.internal.ws.request.timeout", SOAP_REQUEST_TIMEOUT_IN_MILLIS);
LOGGER.debug("SoapClient dispatcher initialiseren - KLAAR");
} catch (Throwable e) {
LOGGER.error("Fout bij creeren SOAPClient:", e);
throw new ServicesNietBereikbaarException("Fout bij creeren SOAPClient", e);
}
}
/**
* 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 java.security.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 =
SoapClient.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();
publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
}
/*
* Controleert de message signature met de public key van de ontvanger.
*
* @param message bericht met de signature
* @throws java.security.KeyStoreException
* @throws javax.xml.soap.SOAPException
* @throws javax.xml.crypto.MarshalException
* @throws javax.xml.crypto.dsig.XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException {
// 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));
}
protected void printResponse(final Document document) throws Exception {
//String xml = XmlUtils.toXmlString(document.getDocumentElement());
//LOGGER.info "xml:\n $xml"
}
}
|
201782_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.testrunner.component.services.soap;
import com.sun.org.apache.xml.internal.security.signature.XMLSignature;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
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.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.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.WebServiceException;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
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;
/**
* SoapClient voor het versturen van soap berichten.
*/
public class SoapClient {
private static final Logger LOGGER = LoggerFactory.getLogger(SoapClient.class);
private static final int SOAP_REQUEST_TIMEOUT_IN_MILLIS = 5 * 60 * 1000;
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private static PublicKey publicKey;
private Dispatch<SOAPMessage> dispatcher;
static {
try {
securityProperties = new Properties();
securityProperties.load(SoapClient.class.getResourceAsStream("/security/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("/security/client_sigpropfile.properties");
initKeyStore();
} catch (WSSecurityException | WebServiceException | CertificateException | NoSuchAlgorithmException | KeyStoreException | IOException e) {
//LOGGER.error 'Fout bij init SoapClient: {}', e.message
throw new RuntimeException("Fout bij init SoapClient", e);
}
}
/**
* Constructor.
* @param params parameters voor het ophalen van WSDL en sturen van de requests
*/
public SoapClient(final SoapParameters params) {
try {
initDispatcher(params);
} catch (MalformedURLException | ServicesNietBereikbaarException e) {
LOGGER.error("Exception creating SoapClient: {}", e.getMessage());
throw new ServicesNietBereikbaarException("Kan geen SoapClient creeren naar ${params.wsdlURL}", e);
}
}
protected InputStream getInputStream(final String bericht) throws IOException {
return new ByteArrayInputStream(bericht.getBytes("UTF-8"));
}
/**
* 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 nl.sandersmee.testtool.ontvanger wordt de body geextraheerd en als {@link org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
public 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);
request.writeTo(System.err);
// 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 javax.xml.soap.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 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 org.w3c.dom.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();
}
/*
* Initialiseert de standaard {@link javax.xml.ws.Dispatch} instantie die gebruikt wordt om de KERN Service aan te
* roepen.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher(final SoapParameters params) throws MalformedURLException {
try {
LOGGER.debug("SoapClient dispatcher initialiseren");
Service s = Service.create(params.getWsdlURL(), params.getServiceQName());
dispatcher = s.createDispatch(params.getPortQName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
Map<String, Object> map = dispatcher.getRequestContext();
map.put("com.sun.xml.internal.ws.request.timeout", SOAP_REQUEST_TIMEOUT_IN_MILLIS);
LOGGER.debug("SoapClient dispatcher initialiseren - KLAAR");
} catch (Throwable e) {
LOGGER.error("Fout bij creeren SOAPClient:", e);
throw new ServicesNietBereikbaarException("Fout bij creeren SOAPClient", e);
}
}
/**
* 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 java.security.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 =
SoapClient.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();
publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
}
/*
* Controleert de message signature met de public key van de ontvanger.
*
* @param message bericht met de signature
* @throws java.security.KeyStoreException
* @throws javax.xml.soap.SOAPException
* @throws javax.xml.crypto.MarshalException
* @throws javax.xml.crypto.dsig.XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException {
// 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));
}
protected void printResponse(final Document document) throws Exception {
//String xml = XmlUtils.toXmlString(document.getDocumentElement());
//LOGGER.info "xml:\n $xml"
}
}
| MinBZK/OperatieBRP | 2016/brp 2016-02-09/test/component-test/src/main/java/nl/bzk/brp/testrunner/component/services/soap/SoapClient.java | 3,534 | // 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.testrunner.component.services.soap;
import com.sun.org.apache.xml.internal.security.signature.XMLSignature;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
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.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.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.WebServiceException;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
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;
/**
* SoapClient voor het versturen van soap berichten.
*/
public class SoapClient {
private static final Logger LOGGER = LoggerFactory.getLogger(SoapClient.class);
private static final int SOAP_REQUEST_TIMEOUT_IN_MILLIS = 5 * 60 * 1000;
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private static PublicKey publicKey;
private Dispatch<SOAPMessage> dispatcher;
static {
try {
securityProperties = new Properties();
securityProperties.load(SoapClient.class.getResourceAsStream("/security/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("/security/client_sigpropfile.properties");
initKeyStore();
} catch (WSSecurityException | WebServiceException | CertificateException | NoSuchAlgorithmException | KeyStoreException | IOException e) {
//LOGGER.error 'Fout bij init SoapClient: {}', e.message
throw new RuntimeException("Fout bij init SoapClient", e);
}
}
/**
* Constructor.
* @param params parameters voor het ophalen van WSDL en sturen van de requests
*/
public SoapClient(final SoapParameters params) {
try {
initDispatcher(params);
} catch (MalformedURLException | ServicesNietBereikbaarException e) {
LOGGER.error("Exception creating SoapClient: {}", e.getMessage());
throw new ServicesNietBereikbaarException("Kan geen SoapClient creeren naar ${params.wsdlURL}", e);
}
}
protected InputStream getInputStream(final String bericht) throws IOException {
return new ByteArrayInputStream(bericht.getBytes("UTF-8"));
}
/**
* 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 nl.sandersmee.testtool.ontvanger wordt de body geextraheerd en als {@link org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
public 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);
request.writeTo(System.err);
// 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 javax.xml.soap.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 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 org.w3c.dom.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();
}
/*
* Initialiseert de standaard {@link javax.xml.ws.Dispatch} instantie die gebruikt wordt om de KERN Service aan te
* roepen.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher(final SoapParameters params) throws MalformedURLException {
try {
LOGGER.debug("SoapClient dispatcher initialiseren");
Service s = Service.create(params.getWsdlURL(), params.getServiceQName());
dispatcher = s.createDispatch(params.getPortQName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
Map<String, Object> map = dispatcher.getRequestContext();
map.put("com.sun.xml.internal.ws.request.timeout", SOAP_REQUEST_TIMEOUT_IN_MILLIS);
LOGGER.debug("SoapClient dispatcher initialiseren - KLAAR");
} catch (Throwable e) {
LOGGER.error("Fout bij creeren SOAPClient:", e);
throw new ServicesNietBereikbaarException("Fout bij creeren SOAPClient", e);
}
}
/**
* 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 java.security.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 =
SoapClient.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();
publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
}
/*
* Controleert de message signature met de public key van de ontvanger.
*
* @param message bericht met de signature
* @throws java.security.KeyStoreException
* @throws javax.xml.soap.SOAPException
* @throws javax.xml.crypto.MarshalException
* @throws javax.xml.crypto.dsig.XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException {
// 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));
}
protected void printResponse(final Document document) throws Exception {
//String xml = XmlUtils.toXmlString(document.getDocumentElement());
//LOGGER.info "xml:\n $xml"
}
}
|
201782_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.testrunner.component.services.soap;
import com.sun.org.apache.xml.internal.security.signature.XMLSignature;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
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.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.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.WebServiceException;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
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;
/**
* SoapClient voor het versturen van soap berichten.
*/
public class SoapClient {
private static final Logger LOGGER = LoggerFactory.getLogger(SoapClient.class);
private static final int SOAP_REQUEST_TIMEOUT_IN_MILLIS = 5 * 60 * 1000;
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private static PublicKey publicKey;
private Dispatch<SOAPMessage> dispatcher;
static {
try {
securityProperties = new Properties();
securityProperties.load(SoapClient.class.getResourceAsStream("/security/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("/security/client_sigpropfile.properties");
initKeyStore();
} catch (WSSecurityException | WebServiceException | CertificateException | NoSuchAlgorithmException | KeyStoreException | IOException e) {
//LOGGER.error 'Fout bij init SoapClient: {}', e.message
throw new RuntimeException("Fout bij init SoapClient", e);
}
}
/**
* Constructor.
* @param params parameters voor het ophalen van WSDL en sturen van de requests
*/
public SoapClient(final SoapParameters params) {
try {
initDispatcher(params);
} catch (MalformedURLException | ServicesNietBereikbaarException e) {
LOGGER.error("Exception creating SoapClient: {}", e.getMessage());
throw new ServicesNietBereikbaarException("Kan geen SoapClient creeren naar ${params.wsdlURL}", e);
}
}
protected InputStream getInputStream(final String bericht) throws IOException {
return new ByteArrayInputStream(bericht.getBytes("UTF-8"));
}
/**
* 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 nl.sandersmee.testtool.ontvanger wordt de body geextraheerd en als {@link org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
public 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);
request.writeTo(System.err);
// 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 javax.xml.soap.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 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 org.w3c.dom.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();
}
/*
* Initialiseert de standaard {@link javax.xml.ws.Dispatch} instantie die gebruikt wordt om de KERN Service aan te
* roepen.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher(final SoapParameters params) throws MalformedURLException {
try {
LOGGER.debug("SoapClient dispatcher initialiseren");
Service s = Service.create(params.getWsdlURL(), params.getServiceQName());
dispatcher = s.createDispatch(params.getPortQName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
Map<String, Object> map = dispatcher.getRequestContext();
map.put("com.sun.xml.internal.ws.request.timeout", SOAP_REQUEST_TIMEOUT_IN_MILLIS);
LOGGER.debug("SoapClient dispatcher initialiseren - KLAAR");
} catch (Throwable e) {
LOGGER.error("Fout bij creeren SOAPClient:", e);
throw new ServicesNietBereikbaarException("Fout bij creeren SOAPClient", e);
}
}
/**
* 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 java.security.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 =
SoapClient.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();
publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
}
/*
* Controleert de message signature met de public key van de ontvanger.
*
* @param message bericht met de signature
* @throws java.security.KeyStoreException
* @throws javax.xml.soap.SOAPException
* @throws javax.xml.crypto.MarshalException
* @throws javax.xml.crypto.dsig.XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException {
// 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));
}
protected void printResponse(final Document document) throws Exception {
//String xml = XmlUtils.toXmlString(document.getDocumentElement());
//LOGGER.info "xml:\n $xml"
}
}
| MinBZK/OperatieBRP | 2016/brp 2016-02-09/test/component-test/src/main/java/nl/bzk/brp/testrunner/component/services/soap/SoapClient.java | 3,534 | // 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.testrunner.component.services.soap;
import com.sun.org.apache.xml.internal.security.signature.XMLSignature;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
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.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.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.WebServiceException;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
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;
/**
* SoapClient voor het versturen van soap berichten.
*/
public class SoapClient {
private static final Logger LOGGER = LoggerFactory.getLogger(SoapClient.class);
private static final int SOAP_REQUEST_TIMEOUT_IN_MILLIS = 5 * 60 * 1000;
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private static PublicKey publicKey;
private Dispatch<SOAPMessage> dispatcher;
static {
try {
securityProperties = new Properties();
securityProperties.load(SoapClient.class.getResourceAsStream("/security/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("/security/client_sigpropfile.properties");
initKeyStore();
} catch (WSSecurityException | WebServiceException | CertificateException | NoSuchAlgorithmException | KeyStoreException | IOException e) {
//LOGGER.error 'Fout bij init SoapClient: {}', e.message
throw new RuntimeException("Fout bij init SoapClient", e);
}
}
/**
* Constructor.
* @param params parameters voor het ophalen van WSDL en sturen van de requests
*/
public SoapClient(final SoapParameters params) {
try {
initDispatcher(params);
} catch (MalformedURLException | ServicesNietBereikbaarException e) {
LOGGER.error("Exception creating SoapClient: {}", e.getMessage());
throw new ServicesNietBereikbaarException("Kan geen SoapClient creeren naar ${params.wsdlURL}", e);
}
}
protected InputStream getInputStream(final String bericht) throws IOException {
return new ByteArrayInputStream(bericht.getBytes("UTF-8"));
}
/**
* 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 nl.sandersmee.testtool.ontvanger wordt de body geextraheerd en als {@link org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
public 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);
request.writeTo(System.err);
// 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 javax.xml.soap.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 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 org.w3c.dom.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();
}
/*
* Initialiseert de standaard {@link javax.xml.ws.Dispatch} instantie die gebruikt wordt om de KERN Service aan te
* roepen.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher(final SoapParameters params) throws MalformedURLException {
try {
LOGGER.debug("SoapClient dispatcher initialiseren");
Service s = Service.create(params.getWsdlURL(), params.getServiceQName());
dispatcher = s.createDispatch(params.getPortQName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
Map<String, Object> map = dispatcher.getRequestContext();
map.put("com.sun.xml.internal.ws.request.timeout", SOAP_REQUEST_TIMEOUT_IN_MILLIS);
LOGGER.debug("SoapClient dispatcher initialiseren - KLAAR");
} catch (Throwable e) {
LOGGER.error("Fout bij creeren SOAPClient:", e);
throw new ServicesNietBereikbaarException("Fout bij creeren SOAPClient", e);
}
}
/**
* 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 java.security.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 =
SoapClient.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();
publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
}
/*
* Controleert de message signature met de public key van de ontvanger.
*
* @param message bericht met de signature
* @throws java.security.KeyStoreException
* @throws javax.xml.soap.SOAPException
* @throws javax.xml.crypto.MarshalException
* @throws javax.xml.crypto.dsig.XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException {
// 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));
}
protected void printResponse(final Document document) throws Exception {
//String xml = XmlUtils.toXmlString(document.getDocumentElement());
//LOGGER.info "xml:\n $xml"
}
}
|
201782_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.testrunner.component.services.soap;
import com.sun.org.apache.xml.internal.security.signature.XMLSignature;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
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.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.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.WebServiceException;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
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;
/**
* SoapClient voor het versturen van soap berichten.
*/
public class SoapClient {
private static final Logger LOGGER = LoggerFactory.getLogger(SoapClient.class);
private static final int SOAP_REQUEST_TIMEOUT_IN_MILLIS = 5 * 60 * 1000;
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private static PublicKey publicKey;
private Dispatch<SOAPMessage> dispatcher;
static {
try {
securityProperties = new Properties();
securityProperties.load(SoapClient.class.getResourceAsStream("/security/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("/security/client_sigpropfile.properties");
initKeyStore();
} catch (WSSecurityException | WebServiceException | CertificateException | NoSuchAlgorithmException | KeyStoreException | IOException e) {
//LOGGER.error 'Fout bij init SoapClient: {}', e.message
throw new RuntimeException("Fout bij init SoapClient", e);
}
}
/**
* Constructor.
* @param params parameters voor het ophalen van WSDL en sturen van de requests
*/
public SoapClient(final SoapParameters params) {
try {
initDispatcher(params);
} catch (MalformedURLException | ServicesNietBereikbaarException e) {
LOGGER.error("Exception creating SoapClient: {}", e.getMessage());
throw new ServicesNietBereikbaarException("Kan geen SoapClient creeren naar ${params.wsdlURL}", e);
}
}
protected InputStream getInputStream(final String bericht) throws IOException {
return new ByteArrayInputStream(bericht.getBytes("UTF-8"));
}
/**
* 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 nl.sandersmee.testtool.ontvanger wordt de body geextraheerd en als {@link org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
public 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);
request.writeTo(System.err);
// 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 javax.xml.soap.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 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 org.w3c.dom.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();
}
/*
* Initialiseert de standaard {@link javax.xml.ws.Dispatch} instantie die gebruikt wordt om de KERN Service aan te
* roepen.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher(final SoapParameters params) throws MalformedURLException {
try {
LOGGER.debug("SoapClient dispatcher initialiseren");
Service s = Service.create(params.getWsdlURL(), params.getServiceQName());
dispatcher = s.createDispatch(params.getPortQName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
Map<String, Object> map = dispatcher.getRequestContext();
map.put("com.sun.xml.internal.ws.request.timeout", SOAP_REQUEST_TIMEOUT_IN_MILLIS);
LOGGER.debug("SoapClient dispatcher initialiseren - KLAAR");
} catch (Throwable e) {
LOGGER.error("Fout bij creeren SOAPClient:", e);
throw new ServicesNietBereikbaarException("Fout bij creeren SOAPClient", e);
}
}
/**
* 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 java.security.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 =
SoapClient.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();
publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
}
/*
* Controleert de message signature met de public key van de ontvanger.
*
* @param message bericht met de signature
* @throws java.security.KeyStoreException
* @throws javax.xml.soap.SOAPException
* @throws javax.xml.crypto.MarshalException
* @throws javax.xml.crypto.dsig.XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException {
// 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));
}
protected void printResponse(final Document document) throws Exception {
//String xml = XmlUtils.toXmlString(document.getDocumentElement());
//LOGGER.info "xml:\n $xml"
}
}
| MinBZK/OperatieBRP | 2016/brp 2016-02-09/test/component-test/src/main/java/nl/bzk/brp/testrunner/component/services/soap/SoapClient.java | 3,534 | // 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.testrunner.component.services.soap;
import com.sun.org.apache.xml.internal.security.signature.XMLSignature;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
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.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.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.WebServiceException;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
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;
/**
* SoapClient voor het versturen van soap berichten.
*/
public class SoapClient {
private static final Logger LOGGER = LoggerFactory.getLogger(SoapClient.class);
private static final int SOAP_REQUEST_TIMEOUT_IN_MILLIS = 5 * 60 * 1000;
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private static PublicKey publicKey;
private Dispatch<SOAPMessage> dispatcher;
static {
try {
securityProperties = new Properties();
securityProperties.load(SoapClient.class.getResourceAsStream("/security/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("/security/client_sigpropfile.properties");
initKeyStore();
} catch (WSSecurityException | WebServiceException | CertificateException | NoSuchAlgorithmException | KeyStoreException | IOException e) {
//LOGGER.error 'Fout bij init SoapClient: {}', e.message
throw new RuntimeException("Fout bij init SoapClient", e);
}
}
/**
* Constructor.
* @param params parameters voor het ophalen van WSDL en sturen van de requests
*/
public SoapClient(final SoapParameters params) {
try {
initDispatcher(params);
} catch (MalformedURLException | ServicesNietBereikbaarException e) {
LOGGER.error("Exception creating SoapClient: {}", e.getMessage());
throw new ServicesNietBereikbaarException("Kan geen SoapClient creeren naar ${params.wsdlURL}", e);
}
}
protected InputStream getInputStream(final String bericht) throws IOException {
return new ByteArrayInputStream(bericht.getBytes("UTF-8"));
}
/**
* 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 nl.sandersmee.testtool.ontvanger wordt de body geextraheerd en als {@link org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
public 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);
request.writeTo(System.err);
// 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 javax.xml.soap.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 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 org.w3c.dom.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();
}
/*
* Initialiseert de standaard {@link javax.xml.ws.Dispatch} instantie die gebruikt wordt om de KERN Service aan te
* roepen.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher(final SoapParameters params) throws MalformedURLException {
try {
LOGGER.debug("SoapClient dispatcher initialiseren");
Service s = Service.create(params.getWsdlURL(), params.getServiceQName());
dispatcher = s.createDispatch(params.getPortQName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
Map<String, Object> map = dispatcher.getRequestContext();
map.put("com.sun.xml.internal.ws.request.timeout", SOAP_REQUEST_TIMEOUT_IN_MILLIS);
LOGGER.debug("SoapClient dispatcher initialiseren - KLAAR");
} catch (Throwable e) {
LOGGER.error("Fout bij creeren SOAPClient:", e);
throw new ServicesNietBereikbaarException("Fout bij creeren SOAPClient", e);
}
}
/**
* 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 java.security.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 =
SoapClient.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();
publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
}
/*
* Controleert de message signature met de public key van de ontvanger.
*
* @param message bericht met de signature
* @throws java.security.KeyStoreException
* @throws javax.xml.soap.SOAPException
* @throws javax.xml.crypto.MarshalException
* @throws javax.xml.crypto.dsig.XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException {
// 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));
}
protected void printResponse(final Document document) throws Exception {
//String xml = XmlUtils.toXmlString(document.getDocumentElement());
//LOGGER.info "xml:\n $xml"
}
}
|
201782_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.testrunner.component.services.soap;
import com.sun.org.apache.xml.internal.security.signature.XMLSignature;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
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.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.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.WebServiceException;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
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;
/**
* SoapClient voor het versturen van soap berichten.
*/
public class SoapClient {
private static final Logger LOGGER = LoggerFactory.getLogger(SoapClient.class);
private static final int SOAP_REQUEST_TIMEOUT_IN_MILLIS = 5 * 60 * 1000;
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private static PublicKey publicKey;
private Dispatch<SOAPMessage> dispatcher;
static {
try {
securityProperties = new Properties();
securityProperties.load(SoapClient.class.getResourceAsStream("/security/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("/security/client_sigpropfile.properties");
initKeyStore();
} catch (WSSecurityException | WebServiceException | CertificateException | NoSuchAlgorithmException | KeyStoreException | IOException e) {
//LOGGER.error 'Fout bij init SoapClient: {}', e.message
throw new RuntimeException("Fout bij init SoapClient", e);
}
}
/**
* Constructor.
* @param params parameters voor het ophalen van WSDL en sturen van de requests
*/
public SoapClient(final SoapParameters params) {
try {
initDispatcher(params);
} catch (MalformedURLException | ServicesNietBereikbaarException e) {
LOGGER.error("Exception creating SoapClient: {}", e.getMessage());
throw new ServicesNietBereikbaarException("Kan geen SoapClient creeren naar ${params.wsdlURL}", e);
}
}
protected InputStream getInputStream(final String bericht) throws IOException {
return new ByteArrayInputStream(bericht.getBytes("UTF-8"));
}
/**
* 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 nl.sandersmee.testtool.ontvanger wordt de body geextraheerd en als {@link org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
public 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);
request.writeTo(System.err);
// 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 javax.xml.soap.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 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 org.w3c.dom.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();
}
/*
* Initialiseert de standaard {@link javax.xml.ws.Dispatch} instantie die gebruikt wordt om de KERN Service aan te
* roepen.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher(final SoapParameters params) throws MalformedURLException {
try {
LOGGER.debug("SoapClient dispatcher initialiseren");
Service s = Service.create(params.getWsdlURL(), params.getServiceQName());
dispatcher = s.createDispatch(params.getPortQName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
Map<String, Object> map = dispatcher.getRequestContext();
map.put("com.sun.xml.internal.ws.request.timeout", SOAP_REQUEST_TIMEOUT_IN_MILLIS);
LOGGER.debug("SoapClient dispatcher initialiseren - KLAAR");
} catch (Throwable e) {
LOGGER.error("Fout bij creeren SOAPClient:", e);
throw new ServicesNietBereikbaarException("Fout bij creeren SOAPClient", e);
}
}
/**
* 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 java.security.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 =
SoapClient.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();
publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
}
/*
* Controleert de message signature met de public key van de ontvanger.
*
* @param message bericht met de signature
* @throws java.security.KeyStoreException
* @throws javax.xml.soap.SOAPException
* @throws javax.xml.crypto.MarshalException
* @throws javax.xml.crypto.dsig.XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException {
// 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));
}
protected void printResponse(final Document document) throws Exception {
//String xml = XmlUtils.toXmlString(document.getDocumentElement());
//LOGGER.info "xml:\n $xml"
}
}
| MinBZK/OperatieBRP | 2016/brp 2016-02-09/test/component-test/src/main/java/nl/bzk/brp/testrunner/component/services/soap/SoapClient.java | 3,534 | // 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.testrunner.component.services.soap;
import com.sun.org.apache.xml.internal.security.signature.XMLSignature;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
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.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.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.WebServiceException;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
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;
/**
* SoapClient voor het versturen van soap berichten.
*/
public class SoapClient {
private static final Logger LOGGER = LoggerFactory.getLogger(SoapClient.class);
private static final int SOAP_REQUEST_TIMEOUT_IN_MILLIS = 5 * 60 * 1000;
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private static PublicKey publicKey;
private Dispatch<SOAPMessage> dispatcher;
static {
try {
securityProperties = new Properties();
securityProperties.load(SoapClient.class.getResourceAsStream("/security/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("/security/client_sigpropfile.properties");
initKeyStore();
} catch (WSSecurityException | WebServiceException | CertificateException | NoSuchAlgorithmException | KeyStoreException | IOException e) {
//LOGGER.error 'Fout bij init SoapClient: {}', e.message
throw new RuntimeException("Fout bij init SoapClient", e);
}
}
/**
* Constructor.
* @param params parameters voor het ophalen van WSDL en sturen van de requests
*/
public SoapClient(final SoapParameters params) {
try {
initDispatcher(params);
} catch (MalformedURLException | ServicesNietBereikbaarException e) {
LOGGER.error("Exception creating SoapClient: {}", e.getMessage());
throw new ServicesNietBereikbaarException("Kan geen SoapClient creeren naar ${params.wsdlURL}", e);
}
}
protected InputStream getInputStream(final String bericht) throws IOException {
return new ByteArrayInputStream(bericht.getBytes("UTF-8"));
}
/**
* 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 nl.sandersmee.testtool.ontvanger wordt de body geextraheerd en als {@link org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
public 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);
request.writeTo(System.err);
// 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 javax.xml.soap.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 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 org.w3c.dom.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();
}
/*
* Initialiseert de standaard {@link javax.xml.ws.Dispatch} instantie die gebruikt wordt om de KERN Service aan te
* roepen.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher(final SoapParameters params) throws MalformedURLException {
try {
LOGGER.debug("SoapClient dispatcher initialiseren");
Service s = Service.create(params.getWsdlURL(), params.getServiceQName());
dispatcher = s.createDispatch(params.getPortQName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
Map<String, Object> map = dispatcher.getRequestContext();
map.put("com.sun.xml.internal.ws.request.timeout", SOAP_REQUEST_TIMEOUT_IN_MILLIS);
LOGGER.debug("SoapClient dispatcher initialiseren - KLAAR");
} catch (Throwable e) {
LOGGER.error("Fout bij creeren SOAPClient:", e);
throw new ServicesNietBereikbaarException("Fout bij creeren SOAPClient", e);
}
}
/**
* 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 java.security.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 =
SoapClient.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();
publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
}
/*
* Controleert de message signature met de public key van de ontvanger.
*
* @param message bericht met de signature
* @throws java.security.KeyStoreException
* @throws javax.xml.soap.SOAPException
* @throws javax.xml.crypto.MarshalException
* @throws javax.xml.crypto.dsig.XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException {
// 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));
}
protected void printResponse(final Document document) throws Exception {
//String xml = XmlUtils.toXmlString(document.getDocumentElement());
//LOGGER.info "xml:\n $xml"
}
}
|
201782_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.testrunner.component.services.soap;
import com.sun.org.apache.xml.internal.security.signature.XMLSignature;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
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.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.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.WebServiceException;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
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;
/**
* SoapClient voor het versturen van soap berichten.
*/
public class SoapClient {
private static final Logger LOGGER = LoggerFactory.getLogger(SoapClient.class);
private static final int SOAP_REQUEST_TIMEOUT_IN_MILLIS = 5 * 60 * 1000;
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private static PublicKey publicKey;
private Dispatch<SOAPMessage> dispatcher;
static {
try {
securityProperties = new Properties();
securityProperties.load(SoapClient.class.getResourceAsStream("/security/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("/security/client_sigpropfile.properties");
initKeyStore();
} catch (WSSecurityException | WebServiceException | CertificateException | NoSuchAlgorithmException | KeyStoreException | IOException e) {
//LOGGER.error 'Fout bij init SoapClient: {}', e.message
throw new RuntimeException("Fout bij init SoapClient", e);
}
}
/**
* Constructor.
* @param params parameters voor het ophalen van WSDL en sturen van de requests
*/
public SoapClient(final SoapParameters params) {
try {
initDispatcher(params);
} catch (MalformedURLException | ServicesNietBereikbaarException e) {
LOGGER.error("Exception creating SoapClient: {}", e.getMessage());
throw new ServicesNietBereikbaarException("Kan geen SoapClient creeren naar ${params.wsdlURL}", e);
}
}
protected InputStream getInputStream(final String bericht) throws IOException {
return new ByteArrayInputStream(bericht.getBytes("UTF-8"));
}
/**
* 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 nl.sandersmee.testtool.ontvanger wordt de body geextraheerd en als {@link org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
public 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);
request.writeTo(System.err);
// 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 javax.xml.soap.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 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 org.w3c.dom.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();
}
/*
* Initialiseert de standaard {@link javax.xml.ws.Dispatch} instantie die gebruikt wordt om de KERN Service aan te
* roepen.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher(final SoapParameters params) throws MalformedURLException {
try {
LOGGER.debug("SoapClient dispatcher initialiseren");
Service s = Service.create(params.getWsdlURL(), params.getServiceQName());
dispatcher = s.createDispatch(params.getPortQName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
Map<String, Object> map = dispatcher.getRequestContext();
map.put("com.sun.xml.internal.ws.request.timeout", SOAP_REQUEST_TIMEOUT_IN_MILLIS);
LOGGER.debug("SoapClient dispatcher initialiseren - KLAAR");
} catch (Throwable e) {
LOGGER.error("Fout bij creeren SOAPClient:", e);
throw new ServicesNietBereikbaarException("Fout bij creeren SOAPClient", e);
}
}
/**
* 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 java.security.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 =
SoapClient.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();
publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
}
/*
* Controleert de message signature met de public key van de ontvanger.
*
* @param message bericht met de signature
* @throws java.security.KeyStoreException
* @throws javax.xml.soap.SOAPException
* @throws javax.xml.crypto.MarshalException
* @throws javax.xml.crypto.dsig.XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException {
// 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));
}
protected void printResponse(final Document document) throws Exception {
//String xml = XmlUtils.toXmlString(document.getDocumentElement());
//LOGGER.info "xml:\n $xml"
}
}
| MinBZK/OperatieBRP | 2016/brp 2016-02-09/test/component-test/src/main/java/nl/bzk/brp/testrunner/component/services/soap/SoapClient.java | 3,534 | /*
* 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.testrunner.component.services.soap;
import com.sun.org.apache.xml.internal.security.signature.XMLSignature;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
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.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.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.WebServiceException;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
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;
/**
* SoapClient voor het versturen van soap berichten.
*/
public class SoapClient {
private static final Logger LOGGER = LoggerFactory.getLogger(SoapClient.class);
private static final int SOAP_REQUEST_TIMEOUT_IN_MILLIS = 5 * 60 * 1000;
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private static PublicKey publicKey;
private Dispatch<SOAPMessage> dispatcher;
static {
try {
securityProperties = new Properties();
securityProperties.load(SoapClient.class.getResourceAsStream("/security/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("/security/client_sigpropfile.properties");
initKeyStore();
} catch (WSSecurityException | WebServiceException | CertificateException | NoSuchAlgorithmException | KeyStoreException | IOException e) {
//LOGGER.error 'Fout bij init SoapClient: {}', e.message
throw new RuntimeException("Fout bij init SoapClient", e);
}
}
/**
* Constructor.
* @param params parameters voor het ophalen van WSDL en sturen van de requests
*/
public SoapClient(final SoapParameters params) {
try {
initDispatcher(params);
} catch (MalformedURLException | ServicesNietBereikbaarException e) {
LOGGER.error("Exception creating SoapClient: {}", e.getMessage());
throw new ServicesNietBereikbaarException("Kan geen SoapClient creeren naar ${params.wsdlURL}", e);
}
}
protected InputStream getInputStream(final String bericht) throws IOException {
return new ByteArrayInputStream(bericht.getBytes("UTF-8"));
}
/**
* 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 nl.sandersmee.testtool.ontvanger wordt de body geextraheerd en als {@link org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
public 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);
request.writeTo(System.err);
// 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 javax.xml.soap.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 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 org.w3c.dom.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();
}
/*
* Initialiseert de standaard {@link javax.xml.ws.Dispatch} instantie die gebruikt wordt om de KERN Service aan te
* roepen.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher(final SoapParameters params) throws MalformedURLException {
try {
LOGGER.debug("SoapClient dispatcher initialiseren");
Service s = Service.create(params.getWsdlURL(), params.getServiceQName());
dispatcher = s.createDispatch(params.getPortQName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
Map<String, Object> map = dispatcher.getRequestContext();
map.put("com.sun.xml.internal.ws.request.timeout", SOAP_REQUEST_TIMEOUT_IN_MILLIS);
LOGGER.debug("SoapClient dispatcher initialiseren - KLAAR");
} catch (Throwable e) {
LOGGER.error("Fout bij creeren SOAPClient:", e);
throw new ServicesNietBereikbaarException("Fout bij creeren SOAPClient", e);
}
}
/**
* 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 java.security.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 =
SoapClient.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();
publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
}
/*
* Controleert de message signature met de public key van de ontvanger.
*
* @param message bericht met de signature
* @throws java.security.KeyStoreException
* @throws javax.xml.soap.SOAPException
* @throws javax.xml.crypto.MarshalException
* @throws javax.xml.crypto.dsig.XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException {
// 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));
}
protected void printResponse(final Document document) throws Exception {
//String xml = XmlUtils.toXmlString(document.getDocumentElement());
//LOGGER.info "xml:\n $xml"
}
}
|
201782_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.testrunner.component.services.soap;
import com.sun.org.apache.xml.internal.security.signature.XMLSignature;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
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.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.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.WebServiceException;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
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;
/**
* SoapClient voor het versturen van soap berichten.
*/
public class SoapClient {
private static final Logger LOGGER = LoggerFactory.getLogger(SoapClient.class);
private static final int SOAP_REQUEST_TIMEOUT_IN_MILLIS = 5 * 60 * 1000;
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private static PublicKey publicKey;
private Dispatch<SOAPMessage> dispatcher;
static {
try {
securityProperties = new Properties();
securityProperties.load(SoapClient.class.getResourceAsStream("/security/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("/security/client_sigpropfile.properties");
initKeyStore();
} catch (WSSecurityException | WebServiceException | CertificateException | NoSuchAlgorithmException | KeyStoreException | IOException e) {
//LOGGER.error 'Fout bij init SoapClient: {}', e.message
throw new RuntimeException("Fout bij init SoapClient", e);
}
}
/**
* Constructor.
* @param params parameters voor het ophalen van WSDL en sturen van de requests
*/
public SoapClient(final SoapParameters params) {
try {
initDispatcher(params);
} catch (MalformedURLException | ServicesNietBereikbaarException e) {
LOGGER.error("Exception creating SoapClient: {}", e.getMessage());
throw new ServicesNietBereikbaarException("Kan geen SoapClient creeren naar ${params.wsdlURL}", e);
}
}
protected InputStream getInputStream(final String bericht) throws IOException {
return new ByteArrayInputStream(bericht.getBytes("UTF-8"));
}
/**
* 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 nl.sandersmee.testtool.ontvanger wordt de body geextraheerd en als {@link org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
public 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);
request.writeTo(System.err);
// 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 javax.xml.soap.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 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 org.w3c.dom.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();
}
/*
* Initialiseert de standaard {@link javax.xml.ws.Dispatch} instantie die gebruikt wordt om de KERN Service aan te
* roepen.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher(final SoapParameters params) throws MalformedURLException {
try {
LOGGER.debug("SoapClient dispatcher initialiseren");
Service s = Service.create(params.getWsdlURL(), params.getServiceQName());
dispatcher = s.createDispatch(params.getPortQName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
Map<String, Object> map = dispatcher.getRequestContext();
map.put("com.sun.xml.internal.ws.request.timeout", SOAP_REQUEST_TIMEOUT_IN_MILLIS);
LOGGER.debug("SoapClient dispatcher initialiseren - KLAAR");
} catch (Throwable e) {
LOGGER.error("Fout bij creeren SOAPClient:", e);
throw new ServicesNietBereikbaarException("Fout bij creeren SOAPClient", e);
}
}
/**
* 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 java.security.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 =
SoapClient.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();
publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
}
/*
* Controleert de message signature met de public key van de ontvanger.
*
* @param message bericht met de signature
* @throws java.security.KeyStoreException
* @throws javax.xml.soap.SOAPException
* @throws javax.xml.crypto.MarshalException
* @throws javax.xml.crypto.dsig.XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException {
// 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));
}
protected void printResponse(final Document document) throws Exception {
//String xml = XmlUtils.toXmlString(document.getDocumentElement());
//LOGGER.info "xml:\n $xml"
}
}
| MinBZK/OperatieBRP | 2016/brp 2016-02-09/test/component-test/src/main/java/nl/bzk/brp/testrunner/component/services/soap/SoapClient.java | 3,534 | /*
* Deze methode past de opgegeven {@link javax.xml.soap.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.testrunner.component.services.soap;
import com.sun.org.apache.xml.internal.security.signature.XMLSignature;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
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.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.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.WebServiceException;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
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;
/**
* SoapClient voor het versturen van soap berichten.
*/
public class SoapClient {
private static final Logger LOGGER = LoggerFactory.getLogger(SoapClient.class);
private static final int SOAP_REQUEST_TIMEOUT_IN_MILLIS = 5 * 60 * 1000;
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private static PublicKey publicKey;
private Dispatch<SOAPMessage> dispatcher;
static {
try {
securityProperties = new Properties();
securityProperties.load(SoapClient.class.getResourceAsStream("/security/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("/security/client_sigpropfile.properties");
initKeyStore();
} catch (WSSecurityException | WebServiceException | CertificateException | NoSuchAlgorithmException | KeyStoreException | IOException e) {
//LOGGER.error 'Fout bij init SoapClient: {}', e.message
throw new RuntimeException("Fout bij init SoapClient", e);
}
}
/**
* Constructor.
* @param params parameters voor het ophalen van WSDL en sturen van de requests
*/
public SoapClient(final SoapParameters params) {
try {
initDispatcher(params);
} catch (MalformedURLException | ServicesNietBereikbaarException e) {
LOGGER.error("Exception creating SoapClient: {}", e.getMessage());
throw new ServicesNietBereikbaarException("Kan geen SoapClient creeren naar ${params.wsdlURL}", e);
}
}
protected InputStream getInputStream(final String bericht) throws IOException {
return new ByteArrayInputStream(bericht.getBytes("UTF-8"));
}
/**
* 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 nl.sandersmee.testtool.ontvanger wordt de body geextraheerd en als {@link org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
public 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);
request.writeTo(System.err);
// 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 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 org.w3c.dom.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();
}
/*
* Initialiseert de standaard {@link javax.xml.ws.Dispatch} instantie die gebruikt wordt om de KERN Service aan te
* roepen.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher(final SoapParameters params) throws MalformedURLException {
try {
LOGGER.debug("SoapClient dispatcher initialiseren");
Service s = Service.create(params.getWsdlURL(), params.getServiceQName());
dispatcher = s.createDispatch(params.getPortQName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
Map<String, Object> map = dispatcher.getRequestContext();
map.put("com.sun.xml.internal.ws.request.timeout", SOAP_REQUEST_TIMEOUT_IN_MILLIS);
LOGGER.debug("SoapClient dispatcher initialiseren - KLAAR");
} catch (Throwable e) {
LOGGER.error("Fout bij creeren SOAPClient:", e);
throw new ServicesNietBereikbaarException("Fout bij creeren SOAPClient", e);
}
}
/**
* 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 java.security.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 =
SoapClient.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();
publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
}
/*
* Controleert de message signature met de public key van de ontvanger.
*
* @param message bericht met de signature
* @throws java.security.KeyStoreException
* @throws javax.xml.soap.SOAPException
* @throws javax.xml.crypto.MarshalException
* @throws javax.xml.crypto.dsig.XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException {
// 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));
}
protected void printResponse(final Document document) throws Exception {
//String xml = XmlUtils.toXmlString(document.getDocumentElement());
//LOGGER.info "xml:\n $xml"
}
}
|
201782_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.testrunner.component.services.soap;
import com.sun.org.apache.xml.internal.security.signature.XMLSignature;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
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.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.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.WebServiceException;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
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;
/**
* SoapClient voor het versturen van soap berichten.
*/
public class SoapClient {
private static final Logger LOGGER = LoggerFactory.getLogger(SoapClient.class);
private static final int SOAP_REQUEST_TIMEOUT_IN_MILLIS = 5 * 60 * 1000;
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private static PublicKey publicKey;
private Dispatch<SOAPMessage> dispatcher;
static {
try {
securityProperties = new Properties();
securityProperties.load(SoapClient.class.getResourceAsStream("/security/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("/security/client_sigpropfile.properties");
initKeyStore();
} catch (WSSecurityException | WebServiceException | CertificateException | NoSuchAlgorithmException | KeyStoreException | IOException e) {
//LOGGER.error 'Fout bij init SoapClient: {}', e.message
throw new RuntimeException("Fout bij init SoapClient", e);
}
}
/**
* Constructor.
* @param params parameters voor het ophalen van WSDL en sturen van de requests
*/
public SoapClient(final SoapParameters params) {
try {
initDispatcher(params);
} catch (MalformedURLException | ServicesNietBereikbaarException e) {
LOGGER.error("Exception creating SoapClient: {}", e.getMessage());
throw new ServicesNietBereikbaarException("Kan geen SoapClient creeren naar ${params.wsdlURL}", e);
}
}
protected InputStream getInputStream(final String bericht) throws IOException {
return new ByteArrayInputStream(bericht.getBytes("UTF-8"));
}
/**
* 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 nl.sandersmee.testtool.ontvanger wordt de body geextraheerd en als {@link org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
public 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);
request.writeTo(System.err);
// 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 javax.xml.soap.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 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 org.w3c.dom.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();
}
/*
* Initialiseert de standaard {@link javax.xml.ws.Dispatch} instantie die gebruikt wordt om de KERN Service aan te
* roepen.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher(final SoapParameters params) throws MalformedURLException {
try {
LOGGER.debug("SoapClient dispatcher initialiseren");
Service s = Service.create(params.getWsdlURL(), params.getServiceQName());
dispatcher = s.createDispatch(params.getPortQName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
Map<String, Object> map = dispatcher.getRequestContext();
map.put("com.sun.xml.internal.ws.request.timeout", SOAP_REQUEST_TIMEOUT_IN_MILLIS);
LOGGER.debug("SoapClient dispatcher initialiseren - KLAAR");
} catch (Throwable e) {
LOGGER.error("Fout bij creeren SOAPClient:", e);
throw new ServicesNietBereikbaarException("Fout bij creeren SOAPClient", e);
}
}
/**
* 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 java.security.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 =
SoapClient.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();
publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
}
/*
* Controleert de message signature met de public key van de ontvanger.
*
* @param message bericht met de signature
* @throws java.security.KeyStoreException
* @throws javax.xml.soap.SOAPException
* @throws javax.xml.crypto.MarshalException
* @throws javax.xml.crypto.dsig.XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException {
// 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));
}
protected void printResponse(final Document document) throws Exception {
//String xml = XmlUtils.toXmlString(document.getDocumentElement());
//LOGGER.info "xml:\n $xml"
}
}
| MinBZK/OperatieBRP | 2016/brp 2016-02-09/test/component-test/src/main/java/nl/bzk/brp/testrunner/component/services/soap/SoapClient.java | 3,534 | // 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.testrunner.component.services.soap;
import com.sun.org.apache.xml.internal.security.signature.XMLSignature;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
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.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.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.WebServiceException;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
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;
/**
* SoapClient voor het versturen van soap berichten.
*/
public class SoapClient {
private static final Logger LOGGER = LoggerFactory.getLogger(SoapClient.class);
private static final int SOAP_REQUEST_TIMEOUT_IN_MILLIS = 5 * 60 * 1000;
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private static PublicKey publicKey;
private Dispatch<SOAPMessage> dispatcher;
static {
try {
securityProperties = new Properties();
securityProperties.load(SoapClient.class.getResourceAsStream("/security/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("/security/client_sigpropfile.properties");
initKeyStore();
} catch (WSSecurityException | WebServiceException | CertificateException | NoSuchAlgorithmException | KeyStoreException | IOException e) {
//LOGGER.error 'Fout bij init SoapClient: {}', e.message
throw new RuntimeException("Fout bij init SoapClient", e);
}
}
/**
* Constructor.
* @param params parameters voor het ophalen van WSDL en sturen van de requests
*/
public SoapClient(final SoapParameters params) {
try {
initDispatcher(params);
} catch (MalformedURLException | ServicesNietBereikbaarException e) {
LOGGER.error("Exception creating SoapClient: {}", e.getMessage());
throw new ServicesNietBereikbaarException("Kan geen SoapClient creeren naar ${params.wsdlURL}", e);
}
}
protected InputStream getInputStream(final String bericht) throws IOException {
return new ByteArrayInputStream(bericht.getBytes("UTF-8"));
}
/**
* 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 nl.sandersmee.testtool.ontvanger wordt de body geextraheerd en als {@link org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
public 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);
request.writeTo(System.err);
// 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 javax.xml.soap.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 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 org.w3c.dom.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();
}
/*
* Initialiseert de standaard {@link javax.xml.ws.Dispatch} instantie die gebruikt wordt om de KERN Service aan te
* roepen.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher(final SoapParameters params) throws MalformedURLException {
try {
LOGGER.debug("SoapClient dispatcher initialiseren");
Service s = Service.create(params.getWsdlURL(), params.getServiceQName());
dispatcher = s.createDispatch(params.getPortQName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
Map<String, Object> map = dispatcher.getRequestContext();
map.put("com.sun.xml.internal.ws.request.timeout", SOAP_REQUEST_TIMEOUT_IN_MILLIS);
LOGGER.debug("SoapClient dispatcher initialiseren - KLAAR");
} catch (Throwable e) {
LOGGER.error("Fout bij creeren SOAPClient:", e);
throw new ServicesNietBereikbaarException("Fout bij creeren SOAPClient", e);
}
}
/**
* 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 java.security.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 =
SoapClient.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();
publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
}
/*
* Controleert de message signature met de public key van de ontvanger.
*
* @param message bericht met de signature
* @throws java.security.KeyStoreException
* @throws javax.xml.soap.SOAPException
* @throws javax.xml.crypto.MarshalException
* @throws javax.xml.crypto.dsig.XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException {
// 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));
}
protected void printResponse(final Document document) throws Exception {
//String xml = XmlUtils.toXmlString(document.getDocumentElement());
//LOGGER.info "xml:\n $xml"
}
}
|
201782_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.testrunner.component.services.soap;
import com.sun.org.apache.xml.internal.security.signature.XMLSignature;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
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.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.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.WebServiceException;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
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;
/**
* SoapClient voor het versturen van soap berichten.
*/
public class SoapClient {
private static final Logger LOGGER = LoggerFactory.getLogger(SoapClient.class);
private static final int SOAP_REQUEST_TIMEOUT_IN_MILLIS = 5 * 60 * 1000;
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private static PublicKey publicKey;
private Dispatch<SOAPMessage> dispatcher;
static {
try {
securityProperties = new Properties();
securityProperties.load(SoapClient.class.getResourceAsStream("/security/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("/security/client_sigpropfile.properties");
initKeyStore();
} catch (WSSecurityException | WebServiceException | CertificateException | NoSuchAlgorithmException | KeyStoreException | IOException e) {
//LOGGER.error 'Fout bij init SoapClient: {}', e.message
throw new RuntimeException("Fout bij init SoapClient", e);
}
}
/**
* Constructor.
* @param params parameters voor het ophalen van WSDL en sturen van de requests
*/
public SoapClient(final SoapParameters params) {
try {
initDispatcher(params);
} catch (MalformedURLException | ServicesNietBereikbaarException e) {
LOGGER.error("Exception creating SoapClient: {}", e.getMessage());
throw new ServicesNietBereikbaarException("Kan geen SoapClient creeren naar ${params.wsdlURL}", e);
}
}
protected InputStream getInputStream(final String bericht) throws IOException {
return new ByteArrayInputStream(bericht.getBytes("UTF-8"));
}
/**
* 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 nl.sandersmee.testtool.ontvanger wordt de body geextraheerd en als {@link org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
public 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);
request.writeTo(System.err);
// 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 javax.xml.soap.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 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 org.w3c.dom.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();
}
/*
* Initialiseert de standaard {@link javax.xml.ws.Dispatch} instantie die gebruikt wordt om de KERN Service aan te
* roepen.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher(final SoapParameters params) throws MalformedURLException {
try {
LOGGER.debug("SoapClient dispatcher initialiseren");
Service s = Service.create(params.getWsdlURL(), params.getServiceQName());
dispatcher = s.createDispatch(params.getPortQName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
Map<String, Object> map = dispatcher.getRequestContext();
map.put("com.sun.xml.internal.ws.request.timeout", SOAP_REQUEST_TIMEOUT_IN_MILLIS);
LOGGER.debug("SoapClient dispatcher initialiseren - KLAAR");
} catch (Throwable e) {
LOGGER.error("Fout bij creeren SOAPClient:", e);
throw new ServicesNietBereikbaarException("Fout bij creeren SOAPClient", e);
}
}
/**
* 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 java.security.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 =
SoapClient.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();
publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
}
/*
* Controleert de message signature met de public key van de ontvanger.
*
* @param message bericht met de signature
* @throws java.security.KeyStoreException
* @throws javax.xml.soap.SOAPException
* @throws javax.xml.crypto.MarshalException
* @throws javax.xml.crypto.dsig.XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException {
// 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));
}
protected void printResponse(final Document document) throws Exception {
//String xml = XmlUtils.toXmlString(document.getDocumentElement());
//LOGGER.info "xml:\n $xml"
}
}
| MinBZK/OperatieBRP | 2016/brp 2016-02-09/test/component-test/src/main/java/nl/bzk/brp/testrunner/component/services/soap/SoapClient.java | 3,534 | /*
* Deze methode extraheert de werkelijke content uit het SOAP antwoord bericht.
*
* @param soapMessage het SOAP bericht waaruit de content gehaald wordt.
* @return een {@link org.w3c.dom.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.testrunner.component.services.soap;
import com.sun.org.apache.xml.internal.security.signature.XMLSignature;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
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.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.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.WebServiceException;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
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;
/**
* SoapClient voor het versturen van soap berichten.
*/
public class SoapClient {
private static final Logger LOGGER = LoggerFactory.getLogger(SoapClient.class);
private static final int SOAP_REQUEST_TIMEOUT_IN_MILLIS = 5 * 60 * 1000;
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private static PublicKey publicKey;
private Dispatch<SOAPMessage> dispatcher;
static {
try {
securityProperties = new Properties();
securityProperties.load(SoapClient.class.getResourceAsStream("/security/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("/security/client_sigpropfile.properties");
initKeyStore();
} catch (WSSecurityException | WebServiceException | CertificateException | NoSuchAlgorithmException | KeyStoreException | IOException e) {
//LOGGER.error 'Fout bij init SoapClient: {}', e.message
throw new RuntimeException("Fout bij init SoapClient", e);
}
}
/**
* Constructor.
* @param params parameters voor het ophalen van WSDL en sturen van de requests
*/
public SoapClient(final SoapParameters params) {
try {
initDispatcher(params);
} catch (MalformedURLException | ServicesNietBereikbaarException e) {
LOGGER.error("Exception creating SoapClient: {}", e.getMessage());
throw new ServicesNietBereikbaarException("Kan geen SoapClient creeren naar ${params.wsdlURL}", e);
}
}
protected InputStream getInputStream(final String bericht) throws IOException {
return new ByteArrayInputStream(bericht.getBytes("UTF-8"));
}
/**
* 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 nl.sandersmee.testtool.ontvanger wordt de body geextraheerd en als {@link org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
public 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);
request.writeTo(System.err);
// 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 javax.xml.soap.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 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();
}
/*
* Initialiseert de standaard {@link javax.xml.ws.Dispatch} instantie die gebruikt wordt om de KERN Service aan te
* roepen.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher(final SoapParameters params) throws MalformedURLException {
try {
LOGGER.debug("SoapClient dispatcher initialiseren");
Service s = Service.create(params.getWsdlURL(), params.getServiceQName());
dispatcher = s.createDispatch(params.getPortQName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
Map<String, Object> map = dispatcher.getRequestContext();
map.put("com.sun.xml.internal.ws.request.timeout", SOAP_REQUEST_TIMEOUT_IN_MILLIS);
LOGGER.debug("SoapClient dispatcher initialiseren - KLAAR");
} catch (Throwable e) {
LOGGER.error("Fout bij creeren SOAPClient:", e);
throw new ServicesNietBereikbaarException("Fout bij creeren SOAPClient", e);
}
}
/**
* 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 java.security.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 =
SoapClient.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();
publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
}
/*
* Controleert de message signature met de public key van de ontvanger.
*
* @param message bericht met de signature
* @throws java.security.KeyStoreException
* @throws javax.xml.soap.SOAPException
* @throws javax.xml.crypto.MarshalException
* @throws javax.xml.crypto.dsig.XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException {
// 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));
}
protected void printResponse(final Document document) throws Exception {
//String xml = XmlUtils.toXmlString(document.getDocumentElement());
//LOGGER.info "xml:\n $xml"
}
}
|
201782_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.testrunner.component.services.soap;
import com.sun.org.apache.xml.internal.security.signature.XMLSignature;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
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.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.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.WebServiceException;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
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;
/**
* SoapClient voor het versturen van soap berichten.
*/
public class SoapClient {
private static final Logger LOGGER = LoggerFactory.getLogger(SoapClient.class);
private static final int SOAP_REQUEST_TIMEOUT_IN_MILLIS = 5 * 60 * 1000;
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private static PublicKey publicKey;
private Dispatch<SOAPMessage> dispatcher;
static {
try {
securityProperties = new Properties();
securityProperties.load(SoapClient.class.getResourceAsStream("/security/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("/security/client_sigpropfile.properties");
initKeyStore();
} catch (WSSecurityException | WebServiceException | CertificateException | NoSuchAlgorithmException | KeyStoreException | IOException e) {
//LOGGER.error 'Fout bij init SoapClient: {}', e.message
throw new RuntimeException("Fout bij init SoapClient", e);
}
}
/**
* Constructor.
* @param params parameters voor het ophalen van WSDL en sturen van de requests
*/
public SoapClient(final SoapParameters params) {
try {
initDispatcher(params);
} catch (MalformedURLException | ServicesNietBereikbaarException e) {
LOGGER.error("Exception creating SoapClient: {}", e.getMessage());
throw new ServicesNietBereikbaarException("Kan geen SoapClient creeren naar ${params.wsdlURL}", e);
}
}
protected InputStream getInputStream(final String bericht) throws IOException {
return new ByteArrayInputStream(bericht.getBytes("UTF-8"));
}
/**
* 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 nl.sandersmee.testtool.ontvanger wordt de body geextraheerd en als {@link org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
public 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);
request.writeTo(System.err);
// 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 javax.xml.soap.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 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 org.w3c.dom.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();
}
/*
* Initialiseert de standaard {@link javax.xml.ws.Dispatch} instantie die gebruikt wordt om de KERN Service aan te
* roepen.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher(final SoapParameters params) throws MalformedURLException {
try {
LOGGER.debug("SoapClient dispatcher initialiseren");
Service s = Service.create(params.getWsdlURL(), params.getServiceQName());
dispatcher = s.createDispatch(params.getPortQName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
Map<String, Object> map = dispatcher.getRequestContext();
map.put("com.sun.xml.internal.ws.request.timeout", SOAP_REQUEST_TIMEOUT_IN_MILLIS);
LOGGER.debug("SoapClient dispatcher initialiseren - KLAAR");
} catch (Throwable e) {
LOGGER.error("Fout bij creeren SOAPClient:", e);
throw new ServicesNietBereikbaarException("Fout bij creeren SOAPClient", e);
}
}
/**
* 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 java.security.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 =
SoapClient.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();
publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
}
/*
* Controleert de message signature met de public key van de ontvanger.
*
* @param message bericht met de signature
* @throws java.security.KeyStoreException
* @throws javax.xml.soap.SOAPException
* @throws javax.xml.crypto.MarshalException
* @throws javax.xml.crypto.dsig.XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException {
// 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));
}
protected void printResponse(final Document document) throws Exception {
//String xml = XmlUtils.toXmlString(document.getDocumentElement());
//LOGGER.info "xml:\n $xml"
}
}
| MinBZK/OperatieBRP | 2016/brp 2016-02-09/test/component-test/src/main/java/nl/bzk/brp/testrunner/component/services/soap/SoapClient.java | 3,534 | /*
* Initialiseert de standaard {@link javax.xml.ws.Dispatch} instantie die gebruikt wordt om de KERN Service aan te
* roepen.
*
* @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.testrunner.component.services.soap;
import com.sun.org.apache.xml.internal.security.signature.XMLSignature;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
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.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.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.WebServiceException;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
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;
/**
* SoapClient voor het versturen van soap berichten.
*/
public class SoapClient {
private static final Logger LOGGER = LoggerFactory.getLogger(SoapClient.class);
private static final int SOAP_REQUEST_TIMEOUT_IN_MILLIS = 5 * 60 * 1000;
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private static PublicKey publicKey;
private Dispatch<SOAPMessage> dispatcher;
static {
try {
securityProperties = new Properties();
securityProperties.load(SoapClient.class.getResourceAsStream("/security/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("/security/client_sigpropfile.properties");
initKeyStore();
} catch (WSSecurityException | WebServiceException | CertificateException | NoSuchAlgorithmException | KeyStoreException | IOException e) {
//LOGGER.error 'Fout bij init SoapClient: {}', e.message
throw new RuntimeException("Fout bij init SoapClient", e);
}
}
/**
* Constructor.
* @param params parameters voor het ophalen van WSDL en sturen van de requests
*/
public SoapClient(final SoapParameters params) {
try {
initDispatcher(params);
} catch (MalformedURLException | ServicesNietBereikbaarException e) {
LOGGER.error("Exception creating SoapClient: {}", e.getMessage());
throw new ServicesNietBereikbaarException("Kan geen SoapClient creeren naar ${params.wsdlURL}", e);
}
}
protected InputStream getInputStream(final String bericht) throws IOException {
return new ByteArrayInputStream(bericht.getBytes("UTF-8"));
}
/**
* 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 nl.sandersmee.testtool.ontvanger wordt de body geextraheerd en als {@link org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
public 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);
request.writeTo(System.err);
// 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 javax.xml.soap.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 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 org.w3c.dom.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();
}
/*
* Initialiseert de standaard<SUF>*/
private void initDispatcher(final SoapParameters params) throws MalformedURLException {
try {
LOGGER.debug("SoapClient dispatcher initialiseren");
Service s = Service.create(params.getWsdlURL(), params.getServiceQName());
dispatcher = s.createDispatch(params.getPortQName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
Map<String, Object> map = dispatcher.getRequestContext();
map.put("com.sun.xml.internal.ws.request.timeout", SOAP_REQUEST_TIMEOUT_IN_MILLIS);
LOGGER.debug("SoapClient dispatcher initialiseren - KLAAR");
} catch (Throwable e) {
LOGGER.error("Fout bij creeren SOAPClient:", e);
throw new ServicesNietBereikbaarException("Fout bij creeren SOAPClient", e);
}
}
/**
* 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 java.security.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 =
SoapClient.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();
publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
}
/*
* Controleert de message signature met de public key van de ontvanger.
*
* @param message bericht met de signature
* @throws java.security.KeyStoreException
* @throws javax.xml.soap.SOAPException
* @throws javax.xml.crypto.MarshalException
* @throws javax.xml.crypto.dsig.XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException {
// 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));
}
protected void printResponse(final Document document) throws Exception {
//String xml = XmlUtils.toXmlString(document.getDocumentElement());
//LOGGER.info "xml:\n $xml"
}
}
|
201782_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.testrunner.component.services.soap;
import com.sun.org.apache.xml.internal.security.signature.XMLSignature;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
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.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.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.WebServiceException;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
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;
/**
* SoapClient voor het versturen van soap berichten.
*/
public class SoapClient {
private static final Logger LOGGER = LoggerFactory.getLogger(SoapClient.class);
private static final int SOAP_REQUEST_TIMEOUT_IN_MILLIS = 5 * 60 * 1000;
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private static PublicKey publicKey;
private Dispatch<SOAPMessage> dispatcher;
static {
try {
securityProperties = new Properties();
securityProperties.load(SoapClient.class.getResourceAsStream("/security/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("/security/client_sigpropfile.properties");
initKeyStore();
} catch (WSSecurityException | WebServiceException | CertificateException | NoSuchAlgorithmException | KeyStoreException | IOException e) {
//LOGGER.error 'Fout bij init SoapClient: {}', e.message
throw new RuntimeException("Fout bij init SoapClient", e);
}
}
/**
* Constructor.
* @param params parameters voor het ophalen van WSDL en sturen van de requests
*/
public SoapClient(final SoapParameters params) {
try {
initDispatcher(params);
} catch (MalformedURLException | ServicesNietBereikbaarException e) {
LOGGER.error("Exception creating SoapClient: {}", e.getMessage());
throw new ServicesNietBereikbaarException("Kan geen SoapClient creeren naar ${params.wsdlURL}", e);
}
}
protected InputStream getInputStream(final String bericht) throws IOException {
return new ByteArrayInputStream(bericht.getBytes("UTF-8"));
}
/**
* 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 nl.sandersmee.testtool.ontvanger wordt de body geextraheerd en als {@link org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
public 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);
request.writeTo(System.err);
// 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 javax.xml.soap.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 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 org.w3c.dom.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();
}
/*
* Initialiseert de standaard {@link javax.xml.ws.Dispatch} instantie die gebruikt wordt om de KERN Service aan te
* roepen.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher(final SoapParameters params) throws MalformedURLException {
try {
LOGGER.debug("SoapClient dispatcher initialiseren");
Service s = Service.create(params.getWsdlURL(), params.getServiceQName());
dispatcher = s.createDispatch(params.getPortQName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
Map<String, Object> map = dispatcher.getRequestContext();
map.put("com.sun.xml.internal.ws.request.timeout", SOAP_REQUEST_TIMEOUT_IN_MILLIS);
LOGGER.debug("SoapClient dispatcher initialiseren - KLAAR");
} catch (Throwable e) {
LOGGER.error("Fout bij creeren SOAPClient:", e);
throw new ServicesNietBereikbaarException("Fout bij creeren SOAPClient", e);
}
}
/**
* 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 java.security.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 =
SoapClient.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();
publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
}
/*
* Controleert de message signature met de public key van de ontvanger.
*
* @param message bericht met de signature
* @throws java.security.KeyStoreException
* @throws javax.xml.soap.SOAPException
* @throws javax.xml.crypto.MarshalException
* @throws javax.xml.crypto.dsig.XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException {
// 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));
}
protected void printResponse(final Document document) throws Exception {
//String xml = XmlUtils.toXmlString(document.getDocumentElement());
//LOGGER.info "xml:\n $xml"
}
}
| MinBZK/OperatieBRP | 2016/brp 2016-02-09/test/component-test/src/main/java/nl/bzk/brp/testrunner/component/services/soap/SoapClient.java | 3,534 | /**
* 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.testrunner.component.services.soap;
import com.sun.org.apache.xml.internal.security.signature.XMLSignature;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
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.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.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.WebServiceException;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
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;
/**
* SoapClient voor het versturen van soap berichten.
*/
public class SoapClient {
private static final Logger LOGGER = LoggerFactory.getLogger(SoapClient.class);
private static final int SOAP_REQUEST_TIMEOUT_IN_MILLIS = 5 * 60 * 1000;
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private static PublicKey publicKey;
private Dispatch<SOAPMessage> dispatcher;
static {
try {
securityProperties = new Properties();
securityProperties.load(SoapClient.class.getResourceAsStream("/security/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("/security/client_sigpropfile.properties");
initKeyStore();
} catch (WSSecurityException | WebServiceException | CertificateException | NoSuchAlgorithmException | KeyStoreException | IOException e) {
//LOGGER.error 'Fout bij init SoapClient: {}', e.message
throw new RuntimeException("Fout bij init SoapClient", e);
}
}
/**
* Constructor.
* @param params parameters voor het ophalen van WSDL en sturen van de requests
*/
public SoapClient(final SoapParameters params) {
try {
initDispatcher(params);
} catch (MalformedURLException | ServicesNietBereikbaarException e) {
LOGGER.error("Exception creating SoapClient: {}", e.getMessage());
throw new ServicesNietBereikbaarException("Kan geen SoapClient creeren naar ${params.wsdlURL}", e);
}
}
protected InputStream getInputStream(final String bericht) throws IOException {
return new ByteArrayInputStream(bericht.getBytes("UTF-8"));
}
/**
* 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 nl.sandersmee.testtool.ontvanger wordt de body geextraheerd en als {@link org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
public 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);
request.writeTo(System.err);
// 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 javax.xml.soap.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 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 org.w3c.dom.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();
}
/*
* Initialiseert de standaard {@link javax.xml.ws.Dispatch} instantie die gebruikt wordt om de KERN Service aan te
* roepen.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher(final SoapParameters params) throws MalformedURLException {
try {
LOGGER.debug("SoapClient dispatcher initialiseren");
Service s = Service.create(params.getWsdlURL(), params.getServiceQName());
dispatcher = s.createDispatch(params.getPortQName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
Map<String, Object> map = dispatcher.getRequestContext();
map.put("com.sun.xml.internal.ws.request.timeout", SOAP_REQUEST_TIMEOUT_IN_MILLIS);
LOGGER.debug("SoapClient dispatcher initialiseren - KLAAR");
} catch (Throwable e) {
LOGGER.error("Fout bij creeren SOAPClient:", e);
throw new ServicesNietBereikbaarException("Fout bij creeren SOAPClient", e);
}
}
/**
* 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 java.security.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 =
SoapClient.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();
publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
}
/*
* Controleert de message signature met de public key van de ontvanger.
*
* @param message bericht met de signature
* @throws java.security.KeyStoreException
* @throws javax.xml.soap.SOAPException
* @throws javax.xml.crypto.MarshalException
* @throws javax.xml.crypto.dsig.XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException {
// 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));
}
protected void printResponse(final Document document) throws Exception {
//String xml = XmlUtils.toXmlString(document.getDocumentElement());
//LOGGER.info "xml:\n $xml"
}
}
|
201782_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.testrunner.component.services.soap;
import com.sun.org.apache.xml.internal.security.signature.XMLSignature;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
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.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.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.WebServiceException;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
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;
/**
* SoapClient voor het versturen van soap berichten.
*/
public class SoapClient {
private static final Logger LOGGER = LoggerFactory.getLogger(SoapClient.class);
private static final int SOAP_REQUEST_TIMEOUT_IN_MILLIS = 5 * 60 * 1000;
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private static PublicKey publicKey;
private Dispatch<SOAPMessage> dispatcher;
static {
try {
securityProperties = new Properties();
securityProperties.load(SoapClient.class.getResourceAsStream("/security/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("/security/client_sigpropfile.properties");
initKeyStore();
} catch (WSSecurityException | WebServiceException | CertificateException | NoSuchAlgorithmException | KeyStoreException | IOException e) {
//LOGGER.error 'Fout bij init SoapClient: {}', e.message
throw new RuntimeException("Fout bij init SoapClient", e);
}
}
/**
* Constructor.
* @param params parameters voor het ophalen van WSDL en sturen van de requests
*/
public SoapClient(final SoapParameters params) {
try {
initDispatcher(params);
} catch (MalformedURLException | ServicesNietBereikbaarException e) {
LOGGER.error("Exception creating SoapClient: {}", e.getMessage());
throw new ServicesNietBereikbaarException("Kan geen SoapClient creeren naar ${params.wsdlURL}", e);
}
}
protected InputStream getInputStream(final String bericht) throws IOException {
return new ByteArrayInputStream(bericht.getBytes("UTF-8"));
}
/**
* 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 nl.sandersmee.testtool.ontvanger wordt de body geextraheerd en als {@link org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
public 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);
request.writeTo(System.err);
// 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 javax.xml.soap.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 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 org.w3c.dom.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();
}
/*
* Initialiseert de standaard {@link javax.xml.ws.Dispatch} instantie die gebruikt wordt om de KERN Service aan te
* roepen.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher(final SoapParameters params) throws MalformedURLException {
try {
LOGGER.debug("SoapClient dispatcher initialiseren");
Service s = Service.create(params.getWsdlURL(), params.getServiceQName());
dispatcher = s.createDispatch(params.getPortQName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
Map<String, Object> map = dispatcher.getRequestContext();
map.put("com.sun.xml.internal.ws.request.timeout", SOAP_REQUEST_TIMEOUT_IN_MILLIS);
LOGGER.debug("SoapClient dispatcher initialiseren - KLAAR");
} catch (Throwable e) {
LOGGER.error("Fout bij creeren SOAPClient:", e);
throw new ServicesNietBereikbaarException("Fout bij creeren SOAPClient", e);
}
}
/**
* 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 java.security.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 =
SoapClient.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();
publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
}
/*
* Controleert de message signature met de public key van de ontvanger.
*
* @param message bericht met de signature
* @throws java.security.KeyStoreException
* @throws javax.xml.soap.SOAPException
* @throws javax.xml.crypto.MarshalException
* @throws javax.xml.crypto.dsig.XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException {
// 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));
}
protected void printResponse(final Document document) throws Exception {
//String xml = XmlUtils.toXmlString(document.getDocumentElement());
//LOGGER.info "xml:\n $xml"
}
}
| MinBZK/OperatieBRP | 2016/brp 2016-02-09/test/component-test/src/main/java/nl/bzk/brp/testrunner/component/services/soap/SoapClient.java | 3,534 | // 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.testrunner.component.services.soap;
import com.sun.org.apache.xml.internal.security.signature.XMLSignature;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
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.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.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.WebServiceException;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
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;
/**
* SoapClient voor het versturen van soap berichten.
*/
public class SoapClient {
private static final Logger LOGGER = LoggerFactory.getLogger(SoapClient.class);
private static final int SOAP_REQUEST_TIMEOUT_IN_MILLIS = 5 * 60 * 1000;
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private static PublicKey publicKey;
private Dispatch<SOAPMessage> dispatcher;
static {
try {
securityProperties = new Properties();
securityProperties.load(SoapClient.class.getResourceAsStream("/security/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("/security/client_sigpropfile.properties");
initKeyStore();
} catch (WSSecurityException | WebServiceException | CertificateException | NoSuchAlgorithmException | KeyStoreException | IOException e) {
//LOGGER.error 'Fout bij init SoapClient: {}', e.message
throw new RuntimeException("Fout bij init SoapClient", e);
}
}
/**
* Constructor.
* @param params parameters voor het ophalen van WSDL en sturen van de requests
*/
public SoapClient(final SoapParameters params) {
try {
initDispatcher(params);
} catch (MalformedURLException | ServicesNietBereikbaarException e) {
LOGGER.error("Exception creating SoapClient: {}", e.getMessage());
throw new ServicesNietBereikbaarException("Kan geen SoapClient creeren naar ${params.wsdlURL}", e);
}
}
protected InputStream getInputStream(final String bericht) throws IOException {
return new ByteArrayInputStream(bericht.getBytes("UTF-8"));
}
/**
* 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 nl.sandersmee.testtool.ontvanger wordt de body geextraheerd en als {@link org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
public 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);
request.writeTo(System.err);
// 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 javax.xml.soap.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 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 org.w3c.dom.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();
}
/*
* Initialiseert de standaard {@link javax.xml.ws.Dispatch} instantie die gebruikt wordt om de KERN Service aan te
* roepen.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher(final SoapParameters params) throws MalformedURLException {
try {
LOGGER.debug("SoapClient dispatcher initialiseren");
Service s = Service.create(params.getWsdlURL(), params.getServiceQName());
dispatcher = s.createDispatch(params.getPortQName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
Map<String, Object> map = dispatcher.getRequestContext();
map.put("com.sun.xml.internal.ws.request.timeout", SOAP_REQUEST_TIMEOUT_IN_MILLIS);
LOGGER.debug("SoapClient dispatcher initialiseren - KLAAR");
} catch (Throwable e) {
LOGGER.error("Fout bij creeren SOAPClient:", e);
throw new ServicesNietBereikbaarException("Fout bij creeren SOAPClient", e);
}
}
/**
* 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 java.security.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 =
SoapClient.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();
publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
}
/*
* Controleert de message signature met de public key van de ontvanger.
*
* @param message bericht met de signature
* @throws java.security.KeyStoreException
* @throws javax.xml.soap.SOAPException
* @throws javax.xml.crypto.MarshalException
* @throws javax.xml.crypto.dsig.XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException {
// 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));
}
protected void printResponse(final Document document) throws Exception {
//String xml = XmlUtils.toXmlString(document.getDocumentElement());
//LOGGER.info "xml:\n $xml"
}
}
|
201782_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.testrunner.component.services.soap;
import com.sun.org.apache.xml.internal.security.signature.XMLSignature;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
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.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.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.WebServiceException;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
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;
/**
* SoapClient voor het versturen van soap berichten.
*/
public class SoapClient {
private static final Logger LOGGER = LoggerFactory.getLogger(SoapClient.class);
private static final int SOAP_REQUEST_TIMEOUT_IN_MILLIS = 5 * 60 * 1000;
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private static PublicKey publicKey;
private Dispatch<SOAPMessage> dispatcher;
static {
try {
securityProperties = new Properties();
securityProperties.load(SoapClient.class.getResourceAsStream("/security/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("/security/client_sigpropfile.properties");
initKeyStore();
} catch (WSSecurityException | WebServiceException | CertificateException | NoSuchAlgorithmException | KeyStoreException | IOException e) {
//LOGGER.error 'Fout bij init SoapClient: {}', e.message
throw new RuntimeException("Fout bij init SoapClient", e);
}
}
/**
* Constructor.
* @param params parameters voor het ophalen van WSDL en sturen van de requests
*/
public SoapClient(final SoapParameters params) {
try {
initDispatcher(params);
} catch (MalformedURLException | ServicesNietBereikbaarException e) {
LOGGER.error("Exception creating SoapClient: {}", e.getMessage());
throw new ServicesNietBereikbaarException("Kan geen SoapClient creeren naar ${params.wsdlURL}", e);
}
}
protected InputStream getInputStream(final String bericht) throws IOException {
return new ByteArrayInputStream(bericht.getBytes("UTF-8"));
}
/**
* 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 nl.sandersmee.testtool.ontvanger wordt de body geextraheerd en als {@link org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
public 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);
request.writeTo(System.err);
// 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 javax.xml.soap.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 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 org.w3c.dom.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();
}
/*
* Initialiseert de standaard {@link javax.xml.ws.Dispatch} instantie die gebruikt wordt om de KERN Service aan te
* roepen.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher(final SoapParameters params) throws MalformedURLException {
try {
LOGGER.debug("SoapClient dispatcher initialiseren");
Service s = Service.create(params.getWsdlURL(), params.getServiceQName());
dispatcher = s.createDispatch(params.getPortQName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
Map<String, Object> map = dispatcher.getRequestContext();
map.put("com.sun.xml.internal.ws.request.timeout", SOAP_REQUEST_TIMEOUT_IN_MILLIS);
LOGGER.debug("SoapClient dispatcher initialiseren - KLAAR");
} catch (Throwable e) {
LOGGER.error("Fout bij creeren SOAPClient:", e);
throw new ServicesNietBereikbaarException("Fout bij creeren SOAPClient", e);
}
}
/**
* 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 java.security.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 =
SoapClient.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();
publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
}
/*
* Controleert de message signature met de public key van de ontvanger.
*
* @param message bericht met de signature
* @throws java.security.KeyStoreException
* @throws javax.xml.soap.SOAPException
* @throws javax.xml.crypto.MarshalException
* @throws javax.xml.crypto.dsig.XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException {
// 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));
}
protected void printResponse(final Document document) throws Exception {
//String xml = XmlUtils.toXmlString(document.getDocumentElement());
//LOGGER.info "xml:\n $xml"
}
}
| MinBZK/OperatieBRP | 2016/brp 2016-02-09/test/component-test/src/main/java/nl/bzk/brp/testrunner/component/services/soap/SoapClient.java | 3,534 | //Assert.assertEquals("De response bevat geen Signature element", 1, publiekeSleutelNode.getLength()); | 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.testrunner.component.services.soap;
import com.sun.org.apache.xml.internal.security.signature.XMLSignature;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
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.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.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.WebServiceException;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
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;
/**
* SoapClient voor het versturen van soap berichten.
*/
public class SoapClient {
private static final Logger LOGGER = LoggerFactory.getLogger(SoapClient.class);
private static final int SOAP_REQUEST_TIMEOUT_IN_MILLIS = 5 * 60 * 1000;
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private static PublicKey publicKey;
private Dispatch<SOAPMessage> dispatcher;
static {
try {
securityProperties = new Properties();
securityProperties.load(SoapClient.class.getResourceAsStream("/security/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("/security/client_sigpropfile.properties");
initKeyStore();
} catch (WSSecurityException | WebServiceException | CertificateException | NoSuchAlgorithmException | KeyStoreException | IOException e) {
//LOGGER.error 'Fout bij init SoapClient: {}', e.message
throw new RuntimeException("Fout bij init SoapClient", e);
}
}
/**
* Constructor.
* @param params parameters voor het ophalen van WSDL en sturen van de requests
*/
public SoapClient(final SoapParameters params) {
try {
initDispatcher(params);
} catch (MalformedURLException | ServicesNietBereikbaarException e) {
LOGGER.error("Exception creating SoapClient: {}", e.getMessage());
throw new ServicesNietBereikbaarException("Kan geen SoapClient creeren naar ${params.wsdlURL}", e);
}
}
protected InputStream getInputStream(final String bericht) throws IOException {
return new ByteArrayInputStream(bericht.getBytes("UTF-8"));
}
/**
* 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 nl.sandersmee.testtool.ontvanger wordt de body geextraheerd en als {@link org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
public 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);
request.writeTo(System.err);
// 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 javax.xml.soap.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 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 org.w3c.dom.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();
}
/*
* Initialiseert de standaard {@link javax.xml.ws.Dispatch} instantie die gebruikt wordt om de KERN Service aan te
* roepen.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher(final SoapParameters params) throws MalformedURLException {
try {
LOGGER.debug("SoapClient dispatcher initialiseren");
Service s = Service.create(params.getWsdlURL(), params.getServiceQName());
dispatcher = s.createDispatch(params.getPortQName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
Map<String, Object> map = dispatcher.getRequestContext();
map.put("com.sun.xml.internal.ws.request.timeout", SOAP_REQUEST_TIMEOUT_IN_MILLIS);
LOGGER.debug("SoapClient dispatcher initialiseren - KLAAR");
} catch (Throwable e) {
LOGGER.error("Fout bij creeren SOAPClient:", e);
throw new ServicesNietBereikbaarException("Fout bij creeren SOAPClient", e);
}
}
/**
* 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 java.security.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 =
SoapClient.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();
publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
}
/*
* Controleert de message signature met de public key van de ontvanger.
*
* @param message bericht met de signature
* @throws java.security.KeyStoreException
* @throws javax.xml.soap.SOAPException
* @throws javax.xml.crypto.MarshalException
* @throws javax.xml.crypto.dsig.XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException {
// Haal de PubliekeSleutel element op
NodeList publiekeSleutelNode =
message.getSOAPHeader().getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
//Assert.assertEquals("De response<SUF>
// 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));
}
protected void printResponse(final Document document) throws Exception {
//String xml = XmlUtils.toXmlString(document.getDocumentElement());
//LOGGER.info "xml:\n $xml"
}
}
|
201782_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.testrunner.component.services.soap;
import com.sun.org.apache.xml.internal.security.signature.XMLSignature;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
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.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.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.WebServiceException;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
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;
/**
* SoapClient voor het versturen van soap berichten.
*/
public class SoapClient {
private static final Logger LOGGER = LoggerFactory.getLogger(SoapClient.class);
private static final int SOAP_REQUEST_TIMEOUT_IN_MILLIS = 5 * 60 * 1000;
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private static PublicKey publicKey;
private Dispatch<SOAPMessage> dispatcher;
static {
try {
securityProperties = new Properties();
securityProperties.load(SoapClient.class.getResourceAsStream("/security/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("/security/client_sigpropfile.properties");
initKeyStore();
} catch (WSSecurityException | WebServiceException | CertificateException | NoSuchAlgorithmException | KeyStoreException | IOException e) {
//LOGGER.error 'Fout bij init SoapClient: {}', e.message
throw new RuntimeException("Fout bij init SoapClient", e);
}
}
/**
* Constructor.
* @param params parameters voor het ophalen van WSDL en sturen van de requests
*/
public SoapClient(final SoapParameters params) {
try {
initDispatcher(params);
} catch (MalformedURLException | ServicesNietBereikbaarException e) {
LOGGER.error("Exception creating SoapClient: {}", e.getMessage());
throw new ServicesNietBereikbaarException("Kan geen SoapClient creeren naar ${params.wsdlURL}", e);
}
}
protected InputStream getInputStream(final String bericht) throws IOException {
return new ByteArrayInputStream(bericht.getBytes("UTF-8"));
}
/**
* 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 nl.sandersmee.testtool.ontvanger wordt de body geextraheerd en als {@link org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
public 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);
request.writeTo(System.err);
// 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 javax.xml.soap.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 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 org.w3c.dom.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();
}
/*
* Initialiseert de standaard {@link javax.xml.ws.Dispatch} instantie die gebruikt wordt om de KERN Service aan te
* roepen.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher(final SoapParameters params) throws MalformedURLException {
try {
LOGGER.debug("SoapClient dispatcher initialiseren");
Service s = Service.create(params.getWsdlURL(), params.getServiceQName());
dispatcher = s.createDispatch(params.getPortQName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
Map<String, Object> map = dispatcher.getRequestContext();
map.put("com.sun.xml.internal.ws.request.timeout", SOAP_REQUEST_TIMEOUT_IN_MILLIS);
LOGGER.debug("SoapClient dispatcher initialiseren - KLAAR");
} catch (Throwable e) {
LOGGER.error("Fout bij creeren SOAPClient:", e);
throw new ServicesNietBereikbaarException("Fout bij creeren SOAPClient", e);
}
}
/**
* 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 java.security.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 =
SoapClient.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();
publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
}
/*
* Controleert de message signature met de public key van de ontvanger.
*
* @param message bericht met de signature
* @throws java.security.KeyStoreException
* @throws javax.xml.soap.SOAPException
* @throws javax.xml.crypto.MarshalException
* @throws javax.xml.crypto.dsig.XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException {
// 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));
}
protected void printResponse(final Document document) throws Exception {
//String xml = XmlUtils.toXmlString(document.getDocumentElement());
//LOGGER.info "xml:\n $xml"
}
}
| MinBZK/OperatieBRP | 2016/brp 2016-02-09/test/component-test/src/main/java/nl/bzk/brp/testrunner/component/services/soap/SoapClient.java | 3,534 | // 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.testrunner.component.services.soap;
import com.sun.org.apache.xml.internal.security.signature.XMLSignature;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
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.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.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.WebServiceException;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
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;
/**
* SoapClient voor het versturen van soap berichten.
*/
public class SoapClient {
private static final Logger LOGGER = LoggerFactory.getLogger(SoapClient.class);
private static final int SOAP_REQUEST_TIMEOUT_IN_MILLIS = 5 * 60 * 1000;
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private static PublicKey publicKey;
private Dispatch<SOAPMessage> dispatcher;
static {
try {
securityProperties = new Properties();
securityProperties.load(SoapClient.class.getResourceAsStream("/security/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("/security/client_sigpropfile.properties");
initKeyStore();
} catch (WSSecurityException | WebServiceException | CertificateException | NoSuchAlgorithmException | KeyStoreException | IOException e) {
//LOGGER.error 'Fout bij init SoapClient: {}', e.message
throw new RuntimeException("Fout bij init SoapClient", e);
}
}
/**
* Constructor.
* @param params parameters voor het ophalen van WSDL en sturen van de requests
*/
public SoapClient(final SoapParameters params) {
try {
initDispatcher(params);
} catch (MalformedURLException | ServicesNietBereikbaarException e) {
LOGGER.error("Exception creating SoapClient: {}", e.getMessage());
throw new ServicesNietBereikbaarException("Kan geen SoapClient creeren naar ${params.wsdlURL}", e);
}
}
protected InputStream getInputStream(final String bericht) throws IOException {
return new ByteArrayInputStream(bericht.getBytes("UTF-8"));
}
/**
* 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 nl.sandersmee.testtool.ontvanger wordt de body geextraheerd en als {@link org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
public 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);
request.writeTo(System.err);
// 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 javax.xml.soap.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 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 org.w3c.dom.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();
}
/*
* Initialiseert de standaard {@link javax.xml.ws.Dispatch} instantie die gebruikt wordt om de KERN Service aan te
* roepen.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher(final SoapParameters params) throws MalformedURLException {
try {
LOGGER.debug("SoapClient dispatcher initialiseren");
Service s = Service.create(params.getWsdlURL(), params.getServiceQName());
dispatcher = s.createDispatch(params.getPortQName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
Map<String, Object> map = dispatcher.getRequestContext();
map.put("com.sun.xml.internal.ws.request.timeout", SOAP_REQUEST_TIMEOUT_IN_MILLIS);
LOGGER.debug("SoapClient dispatcher initialiseren - KLAAR");
} catch (Throwable e) {
LOGGER.error("Fout bij creeren SOAPClient:", e);
throw new ServicesNietBereikbaarException("Fout bij creeren SOAPClient", e);
}
}
/**
* 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 java.security.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 =
SoapClient.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();
publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
}
/*
* Controleert de message signature met de public key van de ontvanger.
*
* @param message bericht met de signature
* @throws java.security.KeyStoreException
* @throws javax.xml.soap.SOAPException
* @throws javax.xml.crypto.MarshalException
* @throws javax.xml.crypto.dsig.XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException {
// 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));
}
protected void printResponse(final Document document) throws Exception {
//String xml = XmlUtils.toXmlString(document.getDocumentElement());
//LOGGER.info "xml:\n $xml"
}
}
|
201782_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.testrunner.component.services.soap;
import com.sun.org.apache.xml.internal.security.signature.XMLSignature;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
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.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.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.WebServiceException;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
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;
/**
* SoapClient voor het versturen van soap berichten.
*/
public class SoapClient {
private static final Logger LOGGER = LoggerFactory.getLogger(SoapClient.class);
private static final int SOAP_REQUEST_TIMEOUT_IN_MILLIS = 5 * 60 * 1000;
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private static PublicKey publicKey;
private Dispatch<SOAPMessage> dispatcher;
static {
try {
securityProperties = new Properties();
securityProperties.load(SoapClient.class.getResourceAsStream("/security/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("/security/client_sigpropfile.properties");
initKeyStore();
} catch (WSSecurityException | WebServiceException | CertificateException | NoSuchAlgorithmException | KeyStoreException | IOException e) {
//LOGGER.error 'Fout bij init SoapClient: {}', e.message
throw new RuntimeException("Fout bij init SoapClient", e);
}
}
/**
* Constructor.
* @param params parameters voor het ophalen van WSDL en sturen van de requests
*/
public SoapClient(final SoapParameters params) {
try {
initDispatcher(params);
} catch (MalformedURLException | ServicesNietBereikbaarException e) {
LOGGER.error("Exception creating SoapClient: {}", e.getMessage());
throw new ServicesNietBereikbaarException("Kan geen SoapClient creeren naar ${params.wsdlURL}", e);
}
}
protected InputStream getInputStream(final String bericht) throws IOException {
return new ByteArrayInputStream(bericht.getBytes("UTF-8"));
}
/**
* 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 nl.sandersmee.testtool.ontvanger wordt de body geextraheerd en als {@link org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
public 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);
request.writeTo(System.err);
// 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 javax.xml.soap.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 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 org.w3c.dom.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();
}
/*
* Initialiseert de standaard {@link javax.xml.ws.Dispatch} instantie die gebruikt wordt om de KERN Service aan te
* roepen.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher(final SoapParameters params) throws MalformedURLException {
try {
LOGGER.debug("SoapClient dispatcher initialiseren");
Service s = Service.create(params.getWsdlURL(), params.getServiceQName());
dispatcher = s.createDispatch(params.getPortQName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
Map<String, Object> map = dispatcher.getRequestContext();
map.put("com.sun.xml.internal.ws.request.timeout", SOAP_REQUEST_TIMEOUT_IN_MILLIS);
LOGGER.debug("SoapClient dispatcher initialiseren - KLAAR");
} catch (Throwable e) {
LOGGER.error("Fout bij creeren SOAPClient:", e);
throw new ServicesNietBereikbaarException("Fout bij creeren SOAPClient", e);
}
}
/**
* 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 java.security.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 =
SoapClient.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();
publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
}
/*
* Controleert de message signature met de public key van de ontvanger.
*
* @param message bericht met de signature
* @throws java.security.KeyStoreException
* @throws javax.xml.soap.SOAPException
* @throws javax.xml.crypto.MarshalException
* @throws javax.xml.crypto.dsig.XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException {
// 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));
}
protected void printResponse(final Document document) throws Exception {
//String xml = XmlUtils.toXmlString(document.getDocumentElement());
//LOGGER.info "xml:\n $xml"
}
}
| MinBZK/OperatieBRP | 2016/brp 2016-02-09/test/component-test/src/main/java/nl/bzk/brp/testrunner/component/services/soap/SoapClient.java | 3,534 | // 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.testrunner.component.services.soap;
import com.sun.org.apache.xml.internal.security.signature.XMLSignature;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
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.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.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.WebServiceException;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
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;
/**
* SoapClient voor het versturen van soap berichten.
*/
public class SoapClient {
private static final Logger LOGGER = LoggerFactory.getLogger(SoapClient.class);
private static final int SOAP_REQUEST_TIMEOUT_IN_MILLIS = 5 * 60 * 1000;
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private static PublicKey publicKey;
private Dispatch<SOAPMessage> dispatcher;
static {
try {
securityProperties = new Properties();
securityProperties.load(SoapClient.class.getResourceAsStream("/security/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("/security/client_sigpropfile.properties");
initKeyStore();
} catch (WSSecurityException | WebServiceException | CertificateException | NoSuchAlgorithmException | KeyStoreException | IOException e) {
//LOGGER.error 'Fout bij init SoapClient: {}', e.message
throw new RuntimeException("Fout bij init SoapClient", e);
}
}
/**
* Constructor.
* @param params parameters voor het ophalen van WSDL en sturen van de requests
*/
public SoapClient(final SoapParameters params) {
try {
initDispatcher(params);
} catch (MalformedURLException | ServicesNietBereikbaarException e) {
LOGGER.error("Exception creating SoapClient: {}", e.getMessage());
throw new ServicesNietBereikbaarException("Kan geen SoapClient creeren naar ${params.wsdlURL}", e);
}
}
protected InputStream getInputStream(final String bericht) throws IOException {
return new ByteArrayInputStream(bericht.getBytes("UTF-8"));
}
/**
* 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 nl.sandersmee.testtool.ontvanger wordt de body geextraheerd en als {@link org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
public 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);
request.writeTo(System.err);
// 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 javax.xml.soap.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 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 org.w3c.dom.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();
}
/*
* Initialiseert de standaard {@link javax.xml.ws.Dispatch} instantie die gebruikt wordt om de KERN Service aan te
* roepen.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher(final SoapParameters params) throws MalformedURLException {
try {
LOGGER.debug("SoapClient dispatcher initialiseren");
Service s = Service.create(params.getWsdlURL(), params.getServiceQName());
dispatcher = s.createDispatch(params.getPortQName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
Map<String, Object> map = dispatcher.getRequestContext();
map.put("com.sun.xml.internal.ws.request.timeout", SOAP_REQUEST_TIMEOUT_IN_MILLIS);
LOGGER.debug("SoapClient dispatcher initialiseren - KLAAR");
} catch (Throwable e) {
LOGGER.error("Fout bij creeren SOAPClient:", e);
throw new ServicesNietBereikbaarException("Fout bij creeren SOAPClient", e);
}
}
/**
* 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 java.security.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 =
SoapClient.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();
publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
}
/*
* Controleert de message signature met de public key van de ontvanger.
*
* @param message bericht met de signature
* @throws java.security.KeyStoreException
* @throws javax.xml.soap.SOAPException
* @throws javax.xml.crypto.MarshalException
* @throws javax.xml.crypto.dsig.XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException {
// 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));
}
protected void printResponse(final Document document) throws Exception {
//String xml = XmlUtils.toXmlString(document.getDocumentElement());
//LOGGER.info "xml:\n $xml"
}
}
|
201782_23 | /**
* 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.testrunner.component.services.soap;
import com.sun.org.apache.xml.internal.security.signature.XMLSignature;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
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.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.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.WebServiceException;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
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;
/**
* SoapClient voor het versturen van soap berichten.
*/
public class SoapClient {
private static final Logger LOGGER = LoggerFactory.getLogger(SoapClient.class);
private static final int SOAP_REQUEST_TIMEOUT_IN_MILLIS = 5 * 60 * 1000;
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private static PublicKey publicKey;
private Dispatch<SOAPMessage> dispatcher;
static {
try {
securityProperties = new Properties();
securityProperties.load(SoapClient.class.getResourceAsStream("/security/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("/security/client_sigpropfile.properties");
initKeyStore();
} catch (WSSecurityException | WebServiceException | CertificateException | NoSuchAlgorithmException | KeyStoreException | IOException e) {
//LOGGER.error 'Fout bij init SoapClient: {}', e.message
throw new RuntimeException("Fout bij init SoapClient", e);
}
}
/**
* Constructor.
* @param params parameters voor het ophalen van WSDL en sturen van de requests
*/
public SoapClient(final SoapParameters params) {
try {
initDispatcher(params);
} catch (MalformedURLException | ServicesNietBereikbaarException e) {
LOGGER.error("Exception creating SoapClient: {}", e.getMessage());
throw new ServicesNietBereikbaarException("Kan geen SoapClient creeren naar ${params.wsdlURL}", e);
}
}
protected InputStream getInputStream(final String bericht) throws IOException {
return new ByteArrayInputStream(bericht.getBytes("UTF-8"));
}
/**
* 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 nl.sandersmee.testtool.ontvanger wordt de body geextraheerd en als {@link org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
public 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);
request.writeTo(System.err);
// 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 javax.xml.soap.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 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 org.w3c.dom.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();
}
/*
* Initialiseert de standaard {@link javax.xml.ws.Dispatch} instantie die gebruikt wordt om de KERN Service aan te
* roepen.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher(final SoapParameters params) throws MalformedURLException {
try {
LOGGER.debug("SoapClient dispatcher initialiseren");
Service s = Service.create(params.getWsdlURL(), params.getServiceQName());
dispatcher = s.createDispatch(params.getPortQName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
Map<String, Object> map = dispatcher.getRequestContext();
map.put("com.sun.xml.internal.ws.request.timeout", SOAP_REQUEST_TIMEOUT_IN_MILLIS);
LOGGER.debug("SoapClient dispatcher initialiseren - KLAAR");
} catch (Throwable e) {
LOGGER.error("Fout bij creeren SOAPClient:", e);
throw new ServicesNietBereikbaarException("Fout bij creeren SOAPClient", e);
}
}
/**
* 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 java.security.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 =
SoapClient.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();
publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
}
/*
* Controleert de message signature met de public key van de ontvanger.
*
* @param message bericht met de signature
* @throws java.security.KeyStoreException
* @throws javax.xml.soap.SOAPException
* @throws javax.xml.crypto.MarshalException
* @throws javax.xml.crypto.dsig.XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException {
// 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));
}
protected void printResponse(final Document document) throws Exception {
//String xml = XmlUtils.toXmlString(document.getDocumentElement());
//LOGGER.info "xml:\n $xml"
}
}
| MinBZK/OperatieBRP | 2016/brp 2016-02-09/test/component-test/src/main/java/nl/bzk/brp/testrunner/component/services/soap/SoapClient.java | 3,534 | // 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.testrunner.component.services.soap;
import com.sun.org.apache.xml.internal.security.signature.XMLSignature;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
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.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.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.WebServiceException;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
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;
/**
* SoapClient voor het versturen van soap berichten.
*/
public class SoapClient {
private static final Logger LOGGER = LoggerFactory.getLogger(SoapClient.class);
private static final int SOAP_REQUEST_TIMEOUT_IN_MILLIS = 5 * 60 * 1000;
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private static PublicKey publicKey;
private Dispatch<SOAPMessage> dispatcher;
static {
try {
securityProperties = new Properties();
securityProperties.load(SoapClient.class.getResourceAsStream("/security/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("/security/client_sigpropfile.properties");
initKeyStore();
} catch (WSSecurityException | WebServiceException | CertificateException | NoSuchAlgorithmException | KeyStoreException | IOException e) {
//LOGGER.error 'Fout bij init SoapClient: {}', e.message
throw new RuntimeException("Fout bij init SoapClient", e);
}
}
/**
* Constructor.
* @param params parameters voor het ophalen van WSDL en sturen van de requests
*/
public SoapClient(final SoapParameters params) {
try {
initDispatcher(params);
} catch (MalformedURLException | ServicesNietBereikbaarException e) {
LOGGER.error("Exception creating SoapClient: {}", e.getMessage());
throw new ServicesNietBereikbaarException("Kan geen SoapClient creeren naar ${params.wsdlURL}", e);
}
}
protected InputStream getInputStream(final String bericht) throws IOException {
return new ByteArrayInputStream(bericht.getBytes("UTF-8"));
}
/**
* 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 nl.sandersmee.testtool.ontvanger wordt de body geextraheerd en als {@link org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
public 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);
request.writeTo(System.err);
// 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 javax.xml.soap.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 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 org.w3c.dom.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();
}
/*
* Initialiseert de standaard {@link javax.xml.ws.Dispatch} instantie die gebruikt wordt om de KERN Service aan te
* roepen.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher(final SoapParameters params) throws MalformedURLException {
try {
LOGGER.debug("SoapClient dispatcher initialiseren");
Service s = Service.create(params.getWsdlURL(), params.getServiceQName());
dispatcher = s.createDispatch(params.getPortQName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
Map<String, Object> map = dispatcher.getRequestContext();
map.put("com.sun.xml.internal.ws.request.timeout", SOAP_REQUEST_TIMEOUT_IN_MILLIS);
LOGGER.debug("SoapClient dispatcher initialiseren - KLAAR");
} catch (Throwable e) {
LOGGER.error("Fout bij creeren SOAPClient:", e);
throw new ServicesNietBereikbaarException("Fout bij creeren SOAPClient", e);
}
}
/**
* 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 java.security.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 =
SoapClient.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();
publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
}
/*
* Controleert de message signature met de public key van de ontvanger.
*
* @param message bericht met de signature
* @throws java.security.KeyStoreException
* @throws javax.xml.soap.SOAPException
* @throws javax.xml.crypto.MarshalException
* @throws javax.xml.crypto.dsig.XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException {
// 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));
}
protected void printResponse(final Document document) throws Exception {
//String xml = XmlUtils.toXmlString(document.getDocumentElement());
//LOGGER.info "xml:\n $xml"
}
}
|
201782_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.testrunner.component.services.soap;
import com.sun.org.apache.xml.internal.security.signature.XMLSignature;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
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.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.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.WebServiceException;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
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;
/**
* SoapClient voor het versturen van soap berichten.
*/
public class SoapClient {
private static final Logger LOGGER = LoggerFactory.getLogger(SoapClient.class);
private static final int SOAP_REQUEST_TIMEOUT_IN_MILLIS = 5 * 60 * 1000;
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private static PublicKey publicKey;
private Dispatch<SOAPMessage> dispatcher;
static {
try {
securityProperties = new Properties();
securityProperties.load(SoapClient.class.getResourceAsStream("/security/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("/security/client_sigpropfile.properties");
initKeyStore();
} catch (WSSecurityException | WebServiceException | CertificateException | NoSuchAlgorithmException | KeyStoreException | IOException e) {
//LOGGER.error 'Fout bij init SoapClient: {}', e.message
throw new RuntimeException("Fout bij init SoapClient", e);
}
}
/**
* Constructor.
* @param params parameters voor het ophalen van WSDL en sturen van de requests
*/
public SoapClient(final SoapParameters params) {
try {
initDispatcher(params);
} catch (MalformedURLException | ServicesNietBereikbaarException e) {
LOGGER.error("Exception creating SoapClient: {}", e.getMessage());
throw new ServicesNietBereikbaarException("Kan geen SoapClient creeren naar ${params.wsdlURL}", e);
}
}
protected InputStream getInputStream(final String bericht) throws IOException {
return new ByteArrayInputStream(bericht.getBytes("UTF-8"));
}
/**
* 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 nl.sandersmee.testtool.ontvanger wordt de body geextraheerd en als {@link org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
public 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);
request.writeTo(System.err);
// 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 javax.xml.soap.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 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 org.w3c.dom.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();
}
/*
* Initialiseert de standaard {@link javax.xml.ws.Dispatch} instantie die gebruikt wordt om de KERN Service aan te
* roepen.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher(final SoapParameters params) throws MalformedURLException {
try {
LOGGER.debug("SoapClient dispatcher initialiseren");
Service s = Service.create(params.getWsdlURL(), params.getServiceQName());
dispatcher = s.createDispatch(params.getPortQName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
Map<String, Object> map = dispatcher.getRequestContext();
map.put("com.sun.xml.internal.ws.request.timeout", SOAP_REQUEST_TIMEOUT_IN_MILLIS);
LOGGER.debug("SoapClient dispatcher initialiseren - KLAAR");
} catch (Throwable e) {
LOGGER.error("Fout bij creeren SOAPClient:", e);
throw new ServicesNietBereikbaarException("Fout bij creeren SOAPClient", e);
}
}
/**
* 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 java.security.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 =
SoapClient.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();
publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
}
/*
* Controleert de message signature met de public key van de ontvanger.
*
* @param message bericht met de signature
* @throws java.security.KeyStoreException
* @throws javax.xml.soap.SOAPException
* @throws javax.xml.crypto.MarshalException
* @throws javax.xml.crypto.dsig.XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException {
// 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));
}
protected void printResponse(final Document document) throws Exception {
//String xml = XmlUtils.toXmlString(document.getDocumentElement());
//LOGGER.info "xml:\n $xml"
}
}
| MinBZK/OperatieBRP | 2016/brp 2016-02-09/test/component-test/src/main/java/nl/bzk/brp/testrunner/component/services/soap/SoapClient.java | 3,534 | // 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.testrunner.component.services.soap;
import com.sun.org.apache.xml.internal.security.signature.XMLSignature;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
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.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.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.WebServiceException;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
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;
/**
* SoapClient voor het versturen van soap berichten.
*/
public class SoapClient {
private static final Logger LOGGER = LoggerFactory.getLogger(SoapClient.class);
private static final int SOAP_REQUEST_TIMEOUT_IN_MILLIS = 5 * 60 * 1000;
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private static PublicKey publicKey;
private Dispatch<SOAPMessage> dispatcher;
static {
try {
securityProperties = new Properties();
securityProperties.load(SoapClient.class.getResourceAsStream("/security/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("/security/client_sigpropfile.properties");
initKeyStore();
} catch (WSSecurityException | WebServiceException | CertificateException | NoSuchAlgorithmException | KeyStoreException | IOException e) {
//LOGGER.error 'Fout bij init SoapClient: {}', e.message
throw new RuntimeException("Fout bij init SoapClient", e);
}
}
/**
* Constructor.
* @param params parameters voor het ophalen van WSDL en sturen van de requests
*/
public SoapClient(final SoapParameters params) {
try {
initDispatcher(params);
} catch (MalformedURLException | ServicesNietBereikbaarException e) {
LOGGER.error("Exception creating SoapClient: {}", e.getMessage());
throw new ServicesNietBereikbaarException("Kan geen SoapClient creeren naar ${params.wsdlURL}", e);
}
}
protected InputStream getInputStream(final String bericht) throws IOException {
return new ByteArrayInputStream(bericht.getBytes("UTF-8"));
}
/**
* 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 nl.sandersmee.testtool.ontvanger wordt de body geextraheerd en als {@link org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
public 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);
request.writeTo(System.err);
// 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 javax.xml.soap.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 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 org.w3c.dom.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();
}
/*
* Initialiseert de standaard {@link javax.xml.ws.Dispatch} instantie die gebruikt wordt om de KERN Service aan te
* roepen.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher(final SoapParameters params) throws MalformedURLException {
try {
LOGGER.debug("SoapClient dispatcher initialiseren");
Service s = Service.create(params.getWsdlURL(), params.getServiceQName());
dispatcher = s.createDispatch(params.getPortQName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
Map<String, Object> map = dispatcher.getRequestContext();
map.put("com.sun.xml.internal.ws.request.timeout", SOAP_REQUEST_TIMEOUT_IN_MILLIS);
LOGGER.debug("SoapClient dispatcher initialiseren - KLAAR");
} catch (Throwable e) {
LOGGER.error("Fout bij creeren SOAPClient:", e);
throw new ServicesNietBereikbaarException("Fout bij creeren SOAPClient", e);
}
}
/**
* 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 java.security.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 =
SoapClient.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();
publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
}
/*
* Controleert de message signature met de public key van de ontvanger.
*
* @param message bericht met de signature
* @throws java.security.KeyStoreException
* @throws javax.xml.soap.SOAPException
* @throws javax.xml.crypto.MarshalException
* @throws javax.xml.crypto.dsig.XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException {
// 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));
}
protected void printResponse(final Document document) throws Exception {
//String xml = XmlUtils.toXmlString(document.getDocumentElement());
//LOGGER.info "xml:\n $xml"
}
}
|
201782_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.testrunner.component.services.soap;
import com.sun.org.apache.xml.internal.security.signature.XMLSignature;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
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.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.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.WebServiceException;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
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;
/**
* SoapClient voor het versturen van soap berichten.
*/
public class SoapClient {
private static final Logger LOGGER = LoggerFactory.getLogger(SoapClient.class);
private static final int SOAP_REQUEST_TIMEOUT_IN_MILLIS = 5 * 60 * 1000;
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private static PublicKey publicKey;
private Dispatch<SOAPMessage> dispatcher;
static {
try {
securityProperties = new Properties();
securityProperties.load(SoapClient.class.getResourceAsStream("/security/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("/security/client_sigpropfile.properties");
initKeyStore();
} catch (WSSecurityException | WebServiceException | CertificateException | NoSuchAlgorithmException | KeyStoreException | IOException e) {
//LOGGER.error 'Fout bij init SoapClient: {}', e.message
throw new RuntimeException("Fout bij init SoapClient", e);
}
}
/**
* Constructor.
* @param params parameters voor het ophalen van WSDL en sturen van de requests
*/
public SoapClient(final SoapParameters params) {
try {
initDispatcher(params);
} catch (MalformedURLException | ServicesNietBereikbaarException e) {
LOGGER.error("Exception creating SoapClient: {}", e.getMessage());
throw new ServicesNietBereikbaarException("Kan geen SoapClient creeren naar ${params.wsdlURL}", e);
}
}
protected InputStream getInputStream(final String bericht) throws IOException {
return new ByteArrayInputStream(bericht.getBytes("UTF-8"));
}
/**
* 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 nl.sandersmee.testtool.ontvanger wordt de body geextraheerd en als {@link org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
public 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);
request.writeTo(System.err);
// 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 javax.xml.soap.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 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 org.w3c.dom.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();
}
/*
* Initialiseert de standaard {@link javax.xml.ws.Dispatch} instantie die gebruikt wordt om de KERN Service aan te
* roepen.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher(final SoapParameters params) throws MalformedURLException {
try {
LOGGER.debug("SoapClient dispatcher initialiseren");
Service s = Service.create(params.getWsdlURL(), params.getServiceQName());
dispatcher = s.createDispatch(params.getPortQName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
Map<String, Object> map = dispatcher.getRequestContext();
map.put("com.sun.xml.internal.ws.request.timeout", SOAP_REQUEST_TIMEOUT_IN_MILLIS);
LOGGER.debug("SoapClient dispatcher initialiseren - KLAAR");
} catch (Throwable e) {
LOGGER.error("Fout bij creeren SOAPClient:", e);
throw new ServicesNietBereikbaarException("Fout bij creeren SOAPClient", e);
}
}
/**
* 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 java.security.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 =
SoapClient.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();
publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
}
/*
* Controleert de message signature met de public key van de ontvanger.
*
* @param message bericht met de signature
* @throws java.security.KeyStoreException
* @throws javax.xml.soap.SOAPException
* @throws javax.xml.crypto.MarshalException
* @throws javax.xml.crypto.dsig.XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException {
// 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));
}
protected void printResponse(final Document document) throws Exception {
//String xml = XmlUtils.toXmlString(document.getDocumentElement());
//LOGGER.info "xml:\n $xml"
}
}
| MinBZK/OperatieBRP | 2016/brp 2016-02-09/test/component-test/src/main/java/nl/bzk/brp/testrunner/component/services/soap/SoapClient.java | 3,534 | //Assert.assertTrue("De signature van de response is niet geldig.", signature.validate(validatieContext)); | 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.testrunner.component.services.soap;
import com.sun.org.apache.xml.internal.security.signature.XMLSignature;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
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.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.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.WebServiceException;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
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;
/**
* SoapClient voor het versturen van soap berichten.
*/
public class SoapClient {
private static final Logger LOGGER = LoggerFactory.getLogger(SoapClient.class);
private static final int SOAP_REQUEST_TIMEOUT_IN_MILLIS = 5 * 60 * 1000;
private static final String SERVER_PUBLICKEY_ALIAS = "server";
private static Properties securityProperties;
private static Crypto crypto;
private static KeyStore keyStore;
private static PublicKey publicKey;
private Dispatch<SOAPMessage> dispatcher;
static {
try {
securityProperties = new Properties();
securityProperties.load(SoapClient.class.getResourceAsStream("/security/client_sigpropfile.properties"));
WSSConfig.init();
crypto = CryptoFactory.getInstance("/security/client_sigpropfile.properties");
initKeyStore();
} catch (WSSecurityException | WebServiceException | CertificateException | NoSuchAlgorithmException | KeyStoreException | IOException e) {
//LOGGER.error 'Fout bij init SoapClient: {}', e.message
throw new RuntimeException("Fout bij init SoapClient", e);
}
}
/**
* Constructor.
* @param params parameters voor het ophalen van WSDL en sturen van de requests
*/
public SoapClient(final SoapParameters params) {
try {
initDispatcher(params);
} catch (MalformedURLException | ServicesNietBereikbaarException e) {
LOGGER.error("Exception creating SoapClient: {}", e.getMessage());
throw new ServicesNietBereikbaarException("Kan geen SoapClient creeren naar ${params.wsdlURL}", e);
}
}
protected InputStream getInputStream(final String bericht) throws IOException {
return new ByteArrayInputStream(bericht.getBytes("UTF-8"));
}
/**
* 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 nl.sandersmee.testtool.ontvanger wordt de body geextraheerd en als {@link org.w3c.dom.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 javax.xml.crypto.dsig.XMLSignatureException
* @throws javax.xml.crypto.MarshalException
*/
public 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);
request.writeTo(System.err);
// 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 javax.xml.soap.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 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 org.w3c.dom.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();
}
/*
* Initialiseert de standaard {@link javax.xml.ws.Dispatch} instantie die gebruikt wordt om de KERN Service aan te
* roepen.
*
* @throws java.net.MalformedURLException indien de URL van de WSDL niet correct is.
*/
private void initDispatcher(final SoapParameters params) throws MalformedURLException {
try {
LOGGER.debug("SoapClient dispatcher initialiseren");
Service s = Service.create(params.getWsdlURL(), params.getServiceQName());
dispatcher = s.createDispatch(params.getPortQName(), SOAPMessage.class, Service.Mode.MESSAGE, new AddressingFeature());
Map<String, Object> map = dispatcher.getRequestContext();
map.put("com.sun.xml.internal.ws.request.timeout", SOAP_REQUEST_TIMEOUT_IN_MILLIS);
LOGGER.debug("SoapClient dispatcher initialiseren - KLAAR");
} catch (Throwable e) {
LOGGER.error("Fout bij creeren SOAPClient:", e);
throw new ServicesNietBereikbaarException("Fout bij creeren SOAPClient", e);
}
}
/**
* 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 java.security.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 =
SoapClient.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();
publicKey = keyStore.getCertificate(SERVER_PUBLICKEY_ALIAS).getPublicKey();
}
/*
* Controleert de message signature met de public key van de ontvanger.
*
* @param message bericht met de signature
* @throws java.security.KeyStoreException
* @throws javax.xml.soap.SOAPException
* @throws javax.xml.crypto.MarshalException
* @throws javax.xml.crypto.dsig.XMLSignatureException
*/
private void valideerSignature(final SOAPMessage message) throws KeyStoreException, SOAPException,
MarshalException, XMLSignatureException {
// 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<SUF>
}
protected void printResponse(final Document document) throws Exception {
//String xml = XmlUtils.toXmlString(document.getDocumentElement());
//LOGGER.info "xml:\n $xml"
}
}
|
201795_0 | package cz.metacentrum.perun.core.api;
import cz.metacentrum.perun.core.api.exceptions.InternalErrorException;
import java.util.UUID;
/**
* Vo entity.
*/
public class Vo extends Auditable implements Comparable<PerunBean>, HasUuid {
private String name;
private String shortName;
private UUID uuid;
public Vo() {
}
public Vo(int id, String name, String shortName) {
super(id);
if (name == null) {
throw new InternalErrorException(new NullPointerException("name is null"));
}
if (shortName == null) {
throw new InternalErrorException(new NullPointerException("shortName is null"));
}
this.name = name;
this.shortName = shortName;
}
@Deprecated
public Vo(int id, String name, String shortName, String createdAt, String createdBy, String modifiedAt,
String modifiedBy) {
super(id, createdAt, createdBy, modifiedAt, modifiedBy, null, null);
if (name == null) {
throw new InternalErrorException(new NullPointerException("name is null"));
}
if (shortName == null) {
throw new InternalErrorException(new NullPointerException("shortName is null"));
}
this.name = name;
this.shortName = shortName;
}
public Vo(int id, String name, String shortName, String createdAt, String createdBy, String modifiedAt,
String modifiedBy, Integer createdByUid, Integer modifiedByUid) {
super(id, createdAt, createdBy, modifiedAt, modifiedBy, createdByUid, modifiedByUid);
if (name == null) {
throw new InternalErrorException(new NullPointerException("name is null"));
}
if (shortName == null) {
throw new InternalErrorException(new NullPointerException("shortName is null"));
}
this.name = name;
this.shortName = shortName;
}
public Vo(int id, UUID uuid, String name, String shortName, String createdAt, String createdBy, String modifiedAt,
String modifiedBy, Integer createdByUid, Integer modifiedByUid) {
super(id, createdAt, createdBy, modifiedAt, modifiedBy, createdByUid, modifiedByUid);
if (name == null) {
throw new InternalErrorException(new NullPointerException("name is null"));
}
if (shortName == null) {
throw new InternalErrorException(new NullPointerException("shortName is null"));
}
this.name = name;
this.shortName = shortName;
this.uuid = uuid;
}
@Override
public int compareTo(PerunBean perunBean) {
if (perunBean == null) {
throw new NullPointerException("PerunBean to compare with is null.");
}
if (perunBean instanceof Vo) {
Vo vo = (Vo) perunBean;
if (this.getName() == null && vo.getName() != null) {
return -1;
}
if (vo.getName() == null && this.getName() != null) {
return 1;
}
if (this.getName() == null && vo.getName() == null) {
return 0;
}
return this.getName().compareToIgnoreCase(vo.getName());
} else {
return (this.getId() - perunBean.getId());
}
}
@Override
public boolean equals(Object obj) {
if (obj == null) {
return false;
}
if (getClass() != obj.getClass()) {
return false;
}
final Vo other = (Vo) obj;
if (this.getId() != other.getId()) {
return false;
}
if ((this.name == null) ? (other.name != null) : !this.name.equals(other.name)) {
return false;
}
if ((this.shortName == null) ? (other.shortName != null) : !this.shortName.equals(other.shortName)) {
return false;
}
return true;
}
public String getName() {
return name;
}
public void setName(String name) {
if (name == null) {
throw new InternalErrorException(new NullPointerException("name is null"));
}
this.name = name;
}
public String getShortName() {
return shortName;
}
public void setShortName(String shortName) {
if (shortName == null) {
throw new InternalErrorException(new NullPointerException("shortName is null"));
}
this.shortName = shortName;
}
@Override
public UUID getUuid() {
return uuid;
}
public void setUuid(UUID uuid) {
this.uuid = uuid;
}
@Override
public int hashCode() {
int hash = 7;
hash = 53 * hash + this.getId();
hash = 53 * hash + (this.name != null ? this.name.hashCode() : 0);
hash = 53 * hash + (this.shortName != null ? this.shortName.hashCode() : 0);
return hash;
}
@Override
public String serializeToString() {
StringBuilder str = new StringBuilder();
return str.append(this.getClass().getSimpleName()).append(":[").append("id=<").append(getId()).append(">")
.append(", uuid=<").append(getUuid()).append(">").append(", name=<")
.append(getName() == null ? "\\0" : BeansUtils.createEscaping(getName())).append(">").append(", shortName=<")
.append(getShortName() == null ? "\\0" : BeansUtils.createEscaping(getShortName())).append(">").append(']')
.toString();
}
@Override
public String toString() {
StringBuilder str = new StringBuilder();
return str.append(this.getClass().getSimpleName()).append(":[").append("id='").append(this.getId()).append('\'')
.append(", uuid='").append(uuid).append('\'').append(", name='").append(name).append('\'')
.append(", shortName='").append(shortName).append('\'').append(']').toString();
}
}
| CESNET/perun | perun-base/src/main/java/cz/metacentrum/perun/core/api/Vo.java | 1,488 | /**
* Vo entity.
*/ | block_comment | nl | package cz.metacentrum.perun.core.api;
import cz.metacentrum.perun.core.api.exceptions.InternalErrorException;
import java.util.UUID;
/**
* Vo entity.
<SUF>*/
public class Vo extends Auditable implements Comparable<PerunBean>, HasUuid {
private String name;
private String shortName;
private UUID uuid;
public Vo() {
}
public Vo(int id, String name, String shortName) {
super(id);
if (name == null) {
throw new InternalErrorException(new NullPointerException("name is null"));
}
if (shortName == null) {
throw new InternalErrorException(new NullPointerException("shortName is null"));
}
this.name = name;
this.shortName = shortName;
}
@Deprecated
public Vo(int id, String name, String shortName, String createdAt, String createdBy, String modifiedAt,
String modifiedBy) {
super(id, createdAt, createdBy, modifiedAt, modifiedBy, null, null);
if (name == null) {
throw new InternalErrorException(new NullPointerException("name is null"));
}
if (shortName == null) {
throw new InternalErrorException(new NullPointerException("shortName is null"));
}
this.name = name;
this.shortName = shortName;
}
public Vo(int id, String name, String shortName, String createdAt, String createdBy, String modifiedAt,
String modifiedBy, Integer createdByUid, Integer modifiedByUid) {
super(id, createdAt, createdBy, modifiedAt, modifiedBy, createdByUid, modifiedByUid);
if (name == null) {
throw new InternalErrorException(new NullPointerException("name is null"));
}
if (shortName == null) {
throw new InternalErrorException(new NullPointerException("shortName is null"));
}
this.name = name;
this.shortName = shortName;
}
public Vo(int id, UUID uuid, String name, String shortName, String createdAt, String createdBy, String modifiedAt,
String modifiedBy, Integer createdByUid, Integer modifiedByUid) {
super(id, createdAt, createdBy, modifiedAt, modifiedBy, createdByUid, modifiedByUid);
if (name == null) {
throw new InternalErrorException(new NullPointerException("name is null"));
}
if (shortName == null) {
throw new InternalErrorException(new NullPointerException("shortName is null"));
}
this.name = name;
this.shortName = shortName;
this.uuid = uuid;
}
@Override
public int compareTo(PerunBean perunBean) {
if (perunBean == null) {
throw new NullPointerException("PerunBean to compare with is null.");
}
if (perunBean instanceof Vo) {
Vo vo = (Vo) perunBean;
if (this.getName() == null && vo.getName() != null) {
return -1;
}
if (vo.getName() == null && this.getName() != null) {
return 1;
}
if (this.getName() == null && vo.getName() == null) {
return 0;
}
return this.getName().compareToIgnoreCase(vo.getName());
} else {
return (this.getId() - perunBean.getId());
}
}
@Override
public boolean equals(Object obj) {
if (obj == null) {
return false;
}
if (getClass() != obj.getClass()) {
return false;
}
final Vo other = (Vo) obj;
if (this.getId() != other.getId()) {
return false;
}
if ((this.name == null) ? (other.name != null) : !this.name.equals(other.name)) {
return false;
}
if ((this.shortName == null) ? (other.shortName != null) : !this.shortName.equals(other.shortName)) {
return false;
}
return true;
}
public String getName() {
return name;
}
public void setName(String name) {
if (name == null) {
throw new InternalErrorException(new NullPointerException("name is null"));
}
this.name = name;
}
public String getShortName() {
return shortName;
}
public void setShortName(String shortName) {
if (shortName == null) {
throw new InternalErrorException(new NullPointerException("shortName is null"));
}
this.shortName = shortName;
}
@Override
public UUID getUuid() {
return uuid;
}
public void setUuid(UUID uuid) {
this.uuid = uuid;
}
@Override
public int hashCode() {
int hash = 7;
hash = 53 * hash + this.getId();
hash = 53 * hash + (this.name != null ? this.name.hashCode() : 0);
hash = 53 * hash + (this.shortName != null ? this.shortName.hashCode() : 0);
return hash;
}
@Override
public String serializeToString() {
StringBuilder str = new StringBuilder();
return str.append(this.getClass().getSimpleName()).append(":[").append("id=<").append(getId()).append(">")
.append(", uuid=<").append(getUuid()).append(">").append(", name=<")
.append(getName() == null ? "\\0" : BeansUtils.createEscaping(getName())).append(">").append(", shortName=<")
.append(getShortName() == null ? "\\0" : BeansUtils.createEscaping(getShortName())).append(">").append(']')
.toString();
}
@Override
public String toString() {
StringBuilder str = new StringBuilder();
return str.append(this.getClass().getSimpleName()).append(":[").append("id='").append(this.getId()).append('\'')
.append(", uuid='").append(uuid).append('\'').append(", name='").append(name).append('\'')
.append(", shortName='").append(shortName).append('\'').append(']').toString();
}
}
|
201850_35 | /**
* Copyright (c) Michael Steindorfer <Centrum Wiskunde & Informatica> and Contributors.
* All rights reserved.
*
* This file is licensed under the BSD 2-Clause License, which accompanies this project
* and is available under https://opensource.org/licenses/BSD-2-Clause.
*/
package io.usethesource.capsule.core.trie;
import java.util.ListIterator;
import java.util.concurrent.atomic.AtomicReference;
import java.util.function.BiFunction;
/**
* Mapper that traverses a trie and converts each node (of {@code SN}) to a node of type {@code DN}.
*/
public class BottomUpTransientNodeTransformer<SN extends Node, DN extends Node> {
private static final int MAX_DEPTH = 7;
private final BiFunction<SN, AtomicReference<Thread>, DN> nodeMapper;
private final AtomicReference<Thread> mutator;
private final DN dstRootNode;
private int stackIndex = -1;
private final ListIterator<SN>[] srcIteratorStack = new ListIterator[MAX_DEPTH];
private final ListIterator<DN>[] dstIteratorStack = new ListIterator[MAX_DEPTH];
public BottomUpTransientNodeTransformer(final SN srcRootNode,
final BiFunction<SN, AtomicReference<Thread>, DN> nodeMapper) {
this.nodeMapper = nodeMapper;
this.mutator = new AtomicReference<>(Thread.currentThread());
this.dstRootNode = nodeMapper.apply(srcRootNode, mutator);
final ListIterator<SN> srcIterator = (ListIterator<SN>) srcRootNode.nodeArray().iterator();
if (srcIterator.hasNext()) {
final ListIterator<DN> dstIterator = (ListIterator<DN>) dstRootNode.nodeArray().iterator();
pushOnStack(srcIterator, dstIterator);
}
}
public final DN apply() {
if (!isStackEmpty()) {
processStack();
}
mutator.set(null);
return dstRootNode;
}
private final boolean isStackEmpty() {
return stackIndex == -1;
}
private final void pushOnStack(ListIterator<SN> srcNode, ListIterator<DN> dstNode) {
// push on stack
final int nextIndex = ++stackIndex;
srcIteratorStack[nextIndex] = srcNode;
dstIteratorStack[nextIndex] = dstNode;
}
private final void dropFromStack() {
// pop from stack
final int previousIndex = stackIndex--;
srcIteratorStack[previousIndex] = null;
dstIteratorStack[previousIndex] = null;
}
/*
* Traverse trie and convert nodes at first encounter. Sub-trie references are updated
* incrementally throughout iteration.
*/
private final void processStack() {
while (!isStackEmpty()) {
final ListIterator<SN> srcIterator = srcIteratorStack[stackIndex];
final ListIterator<DN> dstIterator = dstIteratorStack[stackIndex];
boolean stackModified = false;
while (!stackModified) {
if (srcIterator.hasNext()) {
final SN src = srcIterator.next();
final DN dst = nodeMapper.apply(src, mutator);
dstIterator.next();
dstIterator.set(dst);
final ListIterator<SN> nextSrcIterator = (ListIterator<SN>) src.nodeArray().iterator();
if (nextSrcIterator.hasNext()) {
final ListIterator<DN> nextDstIterator = (ListIterator<DN>) dst.nodeArray().iterator();
pushOnStack(nextSrcIterator, nextDstIterator);
stackModified = true;
}
} else {
dropFromStack();
stackModified = true;
}
}
}
}
// /*
// * search for next node that can be mapped
// */
// private final Optional<SN> applyNodeTranformation(boolean yieldIntermediate) {
// SN result = null;
//
// while (stackLevel >= 0 && result == null) {
// final ListIterator<MN> srcSubNodeIterator = srcIteratorStack[stackLevel];
// final ListIterator<SN> dstSubNodeIterator = dstIteratorStack[stackLevel];
//
// if (srcSubNodeIterator.hasNext()) {
// final MN nextMapNode = srcSubNodeIterator.next();
// final SN nextSetNode = nodeMapper.apply(nextMapNode, mutator);
//
// dstSubNodeIterator.next();
// dstSubNodeIterator.set(nextSetNode);
//
// final ListIterator<MN> subNodeIterator =
// (ListIterator<MN>) nextMapNode.nodeArray().iterator();
//
// if (subNodeIterator.hasNext()) {
// // next node == (to process) intermediate node
// // put node on next stack level for depth-first traversal
//// final SN nextSetNode = nodeMapper.apply(nextMapNode, mutator);
//
// final int nextStackLevel = ++stackLevel;
// srcIteratorStack[nextStackLevel] = subNodeIterator;
// dstIteratorStack[nextStackLevel] =
// (ListIterator<SN>) nextSetNode.nodeArray().iterator();
// } else if (yieldIntermediate) {
// // nextNode == (finished) leaf node
// result = nextSetNode;
// }
// } else {
// if (yieldIntermediate) {
// // nextNode == (finished) intermidate node
// // result = setNodes[stackLevel]; // ???
// throw new IllegalStateException("TODO: figure out how to return previous element.");
// } else if (stackLevel == 0) {
// result = setRootNode;
// }
//
// // pop from stack
// srcIteratorStack[stackLevel] = null;
// dstIteratorStack[stackLevel] = null;
// stackLevel--;
// }
// }
//
// return Optional.ofNullable(result);
// }
// @Override
// public boolean hasNext() {
// if (next.get().isPresent()) {
// return true;
// } else {
// final Optional<SN> result = applyNodeTranformation(true);
// next.set(result);
// return result.isPresent();
// }
// }
//
// /**
// * Returns transformed --either internal or leaf-- node.
// *
// * @return mapped node
// */
// @Override
// public SN next() {
// if (!hasNext()) {
// throw new NoSuchElementException();
// } else {
// return next.getAndSet(Optional.empty()).get();
// }
// }
//
// @Override
// public void remove() {
// throw new UnsupportedOperationException();
// }
}
| usethesource/capsule | src/main/java/io/usethesource/capsule/core/trie/BottomUpTransientNodeTransformer.java | 1,640 | // if (next.get().isPresent()) { | line_comment | nl | /**
* Copyright (c) Michael Steindorfer <Centrum Wiskunde & Informatica> and Contributors.
* All rights reserved.
*
* This file is licensed under the BSD 2-Clause License, which accompanies this project
* and is available under https://opensource.org/licenses/BSD-2-Clause.
*/
package io.usethesource.capsule.core.trie;
import java.util.ListIterator;
import java.util.concurrent.atomic.AtomicReference;
import java.util.function.BiFunction;
/**
* Mapper that traverses a trie and converts each node (of {@code SN}) to a node of type {@code DN}.
*/
public class BottomUpTransientNodeTransformer<SN extends Node, DN extends Node> {
private static final int MAX_DEPTH = 7;
private final BiFunction<SN, AtomicReference<Thread>, DN> nodeMapper;
private final AtomicReference<Thread> mutator;
private final DN dstRootNode;
private int stackIndex = -1;
private final ListIterator<SN>[] srcIteratorStack = new ListIterator[MAX_DEPTH];
private final ListIterator<DN>[] dstIteratorStack = new ListIterator[MAX_DEPTH];
public BottomUpTransientNodeTransformer(final SN srcRootNode,
final BiFunction<SN, AtomicReference<Thread>, DN> nodeMapper) {
this.nodeMapper = nodeMapper;
this.mutator = new AtomicReference<>(Thread.currentThread());
this.dstRootNode = nodeMapper.apply(srcRootNode, mutator);
final ListIterator<SN> srcIterator = (ListIterator<SN>) srcRootNode.nodeArray().iterator();
if (srcIterator.hasNext()) {
final ListIterator<DN> dstIterator = (ListIterator<DN>) dstRootNode.nodeArray().iterator();
pushOnStack(srcIterator, dstIterator);
}
}
public final DN apply() {
if (!isStackEmpty()) {
processStack();
}
mutator.set(null);
return dstRootNode;
}
private final boolean isStackEmpty() {
return stackIndex == -1;
}
private final void pushOnStack(ListIterator<SN> srcNode, ListIterator<DN> dstNode) {
// push on stack
final int nextIndex = ++stackIndex;
srcIteratorStack[nextIndex] = srcNode;
dstIteratorStack[nextIndex] = dstNode;
}
private final void dropFromStack() {
// pop from stack
final int previousIndex = stackIndex--;
srcIteratorStack[previousIndex] = null;
dstIteratorStack[previousIndex] = null;
}
/*
* Traverse trie and convert nodes at first encounter. Sub-trie references are updated
* incrementally throughout iteration.
*/
private final void processStack() {
while (!isStackEmpty()) {
final ListIterator<SN> srcIterator = srcIteratorStack[stackIndex];
final ListIterator<DN> dstIterator = dstIteratorStack[stackIndex];
boolean stackModified = false;
while (!stackModified) {
if (srcIterator.hasNext()) {
final SN src = srcIterator.next();
final DN dst = nodeMapper.apply(src, mutator);
dstIterator.next();
dstIterator.set(dst);
final ListIterator<SN> nextSrcIterator = (ListIterator<SN>) src.nodeArray().iterator();
if (nextSrcIterator.hasNext()) {
final ListIterator<DN> nextDstIterator = (ListIterator<DN>) dst.nodeArray().iterator();
pushOnStack(nextSrcIterator, nextDstIterator);
stackModified = true;
}
} else {
dropFromStack();
stackModified = true;
}
}
}
}
// /*
// * search for next node that can be mapped
// */
// private final Optional<SN> applyNodeTranformation(boolean yieldIntermediate) {
// SN result = null;
//
// while (stackLevel >= 0 && result == null) {
// final ListIterator<MN> srcSubNodeIterator = srcIteratorStack[stackLevel];
// final ListIterator<SN> dstSubNodeIterator = dstIteratorStack[stackLevel];
//
// if (srcSubNodeIterator.hasNext()) {
// final MN nextMapNode = srcSubNodeIterator.next();
// final SN nextSetNode = nodeMapper.apply(nextMapNode, mutator);
//
// dstSubNodeIterator.next();
// dstSubNodeIterator.set(nextSetNode);
//
// final ListIterator<MN> subNodeIterator =
// (ListIterator<MN>) nextMapNode.nodeArray().iterator();
//
// if (subNodeIterator.hasNext()) {
// // next node == (to process) intermediate node
// // put node on next stack level for depth-first traversal
//// final SN nextSetNode = nodeMapper.apply(nextMapNode, mutator);
//
// final int nextStackLevel = ++stackLevel;
// srcIteratorStack[nextStackLevel] = subNodeIterator;
// dstIteratorStack[nextStackLevel] =
// (ListIterator<SN>) nextSetNode.nodeArray().iterator();
// } else if (yieldIntermediate) {
// // nextNode == (finished) leaf node
// result = nextSetNode;
// }
// } else {
// if (yieldIntermediate) {
// // nextNode == (finished) intermidate node
// // result = setNodes[stackLevel]; // ???
// throw new IllegalStateException("TODO: figure out how to return previous element.");
// } else if (stackLevel == 0) {
// result = setRootNode;
// }
//
// // pop from stack
// srcIteratorStack[stackLevel] = null;
// dstIteratorStack[stackLevel] = null;
// stackLevel--;
// }
// }
//
// return Optional.ofNullable(result);
// }
// @Override
// public boolean hasNext() {
// if (next.get().isPresent())<SUF>
// return true;
// } else {
// final Optional<SN> result = applyNodeTranformation(true);
// next.set(result);
// return result.isPresent();
// }
// }
//
// /**
// * Returns transformed --either internal or leaf-- node.
// *
// * @return mapped node
// */
// @Override
// public SN next() {
// if (!hasNext()) {
// throw new NoSuchElementException();
// } else {
// return next.getAndSet(Optional.empty()).get();
// }
// }
//
// @Override
// public void remove() {
// throw new UnsupportedOperationException();
// }
}
|
201865_15 | /**
* Copyright (c) Michael Steindorfer <Centrum Wiskunde & Informatica> and Contributors.
* All rights reserved.
*
* This file is licensed under the BSD 2-Clause License, which accompanies this project
* and is available under https://opensource.org/licenses/BSD-2-Clause.
*/
package io.usethesource.capsule.jmh;
import java.lang.annotation.Annotation;
import java.lang.management.ManagementFactory;
import java.lang.management.RuntimeMXBean;
import java.math.BigInteger;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.EnumSet;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Random;
import java.util.Set;
import java.util.function.BiFunction;
import java.util.function.Function;
import java.util.function.Supplier;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import com.google.common.base.Predicate;
import com.google.common.base.Predicates;
import com.gs.collections.impl.map.mutable.primitive.IntIntHashMap;
import com.pholser.junit.quickcheck.generator.GenerationStatus;
import com.pholser.junit.quickcheck.generator.Size;
import com.pholser.junit.quickcheck.generator.java.lang.IntegerGenerator;
import com.pholser.junit.quickcheck.internal.GeometricDistribution;
import com.pholser.junit.quickcheck.internal.generator.SimpleGenerationStatus;
import com.pholser.junit.quickcheck.random.SourceOfRandomness;
import gnu.trove.map.hash.TIntIntHashMap;
import io.usethesource.capsule.SetMultimap;
import io.usethesource.capsule.core.PersistentTrieMap;
import io.usethesource.capsule.generators.multimap.AbstractSetMultimapGenerator;
import io.usethesource.capsule.jmh.api.JmhValue;
import it.unimi.dsi.fastutil.ints.Int2IntOpenHashMap;
import objectexplorer.ObjectGraphMeasurer.Footprint;
import org.apache.mahout.math.map.OpenIntIntHashMap;
import static io.usethesource.capsule.util.collection.AbstractSpecialisedImmutableMap.entryOf;
import static io.usethesource.capsule.jmh.FootprintUtils.rangeInclusive;
public final class CalculateFootprintsHeterogeneous {
static final String memoryArchitecture;
static {
/*
* http://stackoverflow.com/questions/1518213/read-java-jvm-startup-parameters-eg-xmx
*/
RuntimeMXBean bean = ManagementFactory.getRuntimeMXBean();
List<String> args = bean.getInputArguments();
if (args.contains("-XX:-UseCompressedOops")) {
memoryArchitecture = "64bit";
} else {
memoryArchitecture = "32bit";
}
}
private static final int multimapValueSize = 2;
private static final int stepSizeOneToOneSelector = 2;
public static void main(String[] args) throws InstantiationException, IllegalAccessException {
// final String userHome = System.getProperty("user.home");
// final String userHomeRelativePath = "Research/datastructures-for-metaprogramming/hamt-heterogeneous/data";
// final Path directoryPath = Paths.get(userHome, userHomeRelativePath);
final Path directoryPath = Paths.get(".", "target").toAbsolutePath().normalize();
final boolean appendToFile = false;
final int numberOfRuns = 1;
final List<Integer> sizes = Arrays
.asList(16, 2048, 1048576, 8388608); // createExponentialRangeWithIntermediatePoints();
final List<Integer> runs = FootprintUtils.rangeExclusive(0, numberOfRuns);
// final EnumSet<MemoryFootprintPreset> presets = EnumSet
// .of(DATA_STRUCTURE_OVERHEAD); // also consider measuring RETAINED_SIZE
final Function<Map.Entry<Integer, Integer>, Stream<String>> measureAllMultimaps =
(sizeRunTuple) -> extractAndApply(sizeRunTuple,
(size, run) -> measurePersistentMultimaps(size, run, FootprintUtils.MemoryFootprintPreset.DATA_STRUCTURE_OVERHEAD).stream());
FootprintUtils.writeToFile(
directoryPath.resolve("map_sizes_heterogeneous_tiny.csv"),
appendToFile,
product(FootprintUtils.rangeInclusive(0, 100, 1), runs).stream()
.flatMap(measureAllMultimaps)
.collect(Collectors.toList()));
// writeToFile(
// directoryPath.resolve("map_sizes_heterogeneous_small.csv"),
// appendToFile,
// product(rangeInclusive(100, 10_000, 100), runs).stream()
// .flatMap(measureAllMultimaps)
// .collect(Collectors.toList()));
//
// writeToFile(
// directoryPath.resolve("map_sizes_heterogeneous_medium.csv"),
// appendToFile,
// product(rangeInclusive(10_000, 100_000, 1_000), runs).stream()
// .flatMap(measureAllMultimaps)
// .collect(Collectors.toList()));
//
// writeToFile(
// directoryPath.resolve("map_sizes_heterogeneous_large.csv"),
// appendToFile,
// product(rangeInclusive(100_000, 8_000_000, 100_000), runs).stream()
// .flatMap(measureAllMultimaps)
// .collect(Collectors.toList()));
FootprintUtils.writeToFile(
directoryPath
.resolve("map_sizes_heterogeneous_exponential_" + memoryArchitecture + "_latest.csv"),
appendToFile,
product(sizes, runs).stream()
.flatMap(measureAllMultimaps)
.collect(Collectors.toList()));
// /*
// * PRIMITIVE DATA
// */
//
// final Function<Map.Entry<Integer, Integer>, Stream<String>> measureAllPrimitiveMultimaps =
// (sizeRunTuple) -> extractAndApply(sizeRunTuple,
// (size, run) -> measureMutablePrimitiveMaps(size, run,
// RETAINED_SIZE_WITH_BOXED_INTEGER_FILTER).stream());
//
// writeToFile(
// directoryPath.resolve("map_sizes_heterogeneous_exponential_"
// + memoryArchitecture + "_primitive_latest.csv"),
// appendToFile,
// product(sizes, runs).stream()
// .flatMap(measureAllPrimitiveMultimaps)
// .collect(Collectors.toList()));
}
public static List<String> measurePersistentMultimaps(int size, int run,
FootprintUtils.MemoryFootprintPreset preset) {
final Function<BenchmarkUtils.ValueFactoryFactory, String> executeExperiment =
(factory) -> createAndMeasureTrieSetMultimap(factory, size, multimapValueSize,
stepSizeOneToOneSelector, run, preset);
final EnumSet<BenchmarkUtils.ValueFactoryFactory> factories = EnumSet
.of(BenchmarkUtils.ValueFactoryFactory.VF_CAPSULE,
BenchmarkUtils.ValueFactoryFactory.VF_SCALA,
BenchmarkUtils.ValueFactoryFactory.VF_CLOJURE);
return factories.stream()
.map(executeExperiment)
.collect(Collectors.toList());
}
/**
* Map<K, V> 3rd party libraries containing persistent data structures.
*/
public static List<String> measurePersistentJavaLibraries(int size, int run,
FootprintUtils.MemoryFootprintPreset preset) {
final Function<BenchmarkUtils.ValueFactoryFactory, String> executeExperiment =
(factory) -> createAndMeasurePersistentMap(factory, size, run, preset);
final EnumSet<BenchmarkUtils.ValueFactoryFactory> factories = EnumSet
.of(BenchmarkUtils.ValueFactoryFactory.VF_PAGURO,
BenchmarkUtils.ValueFactoryFactory.VF_DEXX,
BenchmarkUtils.ValueFactoryFactory.VF_VAVR,
BenchmarkUtils.ValueFactoryFactory.VF_PCOLLECTIONS);
return factories.stream()
.map(executeExperiment)
.collect(Collectors.toList());
}
/**
* Map[int, int].
*/
public static List<String> measureMutablePrimitiveMaps(int size, int run,
FootprintUtils.MemoryFootprintPreset preset) {
final Number[] data = createNumericData(size, run, 1.00);
final Set<Supplier<String>> experiments = new HashSet<>();
experiments.add(() -> createAndMeasureGuavaImmutableMap(data, size, run, preset)); // Reference
// experiments.add(() -> createAndMeasureTrieMapHeterogeneous_asMap(data, size, run, preset));
experiments.add(() -> createAndMeasureFastUtilInt2IntOpenHashMap(data, size, run, preset));
experiments.add(() -> createAndMeasureMahoutMutableIntIntHashMap(data, size, run, preset));
experiments.add(() -> createAndMeasureTrove4jTIntIntHashMap(data, size, run, preset));
experiments.add(() -> createAndMeasureGsImmutableIntIntMap(data, size, run, preset));
// // generic maps
// experiments.add(() -> createAndMeasureJavaUtilHashMap(data, size, run, preset));
// experiments.add(() -> createAndMeasureTrieMapHomogeneous(data, size, run, preset));
// experiments.add(() -> createAndMeasureTrieMapHeterogeneous(data, size, run, preset, true));
// experiments.add(() -> createAndMeasureTrieMapHeterogeneous(data, size, run, preset, false));
return experiments.stream()
.map(Supplier::get)
.collect(Collectors.toList());
}
/**
* SetMultimap.
*/
public static List<String> measureXxxxMultiMaps(int size, int run, FootprintUtils.MemoryFootprintPreset preset) {
final Number[] data = createNumericData(size, run, 1.00);
final Set<Supplier<String>> experiments = new HashSet<>();
experiments.add(() -> createAndMeasureGsImmutableSetMultimap(data, size, run, preset));
experiments.add(() -> createAndMeasureGuavaImmutableSetMultimap(data, size, run, preset));
return experiments.stream()
.map(Supplier::get)
.collect(Collectors.toList());
}
/**
* Map<K, V> vs Multimap<K, V>.
*/
public static List<String> measurePersistentMapVsMultimap(int size, int run,
FootprintUtils.MemoryFootprintPreset preset) {
final Function<BenchmarkUtils.ValueFactoryFactory, String> executeExperiment =
(factory) -> createAndMeasureTrieMap(factory, size, run, preset);
final EnumSet<BenchmarkUtils.ValueFactoryFactory> factories = EnumSet
.of(BenchmarkUtils.ValueFactoryFactory.VF_CAPSULE);
return factories.stream()
.map(executeExperiment)
.collect(Collectors.toList());
}
// public static void testPrintStatsRandomSmallAndBigIntegers() {
// int measurements = 4;
//
// for (int exp = 0; exp <= 23; exp += 1) {
// final int thisExpSize = (int) Math.pow(2, exp);
// final int prevExpSize = (int) Math.pow(2, exp-1);
//
// int stride = (thisExpSize - prevExpSize) / measurements;
//
// if (stride == 0) {
// measurements = 1;
// }
//
// for (int m = measurements - 1; m >= 0; m--) {
// int size = thisExpSize - m * stride;
// }
public static <X, Y, Z> Z extractAndApply(Map.Entry<X, Y> tuple,
BiFunction<X, Y, Z> mapper) {
return mapper.apply(tuple.getKey(), tuple.getValue());
}
public static <X, Y> List<Map.Entry<X, Y>> product(List<X> xs, List<Y> ys) {
List<Map.Entry<X, Y>> xys = new ArrayList<>(xs.size() * ys.size());
for (X x : xs) {
for (Y y : ys) {
xys.add(entryOf(x, y));
}
}
return xys;
}
public static List<Integer> createExponentialRangeWithIntermediatePoints() {
List<Integer> tmpExponentialRange1 = FootprintUtils.createExponentialRange(0, 24);
List<Integer> tmpExponentialRange2 = FootprintUtils.createExponentialRange(-1, 23);
List<Integer> tmpExponentialRange = new ArrayList<>(2 * tmpExponentialRange1.size());
for (int i = 0; i < tmpExponentialRange1.size(); i++) {
tmpExponentialRange.add(tmpExponentialRange1.get(i));
tmpExponentialRange.add(tmpExponentialRange1.get(i) + tmpExponentialRange2.get(i));
}
List<Integer> exponentialRange = tmpExponentialRange.stream().skip(1)
.limit(2L * tmpExponentialRange1.size() - 2).collect(Collectors.toList());
return exponentialRange;
}
public static Number[] createNumericData(int size, int run, double percentageOfPrimitives) {
Number[] data = new Number[size];
int countForPrimitives = (int) ((percentageOfPrimitives) * size);
int smallCount = 0;
int bigCount = 0;
Random rand = new Random(13);
for (int i = 0; i < size; i++) {
final int j = rand.nextInt();
final BigInteger bigJ = BigInteger.valueOf(j).multiply(BigInteger.valueOf(j));
if (i < countForPrimitives) {
// System.out.println("SMALL");
smallCount++;
data[i] = j;
} else {
// System.out.println("BIG");
bigCount++;
data[i] = bigJ;
}
}
System.out.println();
System.out.printf("PRIMITIVE: %10d (%.2f percent)%n", smallCount,
100. * smallCount / (smallCount + bigCount));
System.out.printf("BIG_INTEGER: %10d (%.2f percent)%n", bigCount,
100. * bigCount / (smallCount + bigCount));
// System.out.println(String.format("UNIQUE: %10d (%.2f percent)",
// map.size(), 100. * map.size() / (smallCount + bigCount)));
System.out.println();
return data;
}
public static String createAndMeasureGsImmutableSetMultimap(final Object[] data, int elementCount,
int run, FootprintUtils.MemoryFootprintPreset preset) {
com.gs.collections.api.multimap.set.MutableSetMultimap<Integer, Integer> mutableYs =
com.gs.collections.impl.factory.Multimaps.mutable.set.with();
for (Object o : data) {
for (int i = 0; i < multimapValueSize; i++) {
mutableYs.put((Integer) o, (Integer) i);
}
}
/* Note: direct creation of immutable that uses newWith(...) is tremendously slow. */
com.gs.collections.api.multimap.set.ImmutableSetMultimap<Integer, Integer> ys =
mutableYs.toImmutable();
return measureAndReport(ys, "com.gs.collections.api.multimap.set.ImmutableSetMultimap",
BenchmarkUtils.DataType.SET_MULTIMAP, BenchmarkUtils.Archetype.IMMUTABLE, false, elementCount, run, preset);
}
public static String createAndMeasureFastUtilInt2IntOpenHashMap(final Object[] data,
int elementCount, int run, FootprintUtils.MemoryFootprintPreset preset) {
it.unimi.dsi.fastutil.ints.AbstractInt2IntMap mutableYs = new Int2IntOpenHashMap();
for (Object o : data) {
for (int i = 0; i < multimapValueSize; i++) {
mutableYs.put((Integer) o, (Integer) i);
}
}
return measureAndReport(mutableYs, "it.unimi.dsi.fastutil.ints.Int2IntOpenHashMap",
BenchmarkUtils.DataType.MAP, BenchmarkUtils.Archetype.MUTABLE, false, elementCount, run, preset);
}
public static String createAndMeasureMahoutMutableIntIntHashMap(final Object[] data,
int elementCount, int run, FootprintUtils.MemoryFootprintPreset preset) {
org.apache.mahout.math.map.AbstractIntIntMap mutableYs = new OpenIntIntHashMap();
for (Object o : data) {
for (int i = 0; i < multimapValueSize; i++) {
mutableYs.put((Integer) o, (Integer) i);
}
}
return measureAndReport(mutableYs, "org.apache.mahout.math.map.OpenIntIntHashMap", BenchmarkUtils.DataType.MAP,
BenchmarkUtils.Archetype.MUTABLE, false, elementCount, run, preset);
}
public static String createAndMeasureGsImmutableIntIntMap(final Object[] data, int elementCount,
int run, FootprintUtils.MemoryFootprintPreset preset) {
com.gs.collections.api.map.primitive.MutableIntIntMap mutableYs = new IntIntHashMap();
for (Object o : data) {
for (int i = 0; i < multimapValueSize; i++) {
mutableYs.put((Integer) o, (Integer) i);
}
}
com.gs.collections.api.map.primitive.ImmutableIntIntMap ys = mutableYs.toImmutable();
return measureAndReport(ys, "com.gs.collections.api.map.primitive.ImmutableIntIntMap",
BenchmarkUtils.DataType.MAP, BenchmarkUtils.Archetype.IMMUTABLE, false, elementCount, run, preset);
}
private static JmhValue box(int i) {
return new PureIntegerWithCustomHashCode(i);
}
public static String createAndMeasureGuavaImmutableMap(final Object[] data, int elementCount,
int run, FootprintUtils.MemoryFootprintPreset preset) {
com.google.common.collect.ImmutableMap.Builder<JmhValue, JmhValue> ysBldr =
com.google.common.collect.ImmutableMap.builder();
// filters duplicates (because builder can't handle them)
Set<Object> seenKeys = new HashSet<>(data.length);
for (Object o : data) {
if (!seenKeys.contains(o)) {
seenKeys.add(o);
ysBldr.put(box((Integer) o), box((Integer) o));
}
}
com.google.common.collect.ImmutableMap<JmhValue, JmhValue> ys = ysBldr.build();
return measureAndReport(ys, "com.google.common.collect.ImmutableMap", BenchmarkUtils.DataType.MAP,
BenchmarkUtils.Archetype.IMMUTABLE, false, elementCount, run, preset);
}
public static String createAndMeasureGuavaImmutableSetMultimap(final Object[] data,
int elementCount, int run, FootprintUtils.MemoryFootprintPreset preset) {
com.google.common.collect.ImmutableSetMultimap.Builder<JmhValue, JmhValue> ysBldr =
com.google.common.collect.ImmutableSetMultimap.builder();
for (int keyIdx = 0; keyIdx < data.length; keyIdx++) {
Object o = data[keyIdx];
if (keyIdx % stepSizeOneToOneSelector == 0) {
ysBldr.put(box((Integer) o), box((Integer) o));
} else {
for (int i = 0; i < multimapValueSize; i++) {
ysBldr.put(box((Integer) o), box(i));
}
}
}
com.google.common.collect.ImmutableMultimap<JmhValue, JmhValue> ys = ysBldr.build();
return measureAndReport(ys, "com.google.common.collect.ImmutableSetMultimap",
BenchmarkUtils.DataType.SET_MULTIMAP, BenchmarkUtils.Archetype.IMMUTABLE, false, elementCount, run, preset);
}
public static String createAndMeasurePersistentMap(BenchmarkUtils.ValueFactoryFactory valueFactoryFactory,
int elementCount, int run, FootprintUtils.MemoryFootprintPreset preset) {
try {
final Object mapInstance = JmhMapBenchmarks.generateMap(valueFactoryFactory.getInstance(),
ElementProducer.PDB_INTEGER, false, elementCount, run);
return measureAndReport(mapInstance, valueFactoryFactory.name(), BenchmarkUtils.DataType.MAP,
BenchmarkUtils.Archetype.PERSISTENT, false, elementCount, run, preset);
} catch (Exception e) {
e.printStackTrace();
return "ERROR";
}
}
/*
* TODO: check where this is used; misnomer.
*/
@Deprecated
public static String createAndMeasureTrieMap(BenchmarkUtils.ValueFactoryFactory valueFactoryFactory,
int elementCount, int run, FootprintUtils.MemoryFootprintPreset preset) {
try {
final int fixedMultimapValueSize = 1;
final int fixedStepSizeOneToOneSelector = 1;
final Object setMultimapInstance = JmhSetMultimapBenchmarks.generateSetMultimap(
valueFactoryFactory.getInstance(), ElementProducer.PDB_INTEGER, false, elementCount,
fixedMultimapValueSize, fixedStepSizeOneToOneSelector, run);
return measureAndReport(setMultimapInstance, valueFactoryFactory.name(), BenchmarkUtils.DataType.MAP,
BenchmarkUtils.Archetype.PERSISTENT, false, elementCount, run, preset);
} catch (Exception e) {
e.printStackTrace();
}
return "ERROR";
}
public static Size size(int min, int max) {
return new Size() {
@Override
public int min() {
return min;
}
@Override
public int max() {
return max;
}
@Override
public Class<? extends Annotation> annotationType() {
return Size.class;
}
};
}
public static String createAndMeasureXXX(
Class<? extends AbstractSetMultimapGenerator<? extends SetMultimap.Immutable>> generatorClass,
int elementCount, int multimapValueSize, int stepSizeOneToOneSelector, int run,
FootprintUtils.MemoryFootprintPreset preset) {
try {
final AbstractSetMultimapGenerator<? extends SetMultimap.Immutable> gen =
generatorClass.newInstance();
gen.configure(size(elementCount, elementCount));
gen.addComponentGenerators(Arrays.asList(new IntegerGenerator(), new IntegerGenerator()));
final SourceOfRandomness random =
new SourceOfRandomness(new Random(BenchmarkUtils.seedFromSizeAndRun(elementCount, run)));
final GenerationStatus status =
new SimpleGenerationStatus(new GeometricDistribution(), random, 1);
final Object setMultimapInstance = gen.generate(random, status);
// System.out.println(setMultimapInstance);
return measureAndReport(setMultimapInstance, generatorClass.getName(), BenchmarkUtils.DataType.SET_MULTIMAP,
BenchmarkUtils.Archetype.PERSISTENT, false, elementCount, run, preset);
} catch (InstantiationException e) {
e.printStackTrace();
} catch (IllegalAccessException e) {
e.printStackTrace();
}
return "ERROR";
}
public static <T> Class<T> classCast(Class clazz) {
return (Class<T>) clazz;
}
public static String createAndMeasureTrieSetMultimap(BenchmarkUtils.ValueFactoryFactory valueFactoryFactory,
int elementCount, int multimapValueSize, int stepSizeOneToOneSelector, int run,
FootprintUtils.MemoryFootprintPreset preset) {
try {
final Object setMultimapInstance = JmhSetMultimapBenchmarks.generateSetMultimap(
valueFactoryFactory.getInstance(), ElementProducer.PDB_INTEGER, false, elementCount,
multimapValueSize, stepSizeOneToOneSelector, run);
return measureAndReport(setMultimapInstance, valueFactoryFactory.name(),
BenchmarkUtils.DataType.SET_MULTIMAP, BenchmarkUtils.Archetype.PERSISTENT, false, elementCount, run, preset);
} catch (Exception e) {
e.printStackTrace();
}
return "ERROR";
}
public static String createAndMeasureTrieMapHomogeneous(final Object[] data, int elementCount,
int run, FootprintUtils.MemoryFootprintPreset preset) {
io.usethesource.capsule.Map.Immutable<Integer, Integer> ys = PersistentTrieMap.of();
// for (Object v : data) {
// ys = ys.__put(v, v);
// assert ys.containsKey(v);
// }
int[] convertedData = new int[elementCount];
for (int i = 0; i < elementCount; i++) {
final Object v = data[i];
final int convertedValue;
if (v instanceof Integer) {
convertedValue = (Integer) v;
} else if (v instanceof BigInteger) {
convertedValue = ((BigInteger) v).intValue();
} else {
throw new IllegalStateException("Expecting input data of type Integer or BigInteger.");
}
convertedData[i] = convertedValue;
}
for (int value : convertedData) {
ys = ys.__put(value, value);
assert ys.containsKey(value);
}
String shortName = "TrieMap [Boxed]";
return measureAndReport(ys, shortName, BenchmarkUtils.DataType.MAP, BenchmarkUtils.Archetype.PERSISTENT, false, elementCount,
run, preset);
}
public static String createAndMeasureJavaUtilHashMap(final Object[] data, int elementCount,
int run, FootprintUtils.MemoryFootprintPreset preset) {
Map<Object, Object> ys = new HashMap<>();
for (Object v : data) {
ys.put(v, v);
assert ys.containsKey(v);
}
String shortName = "HashMap";
return measureAndReport(ys, shortName, BenchmarkUtils.DataType.MAP, BenchmarkUtils.Archetype.MUTABLE, false, elementCount,
run, preset);
}
public static String createAndMeasureTrove4jTIntIntHashMap(final Object[] data, int elementCount,
int run, FootprintUtils.MemoryFootprintPreset preset) {
TIntIntHashMap ys = new TIntIntHashMap(elementCount);
int[] convertedData = new int[elementCount];
for (int i = 0; i < elementCount; i++) {
final Object v = data[i];
final int convertedValue;
if (v instanceof Integer) {
convertedValue = (Integer) v;
} else if (v instanceof BigInteger) {
convertedValue = ((BigInteger) v).intValue();
} else {
throw new IllegalStateException("Expecting input data of type Integer or BigInteger.");
}
convertedData[i] = convertedValue;
}
for (int value : convertedData) {
ys.put(value, value);
assert ys.containsKey(value);
}
return measureAndReport(ys, "gnu.trove.map.hash.TIntIntHashMap", BenchmarkUtils.DataType.MAP,
BenchmarkUtils.Archetype.MUTABLE, false, elementCount, run, preset);
}
private static String measureAndReport(final Object objectToMeasure, final String className,
BenchmarkUtils.DataType dataType, BenchmarkUtils.Archetype archetype, boolean supportsStagedMutability, int size, int run,
FootprintUtils.MemoryFootprintPreset preset) {
final Predicate<Object> predicate;
switch (preset) {
case DATA_STRUCTURE_OVERHEAD:
// TODO: create JmhLeaf
// predicate = Predicates
// .not(Predicates.or(Predicates.instanceOf(Integer.class),
// Predicates.instanceOf(BigInteger.class),
// Predicates.instanceOf(JmhValue.class), Predicates.instanceOf(PureInteger.class)));
predicate = Predicates.not(Predicates.or(Predicates.instanceOf(PureInteger.class),
Predicates.instanceOf(PureIntegerWithCustomHashCode.class)));
break;
case RETAINED_SIZE:
predicate = Predicates.alwaysTrue();
break;
case RETAINED_SIZE_WITH_BOXED_INTEGER_FILTER:
predicate = Predicates.not(Predicates.instanceOf(Integer.class));
break;
default:
throw new IllegalStateException();
}
return measureAndReport(objectToMeasure, className, dataType, archetype,
supportsStagedMutability, size, run, predicate);
}
private static String measureAndReport(final Object objectToMeasure, final String className,
BenchmarkUtils.DataType dataType, BenchmarkUtils.Archetype archetype, boolean supportsStagedMutability, int size, int run) {
return measureAndReport(objectToMeasure, className, dataType, archetype,
supportsStagedMutability, size, run, FootprintUtils.MemoryFootprintPreset.DATA_STRUCTURE_OVERHEAD);
}
private static String measureAndReport(final Object objectToMeasure, final String className,
BenchmarkUtils.DataType dataType, BenchmarkUtils.Archetype archetype, boolean supportsStagedMutability, int size, int run,
Predicate<Object> predicate) {
// System.out.println(GraphLayout.parseInstance(objectToMeasure).totalSize());
long memoryInBytes = objectexplorer.MemoryMeasurer.measureBytes(objectToMeasure, predicate);
Footprint memoryFootprint =
objectexplorer.ObjectGraphMeasurer.measure(objectToMeasure, predicate);
final String statString = String.format("%d (%d@%d)\t %60s\t\t %s", size, run, memoryInBytes,
className, memoryFootprint);
System.out.println(statString);
// final String statLatexString = String.format("%s & %s & %s & %b & %d
// & %d & %d & \"%s\" \\\\", className, dataType, archetype,
// supportsStagedMutability, memoryInBytes,
// memoryFootprint.getObjects(), memoryFootprint.getReferences(),
// memoryFootprint.getPrimitives());
// System.out.println(statLatexString);
final String statFileString = String.format("%d,%d,%s,%s,%s,%b,%d,%d,%d", size, run, className,
dataType, archetype, supportsStagedMutability, memoryInBytes, memoryFootprint.getObjects(),
memoryFootprint.getReferences());
return statFileString;
// writeToFile(statFileString);
}
}
| usethesource/capsule | src/jmh/java/io/usethesource/capsule/jmh/CalculateFootprintsHeterogeneous.java | 7,530 | /**
* Map[int, int].
*/ | block_comment | nl | /**
* Copyright (c) Michael Steindorfer <Centrum Wiskunde & Informatica> and Contributors.
* All rights reserved.
*
* This file is licensed under the BSD 2-Clause License, which accompanies this project
* and is available under https://opensource.org/licenses/BSD-2-Clause.
*/
package io.usethesource.capsule.jmh;
import java.lang.annotation.Annotation;
import java.lang.management.ManagementFactory;
import java.lang.management.RuntimeMXBean;
import java.math.BigInteger;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.EnumSet;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Random;
import java.util.Set;
import java.util.function.BiFunction;
import java.util.function.Function;
import java.util.function.Supplier;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import com.google.common.base.Predicate;
import com.google.common.base.Predicates;
import com.gs.collections.impl.map.mutable.primitive.IntIntHashMap;
import com.pholser.junit.quickcheck.generator.GenerationStatus;
import com.pholser.junit.quickcheck.generator.Size;
import com.pholser.junit.quickcheck.generator.java.lang.IntegerGenerator;
import com.pholser.junit.quickcheck.internal.GeometricDistribution;
import com.pholser.junit.quickcheck.internal.generator.SimpleGenerationStatus;
import com.pholser.junit.quickcheck.random.SourceOfRandomness;
import gnu.trove.map.hash.TIntIntHashMap;
import io.usethesource.capsule.SetMultimap;
import io.usethesource.capsule.core.PersistentTrieMap;
import io.usethesource.capsule.generators.multimap.AbstractSetMultimapGenerator;
import io.usethesource.capsule.jmh.api.JmhValue;
import it.unimi.dsi.fastutil.ints.Int2IntOpenHashMap;
import objectexplorer.ObjectGraphMeasurer.Footprint;
import org.apache.mahout.math.map.OpenIntIntHashMap;
import static io.usethesource.capsule.util.collection.AbstractSpecialisedImmutableMap.entryOf;
import static io.usethesource.capsule.jmh.FootprintUtils.rangeInclusive;
public final class CalculateFootprintsHeterogeneous {
static final String memoryArchitecture;
static {
/*
* http://stackoverflow.com/questions/1518213/read-java-jvm-startup-parameters-eg-xmx
*/
RuntimeMXBean bean = ManagementFactory.getRuntimeMXBean();
List<String> args = bean.getInputArguments();
if (args.contains("-XX:-UseCompressedOops")) {
memoryArchitecture = "64bit";
} else {
memoryArchitecture = "32bit";
}
}
private static final int multimapValueSize = 2;
private static final int stepSizeOneToOneSelector = 2;
public static void main(String[] args) throws InstantiationException, IllegalAccessException {
// final String userHome = System.getProperty("user.home");
// final String userHomeRelativePath = "Research/datastructures-for-metaprogramming/hamt-heterogeneous/data";
// final Path directoryPath = Paths.get(userHome, userHomeRelativePath);
final Path directoryPath = Paths.get(".", "target").toAbsolutePath().normalize();
final boolean appendToFile = false;
final int numberOfRuns = 1;
final List<Integer> sizes = Arrays
.asList(16, 2048, 1048576, 8388608); // createExponentialRangeWithIntermediatePoints();
final List<Integer> runs = FootprintUtils.rangeExclusive(0, numberOfRuns);
// final EnumSet<MemoryFootprintPreset> presets = EnumSet
// .of(DATA_STRUCTURE_OVERHEAD); // also consider measuring RETAINED_SIZE
final Function<Map.Entry<Integer, Integer>, Stream<String>> measureAllMultimaps =
(sizeRunTuple) -> extractAndApply(sizeRunTuple,
(size, run) -> measurePersistentMultimaps(size, run, FootprintUtils.MemoryFootprintPreset.DATA_STRUCTURE_OVERHEAD).stream());
FootprintUtils.writeToFile(
directoryPath.resolve("map_sizes_heterogeneous_tiny.csv"),
appendToFile,
product(FootprintUtils.rangeInclusive(0, 100, 1), runs).stream()
.flatMap(measureAllMultimaps)
.collect(Collectors.toList()));
// writeToFile(
// directoryPath.resolve("map_sizes_heterogeneous_small.csv"),
// appendToFile,
// product(rangeInclusive(100, 10_000, 100), runs).stream()
// .flatMap(measureAllMultimaps)
// .collect(Collectors.toList()));
//
// writeToFile(
// directoryPath.resolve("map_sizes_heterogeneous_medium.csv"),
// appendToFile,
// product(rangeInclusive(10_000, 100_000, 1_000), runs).stream()
// .flatMap(measureAllMultimaps)
// .collect(Collectors.toList()));
//
// writeToFile(
// directoryPath.resolve("map_sizes_heterogeneous_large.csv"),
// appendToFile,
// product(rangeInclusive(100_000, 8_000_000, 100_000), runs).stream()
// .flatMap(measureAllMultimaps)
// .collect(Collectors.toList()));
FootprintUtils.writeToFile(
directoryPath
.resolve("map_sizes_heterogeneous_exponential_" + memoryArchitecture + "_latest.csv"),
appendToFile,
product(sizes, runs).stream()
.flatMap(measureAllMultimaps)
.collect(Collectors.toList()));
// /*
// * PRIMITIVE DATA
// */
//
// final Function<Map.Entry<Integer, Integer>, Stream<String>> measureAllPrimitiveMultimaps =
// (sizeRunTuple) -> extractAndApply(sizeRunTuple,
// (size, run) -> measureMutablePrimitiveMaps(size, run,
// RETAINED_SIZE_WITH_BOXED_INTEGER_FILTER).stream());
//
// writeToFile(
// directoryPath.resolve("map_sizes_heterogeneous_exponential_"
// + memoryArchitecture + "_primitive_latest.csv"),
// appendToFile,
// product(sizes, runs).stream()
// .flatMap(measureAllPrimitiveMultimaps)
// .collect(Collectors.toList()));
}
public static List<String> measurePersistentMultimaps(int size, int run,
FootprintUtils.MemoryFootprintPreset preset) {
final Function<BenchmarkUtils.ValueFactoryFactory, String> executeExperiment =
(factory) -> createAndMeasureTrieSetMultimap(factory, size, multimapValueSize,
stepSizeOneToOneSelector, run, preset);
final EnumSet<BenchmarkUtils.ValueFactoryFactory> factories = EnumSet
.of(BenchmarkUtils.ValueFactoryFactory.VF_CAPSULE,
BenchmarkUtils.ValueFactoryFactory.VF_SCALA,
BenchmarkUtils.ValueFactoryFactory.VF_CLOJURE);
return factories.stream()
.map(executeExperiment)
.collect(Collectors.toList());
}
/**
* Map<K, V> 3rd party libraries containing persistent data structures.
*/
public static List<String> measurePersistentJavaLibraries(int size, int run,
FootprintUtils.MemoryFootprintPreset preset) {
final Function<BenchmarkUtils.ValueFactoryFactory, String> executeExperiment =
(factory) -> createAndMeasurePersistentMap(factory, size, run, preset);
final EnumSet<BenchmarkUtils.ValueFactoryFactory> factories = EnumSet
.of(BenchmarkUtils.ValueFactoryFactory.VF_PAGURO,
BenchmarkUtils.ValueFactoryFactory.VF_DEXX,
BenchmarkUtils.ValueFactoryFactory.VF_VAVR,
BenchmarkUtils.ValueFactoryFactory.VF_PCOLLECTIONS);
return factories.stream()
.map(executeExperiment)
.collect(Collectors.toList());
}
/**
* Map[int, int].
<SUF>*/
public static List<String> measureMutablePrimitiveMaps(int size, int run,
FootprintUtils.MemoryFootprintPreset preset) {
final Number[] data = createNumericData(size, run, 1.00);
final Set<Supplier<String>> experiments = new HashSet<>();
experiments.add(() -> createAndMeasureGuavaImmutableMap(data, size, run, preset)); // Reference
// experiments.add(() -> createAndMeasureTrieMapHeterogeneous_asMap(data, size, run, preset));
experiments.add(() -> createAndMeasureFastUtilInt2IntOpenHashMap(data, size, run, preset));
experiments.add(() -> createAndMeasureMahoutMutableIntIntHashMap(data, size, run, preset));
experiments.add(() -> createAndMeasureTrove4jTIntIntHashMap(data, size, run, preset));
experiments.add(() -> createAndMeasureGsImmutableIntIntMap(data, size, run, preset));
// // generic maps
// experiments.add(() -> createAndMeasureJavaUtilHashMap(data, size, run, preset));
// experiments.add(() -> createAndMeasureTrieMapHomogeneous(data, size, run, preset));
// experiments.add(() -> createAndMeasureTrieMapHeterogeneous(data, size, run, preset, true));
// experiments.add(() -> createAndMeasureTrieMapHeterogeneous(data, size, run, preset, false));
return experiments.stream()
.map(Supplier::get)
.collect(Collectors.toList());
}
/**
* SetMultimap.
*/
public static List<String> measureXxxxMultiMaps(int size, int run, FootprintUtils.MemoryFootprintPreset preset) {
final Number[] data = createNumericData(size, run, 1.00);
final Set<Supplier<String>> experiments = new HashSet<>();
experiments.add(() -> createAndMeasureGsImmutableSetMultimap(data, size, run, preset));
experiments.add(() -> createAndMeasureGuavaImmutableSetMultimap(data, size, run, preset));
return experiments.stream()
.map(Supplier::get)
.collect(Collectors.toList());
}
/**
* Map<K, V> vs Multimap<K, V>.
*/
public static List<String> measurePersistentMapVsMultimap(int size, int run,
FootprintUtils.MemoryFootprintPreset preset) {
final Function<BenchmarkUtils.ValueFactoryFactory, String> executeExperiment =
(factory) -> createAndMeasureTrieMap(factory, size, run, preset);
final EnumSet<BenchmarkUtils.ValueFactoryFactory> factories = EnumSet
.of(BenchmarkUtils.ValueFactoryFactory.VF_CAPSULE);
return factories.stream()
.map(executeExperiment)
.collect(Collectors.toList());
}
// public static void testPrintStatsRandomSmallAndBigIntegers() {
// int measurements = 4;
//
// for (int exp = 0; exp <= 23; exp += 1) {
// final int thisExpSize = (int) Math.pow(2, exp);
// final int prevExpSize = (int) Math.pow(2, exp-1);
//
// int stride = (thisExpSize - prevExpSize) / measurements;
//
// if (stride == 0) {
// measurements = 1;
// }
//
// for (int m = measurements - 1; m >= 0; m--) {
// int size = thisExpSize - m * stride;
// }
public static <X, Y, Z> Z extractAndApply(Map.Entry<X, Y> tuple,
BiFunction<X, Y, Z> mapper) {
return mapper.apply(tuple.getKey(), tuple.getValue());
}
public static <X, Y> List<Map.Entry<X, Y>> product(List<X> xs, List<Y> ys) {
List<Map.Entry<X, Y>> xys = new ArrayList<>(xs.size() * ys.size());
for (X x : xs) {
for (Y y : ys) {
xys.add(entryOf(x, y));
}
}
return xys;
}
public static List<Integer> createExponentialRangeWithIntermediatePoints() {
List<Integer> tmpExponentialRange1 = FootprintUtils.createExponentialRange(0, 24);
List<Integer> tmpExponentialRange2 = FootprintUtils.createExponentialRange(-1, 23);
List<Integer> tmpExponentialRange = new ArrayList<>(2 * tmpExponentialRange1.size());
for (int i = 0; i < tmpExponentialRange1.size(); i++) {
tmpExponentialRange.add(tmpExponentialRange1.get(i));
tmpExponentialRange.add(tmpExponentialRange1.get(i) + tmpExponentialRange2.get(i));
}
List<Integer> exponentialRange = tmpExponentialRange.stream().skip(1)
.limit(2L * tmpExponentialRange1.size() - 2).collect(Collectors.toList());
return exponentialRange;
}
public static Number[] createNumericData(int size, int run, double percentageOfPrimitives) {
Number[] data = new Number[size];
int countForPrimitives = (int) ((percentageOfPrimitives) * size);
int smallCount = 0;
int bigCount = 0;
Random rand = new Random(13);
for (int i = 0; i < size; i++) {
final int j = rand.nextInt();
final BigInteger bigJ = BigInteger.valueOf(j).multiply(BigInteger.valueOf(j));
if (i < countForPrimitives) {
// System.out.println("SMALL");
smallCount++;
data[i] = j;
} else {
// System.out.println("BIG");
bigCount++;
data[i] = bigJ;
}
}
System.out.println();
System.out.printf("PRIMITIVE: %10d (%.2f percent)%n", smallCount,
100. * smallCount / (smallCount + bigCount));
System.out.printf("BIG_INTEGER: %10d (%.2f percent)%n", bigCount,
100. * bigCount / (smallCount + bigCount));
// System.out.println(String.format("UNIQUE: %10d (%.2f percent)",
// map.size(), 100. * map.size() / (smallCount + bigCount)));
System.out.println();
return data;
}
public static String createAndMeasureGsImmutableSetMultimap(final Object[] data, int elementCount,
int run, FootprintUtils.MemoryFootprintPreset preset) {
com.gs.collections.api.multimap.set.MutableSetMultimap<Integer, Integer> mutableYs =
com.gs.collections.impl.factory.Multimaps.mutable.set.with();
for (Object o : data) {
for (int i = 0; i < multimapValueSize; i++) {
mutableYs.put((Integer) o, (Integer) i);
}
}
/* Note: direct creation of immutable that uses newWith(...) is tremendously slow. */
com.gs.collections.api.multimap.set.ImmutableSetMultimap<Integer, Integer> ys =
mutableYs.toImmutable();
return measureAndReport(ys, "com.gs.collections.api.multimap.set.ImmutableSetMultimap",
BenchmarkUtils.DataType.SET_MULTIMAP, BenchmarkUtils.Archetype.IMMUTABLE, false, elementCount, run, preset);
}
public static String createAndMeasureFastUtilInt2IntOpenHashMap(final Object[] data,
int elementCount, int run, FootprintUtils.MemoryFootprintPreset preset) {
it.unimi.dsi.fastutil.ints.AbstractInt2IntMap mutableYs = new Int2IntOpenHashMap();
for (Object o : data) {
for (int i = 0; i < multimapValueSize; i++) {
mutableYs.put((Integer) o, (Integer) i);
}
}
return measureAndReport(mutableYs, "it.unimi.dsi.fastutil.ints.Int2IntOpenHashMap",
BenchmarkUtils.DataType.MAP, BenchmarkUtils.Archetype.MUTABLE, false, elementCount, run, preset);
}
public static String createAndMeasureMahoutMutableIntIntHashMap(final Object[] data,
int elementCount, int run, FootprintUtils.MemoryFootprintPreset preset) {
org.apache.mahout.math.map.AbstractIntIntMap mutableYs = new OpenIntIntHashMap();
for (Object o : data) {
for (int i = 0; i < multimapValueSize; i++) {
mutableYs.put((Integer) o, (Integer) i);
}
}
return measureAndReport(mutableYs, "org.apache.mahout.math.map.OpenIntIntHashMap", BenchmarkUtils.DataType.MAP,
BenchmarkUtils.Archetype.MUTABLE, false, elementCount, run, preset);
}
public static String createAndMeasureGsImmutableIntIntMap(final Object[] data, int elementCount,
int run, FootprintUtils.MemoryFootprintPreset preset) {
com.gs.collections.api.map.primitive.MutableIntIntMap mutableYs = new IntIntHashMap();
for (Object o : data) {
for (int i = 0; i < multimapValueSize; i++) {
mutableYs.put((Integer) o, (Integer) i);
}
}
com.gs.collections.api.map.primitive.ImmutableIntIntMap ys = mutableYs.toImmutable();
return measureAndReport(ys, "com.gs.collections.api.map.primitive.ImmutableIntIntMap",
BenchmarkUtils.DataType.MAP, BenchmarkUtils.Archetype.IMMUTABLE, false, elementCount, run, preset);
}
private static JmhValue box(int i) {
return new PureIntegerWithCustomHashCode(i);
}
public static String createAndMeasureGuavaImmutableMap(final Object[] data, int elementCount,
int run, FootprintUtils.MemoryFootprintPreset preset) {
com.google.common.collect.ImmutableMap.Builder<JmhValue, JmhValue> ysBldr =
com.google.common.collect.ImmutableMap.builder();
// filters duplicates (because builder can't handle them)
Set<Object> seenKeys = new HashSet<>(data.length);
for (Object o : data) {
if (!seenKeys.contains(o)) {
seenKeys.add(o);
ysBldr.put(box((Integer) o), box((Integer) o));
}
}
com.google.common.collect.ImmutableMap<JmhValue, JmhValue> ys = ysBldr.build();
return measureAndReport(ys, "com.google.common.collect.ImmutableMap", BenchmarkUtils.DataType.MAP,
BenchmarkUtils.Archetype.IMMUTABLE, false, elementCount, run, preset);
}
public static String createAndMeasureGuavaImmutableSetMultimap(final Object[] data,
int elementCount, int run, FootprintUtils.MemoryFootprintPreset preset) {
com.google.common.collect.ImmutableSetMultimap.Builder<JmhValue, JmhValue> ysBldr =
com.google.common.collect.ImmutableSetMultimap.builder();
for (int keyIdx = 0; keyIdx < data.length; keyIdx++) {
Object o = data[keyIdx];
if (keyIdx % stepSizeOneToOneSelector == 0) {
ysBldr.put(box((Integer) o), box((Integer) o));
} else {
for (int i = 0; i < multimapValueSize; i++) {
ysBldr.put(box((Integer) o), box(i));
}
}
}
com.google.common.collect.ImmutableMultimap<JmhValue, JmhValue> ys = ysBldr.build();
return measureAndReport(ys, "com.google.common.collect.ImmutableSetMultimap",
BenchmarkUtils.DataType.SET_MULTIMAP, BenchmarkUtils.Archetype.IMMUTABLE, false, elementCount, run, preset);
}
public static String createAndMeasurePersistentMap(BenchmarkUtils.ValueFactoryFactory valueFactoryFactory,
int elementCount, int run, FootprintUtils.MemoryFootprintPreset preset) {
try {
final Object mapInstance = JmhMapBenchmarks.generateMap(valueFactoryFactory.getInstance(),
ElementProducer.PDB_INTEGER, false, elementCount, run);
return measureAndReport(mapInstance, valueFactoryFactory.name(), BenchmarkUtils.DataType.MAP,
BenchmarkUtils.Archetype.PERSISTENT, false, elementCount, run, preset);
} catch (Exception e) {
e.printStackTrace();
return "ERROR";
}
}
/*
* TODO: check where this is used; misnomer.
*/
@Deprecated
public static String createAndMeasureTrieMap(BenchmarkUtils.ValueFactoryFactory valueFactoryFactory,
int elementCount, int run, FootprintUtils.MemoryFootprintPreset preset) {
try {
final int fixedMultimapValueSize = 1;
final int fixedStepSizeOneToOneSelector = 1;
final Object setMultimapInstance = JmhSetMultimapBenchmarks.generateSetMultimap(
valueFactoryFactory.getInstance(), ElementProducer.PDB_INTEGER, false, elementCount,
fixedMultimapValueSize, fixedStepSizeOneToOneSelector, run);
return measureAndReport(setMultimapInstance, valueFactoryFactory.name(), BenchmarkUtils.DataType.MAP,
BenchmarkUtils.Archetype.PERSISTENT, false, elementCount, run, preset);
} catch (Exception e) {
e.printStackTrace();
}
return "ERROR";
}
public static Size size(int min, int max) {
return new Size() {
@Override
public int min() {
return min;
}
@Override
public int max() {
return max;
}
@Override
public Class<? extends Annotation> annotationType() {
return Size.class;
}
};
}
public static String createAndMeasureXXX(
Class<? extends AbstractSetMultimapGenerator<? extends SetMultimap.Immutable>> generatorClass,
int elementCount, int multimapValueSize, int stepSizeOneToOneSelector, int run,
FootprintUtils.MemoryFootprintPreset preset) {
try {
final AbstractSetMultimapGenerator<? extends SetMultimap.Immutable> gen =
generatorClass.newInstance();
gen.configure(size(elementCount, elementCount));
gen.addComponentGenerators(Arrays.asList(new IntegerGenerator(), new IntegerGenerator()));
final SourceOfRandomness random =
new SourceOfRandomness(new Random(BenchmarkUtils.seedFromSizeAndRun(elementCount, run)));
final GenerationStatus status =
new SimpleGenerationStatus(new GeometricDistribution(), random, 1);
final Object setMultimapInstance = gen.generate(random, status);
// System.out.println(setMultimapInstance);
return measureAndReport(setMultimapInstance, generatorClass.getName(), BenchmarkUtils.DataType.SET_MULTIMAP,
BenchmarkUtils.Archetype.PERSISTENT, false, elementCount, run, preset);
} catch (InstantiationException e) {
e.printStackTrace();
} catch (IllegalAccessException e) {
e.printStackTrace();
}
return "ERROR";
}
public static <T> Class<T> classCast(Class clazz) {
return (Class<T>) clazz;
}
public static String createAndMeasureTrieSetMultimap(BenchmarkUtils.ValueFactoryFactory valueFactoryFactory,
int elementCount, int multimapValueSize, int stepSizeOneToOneSelector, int run,
FootprintUtils.MemoryFootprintPreset preset) {
try {
final Object setMultimapInstance = JmhSetMultimapBenchmarks.generateSetMultimap(
valueFactoryFactory.getInstance(), ElementProducer.PDB_INTEGER, false, elementCount,
multimapValueSize, stepSizeOneToOneSelector, run);
return measureAndReport(setMultimapInstance, valueFactoryFactory.name(),
BenchmarkUtils.DataType.SET_MULTIMAP, BenchmarkUtils.Archetype.PERSISTENT, false, elementCount, run, preset);
} catch (Exception e) {
e.printStackTrace();
}
return "ERROR";
}
public static String createAndMeasureTrieMapHomogeneous(final Object[] data, int elementCount,
int run, FootprintUtils.MemoryFootprintPreset preset) {
io.usethesource.capsule.Map.Immutable<Integer, Integer> ys = PersistentTrieMap.of();
// for (Object v : data) {
// ys = ys.__put(v, v);
// assert ys.containsKey(v);
// }
int[] convertedData = new int[elementCount];
for (int i = 0; i < elementCount; i++) {
final Object v = data[i];
final int convertedValue;
if (v instanceof Integer) {
convertedValue = (Integer) v;
} else if (v instanceof BigInteger) {
convertedValue = ((BigInteger) v).intValue();
} else {
throw new IllegalStateException("Expecting input data of type Integer or BigInteger.");
}
convertedData[i] = convertedValue;
}
for (int value : convertedData) {
ys = ys.__put(value, value);
assert ys.containsKey(value);
}
String shortName = "TrieMap [Boxed]";
return measureAndReport(ys, shortName, BenchmarkUtils.DataType.MAP, BenchmarkUtils.Archetype.PERSISTENT, false, elementCount,
run, preset);
}
public static String createAndMeasureJavaUtilHashMap(final Object[] data, int elementCount,
int run, FootprintUtils.MemoryFootprintPreset preset) {
Map<Object, Object> ys = new HashMap<>();
for (Object v : data) {
ys.put(v, v);
assert ys.containsKey(v);
}
String shortName = "HashMap";
return measureAndReport(ys, shortName, BenchmarkUtils.DataType.MAP, BenchmarkUtils.Archetype.MUTABLE, false, elementCount,
run, preset);
}
public static String createAndMeasureTrove4jTIntIntHashMap(final Object[] data, int elementCount,
int run, FootprintUtils.MemoryFootprintPreset preset) {
TIntIntHashMap ys = new TIntIntHashMap(elementCount);
int[] convertedData = new int[elementCount];
for (int i = 0; i < elementCount; i++) {
final Object v = data[i];
final int convertedValue;
if (v instanceof Integer) {
convertedValue = (Integer) v;
} else if (v instanceof BigInteger) {
convertedValue = ((BigInteger) v).intValue();
} else {
throw new IllegalStateException("Expecting input data of type Integer or BigInteger.");
}
convertedData[i] = convertedValue;
}
for (int value : convertedData) {
ys.put(value, value);
assert ys.containsKey(value);
}
return measureAndReport(ys, "gnu.trove.map.hash.TIntIntHashMap", BenchmarkUtils.DataType.MAP,
BenchmarkUtils.Archetype.MUTABLE, false, elementCount, run, preset);
}
private static String measureAndReport(final Object objectToMeasure, final String className,
BenchmarkUtils.DataType dataType, BenchmarkUtils.Archetype archetype, boolean supportsStagedMutability, int size, int run,
FootprintUtils.MemoryFootprintPreset preset) {
final Predicate<Object> predicate;
switch (preset) {
case DATA_STRUCTURE_OVERHEAD:
// TODO: create JmhLeaf
// predicate = Predicates
// .not(Predicates.or(Predicates.instanceOf(Integer.class),
// Predicates.instanceOf(BigInteger.class),
// Predicates.instanceOf(JmhValue.class), Predicates.instanceOf(PureInteger.class)));
predicate = Predicates.not(Predicates.or(Predicates.instanceOf(PureInteger.class),
Predicates.instanceOf(PureIntegerWithCustomHashCode.class)));
break;
case RETAINED_SIZE:
predicate = Predicates.alwaysTrue();
break;
case RETAINED_SIZE_WITH_BOXED_INTEGER_FILTER:
predicate = Predicates.not(Predicates.instanceOf(Integer.class));
break;
default:
throw new IllegalStateException();
}
return measureAndReport(objectToMeasure, className, dataType, archetype,
supportsStagedMutability, size, run, predicate);
}
private static String measureAndReport(final Object objectToMeasure, final String className,
BenchmarkUtils.DataType dataType, BenchmarkUtils.Archetype archetype, boolean supportsStagedMutability, int size, int run) {
return measureAndReport(objectToMeasure, className, dataType, archetype,
supportsStagedMutability, size, run, FootprintUtils.MemoryFootprintPreset.DATA_STRUCTURE_OVERHEAD);
}
private static String measureAndReport(final Object objectToMeasure, final String className,
BenchmarkUtils.DataType dataType, BenchmarkUtils.Archetype archetype, boolean supportsStagedMutability, int size, int run,
Predicate<Object> predicate) {
// System.out.println(GraphLayout.parseInstance(objectToMeasure).totalSize());
long memoryInBytes = objectexplorer.MemoryMeasurer.measureBytes(objectToMeasure, predicate);
Footprint memoryFootprint =
objectexplorer.ObjectGraphMeasurer.measure(objectToMeasure, predicate);
final String statString = String.format("%d (%d@%d)\t %60s\t\t %s", size, run, memoryInBytes,
className, memoryFootprint);
System.out.println(statString);
// final String statLatexString = String.format("%s & %s & %s & %b & %d
// & %d & %d & \"%s\" \\\\", className, dataType, archetype,
// supportsStagedMutability, memoryInBytes,
// memoryFootprint.getObjects(), memoryFootprint.getReferences(),
// memoryFootprint.getPrimitives());
// System.out.println(statLatexString);
final String statFileString = String.format("%d,%d,%s,%s,%s,%b,%d,%d,%d", size, run, className,
dataType, archetype, supportsStagedMutability, memoryInBytes, memoryFootprint.getObjects(),
memoryFootprint.getReferences());
return statFileString;
// writeToFile(statFileString);
}
}
|
201888_0 | package be.vives.ti.dndweapons.controllers;
import be.vives.ti.dndweapons.domain.Weapon;
import be.vives.ti.dndweapons.domain.WeaponAttack;
import be.vives.ti.dndweapons.exceptions.ResourceNotFoundException;
import be.vives.ti.dndweapons.repository.WeaponAttackRepository;
import be.vives.ti.dndweapons.repository.WeaponRepository;
import be.vives.ti.dndweapons.requests.WeaponAttackRequest;
import be.vives.ti.dndweapons.requests.WeaponRequest;
import be.vives.ti.dndweapons.responses.WeaponListResponse;
import be.vives.ti.dndweapons.responses.WeaponResponse;
import be.vives.ti.dndweapons.responses.WeaponWithPropertiesResponse;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.media.ArraySchema;
import io.swagger.v3.oas.annotations.media.Content;
import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import io.swagger.v3.oas.annotations.responses.ApiResponses;
import jakarta.validation.Valid;
import org.springframework.dao.EmptyResultDataAccessException;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.servlet.support.ServletUriComponentsBuilder;
import java.net.URI;
import java.util.List;
@RestController
@RequestMapping("/weapons")
@CrossOrigin("*")
public class WeaponController {
private final WeaponRepository weaponRepository;
private final WeaponAttackRepository weaponAttackRepository;
public WeaponController(WeaponRepository weaponRepository, WeaponAttackRepository weaponAttackRepository) {
this.weaponRepository = weaponRepository;
this.weaponAttackRepository = weaponAttackRepository;
}
@Operation(summary = "Get all weapons", description = "Returns a list with all weapons")
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "Successfully retrieved the list of weapons",
content = { @Content(mediaType = "application/json",
array = @ArraySchema(schema = @Schema(implementation = WeaponListResponse.class))) })
})
@GetMapping
public List<WeaponListResponse> findAllWeapons(){
return weaponRepository.findAll().stream().map(WeaponListResponse::new).toList();
}
@Operation(summary = "Get all weapons containing query", description = "Returns a list with all weapons where the name contains the query")
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "Successfully retrieved the list of weapons",
content = { @Content(mediaType = "application/json",
array = @ArraySchema(schema = @Schema(implementation = WeaponListResponse.class))) })
})
@GetMapping("/search")
public List<WeaponListResponse> findByNameContainingIgnoreCase(@RequestParam("query") String query) {
return weaponRepository.findByNameContainingIgnoreCase(query).stream().map(WeaponListResponse::new).toList();
}
@Operation(summary = "Find weapon by id", description = "Returns one weapon with all its details by id")
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "Found the weapon",
content = { @Content(mediaType = "application/json",
schema = @Schema(implementation = WeaponResponse.class)) }),
@ApiResponse(responseCode = "400", description = "Invalid id",
content = @Content),
@ApiResponse(responseCode = "404", description = "Weapon not found",
content = @Content)
})
@GetMapping("/{weaponId}")
public WeaponResponse retrieveWeaponById(@PathVariable(name = "weaponId") Long weaponId) {
return new WeaponResponse(
weaponRepository.findById(weaponId).orElseThrow(() -> new ResourceNotFoundException(weaponId.toString(), "weapon"))
);
}
@Operation(summary = "Find the properties of a weapon", description = "Returns the properties with description of one weapon by id")
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "Found the weapon",
content = { @Content(mediaType = "application/json",
schema = @Schema(implementation = WeaponWithPropertiesResponse.class)) }),
@ApiResponse(responseCode = "400", description = "Invalid id",
content = @Content),
@ApiResponse(responseCode = "404", description = "Weapon not found",
content = @Content)
})
@GetMapping("/{weaponId}/properties")
public WeaponWithPropertiesResponse retrieveWeaponByIdWithProperties(@PathVariable(name = "weaponId") Long weaponId) {
return new WeaponWithPropertiesResponse(weaponRepository.findById(weaponId).orElseThrow(() -> new ResourceNotFoundException(weaponId.toString(), "weapon")));
}
@Operation(summary = "Add new weapon", description = "Add new weapon")
@ApiResponses(value = {
@ApiResponse(responseCode = "201", description = "Weapon created",
content = @Content),
@ApiResponse(responseCode = "400", description = "Invalid input",
content = @Content)
})
@PostMapping
@ResponseStatus(HttpStatus.CREATED)
public ResponseEntity<Object> createWeapon(@RequestBody @Valid WeaponRequest weaponRequest) {
Weapon newWeapon = new Weapon(
weaponRequest.getName(),
weaponRequest.getCost(),
weaponRequest.getRarity(),
weaponRequest.getDamageModifier(),
weaponRequest.getWeight(),
weaponRequest.getProperties(),
weaponRequest.getWeaponType(),
weaponRequest.isMartial()
);
Weapon weapon = weaponRepository.save(newWeapon);
URI location = ServletUriComponentsBuilder.fromCurrentRequest()
.path("/{id}")
.buildAndExpand(weapon.getId())
.toUri();
return ResponseEntity.created(location).build();
}
@Operation(summary = "Update existing weapon", description = "Update existing weapon by id")
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "Weapon updated",
content = { @Content(mediaType = "application/json",
schema = @Schema(implementation = WeaponResponse.class)) }),
@ApiResponse(responseCode = "400", description = "Invalid input",
content = @Content),
@ApiResponse(responseCode = "404", description = "Weapon not found",
content = @Content)
})
@PutMapping("/{weaponId}")
public WeaponResponse putWeapon(@PathVariable(name = "weaponId") Long weaponId,
@RequestBody @Valid WeaponRequest weaponRequest) {
Weapon weapon = weaponRepository.findById(Long.parseLong(weaponId.toString())).orElseThrow(
() -> new ResourceNotFoundException(weaponId.toString(), "weapon")
);
weapon.setName(weaponRequest.getName());
weapon.setCost(weaponRequest.getCost());
weapon.setRarity(weaponRequest.getRarity());
weapon.setDamageModifier(weaponRequest.getDamageModifier());
weapon.setWeight(weaponRequest.getWeight());
weapon.setProperties(weaponRequest.getProperties());
weapon.setWeaponType(weaponRequest.getWeaponType());
weapon.setMartial(weaponRequest.isMartial());
return new WeaponResponse(weaponRepository.save(weapon));
}
@Operation(summary = "Delete weapon", description = "Delete weapon and its weapon-attacks by id")
@ApiResponses(value = {
@ApiResponse(responseCode = "204", description = "Weapon deleted",
content = @Content),
@ApiResponse(responseCode = "404", description = "Weapon not found",
content = @Content)
})
@DeleteMapping("/{weaponId}")
@ResponseStatus(HttpStatus.NO_CONTENT)
public void deleteWeapon(@PathVariable(name = "weaponId") Long weaponId) {
weaponRepository.findById(weaponId).orElseThrow(() -> new ResourceNotFoundException(weaponId.toString(), "weapon"));
try {
weaponRepository.deleteById(weaponId);
} catch (EmptyResultDataAccessException e) {
// als het niet bestaat dan hoefde het niet verwijderd te worden
}
}
@Operation(summary = "Add new weapon-attack", description = "Add new weapon-attack to existing weapon")
@ApiResponses(value = {
@ApiResponse(responseCode = "201", description = "Weapon-attack created",
content = @Content),
@ApiResponse(responseCode = "400", description = "Invalid input",
content = @Content),
@ApiResponse(responseCode = "404", description = "Weapon not found",
content = @Content)
})
@PostMapping("/{weaponId}/weapon-attacks")
@ResponseStatus(HttpStatus.CREATED)
public ResponseEntity<Object> addAttackToWeapon(@PathVariable(name = "weaponId") Long weaponId, @RequestBody @Valid WeaponAttackRequest weaponAttackRequest) {
WeaponAttack newWeaponAttack = new WeaponAttack(
weaponAttackRequest.getName(),
weaponAttackRequest.getDamageRolls(),
weaponAttackRequest.getRange()
);
WeaponAttack weaponAttack = weaponAttackRepository.save(newWeaponAttack);
Weapon weapon = weaponRepository.findById(weaponId)
.orElseThrow(() -> new ResourceNotFoundException(weaponId.toString(), "weapon"));
weapon.addAttack(weaponAttack);
weaponRepository.save(weapon);
URI location = ServletUriComponentsBuilder.fromCurrentContextPath()
.path("/weapons/{id}/weapon-attacks")
.buildAndExpand(weaponAttack.getId())
.toUri();
return ResponseEntity.created(location).build();
}
@Operation(summary = "Delete weapon", description = "Delete weapon-attack by id")
@ApiResponses(value = {
@ApiResponse(responseCode = "204", description = "Weapon attack deleted",
content = @Content),
@ApiResponse(responseCode = "404", description = "Weapon not found",
content = @Content)
})
@DeleteMapping("/weapon-attacks/{weaponAttackId}")
@ResponseStatus(HttpStatus.NO_CONTENT)
public void deleteAttackOfWeapon(@PathVariable(name = "weaponAttackId") Long weaponAttackId) {
try {
weaponAttackRepository.deleteById(weaponAttackId);
} catch (EmptyResultDataAccessException e) {
// als het niet bestaat dan hoefde het niet verwijderd te worden
}
}
}
| vanhaverbekejitse/dnd-weapons | src/main/java/be/vives/ti/dndweapons/controllers/WeaponController.java | 2,486 | // als het niet bestaat dan hoefde het niet verwijderd te worden | line_comment | nl | package be.vives.ti.dndweapons.controllers;
import be.vives.ti.dndweapons.domain.Weapon;
import be.vives.ti.dndweapons.domain.WeaponAttack;
import be.vives.ti.dndweapons.exceptions.ResourceNotFoundException;
import be.vives.ti.dndweapons.repository.WeaponAttackRepository;
import be.vives.ti.dndweapons.repository.WeaponRepository;
import be.vives.ti.dndweapons.requests.WeaponAttackRequest;
import be.vives.ti.dndweapons.requests.WeaponRequest;
import be.vives.ti.dndweapons.responses.WeaponListResponse;
import be.vives.ti.dndweapons.responses.WeaponResponse;
import be.vives.ti.dndweapons.responses.WeaponWithPropertiesResponse;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.media.ArraySchema;
import io.swagger.v3.oas.annotations.media.Content;
import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import io.swagger.v3.oas.annotations.responses.ApiResponses;
import jakarta.validation.Valid;
import org.springframework.dao.EmptyResultDataAccessException;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.servlet.support.ServletUriComponentsBuilder;
import java.net.URI;
import java.util.List;
@RestController
@RequestMapping("/weapons")
@CrossOrigin("*")
public class WeaponController {
private final WeaponRepository weaponRepository;
private final WeaponAttackRepository weaponAttackRepository;
public WeaponController(WeaponRepository weaponRepository, WeaponAttackRepository weaponAttackRepository) {
this.weaponRepository = weaponRepository;
this.weaponAttackRepository = weaponAttackRepository;
}
@Operation(summary = "Get all weapons", description = "Returns a list with all weapons")
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "Successfully retrieved the list of weapons",
content = { @Content(mediaType = "application/json",
array = @ArraySchema(schema = @Schema(implementation = WeaponListResponse.class))) })
})
@GetMapping
public List<WeaponListResponse> findAllWeapons(){
return weaponRepository.findAll().stream().map(WeaponListResponse::new).toList();
}
@Operation(summary = "Get all weapons containing query", description = "Returns a list with all weapons where the name contains the query")
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "Successfully retrieved the list of weapons",
content = { @Content(mediaType = "application/json",
array = @ArraySchema(schema = @Schema(implementation = WeaponListResponse.class))) })
})
@GetMapping("/search")
public List<WeaponListResponse> findByNameContainingIgnoreCase(@RequestParam("query") String query) {
return weaponRepository.findByNameContainingIgnoreCase(query).stream().map(WeaponListResponse::new).toList();
}
@Operation(summary = "Find weapon by id", description = "Returns one weapon with all its details by id")
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "Found the weapon",
content = { @Content(mediaType = "application/json",
schema = @Schema(implementation = WeaponResponse.class)) }),
@ApiResponse(responseCode = "400", description = "Invalid id",
content = @Content),
@ApiResponse(responseCode = "404", description = "Weapon not found",
content = @Content)
})
@GetMapping("/{weaponId}")
public WeaponResponse retrieveWeaponById(@PathVariable(name = "weaponId") Long weaponId) {
return new WeaponResponse(
weaponRepository.findById(weaponId).orElseThrow(() -> new ResourceNotFoundException(weaponId.toString(), "weapon"))
);
}
@Operation(summary = "Find the properties of a weapon", description = "Returns the properties with description of one weapon by id")
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "Found the weapon",
content = { @Content(mediaType = "application/json",
schema = @Schema(implementation = WeaponWithPropertiesResponse.class)) }),
@ApiResponse(responseCode = "400", description = "Invalid id",
content = @Content),
@ApiResponse(responseCode = "404", description = "Weapon not found",
content = @Content)
})
@GetMapping("/{weaponId}/properties")
public WeaponWithPropertiesResponse retrieveWeaponByIdWithProperties(@PathVariable(name = "weaponId") Long weaponId) {
return new WeaponWithPropertiesResponse(weaponRepository.findById(weaponId).orElseThrow(() -> new ResourceNotFoundException(weaponId.toString(), "weapon")));
}
@Operation(summary = "Add new weapon", description = "Add new weapon")
@ApiResponses(value = {
@ApiResponse(responseCode = "201", description = "Weapon created",
content = @Content),
@ApiResponse(responseCode = "400", description = "Invalid input",
content = @Content)
})
@PostMapping
@ResponseStatus(HttpStatus.CREATED)
public ResponseEntity<Object> createWeapon(@RequestBody @Valid WeaponRequest weaponRequest) {
Weapon newWeapon = new Weapon(
weaponRequest.getName(),
weaponRequest.getCost(),
weaponRequest.getRarity(),
weaponRequest.getDamageModifier(),
weaponRequest.getWeight(),
weaponRequest.getProperties(),
weaponRequest.getWeaponType(),
weaponRequest.isMartial()
);
Weapon weapon = weaponRepository.save(newWeapon);
URI location = ServletUriComponentsBuilder.fromCurrentRequest()
.path("/{id}")
.buildAndExpand(weapon.getId())
.toUri();
return ResponseEntity.created(location).build();
}
@Operation(summary = "Update existing weapon", description = "Update existing weapon by id")
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "Weapon updated",
content = { @Content(mediaType = "application/json",
schema = @Schema(implementation = WeaponResponse.class)) }),
@ApiResponse(responseCode = "400", description = "Invalid input",
content = @Content),
@ApiResponse(responseCode = "404", description = "Weapon not found",
content = @Content)
})
@PutMapping("/{weaponId}")
public WeaponResponse putWeapon(@PathVariable(name = "weaponId") Long weaponId,
@RequestBody @Valid WeaponRequest weaponRequest) {
Weapon weapon = weaponRepository.findById(Long.parseLong(weaponId.toString())).orElseThrow(
() -> new ResourceNotFoundException(weaponId.toString(), "weapon")
);
weapon.setName(weaponRequest.getName());
weapon.setCost(weaponRequest.getCost());
weapon.setRarity(weaponRequest.getRarity());
weapon.setDamageModifier(weaponRequest.getDamageModifier());
weapon.setWeight(weaponRequest.getWeight());
weapon.setProperties(weaponRequest.getProperties());
weapon.setWeaponType(weaponRequest.getWeaponType());
weapon.setMartial(weaponRequest.isMartial());
return new WeaponResponse(weaponRepository.save(weapon));
}
@Operation(summary = "Delete weapon", description = "Delete weapon and its weapon-attacks by id")
@ApiResponses(value = {
@ApiResponse(responseCode = "204", description = "Weapon deleted",
content = @Content),
@ApiResponse(responseCode = "404", description = "Weapon not found",
content = @Content)
})
@DeleteMapping("/{weaponId}")
@ResponseStatus(HttpStatus.NO_CONTENT)
public void deleteWeapon(@PathVariable(name = "weaponId") Long weaponId) {
weaponRepository.findById(weaponId).orElseThrow(() -> new ResourceNotFoundException(weaponId.toString(), "weapon"));
try {
weaponRepository.deleteById(weaponId);
} catch (EmptyResultDataAccessException e) {
// als het<SUF>
}
}
@Operation(summary = "Add new weapon-attack", description = "Add new weapon-attack to existing weapon")
@ApiResponses(value = {
@ApiResponse(responseCode = "201", description = "Weapon-attack created",
content = @Content),
@ApiResponse(responseCode = "400", description = "Invalid input",
content = @Content),
@ApiResponse(responseCode = "404", description = "Weapon not found",
content = @Content)
})
@PostMapping("/{weaponId}/weapon-attacks")
@ResponseStatus(HttpStatus.CREATED)
public ResponseEntity<Object> addAttackToWeapon(@PathVariable(name = "weaponId") Long weaponId, @RequestBody @Valid WeaponAttackRequest weaponAttackRequest) {
WeaponAttack newWeaponAttack = new WeaponAttack(
weaponAttackRequest.getName(),
weaponAttackRequest.getDamageRolls(),
weaponAttackRequest.getRange()
);
WeaponAttack weaponAttack = weaponAttackRepository.save(newWeaponAttack);
Weapon weapon = weaponRepository.findById(weaponId)
.orElseThrow(() -> new ResourceNotFoundException(weaponId.toString(), "weapon"));
weapon.addAttack(weaponAttack);
weaponRepository.save(weapon);
URI location = ServletUriComponentsBuilder.fromCurrentContextPath()
.path("/weapons/{id}/weapon-attacks")
.buildAndExpand(weaponAttack.getId())
.toUri();
return ResponseEntity.created(location).build();
}
@Operation(summary = "Delete weapon", description = "Delete weapon-attack by id")
@ApiResponses(value = {
@ApiResponse(responseCode = "204", description = "Weapon attack deleted",
content = @Content),
@ApiResponse(responseCode = "404", description = "Weapon not found",
content = @Content)
})
@DeleteMapping("/weapon-attacks/{weaponAttackId}")
@ResponseStatus(HttpStatus.NO_CONTENT)
public void deleteAttackOfWeapon(@PathVariable(name = "weaponAttackId") Long weaponAttackId) {
try {
weaponAttackRepository.deleteById(weaponAttackId);
} catch (EmptyResultDataAccessException e) {
// als het niet bestaat dan hoefde het niet verwijderd te worden
}
}
}
|
201888_1 | package be.vives.ti.dndweapons.controllers;
import be.vives.ti.dndweapons.domain.Weapon;
import be.vives.ti.dndweapons.domain.WeaponAttack;
import be.vives.ti.dndweapons.exceptions.ResourceNotFoundException;
import be.vives.ti.dndweapons.repository.WeaponAttackRepository;
import be.vives.ti.dndweapons.repository.WeaponRepository;
import be.vives.ti.dndweapons.requests.WeaponAttackRequest;
import be.vives.ti.dndweapons.requests.WeaponRequest;
import be.vives.ti.dndweapons.responses.WeaponListResponse;
import be.vives.ti.dndweapons.responses.WeaponResponse;
import be.vives.ti.dndweapons.responses.WeaponWithPropertiesResponse;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.media.ArraySchema;
import io.swagger.v3.oas.annotations.media.Content;
import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import io.swagger.v3.oas.annotations.responses.ApiResponses;
import jakarta.validation.Valid;
import org.springframework.dao.EmptyResultDataAccessException;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.servlet.support.ServletUriComponentsBuilder;
import java.net.URI;
import java.util.List;
@RestController
@RequestMapping("/weapons")
@CrossOrigin("*")
public class WeaponController {
private final WeaponRepository weaponRepository;
private final WeaponAttackRepository weaponAttackRepository;
public WeaponController(WeaponRepository weaponRepository, WeaponAttackRepository weaponAttackRepository) {
this.weaponRepository = weaponRepository;
this.weaponAttackRepository = weaponAttackRepository;
}
@Operation(summary = "Get all weapons", description = "Returns a list with all weapons")
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "Successfully retrieved the list of weapons",
content = { @Content(mediaType = "application/json",
array = @ArraySchema(schema = @Schema(implementation = WeaponListResponse.class))) })
})
@GetMapping
public List<WeaponListResponse> findAllWeapons(){
return weaponRepository.findAll().stream().map(WeaponListResponse::new).toList();
}
@Operation(summary = "Get all weapons containing query", description = "Returns a list with all weapons where the name contains the query")
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "Successfully retrieved the list of weapons",
content = { @Content(mediaType = "application/json",
array = @ArraySchema(schema = @Schema(implementation = WeaponListResponse.class))) })
})
@GetMapping("/search")
public List<WeaponListResponse> findByNameContainingIgnoreCase(@RequestParam("query") String query) {
return weaponRepository.findByNameContainingIgnoreCase(query).stream().map(WeaponListResponse::new).toList();
}
@Operation(summary = "Find weapon by id", description = "Returns one weapon with all its details by id")
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "Found the weapon",
content = { @Content(mediaType = "application/json",
schema = @Schema(implementation = WeaponResponse.class)) }),
@ApiResponse(responseCode = "400", description = "Invalid id",
content = @Content),
@ApiResponse(responseCode = "404", description = "Weapon not found",
content = @Content)
})
@GetMapping("/{weaponId}")
public WeaponResponse retrieveWeaponById(@PathVariable(name = "weaponId") Long weaponId) {
return new WeaponResponse(
weaponRepository.findById(weaponId).orElseThrow(() -> new ResourceNotFoundException(weaponId.toString(), "weapon"))
);
}
@Operation(summary = "Find the properties of a weapon", description = "Returns the properties with description of one weapon by id")
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "Found the weapon",
content = { @Content(mediaType = "application/json",
schema = @Schema(implementation = WeaponWithPropertiesResponse.class)) }),
@ApiResponse(responseCode = "400", description = "Invalid id",
content = @Content),
@ApiResponse(responseCode = "404", description = "Weapon not found",
content = @Content)
})
@GetMapping("/{weaponId}/properties")
public WeaponWithPropertiesResponse retrieveWeaponByIdWithProperties(@PathVariable(name = "weaponId") Long weaponId) {
return new WeaponWithPropertiesResponse(weaponRepository.findById(weaponId).orElseThrow(() -> new ResourceNotFoundException(weaponId.toString(), "weapon")));
}
@Operation(summary = "Add new weapon", description = "Add new weapon")
@ApiResponses(value = {
@ApiResponse(responseCode = "201", description = "Weapon created",
content = @Content),
@ApiResponse(responseCode = "400", description = "Invalid input",
content = @Content)
})
@PostMapping
@ResponseStatus(HttpStatus.CREATED)
public ResponseEntity<Object> createWeapon(@RequestBody @Valid WeaponRequest weaponRequest) {
Weapon newWeapon = new Weapon(
weaponRequest.getName(),
weaponRequest.getCost(),
weaponRequest.getRarity(),
weaponRequest.getDamageModifier(),
weaponRequest.getWeight(),
weaponRequest.getProperties(),
weaponRequest.getWeaponType(),
weaponRequest.isMartial()
);
Weapon weapon = weaponRepository.save(newWeapon);
URI location = ServletUriComponentsBuilder.fromCurrentRequest()
.path("/{id}")
.buildAndExpand(weapon.getId())
.toUri();
return ResponseEntity.created(location).build();
}
@Operation(summary = "Update existing weapon", description = "Update existing weapon by id")
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "Weapon updated",
content = { @Content(mediaType = "application/json",
schema = @Schema(implementation = WeaponResponse.class)) }),
@ApiResponse(responseCode = "400", description = "Invalid input",
content = @Content),
@ApiResponse(responseCode = "404", description = "Weapon not found",
content = @Content)
})
@PutMapping("/{weaponId}")
public WeaponResponse putWeapon(@PathVariable(name = "weaponId") Long weaponId,
@RequestBody @Valid WeaponRequest weaponRequest) {
Weapon weapon = weaponRepository.findById(Long.parseLong(weaponId.toString())).orElseThrow(
() -> new ResourceNotFoundException(weaponId.toString(), "weapon")
);
weapon.setName(weaponRequest.getName());
weapon.setCost(weaponRequest.getCost());
weapon.setRarity(weaponRequest.getRarity());
weapon.setDamageModifier(weaponRequest.getDamageModifier());
weapon.setWeight(weaponRequest.getWeight());
weapon.setProperties(weaponRequest.getProperties());
weapon.setWeaponType(weaponRequest.getWeaponType());
weapon.setMartial(weaponRequest.isMartial());
return new WeaponResponse(weaponRepository.save(weapon));
}
@Operation(summary = "Delete weapon", description = "Delete weapon and its weapon-attacks by id")
@ApiResponses(value = {
@ApiResponse(responseCode = "204", description = "Weapon deleted",
content = @Content),
@ApiResponse(responseCode = "404", description = "Weapon not found",
content = @Content)
})
@DeleteMapping("/{weaponId}")
@ResponseStatus(HttpStatus.NO_CONTENT)
public void deleteWeapon(@PathVariable(name = "weaponId") Long weaponId) {
weaponRepository.findById(weaponId).orElseThrow(() -> new ResourceNotFoundException(weaponId.toString(), "weapon"));
try {
weaponRepository.deleteById(weaponId);
} catch (EmptyResultDataAccessException e) {
// als het niet bestaat dan hoefde het niet verwijderd te worden
}
}
@Operation(summary = "Add new weapon-attack", description = "Add new weapon-attack to existing weapon")
@ApiResponses(value = {
@ApiResponse(responseCode = "201", description = "Weapon-attack created",
content = @Content),
@ApiResponse(responseCode = "400", description = "Invalid input",
content = @Content),
@ApiResponse(responseCode = "404", description = "Weapon not found",
content = @Content)
})
@PostMapping("/{weaponId}/weapon-attacks")
@ResponseStatus(HttpStatus.CREATED)
public ResponseEntity<Object> addAttackToWeapon(@PathVariable(name = "weaponId") Long weaponId, @RequestBody @Valid WeaponAttackRequest weaponAttackRequest) {
WeaponAttack newWeaponAttack = new WeaponAttack(
weaponAttackRequest.getName(),
weaponAttackRequest.getDamageRolls(),
weaponAttackRequest.getRange()
);
WeaponAttack weaponAttack = weaponAttackRepository.save(newWeaponAttack);
Weapon weapon = weaponRepository.findById(weaponId)
.orElseThrow(() -> new ResourceNotFoundException(weaponId.toString(), "weapon"));
weapon.addAttack(weaponAttack);
weaponRepository.save(weapon);
URI location = ServletUriComponentsBuilder.fromCurrentContextPath()
.path("/weapons/{id}/weapon-attacks")
.buildAndExpand(weaponAttack.getId())
.toUri();
return ResponseEntity.created(location).build();
}
@Operation(summary = "Delete weapon", description = "Delete weapon-attack by id")
@ApiResponses(value = {
@ApiResponse(responseCode = "204", description = "Weapon attack deleted",
content = @Content),
@ApiResponse(responseCode = "404", description = "Weapon not found",
content = @Content)
})
@DeleteMapping("/weapon-attacks/{weaponAttackId}")
@ResponseStatus(HttpStatus.NO_CONTENT)
public void deleteAttackOfWeapon(@PathVariable(name = "weaponAttackId") Long weaponAttackId) {
try {
weaponAttackRepository.deleteById(weaponAttackId);
} catch (EmptyResultDataAccessException e) {
// als het niet bestaat dan hoefde het niet verwijderd te worden
}
}
}
| vanhaverbekejitse/dnd-weapons | src/main/java/be/vives/ti/dndweapons/controllers/WeaponController.java | 2,486 | // als het niet bestaat dan hoefde het niet verwijderd te worden | line_comment | nl | package be.vives.ti.dndweapons.controllers;
import be.vives.ti.dndweapons.domain.Weapon;
import be.vives.ti.dndweapons.domain.WeaponAttack;
import be.vives.ti.dndweapons.exceptions.ResourceNotFoundException;
import be.vives.ti.dndweapons.repository.WeaponAttackRepository;
import be.vives.ti.dndweapons.repository.WeaponRepository;
import be.vives.ti.dndweapons.requests.WeaponAttackRequest;
import be.vives.ti.dndweapons.requests.WeaponRequest;
import be.vives.ti.dndweapons.responses.WeaponListResponse;
import be.vives.ti.dndweapons.responses.WeaponResponse;
import be.vives.ti.dndweapons.responses.WeaponWithPropertiesResponse;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.media.ArraySchema;
import io.swagger.v3.oas.annotations.media.Content;
import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import io.swagger.v3.oas.annotations.responses.ApiResponses;
import jakarta.validation.Valid;
import org.springframework.dao.EmptyResultDataAccessException;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.servlet.support.ServletUriComponentsBuilder;
import java.net.URI;
import java.util.List;
@RestController
@RequestMapping("/weapons")
@CrossOrigin("*")
public class WeaponController {
private final WeaponRepository weaponRepository;
private final WeaponAttackRepository weaponAttackRepository;
public WeaponController(WeaponRepository weaponRepository, WeaponAttackRepository weaponAttackRepository) {
this.weaponRepository = weaponRepository;
this.weaponAttackRepository = weaponAttackRepository;
}
@Operation(summary = "Get all weapons", description = "Returns a list with all weapons")
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "Successfully retrieved the list of weapons",
content = { @Content(mediaType = "application/json",
array = @ArraySchema(schema = @Schema(implementation = WeaponListResponse.class))) })
})
@GetMapping
public List<WeaponListResponse> findAllWeapons(){
return weaponRepository.findAll().stream().map(WeaponListResponse::new).toList();
}
@Operation(summary = "Get all weapons containing query", description = "Returns a list with all weapons where the name contains the query")
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "Successfully retrieved the list of weapons",
content = { @Content(mediaType = "application/json",
array = @ArraySchema(schema = @Schema(implementation = WeaponListResponse.class))) })
})
@GetMapping("/search")
public List<WeaponListResponse> findByNameContainingIgnoreCase(@RequestParam("query") String query) {
return weaponRepository.findByNameContainingIgnoreCase(query).stream().map(WeaponListResponse::new).toList();
}
@Operation(summary = "Find weapon by id", description = "Returns one weapon with all its details by id")
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "Found the weapon",
content = { @Content(mediaType = "application/json",
schema = @Schema(implementation = WeaponResponse.class)) }),
@ApiResponse(responseCode = "400", description = "Invalid id",
content = @Content),
@ApiResponse(responseCode = "404", description = "Weapon not found",
content = @Content)
})
@GetMapping("/{weaponId}")
public WeaponResponse retrieveWeaponById(@PathVariable(name = "weaponId") Long weaponId) {
return new WeaponResponse(
weaponRepository.findById(weaponId).orElseThrow(() -> new ResourceNotFoundException(weaponId.toString(), "weapon"))
);
}
@Operation(summary = "Find the properties of a weapon", description = "Returns the properties with description of one weapon by id")
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "Found the weapon",
content = { @Content(mediaType = "application/json",
schema = @Schema(implementation = WeaponWithPropertiesResponse.class)) }),
@ApiResponse(responseCode = "400", description = "Invalid id",
content = @Content),
@ApiResponse(responseCode = "404", description = "Weapon not found",
content = @Content)
})
@GetMapping("/{weaponId}/properties")
public WeaponWithPropertiesResponse retrieveWeaponByIdWithProperties(@PathVariable(name = "weaponId") Long weaponId) {
return new WeaponWithPropertiesResponse(weaponRepository.findById(weaponId).orElseThrow(() -> new ResourceNotFoundException(weaponId.toString(), "weapon")));
}
@Operation(summary = "Add new weapon", description = "Add new weapon")
@ApiResponses(value = {
@ApiResponse(responseCode = "201", description = "Weapon created",
content = @Content),
@ApiResponse(responseCode = "400", description = "Invalid input",
content = @Content)
})
@PostMapping
@ResponseStatus(HttpStatus.CREATED)
public ResponseEntity<Object> createWeapon(@RequestBody @Valid WeaponRequest weaponRequest) {
Weapon newWeapon = new Weapon(
weaponRequest.getName(),
weaponRequest.getCost(),
weaponRequest.getRarity(),
weaponRequest.getDamageModifier(),
weaponRequest.getWeight(),
weaponRequest.getProperties(),
weaponRequest.getWeaponType(),
weaponRequest.isMartial()
);
Weapon weapon = weaponRepository.save(newWeapon);
URI location = ServletUriComponentsBuilder.fromCurrentRequest()
.path("/{id}")
.buildAndExpand(weapon.getId())
.toUri();
return ResponseEntity.created(location).build();
}
@Operation(summary = "Update existing weapon", description = "Update existing weapon by id")
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "Weapon updated",
content = { @Content(mediaType = "application/json",
schema = @Schema(implementation = WeaponResponse.class)) }),
@ApiResponse(responseCode = "400", description = "Invalid input",
content = @Content),
@ApiResponse(responseCode = "404", description = "Weapon not found",
content = @Content)
})
@PutMapping("/{weaponId}")
public WeaponResponse putWeapon(@PathVariable(name = "weaponId") Long weaponId,
@RequestBody @Valid WeaponRequest weaponRequest) {
Weapon weapon = weaponRepository.findById(Long.parseLong(weaponId.toString())).orElseThrow(
() -> new ResourceNotFoundException(weaponId.toString(), "weapon")
);
weapon.setName(weaponRequest.getName());
weapon.setCost(weaponRequest.getCost());
weapon.setRarity(weaponRequest.getRarity());
weapon.setDamageModifier(weaponRequest.getDamageModifier());
weapon.setWeight(weaponRequest.getWeight());
weapon.setProperties(weaponRequest.getProperties());
weapon.setWeaponType(weaponRequest.getWeaponType());
weapon.setMartial(weaponRequest.isMartial());
return new WeaponResponse(weaponRepository.save(weapon));
}
@Operation(summary = "Delete weapon", description = "Delete weapon and its weapon-attacks by id")
@ApiResponses(value = {
@ApiResponse(responseCode = "204", description = "Weapon deleted",
content = @Content),
@ApiResponse(responseCode = "404", description = "Weapon not found",
content = @Content)
})
@DeleteMapping("/{weaponId}")
@ResponseStatus(HttpStatus.NO_CONTENT)
public void deleteWeapon(@PathVariable(name = "weaponId") Long weaponId) {
weaponRepository.findById(weaponId).orElseThrow(() -> new ResourceNotFoundException(weaponId.toString(), "weapon"));
try {
weaponRepository.deleteById(weaponId);
} catch (EmptyResultDataAccessException e) {
// als het niet bestaat dan hoefde het niet verwijderd te worden
}
}
@Operation(summary = "Add new weapon-attack", description = "Add new weapon-attack to existing weapon")
@ApiResponses(value = {
@ApiResponse(responseCode = "201", description = "Weapon-attack created",
content = @Content),
@ApiResponse(responseCode = "400", description = "Invalid input",
content = @Content),
@ApiResponse(responseCode = "404", description = "Weapon not found",
content = @Content)
})
@PostMapping("/{weaponId}/weapon-attacks")
@ResponseStatus(HttpStatus.CREATED)
public ResponseEntity<Object> addAttackToWeapon(@PathVariable(name = "weaponId") Long weaponId, @RequestBody @Valid WeaponAttackRequest weaponAttackRequest) {
WeaponAttack newWeaponAttack = new WeaponAttack(
weaponAttackRequest.getName(),
weaponAttackRequest.getDamageRolls(),
weaponAttackRequest.getRange()
);
WeaponAttack weaponAttack = weaponAttackRepository.save(newWeaponAttack);
Weapon weapon = weaponRepository.findById(weaponId)
.orElseThrow(() -> new ResourceNotFoundException(weaponId.toString(), "weapon"));
weapon.addAttack(weaponAttack);
weaponRepository.save(weapon);
URI location = ServletUriComponentsBuilder.fromCurrentContextPath()
.path("/weapons/{id}/weapon-attacks")
.buildAndExpand(weaponAttack.getId())
.toUri();
return ResponseEntity.created(location).build();
}
@Operation(summary = "Delete weapon", description = "Delete weapon-attack by id")
@ApiResponses(value = {
@ApiResponse(responseCode = "204", description = "Weapon attack deleted",
content = @Content),
@ApiResponse(responseCode = "404", description = "Weapon not found",
content = @Content)
})
@DeleteMapping("/weapon-attacks/{weaponAttackId}")
@ResponseStatus(HttpStatus.NO_CONTENT)
public void deleteAttackOfWeapon(@PathVariable(name = "weaponAttackId") Long weaponAttackId) {
try {
weaponAttackRepository.deleteById(weaponAttackId);
} catch (EmptyResultDataAccessException e) {
// als het<SUF>
}
}
}
|
201892_0 | package be.vives.ti.dndweapons.controllers;
import be.vives.ti.dndweapons.domain.Attack;
import be.vives.ti.dndweapons.exceptions.ResourceNotFoundException;
import be.vives.ti.dndweapons.repository.AttackRepository;
import be.vives.ti.dndweapons.requests.AttackRequest;
import be.vives.ti.dndweapons.responses.AttackResponse;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.media.ArraySchema;
import io.swagger.v3.oas.annotations.media.Content;
import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import io.swagger.v3.oas.annotations.responses.ApiResponses;
import jakarta.validation.Valid;
import org.springframework.dao.EmptyResultDataAccessException;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.servlet.support.ServletUriComponentsBuilder;
import java.net.URI;
import java.util.List;
@RestController
@RequestMapping("/attacks")
@CrossOrigin("*")
public class AttackController {
private final AttackRepository attackRepository;
public AttackController(AttackRepository attackRepository) {
this.attackRepository = attackRepository;
}
@Operation(summary = "Get all attacks", description = "Returns a list with all attacks")
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "Successfully retrieved the list of attacks",
content = { @Content(mediaType = "application/json",
array = @ArraySchema(schema = @Schema(implementation = AttackResponse.class))) })
})
@GetMapping
public List<AttackResponse> findAllAttacks(){
return attackRepository.findAll().stream().map(AttackResponse::new).toList();
}
@Operation(summary = "Find attack by id", description = "Returns one attack by id")
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "Found the attack",
content = { @Content(mediaType = "application/json",
schema = @Schema(implementation = AttackResponse.class)) }),
@ApiResponse(responseCode = "400", description = "Invalid id",
content = @Content),
@ApiResponse(responseCode = "404", description = "Attack not found",
content = @Content)
})
@GetMapping("/{attackId}")
public AttackResponse retrieveAttackById(@PathVariable(name = "attackId") Long attackId) {
return new AttackResponse(
attackRepository.findById(attackId).orElseThrow(() -> new ResourceNotFoundException(attackId.toString(), "attack"))
);
}
@Operation(summary = "Add new attack", description = "Add new attack")
@ApiResponses(value = {
@ApiResponse(responseCode = "201", description = "Attack created",
content = @Content),
@ApiResponse(responseCode = "400", description = "Invalid input",
content = @Content)
})
@PostMapping
@ResponseStatus(HttpStatus.CREATED)
public ResponseEntity<Object> createAttack(@RequestBody @Valid AttackRequest attackRequest) {
Attack newAttack = new Attack(
attackRequest.getName(),
attackRequest.getDamageModifier(),
attackRequest.getAbilityType(),
attackRequest.getDamageRolls(),
attackRequest.getRange()
);
Attack attack = attackRepository.save(newAttack);
URI location = ServletUriComponentsBuilder.fromCurrentRequest()
.path("/{id}")
.buildAndExpand(attack.getId())
.toUri();
return ResponseEntity.created(location).build();
}
@Operation(summary = "Update existing attack", description = "Update existing attack by id")
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "Attack updated",
content = { @Content(mediaType = "application/json",
schema = @Schema(implementation = AttackResponse.class)) }),
@ApiResponse(responseCode = "400", description = "Invalid input",
content = @Content),
@ApiResponse(responseCode = "404", description = "Attack not found",
content = @Content)
})
@PutMapping("/{attackId}")
public AttackResponse putAttack(@PathVariable(name = "attackId") Long attackId,
@RequestBody @Valid AttackRequest attackRequest) {
Attack attack = attackRepository.findById(attackId).orElseThrow(
() -> new ResourceNotFoundException(attackId.toString(), "attack")
);
attack.setName(attackRequest.getName());
attack.setDamageModifier(attackRequest.getDamageModifier());
attack.setAbilityType(attackRequest.getAbilityType());
attack.setDamageRolls(attackRequest.getDamageRolls());
attack.setRange(attackRequest.getRange());
return new AttackResponse(attackRepository.save(attack));
}
@Operation(summary = "Delete attack", description = "Delete attack by id")
@ApiResponses(value = {
@ApiResponse(responseCode = "204", description = "Attack deleted",
content = @Content),
@ApiResponse(responseCode = "404", description = "Attack not found",
content = @Content)
})
@DeleteMapping("/{attackId}")
@ResponseStatus(HttpStatus.NO_CONTENT)
public void deleteAttack(@PathVariable(name = "attackId") Long attackId) {
attackRepository.findById(attackId).orElseThrow(() -> new ResourceNotFoundException(attackId.toString(), "attack"));
try {
attackRepository.deleteById(attackId);
} catch (EmptyResultDataAccessException e) {
// als het niet bestaat dan hoefde het niet verwijderd te worden
}
}
}
| vanhaverbekejitse/dnd-weapons | src/main/java/be/vives/ti/dndweapons/controllers/AttackController.java | 1,398 | // als het niet bestaat dan hoefde het niet verwijderd te worden | line_comment | nl | package be.vives.ti.dndweapons.controllers;
import be.vives.ti.dndweapons.domain.Attack;
import be.vives.ti.dndweapons.exceptions.ResourceNotFoundException;
import be.vives.ti.dndweapons.repository.AttackRepository;
import be.vives.ti.dndweapons.requests.AttackRequest;
import be.vives.ti.dndweapons.responses.AttackResponse;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.media.ArraySchema;
import io.swagger.v3.oas.annotations.media.Content;
import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import io.swagger.v3.oas.annotations.responses.ApiResponses;
import jakarta.validation.Valid;
import org.springframework.dao.EmptyResultDataAccessException;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.servlet.support.ServletUriComponentsBuilder;
import java.net.URI;
import java.util.List;
@RestController
@RequestMapping("/attacks")
@CrossOrigin("*")
public class AttackController {
private final AttackRepository attackRepository;
public AttackController(AttackRepository attackRepository) {
this.attackRepository = attackRepository;
}
@Operation(summary = "Get all attacks", description = "Returns a list with all attacks")
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "Successfully retrieved the list of attacks",
content = { @Content(mediaType = "application/json",
array = @ArraySchema(schema = @Schema(implementation = AttackResponse.class))) })
})
@GetMapping
public List<AttackResponse> findAllAttacks(){
return attackRepository.findAll().stream().map(AttackResponse::new).toList();
}
@Operation(summary = "Find attack by id", description = "Returns one attack by id")
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "Found the attack",
content = { @Content(mediaType = "application/json",
schema = @Schema(implementation = AttackResponse.class)) }),
@ApiResponse(responseCode = "400", description = "Invalid id",
content = @Content),
@ApiResponse(responseCode = "404", description = "Attack not found",
content = @Content)
})
@GetMapping("/{attackId}")
public AttackResponse retrieveAttackById(@PathVariable(name = "attackId") Long attackId) {
return new AttackResponse(
attackRepository.findById(attackId).orElseThrow(() -> new ResourceNotFoundException(attackId.toString(), "attack"))
);
}
@Operation(summary = "Add new attack", description = "Add new attack")
@ApiResponses(value = {
@ApiResponse(responseCode = "201", description = "Attack created",
content = @Content),
@ApiResponse(responseCode = "400", description = "Invalid input",
content = @Content)
})
@PostMapping
@ResponseStatus(HttpStatus.CREATED)
public ResponseEntity<Object> createAttack(@RequestBody @Valid AttackRequest attackRequest) {
Attack newAttack = new Attack(
attackRequest.getName(),
attackRequest.getDamageModifier(),
attackRequest.getAbilityType(),
attackRequest.getDamageRolls(),
attackRequest.getRange()
);
Attack attack = attackRepository.save(newAttack);
URI location = ServletUriComponentsBuilder.fromCurrentRequest()
.path("/{id}")
.buildAndExpand(attack.getId())
.toUri();
return ResponseEntity.created(location).build();
}
@Operation(summary = "Update existing attack", description = "Update existing attack by id")
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "Attack updated",
content = { @Content(mediaType = "application/json",
schema = @Schema(implementation = AttackResponse.class)) }),
@ApiResponse(responseCode = "400", description = "Invalid input",
content = @Content),
@ApiResponse(responseCode = "404", description = "Attack not found",
content = @Content)
})
@PutMapping("/{attackId}")
public AttackResponse putAttack(@PathVariable(name = "attackId") Long attackId,
@RequestBody @Valid AttackRequest attackRequest) {
Attack attack = attackRepository.findById(attackId).orElseThrow(
() -> new ResourceNotFoundException(attackId.toString(), "attack")
);
attack.setName(attackRequest.getName());
attack.setDamageModifier(attackRequest.getDamageModifier());
attack.setAbilityType(attackRequest.getAbilityType());
attack.setDamageRolls(attackRequest.getDamageRolls());
attack.setRange(attackRequest.getRange());
return new AttackResponse(attackRepository.save(attack));
}
@Operation(summary = "Delete attack", description = "Delete attack by id")
@ApiResponses(value = {
@ApiResponse(responseCode = "204", description = "Attack deleted",
content = @Content),
@ApiResponse(responseCode = "404", description = "Attack not found",
content = @Content)
})
@DeleteMapping("/{attackId}")
@ResponseStatus(HttpStatus.NO_CONTENT)
public void deleteAttack(@PathVariable(name = "attackId") Long attackId) {
attackRepository.findById(attackId).orElseThrow(() -> new ResourceNotFoundException(attackId.toString(), "attack"));
try {
attackRepository.deleteById(attackId);
} catch (EmptyResultDataAccessException e) {
// als het<SUF>
}
}
}
|
201959_14 | package edu.stanford.nlp.coref.data;
import java.io.BufferedReader;
import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Properties;
import java.util.Set;
import edu.stanford.nlp.coref.hybrid.HybridCorefProperties;
import edu.stanford.nlp.io.IOUtils;
import edu.stanford.nlp.io.RuntimeIOException;
import edu.stanford.nlp.neural.VectorMap;
import edu.stanford.nlp.pipeline.DefaultPaths;
import edu.stanford.nlp.stats.ClassicCounter;
import edu.stanford.nlp.stats.Counter;
import edu.stanford.nlp.util.Generics;
import edu.stanford.nlp.util.Pair;
import edu.stanford.nlp.util.PropertiesUtils;
import edu.stanford.nlp.util.StringUtils;
import edu.stanford.nlp.util.logging.Redwood;
/**
* Stores various data used for coreference.
* TODO: get rid of dependence on HybridCorefProperties
*
* @author Heeyoung Lee
*/
public class Dictionaries {
/** A logger for this class */
private static final Redwood.RedwoodChannels log = Redwood.channels(Dictionaries.class);
public enum MentionType {
PRONOMINAL(1), NOMINAL(3), PROPER(4), LIST(2);
/**
* A higher representativeness means that this type of mention is more preferred for choosing
* the representative mention. See {@link Mention#moreRepresentativeThan(Mention)}.
*/
public final int representativeness;
MentionType(int representativeness) { this.representativeness = representativeness; }
}
public enum Gender { MALE, FEMALE, NEUTRAL, UNKNOWN }
public enum Number { SINGULAR, PLURAL, UNKNOWN }
public enum Animacy { ANIMATE, INANIMATE, UNKNOWN }
public enum Person { I, YOU, HE, SHE, WE, THEY, IT, UNKNOWN}
public Set<String> reportVerb;
public Set<String> reportNoun;
public Set<String> nonWords;
public Set<String> copulas;
public Set<String> quantifiers;
public Set<String> parts;
public Set<String> temporals;
public Set<String> femalePronouns;
public Set<String> malePronouns;
public Set<String> neutralPronouns;
public Set<String> possessivePronouns;
public Set<String> otherPronouns;
public Set<String> thirdPersonPronouns;
public Set<String> secondPersonPronouns;
public Set<String> firstPersonPronouns;
public Set<String> moneyPercentNumberPronouns;
public Set<String> dateTimePronouns;
public Set<String> organizationPronouns;
public Set<String> locationPronouns;
public Set<String> inanimatePronouns;
public Set<String> animatePronouns;
public Set<String> indefinitePronouns;
public Set<String> relativePronouns;
public Set<String> interrogativePronouns;
public Set<String> GPEPronouns;
public Set<String> pluralPronouns;
public Set<String> singularPronouns;
public Set<String> facilityVehicleWeaponPronouns;
public Set<String> miscPronouns;
public Set<String> reflexivePronouns;
public Set<String> transparentNouns;
public Set<String> stopWords;
public Set<String> notOrganizationPRP;
public Set<String> quantifiers2;
public Set<String> determiners;
public Set<String> negations;
public Set<String> neg_relations;
public Set<String> modals;
public Set<String> titleWords;
public Set<String> removeWords;
public Set<String> removeChars;
public final Set<String> personPronouns = Generics.newHashSet();
public final Set<String> allPronouns = Generics.newHashSet();
public final Map<String, String> statesAbbreviation = Generics.newHashMap();
private final Map<String, Set<String>> demonyms = Generics.newHashMap();
public final Set<String> demonymSet = Generics.newHashSet();
private final Set<String> adjectiveNation = Generics.newHashSet();
public final Set<String> countries = Generics.newHashSet();
public final Set<String> statesAndProvinces = Generics.newHashSet();
public final Set<String> neutralWords = Generics.newHashSet();
public final Set<String> femaleWords = Generics.newHashSet();
public final Set<String> maleWords = Generics.newHashSet();
public final Set<String> pluralWords = Generics.newHashSet();
public final Set<String> singularWords = Generics.newHashSet();
public final Set<String> inanimateWords = Generics.newHashSet();
public final Set<String> animateWords = Generics.newHashSet();
public final Map<List<String>, Gender> genderNumber = Generics.newHashMap();
public final ArrayList<Counter<Pair<String, String>>> corefDict = new ArrayList<>(4);
public final Counter<Pair<String, String>> corefDictPMI = new ClassicCounter<>();
public final Map<String,Counter<String>> NE_signatures = Generics.newHashMap();
private void readWordLists(Locale lang) {
switch (lang.getLanguage()) {
default: case "en":
reportVerb = WordLists.reportVerbEn;
reportNoun = WordLists.reportNounEn;
nonWords = WordLists.nonWordsEn;
copulas = WordLists.copulasEn;
quantifiers = WordLists.quantifiersEn;
parts = WordLists.partsEn;
temporals = WordLists.temporalsEn;
femalePronouns = WordLists.femalePronounsEn;
malePronouns = WordLists.malePronounsEn;
neutralPronouns = WordLists.neutralPronounsEn;
possessivePronouns = WordLists.possessivePronounsEn;
otherPronouns = WordLists.otherPronounsEn;
thirdPersonPronouns = WordLists.thirdPersonPronounsEn;
secondPersonPronouns = WordLists.secondPersonPronounsEn;
firstPersonPronouns = WordLists.firstPersonPronounsEn;
moneyPercentNumberPronouns = WordLists.moneyPercentNumberPronounsEn;
dateTimePronouns = WordLists.dateTimePronounsEn;
organizationPronouns = WordLists.organizationPronounsEn;
locationPronouns = WordLists.locationPronounsEn;
inanimatePronouns = WordLists.inanimatePronounsEn;
animatePronouns = WordLists.animatePronounsEn;
indefinitePronouns = WordLists.indefinitePronounsEn;
relativePronouns = WordLists.relativePronounsEn;
GPEPronouns = WordLists.GPEPronounsEn;
pluralPronouns = WordLists.pluralPronounsEn;
singularPronouns = WordLists.singularPronounsEn;
facilityVehicleWeaponPronouns = WordLists.facilityVehicleWeaponPronounsEn;
miscPronouns = WordLists.miscPronounsEn;
reflexivePronouns = WordLists.reflexivePronounsEn;
transparentNouns = WordLists.transparentNounsEn;
stopWords = WordLists.stopWordsEn;
notOrganizationPRP = WordLists.notOrganizationPRPEn;
quantifiers2 = WordLists.quantifiers2En;
determiners = WordLists.determinersEn;
negations = WordLists.negationsEn;
neg_relations = WordLists.neg_relationsEn;
modals = WordLists.modalsEn;
break;
case "zh":
reportVerb = WordLists.reportVerbZh;
reportNoun = WordLists.reportNounZh;
nonWords = WordLists.nonWordsZh;
copulas = WordLists.copulasZh;
quantifiers = WordLists.quantifiersZh;
parts = WordLists.partsZh;
temporals = WordLists.temporalsZh;
femalePronouns = WordLists.femalePronounsZh;
malePronouns = WordLists.malePronounsZh;
neutralPronouns = WordLists.neutralPronounsZh;
possessivePronouns = WordLists.possessivePronounsZh;
otherPronouns = WordLists.otherPronounsZh;
thirdPersonPronouns = WordLists.thirdPersonPronounsZh;
secondPersonPronouns = WordLists.secondPersonPronounsZh;
firstPersonPronouns = WordLists.firstPersonPronounsZh;
moneyPercentNumberPronouns = WordLists.moneyPercentNumberPronounsZh;
dateTimePronouns = WordLists.dateTimePronounsZh;
organizationPronouns = WordLists.organizationPronounsZh;
locationPronouns = WordLists.locationPronounsZh;
inanimatePronouns = WordLists.inanimatePronounsZh;
animatePronouns = WordLists.animatePronounsZh;
indefinitePronouns = WordLists.indefinitePronounsZh;
relativePronouns = WordLists.relativePronounsZh;
interrogativePronouns = WordLists.interrogativePronounsZh;
GPEPronouns = WordLists.GPEPronounsZh;
pluralPronouns = WordLists.pluralPronounsZh;
singularPronouns = WordLists.singularPronounsZh;
facilityVehicleWeaponPronouns = WordLists.facilityVehicleWeaponPronounsZh;
miscPronouns = WordLists.miscPronounsZh;
reflexivePronouns = WordLists.reflexivePronounsZh;
transparentNouns = WordLists.transparentNounsZh;
stopWords = WordLists.stopWordsZh;
notOrganizationPRP = WordLists.notOrganizationPRPZh;
quantifiers2 = WordLists.quantifiers2Zh;
determiners = WordLists.determinersZh;
negations = WordLists.negationsZh;
neg_relations = WordLists.neg_relationsZh;
modals = WordLists.modalsZh;
titleWords = WordLists.titleWordsZh;
removeWords = WordLists.removeWordsZh;
removeChars = WordLists.removeCharsZh;
break;
}
}
public int dimVector;
public VectorMap vectors = new VectorMap();
public Map<String, String> strToEntity = Generics.newHashMap();
public Counter<String> dictScore = new ClassicCounter<>();
private void setPronouns() {
personPronouns.addAll(animatePronouns);
allPronouns.addAll(firstPersonPronouns);
allPronouns.addAll(secondPersonPronouns);
allPronouns.addAll(thirdPersonPronouns);
allPronouns.addAll(otherPronouns);
stopWords.addAll(allPronouns);
}
/** The format of each line of this file is
* fullStateName ( TAB abbrev )*
* The file is cased and checked cased.
* The result is: statesAbbreviation is a hash from each abbrev to the fullStateName.
*/
private void loadStateAbbreviation(String statesFile) {
BufferedReader reader = null;
try {
reader = IOUtils.readerFromString(statesFile);
for (String line; (line = reader.readLine()) != null; ) {
String[] tokens = line.split("\t");
for (String token : tokens) {
statesAbbreviation.put(token, tokens[0]);
}
}
} catch (IOException e) {
throw new RuntimeIOException(e);
} finally {
IOUtils.closeIgnoringExceptions(reader);
}
}
/** If the input string is an abbreviation of a U.S. state name
* or the canonical name, the canonical name is returned.
* Otherwise, null is returned.
*
* @param name Is treated as a cased string. ME != me
*/
public String lookupCanonicalAmericanStateName(String name) {
return statesAbbreviation.get(name);
}
/** The format of the demonyms file is
* countryCityOrState ( TAB demonym )*
* Lines starting with # are ignored
* The file is cased but stored in in-memory data structures uncased.
* The results are:
* demonyms is a has from each country (etc.) to a set of demonymic Strings;
* adjectiveNation is a set of demonymic Strings;
* demonymSet has all country (etc.) names and all demonymic Strings.
*/
private void loadDemonymLists(String demonymFile) {
try (BufferedReader reader = IOUtils.readerFromString(demonymFile)) {
for (String line; (line = reader.readLine()) != null; ) {
line = line.toLowerCase(Locale.ENGLISH);
String[] tokens = line.split("\t");
if (tokens[0].startsWith("#")) continue;
Set<String> set = Generics.newHashSet();
for (String s : tokens) {
set.add(s);
demonymSet.add(s);
}
demonyms.put(tokens[0], set);
}
adjectiveNation.addAll(demonymSet);
adjectiveNation.removeAll(demonyms.keySet());
} catch (IOException e) {
throw new RuntimeIOException(e);
}
}
/** Returns a set of demonyms for a country (or city or region).
* @param name Some string perhaps a country name like "Australia"
* @return A Set of demonym Strings, perhaps { "Australian", "Aussie", "Aussies" }.
* If none are known (including if the argument isn't a country/region name,
* then the empty set will be returned.
*/
public Set<String> getDemonyms(String name) {
Set<String> result = demonyms.get(name);
if (result == null) {
result = Collections.emptySet();
}
return result;
}
/** Returns whether this mention (possibly multi-word) is the
* adjectival form of a demonym, like "African" or "Iraqi".
* True if it is an adjectival form, even if also a name for a
* person of that country (such as "Iraqi").
*/
public boolean isAdjectivalDemonym(String token) {
return adjectiveNation.contains(token.toLowerCase(Locale.ENGLISH));
}
private static void getWordsFromFile(String filename, Set<String> resultSet, boolean lowercase) throws IOException {
if(filename==null) {
return ;
}
try (BufferedReader reader = IOUtils.readerFromString(filename)) {
while(reader.ready()) {
if(lowercase) resultSet.add(reader.readLine().toLowerCase());
else resultSet.add(reader.readLine());
}
}
}
private void loadAnimacyLists(String animateWordsFile, String inanimateWordsFile) {
try {
getWordsFromFile(animateWordsFile, animateWords, false);
getWordsFromFile(inanimateWordsFile, inanimateWords, false);
} catch (IOException e) {
throw new RuntimeIOException(e);
}
}
private void loadGenderLists(String maleWordsFile, String neutralWordsFile, String femaleWordsFile) {
try {
getWordsFromFile(maleWordsFile, maleWords, false);
getWordsFromFile(neutralWordsFile, neutralWords, false);
getWordsFromFile(femaleWordsFile, femaleWords, false);
} catch (IOException e) {
throw new RuntimeIOException(e);
}
}
private void loadNumberLists(String pluralWordsFile, String singularWordsFile) {
try {
getWordsFromFile(pluralWordsFile, pluralWords, false);
getWordsFromFile(singularWordsFile, singularWords, false);
} catch (IOException e) {
throw new RuntimeIOException(e);
}
}
private void loadStatesLists(String file) {
try {
getWordsFromFile(file, statesAndProvinces, true);
} catch (IOException e) {
throw new RuntimeIOException(e);
}
}
private void loadCountriesLists(String file) {
try (BufferedReader reader = IOUtils.readerFromString(file)) {
for (String line; (line = reader.readLine()) != null; ) {
countries.add(line.split("\t")[1].toLowerCase());
}
} catch (IOException e) {
throw new RuntimeIOException(e);
}
}
/**
* Load Bergsma and Lin (2006) gender and number list.
* <br>
* The list is converted from raw text and numbers to a serialized
* map, which saves quite a bit of time loading.
* See edu.stanford.nlp.dcoref.util.ConvertGenderFile
*/
/*
private void loadGenderNumber(String file, String neutralWordsFile) {
try {
getWordsFromFile(neutralWordsFile, neutralWords, false);
Map<List<String>, Gender> temp = IOUtils.readObjectFromURLOrClasspathOrFileSystem(file);
genderNumber.putAll(temp);
} catch (IOException e) {
throw new RuntimeIOException(e);
} catch (ClassNotFoundException e) {
throw new RuntimeIOException(e);
}
}
*/
/**
* Load Bergsma and Lin (2006) gender and number list.
*
*/
private void loadGenderNumber(String file, String neutralWordsFile) {
try (BufferedReader reader = IOUtils.readerFromString(file)) {
getWordsFromFile(neutralWordsFile, neutralWords, false);
String[] split = new String[2];
String[] countStr = new String[3];
for (String line; (line = reader.readLine()) != null; ) {
StringUtils.splitOnChar(split, line, '\t');
StringUtils.splitOnChar(countStr, split[1], ' ');
int male = Integer.parseInt(countStr[0]);
int female = Integer.parseInt(countStr[1]);
int neutral = Integer.parseInt(countStr[2]);
Gender gender = Gender.UNKNOWN;
if (male * 0.5 > female + neutral && male > 2) {
gender = Gender.MALE;
} else if (female * 0.5 > male + neutral && female > 2) {
gender = Gender.FEMALE;
} else if (neutral * 0.5 > male + female && neutral > 2) {
gender = Gender.NEUTRAL;
}
if (gender == Gender.UNKNOWN) {
continue;
}
String[] words = split[0].split(" ");
List<String> tokens = Arrays.asList(words);
genderNumber.put(tokens, gender);
}
} catch (IOException e) {
throw new RuntimeIOException(e);
}
}
private void loadChineseGenderNumberAnimacy(String file) {
String[] split = new String[8];
for (String line : IOUtils.readLines(file)) {
if (line.startsWith("#WORD")) continue; // ignore first row
StringUtils.splitOnChar(split, line, '\t');
String word = split[0];
int animate = Integer.parseInt(split[1]);
int inanimate = Integer.parseInt(split[2]);
int male = Integer.parseInt(split[3]);
int female = Integer.parseInt(split[4]);
int neutral = Integer.parseInt(split[5]);
int singular = Integer.parseInt(split[6]);
int plural = Integer.parseInt(split[7]);
if (male * 0.5 > female + neutral && male > 2) {
maleWords.add(word);
} else if (female * 0.5 > male + neutral && female > 2) {
femaleWords.add(word);
} else if (neutral * 0.5 > male + female && neutral > 2) {
neutralWords.add(word);
}
if (animate * 0.5 > inanimate && animate > 2) {
animateWords.add(word);
} else if (inanimate * 0.5 > animate && inanimate > 2) {
inanimateWords.add(word);
}
if (singular * 0.5 > plural && singular >2) {
singularWords.add(word);
} else if (plural * 0.5 > singular && plural > 2) {
pluralWords.add(word);
}
}
}
private static void loadCorefDict(String[] file,
ArrayList<Counter<Pair<String, String>>> dict) {
for(int i = 0; i < 4; i++){
dict.add(new ClassicCounter<>());
BufferedReader reader = null;
try {
reader = IOUtils.readerFromString(file[i]);
// Skip the first line (header)
reader.readLine();
while(reader.ready()) {
String[] split = reader.readLine().split("\t");
dict.get(i).setCount(new Pair<>(split[0], split[1]), Double.parseDouble(split[2]));
}
} catch (IOException e) {
throw new RuntimeException(e);
} finally {
IOUtils.closeIgnoringExceptions(reader);
}
}
}
private static void loadCorefDictPMI(String file, Counter<Pair<String, String>> dict) {
BufferedReader reader = null;
try {
reader = IOUtils.readerFromString(file);
// Skip the first line (header)
reader.readLine();
while(reader.ready()) {
String[] split = reader.readLine().split("\t");
dict.setCount(new Pair<>(split[0], split[1]), Double.parseDouble(split[3]));
}
} catch (IOException e) {
throw new RuntimeException(e);
} finally {
IOUtils.closeIgnoringExceptions(reader);
}
}
private static void loadSignatures(String file, Map<String,Counter<String>> sigs) {
BufferedReader reader = null;
try {
reader = IOUtils.readerFromString(file);
while(reader.ready()) {
String[] split = reader.readLine().split("\t");
Counter<String> cntr = new ClassicCounter<>();
sigs.put(split[0], cntr);
for (int i = 1; i < split.length; i=i+2) {
cntr.setCount(split[i], Double.parseDouble(split[i+1]));
}
}
} catch (IOException e) {
throw new RuntimeException(e);
} finally {
IOUtils.closeIgnoringExceptions(reader);
}
}
public void loadSemantics(Properties props) throws ClassNotFoundException, IOException {
log.info("LOADING SEMANTICS");
// wordnet = new WordNet();
// load word vector
if(HybridCorefProperties.loadWordEmbedding(props)) {
log.info("LOAD: WordVectors");
String wordvectorFile = HybridCorefProperties.getPathSerializedWordVectors(props);
String word2vecFile = HybridCorefProperties.getPathWord2Vec(props);
try {
// Try to read the serialized vectors
vectors = VectorMap.deserialize(wordvectorFile);
} catch (IOException e) {
// If that fails, try to read the vectors from the word2vec file
if(new File(word2vecFile).exists()) {
vectors = VectorMap.readWord2Vec(word2vecFile);
if (wordvectorFile != null && !wordvectorFile.startsWith("edu")) {
vectors.serialize(wordvectorFile);
}
} else {
// If that fails, give up and crash
throw new RuntimeIOException(e);
}
}
dimVector = vectors.entrySet().iterator().next().getValue().length;
// if(Boolean.parseBoolean(props.getProperty("useValDictionary"))) {
// log.info("LOAD: ValDictionary");
// for(String line : IOUtils.readLines(valDict)) {
// String[] split = line.toLowerCase().split("\t");
// strToEntity.put(split[0], split[2]);
// dictScore.setCount(split[0], Double.parseDouble(split[1]));
// }
// }
}
}
public Dictionaries(Properties props) throws ClassNotFoundException, IOException {
this(props.getProperty(HybridCorefProperties.LANG_PROP, HybridCorefProperties.LANGUAGE_DEFAULT.toLanguageTag()),
props.getProperty(HybridCorefProperties.DEMONYM_PROP, DefaultPaths.DEFAULT_DCOREF_DEMONYM),
props.getProperty(HybridCorefProperties.ANIMATE_PROP, DefaultPaths.DEFAULT_DCOREF_ANIMATE),
props.getProperty(HybridCorefProperties.INANIMATE_PROP, DefaultPaths.DEFAULT_DCOREF_INANIMATE),
props.getProperty(HybridCorefProperties.MALE_PROP),
props.getProperty(HybridCorefProperties.NEUTRAL_PROP),
props.getProperty(HybridCorefProperties.FEMALE_PROP),
props.getProperty(HybridCorefProperties.PLURAL_PROP),
props.getProperty(HybridCorefProperties.SINGULAR_PROP),
props.getProperty(HybridCorefProperties.STATES_PROP, DefaultPaths.DEFAULT_DCOREF_STATES),
props.getProperty(HybridCorefProperties.GENDER_NUMBER_PROP, HybridCorefProperties.getGenderNumber(props)),
props.getProperty(HybridCorefProperties.COUNTRIES_PROP, DefaultPaths.DEFAULT_DCOREF_COUNTRIES),
props.getProperty(HybridCorefProperties.STATES_PROVINCES_PROP, DefaultPaths.DEFAULT_DCOREF_STATES_AND_PROVINCES),
HybridCorefProperties.getSieves(props).contains("CorefDictionaryMatch"),
PropertiesUtils.getStringArray(props, HybridCorefProperties.DICT_LIST_PROP,
new String[]{DefaultPaths.DEFAULT_DCOREF_DICT1, DefaultPaths.DEFAULT_DCOREF_DICT2,
DefaultPaths.DEFAULT_DCOREF_DICT3, DefaultPaths.DEFAULT_DCOREF_DICT4}),
props.getProperty(HybridCorefProperties.DICT_PMI_PROP, DefaultPaths.DEFAULT_DCOREF_DICT1),
props.getProperty(HybridCorefProperties.SIGNATURES_PROP, DefaultPaths.DEFAULT_DCOREF_NE_SIGNATURES));
/*if(CorefProperties.useSemantics(props)) {
loadSemantics(props);
} else {
log.info("SEMANTICS NOT LOADED");
}*/
if(props.containsKey("coref.zh.dict")) {
loadChineseGenderNumberAnimacy(props.getProperty("coref.zh.dict"));
}
}
public static String signature(Properties props) {
StringBuilder os = new StringBuilder();
os.append(HybridCorefProperties.DEMONYM_PROP + ":" +
props.getProperty(HybridCorefProperties.DEMONYM_PROP,
DefaultPaths.DEFAULT_DCOREF_DEMONYM));
os.append(HybridCorefProperties.ANIMATE_PROP + ":" +
props.getProperty(HybridCorefProperties.ANIMATE_PROP,
DefaultPaths.DEFAULT_DCOREF_ANIMATE));
os.append(HybridCorefProperties.INANIMATE_PROP + ":" +
props.getProperty(HybridCorefProperties.INANIMATE_PROP,
DefaultPaths.DEFAULT_DCOREF_INANIMATE));
if(props.containsKey(HybridCorefProperties.MALE_PROP)) {
os.append(HybridCorefProperties.MALE_PROP + ":" +
props.getProperty(HybridCorefProperties.MALE_PROP));
}
if(props.containsKey(HybridCorefProperties.NEUTRAL_PROP)) {
os.append(HybridCorefProperties.NEUTRAL_PROP + ":" +
props.getProperty(HybridCorefProperties.NEUTRAL_PROP));
}
if(props.containsKey(HybridCorefProperties.FEMALE_PROP)) {
os.append(HybridCorefProperties.FEMALE_PROP + ":" +
props.getProperty(HybridCorefProperties.FEMALE_PROP));
}
if(props.containsKey(HybridCorefProperties.PLURAL_PROP)) {
os.append(HybridCorefProperties.PLURAL_PROP + ":" +
props.getProperty(HybridCorefProperties.PLURAL_PROP));
}
if(props.containsKey(HybridCorefProperties.SINGULAR_PROP)) {
os.append(HybridCorefProperties.SINGULAR_PROP + ":" +
props.getProperty(HybridCorefProperties.SINGULAR_PROP));
}
os.append(HybridCorefProperties.STATES_PROP + ":" +
props.getProperty(HybridCorefProperties.STATES_PROP,
DefaultPaths.DEFAULT_DCOREF_STATES));
os.append(HybridCorefProperties.GENDER_NUMBER_PROP + ":" +
props.getProperty(HybridCorefProperties.GENDER_NUMBER_PROP,
DefaultPaths.DEFAULT_DCOREF_GENDER_NUMBER));
os.append(HybridCorefProperties.COUNTRIES_PROP + ":" +
props.getProperty(HybridCorefProperties.COUNTRIES_PROP,
DefaultPaths.DEFAULT_DCOREF_COUNTRIES));
os.append(HybridCorefProperties.STATES_PROVINCES_PROP + ":" +
props.getProperty(HybridCorefProperties.STATES_PROVINCES_PROP,
DefaultPaths.DEFAULT_DCOREF_STATES_AND_PROVINCES));
return os.toString();
}
public Dictionaries(
String language,
String demonymWords,
String animateWords,
String inanimateWords,
String maleWords,
String neutralWords,
String femaleWords,
String pluralWords,
String singularWords,
String statesWords,
String genderNumber,
String countries,
String states,
boolean loadCorefDict,
String[] corefDictFiles,
String corefDictPMIFile,
String signaturesFile) {
Locale lang = Locale.forLanguageTag(language);
readWordLists(lang);
loadDemonymLists(demonymWords);
loadStateAbbreviation(statesWords);
loadAnimacyLists(animateWords, inanimateWords);
loadGenderLists(maleWords, neutralWords, femaleWords);
loadNumberLists(pluralWords, singularWords);
loadGenderNumber(genderNumber, neutralWords);
loadCountriesLists(countries);
loadStatesLists(states);
setPronouns();
if(loadCorefDict){
loadCorefDict(corefDictFiles, corefDict);
loadCorefDictPMI(corefDictPMIFile, corefDictPMI);
loadSignatures(signaturesFile, NE_signatures);
}
}
public Dictionaries() throws ClassNotFoundException, IOException {
this(new Properties());
}
}
| stanfordnlp/CoreNLP | src/edu/stanford/nlp/coref/data/Dictionaries.java | 7,423 | // wordnet = new WordNet(); | line_comment | nl | package edu.stanford.nlp.coref.data;
import java.io.BufferedReader;
import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Properties;
import java.util.Set;
import edu.stanford.nlp.coref.hybrid.HybridCorefProperties;
import edu.stanford.nlp.io.IOUtils;
import edu.stanford.nlp.io.RuntimeIOException;
import edu.stanford.nlp.neural.VectorMap;
import edu.stanford.nlp.pipeline.DefaultPaths;
import edu.stanford.nlp.stats.ClassicCounter;
import edu.stanford.nlp.stats.Counter;
import edu.stanford.nlp.util.Generics;
import edu.stanford.nlp.util.Pair;
import edu.stanford.nlp.util.PropertiesUtils;
import edu.stanford.nlp.util.StringUtils;
import edu.stanford.nlp.util.logging.Redwood;
/**
* Stores various data used for coreference.
* TODO: get rid of dependence on HybridCorefProperties
*
* @author Heeyoung Lee
*/
public class Dictionaries {
/** A logger for this class */
private static final Redwood.RedwoodChannels log = Redwood.channels(Dictionaries.class);
public enum MentionType {
PRONOMINAL(1), NOMINAL(3), PROPER(4), LIST(2);
/**
* A higher representativeness means that this type of mention is more preferred for choosing
* the representative mention. See {@link Mention#moreRepresentativeThan(Mention)}.
*/
public final int representativeness;
MentionType(int representativeness) { this.representativeness = representativeness; }
}
public enum Gender { MALE, FEMALE, NEUTRAL, UNKNOWN }
public enum Number { SINGULAR, PLURAL, UNKNOWN }
public enum Animacy { ANIMATE, INANIMATE, UNKNOWN }
public enum Person { I, YOU, HE, SHE, WE, THEY, IT, UNKNOWN}
public Set<String> reportVerb;
public Set<String> reportNoun;
public Set<String> nonWords;
public Set<String> copulas;
public Set<String> quantifiers;
public Set<String> parts;
public Set<String> temporals;
public Set<String> femalePronouns;
public Set<String> malePronouns;
public Set<String> neutralPronouns;
public Set<String> possessivePronouns;
public Set<String> otherPronouns;
public Set<String> thirdPersonPronouns;
public Set<String> secondPersonPronouns;
public Set<String> firstPersonPronouns;
public Set<String> moneyPercentNumberPronouns;
public Set<String> dateTimePronouns;
public Set<String> organizationPronouns;
public Set<String> locationPronouns;
public Set<String> inanimatePronouns;
public Set<String> animatePronouns;
public Set<String> indefinitePronouns;
public Set<String> relativePronouns;
public Set<String> interrogativePronouns;
public Set<String> GPEPronouns;
public Set<String> pluralPronouns;
public Set<String> singularPronouns;
public Set<String> facilityVehicleWeaponPronouns;
public Set<String> miscPronouns;
public Set<String> reflexivePronouns;
public Set<String> transparentNouns;
public Set<String> stopWords;
public Set<String> notOrganizationPRP;
public Set<String> quantifiers2;
public Set<String> determiners;
public Set<String> negations;
public Set<String> neg_relations;
public Set<String> modals;
public Set<String> titleWords;
public Set<String> removeWords;
public Set<String> removeChars;
public final Set<String> personPronouns = Generics.newHashSet();
public final Set<String> allPronouns = Generics.newHashSet();
public final Map<String, String> statesAbbreviation = Generics.newHashMap();
private final Map<String, Set<String>> demonyms = Generics.newHashMap();
public final Set<String> demonymSet = Generics.newHashSet();
private final Set<String> adjectiveNation = Generics.newHashSet();
public final Set<String> countries = Generics.newHashSet();
public final Set<String> statesAndProvinces = Generics.newHashSet();
public final Set<String> neutralWords = Generics.newHashSet();
public final Set<String> femaleWords = Generics.newHashSet();
public final Set<String> maleWords = Generics.newHashSet();
public final Set<String> pluralWords = Generics.newHashSet();
public final Set<String> singularWords = Generics.newHashSet();
public final Set<String> inanimateWords = Generics.newHashSet();
public final Set<String> animateWords = Generics.newHashSet();
public final Map<List<String>, Gender> genderNumber = Generics.newHashMap();
public final ArrayList<Counter<Pair<String, String>>> corefDict = new ArrayList<>(4);
public final Counter<Pair<String, String>> corefDictPMI = new ClassicCounter<>();
public final Map<String,Counter<String>> NE_signatures = Generics.newHashMap();
private void readWordLists(Locale lang) {
switch (lang.getLanguage()) {
default: case "en":
reportVerb = WordLists.reportVerbEn;
reportNoun = WordLists.reportNounEn;
nonWords = WordLists.nonWordsEn;
copulas = WordLists.copulasEn;
quantifiers = WordLists.quantifiersEn;
parts = WordLists.partsEn;
temporals = WordLists.temporalsEn;
femalePronouns = WordLists.femalePronounsEn;
malePronouns = WordLists.malePronounsEn;
neutralPronouns = WordLists.neutralPronounsEn;
possessivePronouns = WordLists.possessivePronounsEn;
otherPronouns = WordLists.otherPronounsEn;
thirdPersonPronouns = WordLists.thirdPersonPronounsEn;
secondPersonPronouns = WordLists.secondPersonPronounsEn;
firstPersonPronouns = WordLists.firstPersonPronounsEn;
moneyPercentNumberPronouns = WordLists.moneyPercentNumberPronounsEn;
dateTimePronouns = WordLists.dateTimePronounsEn;
organizationPronouns = WordLists.organizationPronounsEn;
locationPronouns = WordLists.locationPronounsEn;
inanimatePronouns = WordLists.inanimatePronounsEn;
animatePronouns = WordLists.animatePronounsEn;
indefinitePronouns = WordLists.indefinitePronounsEn;
relativePronouns = WordLists.relativePronounsEn;
GPEPronouns = WordLists.GPEPronounsEn;
pluralPronouns = WordLists.pluralPronounsEn;
singularPronouns = WordLists.singularPronounsEn;
facilityVehicleWeaponPronouns = WordLists.facilityVehicleWeaponPronounsEn;
miscPronouns = WordLists.miscPronounsEn;
reflexivePronouns = WordLists.reflexivePronounsEn;
transparentNouns = WordLists.transparentNounsEn;
stopWords = WordLists.stopWordsEn;
notOrganizationPRP = WordLists.notOrganizationPRPEn;
quantifiers2 = WordLists.quantifiers2En;
determiners = WordLists.determinersEn;
negations = WordLists.negationsEn;
neg_relations = WordLists.neg_relationsEn;
modals = WordLists.modalsEn;
break;
case "zh":
reportVerb = WordLists.reportVerbZh;
reportNoun = WordLists.reportNounZh;
nonWords = WordLists.nonWordsZh;
copulas = WordLists.copulasZh;
quantifiers = WordLists.quantifiersZh;
parts = WordLists.partsZh;
temporals = WordLists.temporalsZh;
femalePronouns = WordLists.femalePronounsZh;
malePronouns = WordLists.malePronounsZh;
neutralPronouns = WordLists.neutralPronounsZh;
possessivePronouns = WordLists.possessivePronounsZh;
otherPronouns = WordLists.otherPronounsZh;
thirdPersonPronouns = WordLists.thirdPersonPronounsZh;
secondPersonPronouns = WordLists.secondPersonPronounsZh;
firstPersonPronouns = WordLists.firstPersonPronounsZh;
moneyPercentNumberPronouns = WordLists.moneyPercentNumberPronounsZh;
dateTimePronouns = WordLists.dateTimePronounsZh;
organizationPronouns = WordLists.organizationPronounsZh;
locationPronouns = WordLists.locationPronounsZh;
inanimatePronouns = WordLists.inanimatePronounsZh;
animatePronouns = WordLists.animatePronounsZh;
indefinitePronouns = WordLists.indefinitePronounsZh;
relativePronouns = WordLists.relativePronounsZh;
interrogativePronouns = WordLists.interrogativePronounsZh;
GPEPronouns = WordLists.GPEPronounsZh;
pluralPronouns = WordLists.pluralPronounsZh;
singularPronouns = WordLists.singularPronounsZh;
facilityVehicleWeaponPronouns = WordLists.facilityVehicleWeaponPronounsZh;
miscPronouns = WordLists.miscPronounsZh;
reflexivePronouns = WordLists.reflexivePronounsZh;
transparentNouns = WordLists.transparentNounsZh;
stopWords = WordLists.stopWordsZh;
notOrganizationPRP = WordLists.notOrganizationPRPZh;
quantifiers2 = WordLists.quantifiers2Zh;
determiners = WordLists.determinersZh;
negations = WordLists.negationsZh;
neg_relations = WordLists.neg_relationsZh;
modals = WordLists.modalsZh;
titleWords = WordLists.titleWordsZh;
removeWords = WordLists.removeWordsZh;
removeChars = WordLists.removeCharsZh;
break;
}
}
public int dimVector;
public VectorMap vectors = new VectorMap();
public Map<String, String> strToEntity = Generics.newHashMap();
public Counter<String> dictScore = new ClassicCounter<>();
private void setPronouns() {
personPronouns.addAll(animatePronouns);
allPronouns.addAll(firstPersonPronouns);
allPronouns.addAll(secondPersonPronouns);
allPronouns.addAll(thirdPersonPronouns);
allPronouns.addAll(otherPronouns);
stopWords.addAll(allPronouns);
}
/** The format of each line of this file is
* fullStateName ( TAB abbrev )*
* The file is cased and checked cased.
* The result is: statesAbbreviation is a hash from each abbrev to the fullStateName.
*/
private void loadStateAbbreviation(String statesFile) {
BufferedReader reader = null;
try {
reader = IOUtils.readerFromString(statesFile);
for (String line; (line = reader.readLine()) != null; ) {
String[] tokens = line.split("\t");
for (String token : tokens) {
statesAbbreviation.put(token, tokens[0]);
}
}
} catch (IOException e) {
throw new RuntimeIOException(e);
} finally {
IOUtils.closeIgnoringExceptions(reader);
}
}
/** If the input string is an abbreviation of a U.S. state name
* or the canonical name, the canonical name is returned.
* Otherwise, null is returned.
*
* @param name Is treated as a cased string. ME != me
*/
public String lookupCanonicalAmericanStateName(String name) {
return statesAbbreviation.get(name);
}
/** The format of the demonyms file is
* countryCityOrState ( TAB demonym )*
* Lines starting with # are ignored
* The file is cased but stored in in-memory data structures uncased.
* The results are:
* demonyms is a has from each country (etc.) to a set of demonymic Strings;
* adjectiveNation is a set of demonymic Strings;
* demonymSet has all country (etc.) names and all demonymic Strings.
*/
private void loadDemonymLists(String demonymFile) {
try (BufferedReader reader = IOUtils.readerFromString(demonymFile)) {
for (String line; (line = reader.readLine()) != null; ) {
line = line.toLowerCase(Locale.ENGLISH);
String[] tokens = line.split("\t");
if (tokens[0].startsWith("#")) continue;
Set<String> set = Generics.newHashSet();
for (String s : tokens) {
set.add(s);
demonymSet.add(s);
}
demonyms.put(tokens[0], set);
}
adjectiveNation.addAll(demonymSet);
adjectiveNation.removeAll(demonyms.keySet());
} catch (IOException e) {
throw new RuntimeIOException(e);
}
}
/** Returns a set of demonyms for a country (or city or region).
* @param name Some string perhaps a country name like "Australia"
* @return A Set of demonym Strings, perhaps { "Australian", "Aussie", "Aussies" }.
* If none are known (including if the argument isn't a country/region name,
* then the empty set will be returned.
*/
public Set<String> getDemonyms(String name) {
Set<String> result = demonyms.get(name);
if (result == null) {
result = Collections.emptySet();
}
return result;
}
/** Returns whether this mention (possibly multi-word) is the
* adjectival form of a demonym, like "African" or "Iraqi".
* True if it is an adjectival form, even if also a name for a
* person of that country (such as "Iraqi").
*/
public boolean isAdjectivalDemonym(String token) {
return adjectiveNation.contains(token.toLowerCase(Locale.ENGLISH));
}
private static void getWordsFromFile(String filename, Set<String> resultSet, boolean lowercase) throws IOException {
if(filename==null) {
return ;
}
try (BufferedReader reader = IOUtils.readerFromString(filename)) {
while(reader.ready()) {
if(lowercase) resultSet.add(reader.readLine().toLowerCase());
else resultSet.add(reader.readLine());
}
}
}
private void loadAnimacyLists(String animateWordsFile, String inanimateWordsFile) {
try {
getWordsFromFile(animateWordsFile, animateWords, false);
getWordsFromFile(inanimateWordsFile, inanimateWords, false);
} catch (IOException e) {
throw new RuntimeIOException(e);
}
}
private void loadGenderLists(String maleWordsFile, String neutralWordsFile, String femaleWordsFile) {
try {
getWordsFromFile(maleWordsFile, maleWords, false);
getWordsFromFile(neutralWordsFile, neutralWords, false);
getWordsFromFile(femaleWordsFile, femaleWords, false);
} catch (IOException e) {
throw new RuntimeIOException(e);
}
}
private void loadNumberLists(String pluralWordsFile, String singularWordsFile) {
try {
getWordsFromFile(pluralWordsFile, pluralWords, false);
getWordsFromFile(singularWordsFile, singularWords, false);
} catch (IOException e) {
throw new RuntimeIOException(e);
}
}
private void loadStatesLists(String file) {
try {
getWordsFromFile(file, statesAndProvinces, true);
} catch (IOException e) {
throw new RuntimeIOException(e);
}
}
private void loadCountriesLists(String file) {
try (BufferedReader reader = IOUtils.readerFromString(file)) {
for (String line; (line = reader.readLine()) != null; ) {
countries.add(line.split("\t")[1].toLowerCase());
}
} catch (IOException e) {
throw new RuntimeIOException(e);
}
}
/**
* Load Bergsma and Lin (2006) gender and number list.
* <br>
* The list is converted from raw text and numbers to a serialized
* map, which saves quite a bit of time loading.
* See edu.stanford.nlp.dcoref.util.ConvertGenderFile
*/
/*
private void loadGenderNumber(String file, String neutralWordsFile) {
try {
getWordsFromFile(neutralWordsFile, neutralWords, false);
Map<List<String>, Gender> temp = IOUtils.readObjectFromURLOrClasspathOrFileSystem(file);
genderNumber.putAll(temp);
} catch (IOException e) {
throw new RuntimeIOException(e);
} catch (ClassNotFoundException e) {
throw new RuntimeIOException(e);
}
}
*/
/**
* Load Bergsma and Lin (2006) gender and number list.
*
*/
private void loadGenderNumber(String file, String neutralWordsFile) {
try (BufferedReader reader = IOUtils.readerFromString(file)) {
getWordsFromFile(neutralWordsFile, neutralWords, false);
String[] split = new String[2];
String[] countStr = new String[3];
for (String line; (line = reader.readLine()) != null; ) {
StringUtils.splitOnChar(split, line, '\t');
StringUtils.splitOnChar(countStr, split[1], ' ');
int male = Integer.parseInt(countStr[0]);
int female = Integer.parseInt(countStr[1]);
int neutral = Integer.parseInt(countStr[2]);
Gender gender = Gender.UNKNOWN;
if (male * 0.5 > female + neutral && male > 2) {
gender = Gender.MALE;
} else if (female * 0.5 > male + neutral && female > 2) {
gender = Gender.FEMALE;
} else if (neutral * 0.5 > male + female && neutral > 2) {
gender = Gender.NEUTRAL;
}
if (gender == Gender.UNKNOWN) {
continue;
}
String[] words = split[0].split(" ");
List<String> tokens = Arrays.asList(words);
genderNumber.put(tokens, gender);
}
} catch (IOException e) {
throw new RuntimeIOException(e);
}
}
private void loadChineseGenderNumberAnimacy(String file) {
String[] split = new String[8];
for (String line : IOUtils.readLines(file)) {
if (line.startsWith("#WORD")) continue; // ignore first row
StringUtils.splitOnChar(split, line, '\t');
String word = split[0];
int animate = Integer.parseInt(split[1]);
int inanimate = Integer.parseInt(split[2]);
int male = Integer.parseInt(split[3]);
int female = Integer.parseInt(split[4]);
int neutral = Integer.parseInt(split[5]);
int singular = Integer.parseInt(split[6]);
int plural = Integer.parseInt(split[7]);
if (male * 0.5 > female + neutral && male > 2) {
maleWords.add(word);
} else if (female * 0.5 > male + neutral && female > 2) {
femaleWords.add(word);
} else if (neutral * 0.5 > male + female && neutral > 2) {
neutralWords.add(word);
}
if (animate * 0.5 > inanimate && animate > 2) {
animateWords.add(word);
} else if (inanimate * 0.5 > animate && inanimate > 2) {
inanimateWords.add(word);
}
if (singular * 0.5 > plural && singular >2) {
singularWords.add(word);
} else if (plural * 0.5 > singular && plural > 2) {
pluralWords.add(word);
}
}
}
private static void loadCorefDict(String[] file,
ArrayList<Counter<Pair<String, String>>> dict) {
for(int i = 0; i < 4; i++){
dict.add(new ClassicCounter<>());
BufferedReader reader = null;
try {
reader = IOUtils.readerFromString(file[i]);
// Skip the first line (header)
reader.readLine();
while(reader.ready()) {
String[] split = reader.readLine().split("\t");
dict.get(i).setCount(new Pair<>(split[0], split[1]), Double.parseDouble(split[2]));
}
} catch (IOException e) {
throw new RuntimeException(e);
} finally {
IOUtils.closeIgnoringExceptions(reader);
}
}
}
private static void loadCorefDictPMI(String file, Counter<Pair<String, String>> dict) {
BufferedReader reader = null;
try {
reader = IOUtils.readerFromString(file);
// Skip the first line (header)
reader.readLine();
while(reader.ready()) {
String[] split = reader.readLine().split("\t");
dict.setCount(new Pair<>(split[0], split[1]), Double.parseDouble(split[3]));
}
} catch (IOException e) {
throw new RuntimeException(e);
} finally {
IOUtils.closeIgnoringExceptions(reader);
}
}
private static void loadSignatures(String file, Map<String,Counter<String>> sigs) {
BufferedReader reader = null;
try {
reader = IOUtils.readerFromString(file);
while(reader.ready()) {
String[] split = reader.readLine().split("\t");
Counter<String> cntr = new ClassicCounter<>();
sigs.put(split[0], cntr);
for (int i = 1; i < split.length; i=i+2) {
cntr.setCount(split[i], Double.parseDouble(split[i+1]));
}
}
} catch (IOException e) {
throw new RuntimeException(e);
} finally {
IOUtils.closeIgnoringExceptions(reader);
}
}
public void loadSemantics(Properties props) throws ClassNotFoundException, IOException {
log.info("LOADING SEMANTICS");
// wordnet =<SUF>
// load word vector
if(HybridCorefProperties.loadWordEmbedding(props)) {
log.info("LOAD: WordVectors");
String wordvectorFile = HybridCorefProperties.getPathSerializedWordVectors(props);
String word2vecFile = HybridCorefProperties.getPathWord2Vec(props);
try {
// Try to read the serialized vectors
vectors = VectorMap.deserialize(wordvectorFile);
} catch (IOException e) {
// If that fails, try to read the vectors from the word2vec file
if(new File(word2vecFile).exists()) {
vectors = VectorMap.readWord2Vec(word2vecFile);
if (wordvectorFile != null && !wordvectorFile.startsWith("edu")) {
vectors.serialize(wordvectorFile);
}
} else {
// If that fails, give up and crash
throw new RuntimeIOException(e);
}
}
dimVector = vectors.entrySet().iterator().next().getValue().length;
// if(Boolean.parseBoolean(props.getProperty("useValDictionary"))) {
// log.info("LOAD: ValDictionary");
// for(String line : IOUtils.readLines(valDict)) {
// String[] split = line.toLowerCase().split("\t");
// strToEntity.put(split[0], split[2]);
// dictScore.setCount(split[0], Double.parseDouble(split[1]));
// }
// }
}
}
public Dictionaries(Properties props) throws ClassNotFoundException, IOException {
this(props.getProperty(HybridCorefProperties.LANG_PROP, HybridCorefProperties.LANGUAGE_DEFAULT.toLanguageTag()),
props.getProperty(HybridCorefProperties.DEMONYM_PROP, DefaultPaths.DEFAULT_DCOREF_DEMONYM),
props.getProperty(HybridCorefProperties.ANIMATE_PROP, DefaultPaths.DEFAULT_DCOREF_ANIMATE),
props.getProperty(HybridCorefProperties.INANIMATE_PROP, DefaultPaths.DEFAULT_DCOREF_INANIMATE),
props.getProperty(HybridCorefProperties.MALE_PROP),
props.getProperty(HybridCorefProperties.NEUTRAL_PROP),
props.getProperty(HybridCorefProperties.FEMALE_PROP),
props.getProperty(HybridCorefProperties.PLURAL_PROP),
props.getProperty(HybridCorefProperties.SINGULAR_PROP),
props.getProperty(HybridCorefProperties.STATES_PROP, DefaultPaths.DEFAULT_DCOREF_STATES),
props.getProperty(HybridCorefProperties.GENDER_NUMBER_PROP, HybridCorefProperties.getGenderNumber(props)),
props.getProperty(HybridCorefProperties.COUNTRIES_PROP, DefaultPaths.DEFAULT_DCOREF_COUNTRIES),
props.getProperty(HybridCorefProperties.STATES_PROVINCES_PROP, DefaultPaths.DEFAULT_DCOREF_STATES_AND_PROVINCES),
HybridCorefProperties.getSieves(props).contains("CorefDictionaryMatch"),
PropertiesUtils.getStringArray(props, HybridCorefProperties.DICT_LIST_PROP,
new String[]{DefaultPaths.DEFAULT_DCOREF_DICT1, DefaultPaths.DEFAULT_DCOREF_DICT2,
DefaultPaths.DEFAULT_DCOREF_DICT3, DefaultPaths.DEFAULT_DCOREF_DICT4}),
props.getProperty(HybridCorefProperties.DICT_PMI_PROP, DefaultPaths.DEFAULT_DCOREF_DICT1),
props.getProperty(HybridCorefProperties.SIGNATURES_PROP, DefaultPaths.DEFAULT_DCOREF_NE_SIGNATURES));
/*if(CorefProperties.useSemantics(props)) {
loadSemantics(props);
} else {
log.info("SEMANTICS NOT LOADED");
}*/
if(props.containsKey("coref.zh.dict")) {
loadChineseGenderNumberAnimacy(props.getProperty("coref.zh.dict"));
}
}
public static String signature(Properties props) {
StringBuilder os = new StringBuilder();
os.append(HybridCorefProperties.DEMONYM_PROP + ":" +
props.getProperty(HybridCorefProperties.DEMONYM_PROP,
DefaultPaths.DEFAULT_DCOREF_DEMONYM));
os.append(HybridCorefProperties.ANIMATE_PROP + ":" +
props.getProperty(HybridCorefProperties.ANIMATE_PROP,
DefaultPaths.DEFAULT_DCOREF_ANIMATE));
os.append(HybridCorefProperties.INANIMATE_PROP + ":" +
props.getProperty(HybridCorefProperties.INANIMATE_PROP,
DefaultPaths.DEFAULT_DCOREF_INANIMATE));
if(props.containsKey(HybridCorefProperties.MALE_PROP)) {
os.append(HybridCorefProperties.MALE_PROP + ":" +
props.getProperty(HybridCorefProperties.MALE_PROP));
}
if(props.containsKey(HybridCorefProperties.NEUTRAL_PROP)) {
os.append(HybridCorefProperties.NEUTRAL_PROP + ":" +
props.getProperty(HybridCorefProperties.NEUTRAL_PROP));
}
if(props.containsKey(HybridCorefProperties.FEMALE_PROP)) {
os.append(HybridCorefProperties.FEMALE_PROP + ":" +
props.getProperty(HybridCorefProperties.FEMALE_PROP));
}
if(props.containsKey(HybridCorefProperties.PLURAL_PROP)) {
os.append(HybridCorefProperties.PLURAL_PROP + ":" +
props.getProperty(HybridCorefProperties.PLURAL_PROP));
}
if(props.containsKey(HybridCorefProperties.SINGULAR_PROP)) {
os.append(HybridCorefProperties.SINGULAR_PROP + ":" +
props.getProperty(HybridCorefProperties.SINGULAR_PROP));
}
os.append(HybridCorefProperties.STATES_PROP + ":" +
props.getProperty(HybridCorefProperties.STATES_PROP,
DefaultPaths.DEFAULT_DCOREF_STATES));
os.append(HybridCorefProperties.GENDER_NUMBER_PROP + ":" +
props.getProperty(HybridCorefProperties.GENDER_NUMBER_PROP,
DefaultPaths.DEFAULT_DCOREF_GENDER_NUMBER));
os.append(HybridCorefProperties.COUNTRIES_PROP + ":" +
props.getProperty(HybridCorefProperties.COUNTRIES_PROP,
DefaultPaths.DEFAULT_DCOREF_COUNTRIES));
os.append(HybridCorefProperties.STATES_PROVINCES_PROP + ":" +
props.getProperty(HybridCorefProperties.STATES_PROVINCES_PROP,
DefaultPaths.DEFAULT_DCOREF_STATES_AND_PROVINCES));
return os.toString();
}
public Dictionaries(
String language,
String demonymWords,
String animateWords,
String inanimateWords,
String maleWords,
String neutralWords,
String femaleWords,
String pluralWords,
String singularWords,
String statesWords,
String genderNumber,
String countries,
String states,
boolean loadCorefDict,
String[] corefDictFiles,
String corefDictPMIFile,
String signaturesFile) {
Locale lang = Locale.forLanguageTag(language);
readWordLists(lang);
loadDemonymLists(demonymWords);
loadStateAbbreviation(statesWords);
loadAnimacyLists(animateWords, inanimateWords);
loadGenderLists(maleWords, neutralWords, femaleWords);
loadNumberLists(pluralWords, singularWords);
loadGenderNumber(genderNumber, neutralWords);
loadCountriesLists(countries);
loadStatesLists(states);
setPronouns();
if(loadCorefDict){
loadCorefDict(corefDictFiles, corefDict);
loadCorefDictPMI(corefDictPMIFile, corefDictPMI);
loadSignatures(signaturesFile, NE_signatures);
}
}
public Dictionaries() throws ClassNotFoundException, IOException {
this(new Properties());
}
}
|
202033_19 | /******************************************************************************
* Product: Adempiere ERP & CRM Smart Business Solution *
* Copyright (C) 1999-2006 ComPiere, Inc. All Rights Reserved. *
* This program is free software; you can redistribute it and/or modify it *
* under the terms version 2 of the GNU General Public License as published *
* by the Free Software Foundation. This program is distributed in the hope *
* that it will be useful, but WITHOUT ANY WARRANTY; without even the implied *
* warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. *
* See the GNU General Public License for more details. *
* You should have received a copy of the GNU General Public License along *
* with this program; if not, write to the Free Software Foundation, Inc., *
* 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. *
* For the text or an alternative of this public license, you may reach us *
* ComPiere, Inc., 2620 Augustine Dr. #245, Santa Clara, CA 95054, USA *
* or via [email protected] or http://www.compiere.org/license.html *
*****************************************************************************/
package org.adempiere.plaf;
import java.awt.BorderLayout;
import java.awt.Color;
import java.awt.Cursor;
import java.awt.Dialog;
import java.awt.Dimension;
import java.awt.FlowLayout;
import java.awt.Frame;
import java.awt.GridBagConstraints;
import java.awt.GridBagLayout;
import java.awt.Insets;
import java.awt.Toolkit;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.util.ResourceBundle;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.swing.DefaultComboBoxModel;
import javax.swing.JButton;
import javax.swing.JCheckBox;
import javax.swing.JComboBox;
import javax.swing.JDialog;
import javax.swing.JEditorPane;
import javax.swing.JLabel;
import javax.swing.JList;
import javax.swing.JOptionPane;
import javax.swing.JPasswordField;
import javax.swing.JRadioButton;
import javax.swing.JScrollPane;
import javax.swing.JSplitPane;
import javax.swing.JTable;
import javax.swing.JTextArea;
import javax.swing.JTextField;
import javax.swing.JTextPane;
import javax.swing.JTree;
import javax.swing.LookAndFeel;
import javax.swing.UIManager;
import javax.swing.WindowConstants;
import javax.swing.border.TitledBorder;
import javax.swing.plaf.metal.MetalLookAndFeel;
import javax.swing.plaf.metal.MetalTheme;
import org.compiere.plaf.CompiereColor;
import org.compiere.plaf.CompiereLookAndFeel;
import org.compiere.swing.CButton;
import org.compiere.swing.CCheckBox;
import org.compiere.swing.CComboBox;
import org.compiere.swing.CLabel;
import org.compiere.swing.CPanel;
import org.compiere.swing.CTabbedPane;
import org.compiere.swing.CTextField;
import org.compiere.swing.CToggleButton;
import org.compiere.swing.ColorBlind;
import org.compiere.util.Ini;
import org.compiere.util.MiniBrowser;
import org.compiere.util.ValueNamePair;
/**
* Adempiere PLAF Editor.
* <p>
* start with <code>new AdempierePLAFEditor()</code>
*
* @author Jorg Janke
* @author Marek Mosiewicz - switching to correct way of detecting theme
* @version $Id: AdempierePLAFEditor.java,v 1.3 2006/07/30 00:52:24 jjanke Exp $
*/
public class PLAFEditor extends JDialog
implements ActionListener
{
/**
*
*/
private static final long serialVersionUID = -6010229234801706748L;
/**
* Default Constructor
* Don't Show Example
*/
public PLAFEditor()
{
super();
init(false);
} // PLAFEditor
/**
* Constructor
* @param showExample if true, show Example
*/
public PLAFEditor (boolean showExample)
{
super();
init(true);
} // PLAFEditor
/**
* Modal Dialog Constructor
* @param owner
* @param showExample if true, show Example
*/
public PLAFEditor(Dialog owner, boolean showExample)
{
super(owner, "", true);
init(true);
} // PLAFEditor
/**
* Modal Frame Constructor
* @param owner
* @param showExample if true, show Example
*/
public PLAFEditor(Frame owner, boolean showExample)
{
super(owner, "", true);
init(true);
} // PLAFEditor
/** Logger */
private static Logger log = Logger.getLogger(PLAFEditor.class.getName());
/**************************************************************************
* Init Editor
* @param showExample if true, show Example
*/
private void init (boolean showExample)
{
try
{
jbInit();
dynInit();
// Display
example.setVisible(showExample);
blindLabel.setVisible(showExample);
blindField.setVisible(showExample);
AdempierePLAF.showCenterScreen(this);
}
catch(Exception e)
{
log.log(Level.SEVERE, "", e);
}
} // PLAFEditor
/** Diable Theme Field */
private boolean m_setting = false;
/** We did test for true color */
private boolean m_colorTest = false;
static ResourceBundle s_res = ResourceBundle.getBundle("org.compiere.plaf.PlafRes");
static Object[] s_columns = new Object[] {"-0-", "-1-", "-2-", "-3-", "-O-", "-l-"};
static Object[][] s_data = new Object[][] {
{"-00-", "-01-", "-02-", "-03-", "-0O-", "-0l-"},
{"-10-", "-11-", "-12-", "-13-", "-1O-", "-1l-"},
{"-20-", "-21-", "-22-", "-23-", "-2O-", "-2l-"},
{"-30-", "-31-", "-32-", "-33-", "-3O-", "-3l-"},
{"-O0-", "-O1-", "-O2-", "-O3-", "-OO-", "-Ol-"},
{"-l0-", "-l1-", "-l2-", "-l3-", "-lO-", "-ll-"}};
static Object[] s_pos = new Object[] {"Top", "Left", "Bottom", "Right"};
private CPanel mainPanel = new CPanel(new BorderLayout());
private CPanel northPanel = new CPanel();
private CPanel southPanel = new CPanel();
private CButton bOK = AdempierePLAF.getOKButton();
private CButton bCancel = AdempierePLAF.getCancelButton();
private CButton bHelp = new CButton(); /** @todo Help Button */
private GridBagLayout northLayout = new GridBagLayout();
private CLabel lfLabel = new CLabel();
private CComboBox lfField = new CComboBox(AdempierePLAF.getPLAFs());
private CLabel themeLabel = new CLabel();
private CComboBox themeField = new CComboBox(AdempierePLAF.getThemes());
private FlowLayout southLayout = new FlowLayout();
private CButton rButton = new CButton();
private CComboBox blindField = new CComboBox(ColorBlind.COLORBLIND_TYPE);
private CLabel blindLabel = new CLabel();
private BorderLayout mainLayout = new BorderLayout();
//
private CTabbedPane example = new CTabbedPane();
private CPanel jPanel1 = new CPanel();
private TitledBorder exampleBorder;
private CPanel jPanel2 = new CPanel();
private JLabel jLabel1 = new JLabel();
private JTextField jTextField1 = new JTextField();
private JCheckBox jCheckBox1 = new JCheckBox();
private JRadioButton jRadioButton1 = new JRadioButton();
private CButton jButton1 = new CButton();
private CToggleButton jToggleButton1 = new CToggleButton();
private CComboBox jComboBox1 = new CComboBox(s_columns);
private JTextArea jTextArea1 = new JTextArea();
private JTextPane jTextPane1 = new JTextPane();
private JEditorPane jEditorPane1 = new JEditorPane();
private JPasswordField jPasswordField1 = new JPasswordField();
private JList jList1 = new JList(s_columns);
private JSplitPane jSplitPane1 = new JSplitPane();
private BorderLayout borderLayout1 = new BorderLayout();
private JScrollPane jScrollPane1 = new JScrollPane();
private JTree jTree1 = new JTree();
private JScrollPane jScrollPane2 = new JScrollPane();
private JTable jTable1 = new JTable(s_data, s_columns);
private GridBagLayout gridBagLayout1 = new GridBagLayout();
private CPanel jPanelFlat = new CPanel(new CompiereColor(new Color(255,205,255), true));
private CPanel jPanelGradient = new CPanel(new CompiereColor(new Color(233,210,210), new Color(217,210,233)));
private CPanel jPanelTexture = new CPanel(new CompiereColor(CompiereColor.class.getResource("vincent.jpg"), Color.lightGray, 0.7f));
private CPanel jPanelLines = new CPanel(new CompiereColor(new Color(178,181,205), new Color(193,193,205), 1.0f, 5));
private JButton jButtonFlat = new JButton();
private CButton jButtonGardient = new CButton();
private JButton jButtonTexture = new JButton();
private CButton jButtonLines = new CButton();
private JComboBox jComboBoxFlat = new JComboBox(s_pos);
private JTextField jTextFieldFlat = new JTextField();
private JLabel jLabelFlat = new JLabel();
private CComboBox jComboBoxGradient = new CComboBox(s_pos);
private CTextField jTextFieldGradient = new CTextField();
private CLabel jLabelGradient = new CLabel();
private JComboBox jComboBoxTexture = new JComboBox(s_pos);
private JTextField jTextFieldTexture = new JTextField();
private JLabel jLabelTexture = new JLabel();
private CComboBox jComboBoxLines = new CComboBox(s_pos);
private CTextField jTextFieldLines = new CTextField();
private CLabel jLabelLines = new CLabel();
private CCheckBox jCheckBoxLines = new CCheckBox();
private JCheckBox jCheckBoxTexture = new JCheckBox();
private CCheckBox jCheckBoxGradient = new CCheckBox();
private JCheckBox jCheckBoxFlat = new JCheckBox();
/**
* Static Layout
* @throws Exception
*/
private void jbInit() throws Exception
{
this.setDefaultCloseOperation(WindowConstants.DISPOSE_ON_CLOSE);
this.setTitle(s_res.getString("LookAndFeelEditor"));
mainPanel.setLayout(mainLayout);
mainLayout.setHgap(5);
mainLayout.setVgap(5);
jTextFieldFlat.setColumns(10);
jTextFieldGradient.setColumns(10);
jTextFieldTexture.setColumns(10);
jTextFieldLines.setColumns(10);
jCheckBoxLines.setText("jCheckBox");
jCheckBoxTexture.setText("jCheckBox");
jCheckBoxGradient.setText("jCheckBox");
jCheckBoxFlat.setText("jCheckBox");
jPanelGradient.setToolTipText("Indented Level 1");
jPanelTexture.setToolTipText("Indented Level 2");
jPanelLines.setToolTipText("Indented Level 1");
this.getContentPane().add(mainPanel, BorderLayout.CENTER);
//
lfLabel.setText(s_res.getString("LookAndFeel"));
lfField.addActionListener(this);
themeLabel.setText(s_res.getString("Theme"));
themeField.addActionListener(this);
rButton.setText(s_res.getString("Reset"));
rButton.addActionListener(this);
blindLabel.setText(s_res.getString("ColorBlind"));
blindField.addActionListener(this);
//
bOK.addActionListener(this);
bCancel.addActionListener(this);
bHelp.addActionListener(this);
//
northPanel.setLayout(northLayout);
southPanel.setLayout(southLayout);
southLayout.setAlignment(FlowLayout.RIGHT);
//
exampleBorder = new TitledBorder(s_res.getString("Example"));
example.setBorder(exampleBorder);
jLabel1.setText("jLabel");
jTextField1.setText("jTextField");
jCheckBox1.setText("jCheckBox");
jRadioButton1.setText("jRadioButton");
jButton1.setText("jButton");
jToggleButton1.setText("jToggleButton");
jTextArea1.setText("jTextArea");
jTextPane1.setText("jTextPane");
jEditorPane1.setText("jEditorPane");
jPasswordField1.setText("jPasswordField");
jPanel2.setLayout(borderLayout1);
jPanel1.setLayout(gridBagLayout1);
jScrollPane1.setPreferredSize(new Dimension(100, 200));
jScrollPane2.setPreferredSize(new Dimension(100, 200));
jButtonFlat.setText("Confirm");
jButtonGardient.setText("Input");
jButtonTexture.setText("Message");
jButtonLines.setText("Error");
jTextFieldFlat.setText("jTextField");
jLabelFlat.setText("jLabel");
jTextFieldGradient.setText("jTextField");
jLabelGradient.setText("jLabel");
jTextFieldTexture.setText("jTextField");
jLabelTexture.setText("jLabel");
jTextFieldLines.setText("jTextField");
jLabelLines.setText("jLabel");
mainPanel.add(northPanel, BorderLayout.NORTH);
northPanel.add(lfLabel, new GridBagConstraints(0, 0, 1, 1, 0.0, 0.0
,GridBagConstraints.EAST, GridBagConstraints.NONE, new Insets(12, 12, 5, 5), 0, 0));
northPanel.add(lfField, new GridBagConstraints(1, 0, 1, 1, 0.0, 0.0
,GridBagConstraints.WEST, GridBagConstraints.HORIZONTAL, new Insets(12, 0, 5, 12), 0, 0));
northPanel.add(themeLabel, new GridBagConstraints(0, 1, 1, 1, 0.0, 0.0
,GridBagConstraints.EAST, GridBagConstraints.NONE, new Insets(0, 12, 5, 5), 0, 0));
northPanel.add(themeField, new GridBagConstraints(1, 1, 1, 1, 0.0, 0.0
,GridBagConstraints.WEST, GridBagConstraints.HORIZONTAL, new Insets(0, 0, 5, 12), 0, 0));
northPanel.add(rButton, new GridBagConstraints(0, 2, 1, 1, 0.0, 0.0
,GridBagConstraints.EAST, GridBagConstraints.NONE, new Insets(5, 12, 5, 5), 0, 0));
northPanel.add(blindLabel, new GridBagConstraints(0, 5, 1, 1, 0.0, 0.0
,GridBagConstraints.EAST, GridBagConstraints.NONE, new Insets(5, 12, 5, 5), 0, 0));
northPanel.add(blindField, new GridBagConstraints(1, 5, 1, 1, 0.0, 0.0
,GridBagConstraints.WEST, GridBagConstraints.NONE, new Insets(5, 0, 5, 12), 0, 0));
mainPanel.add(southPanel, BorderLayout.SOUTH);
southPanel.add(bCancel, null);
southPanel.add(bOK, null);
mainPanel.add(example, BorderLayout.CENTER);
example.add(jPanel1, "JPanel");
jPanel1.add(jTextPane1, new GridBagConstraints(2, 3, 1, 1, 0.0, 0.2
,GridBagConstraints.CENTER, GridBagConstraints.BOTH, new Insets(5, 5, 5, 5), 0, 0));
jPanel1.add(jEditorPane1, new GridBagConstraints(1, 3, 1, 1, 0.0, 0.2
,GridBagConstraints.CENTER, GridBagConstraints.BOTH, new Insets(5, 5, 5, 5), 0, 0));
jPanel1.add(jList1, new GridBagConstraints(1, 2, 1, 1, 0.0, 0.2
,GridBagConstraints.CENTER, GridBagConstraints.BOTH, new Insets(5, 5, 5, 5), 0, 0));
jPanel1.add(jLabel1, new GridBagConstraints(0, 0, 1, 1, 0.0, 0.0
,GridBagConstraints.CENTER, GridBagConstraints.NONE, new Insets(5, 5, 5, 5), 0, 0));
jPanel1.add(jTextField1, new GridBagConstraints(1, 0, 1, 1, 0.0, 0.0
,GridBagConstraints.CENTER, GridBagConstraints.HORIZONTAL, new Insets(5, 5, 5, 5), 0, 0));
jPanel1.add(jCheckBox1, new GridBagConstraints(0, 1, 1, 1, 0.0, 0.0
,GridBagConstraints.CENTER, GridBagConstraints.NONE, new Insets(1, 1, 1, 1), 0, 0));
jPanel1.add(jRadioButton1, new GridBagConstraints(1, 1, 1, 1, 0.0, 0.0
,GridBagConstraints.CENTER, GridBagConstraints.NONE, new Insets(5, 5, 5, 5), 0, 0));
jPanel1.add(jButton1, new GridBagConstraints(2, 0, 1, 1, 0.0, 0.1
,GridBagConstraints.CENTER, GridBagConstraints.NONE, new Insets(5, 5, 5, 5), 0, 0));
jPanel1.add(jToggleButton1, new GridBagConstraints(2, 1, 1, 1, 0.0, 0.1
,GridBagConstraints.CENTER, GridBagConstraints.NONE, new Insets(5, 5, 5, 5), 0, 0));
jPanel1.add(jTextArea1, new GridBagConstraints(0, 3, 1, 1, 0.0, 0.2
,GridBagConstraints.CENTER, GridBagConstraints.BOTH, new Insets(5, 5, 5, 5), 0, 0));
jPanel1.add(jComboBox1, new GridBagConstraints(0, 2, 1, 1, 0.0, 0.0
,GridBagConstraints.CENTER, GridBagConstraints.NONE, new Insets(5, 5, 5, 5), 0, 0));
jPanel1.add(jPasswordField1, new GridBagConstraints(2, 2, 1, 1, 0.0, 0.0
,GridBagConstraints.CENTER, GridBagConstraints.HORIZONTAL, new Insets(5, 5, 5, 5), 0, 0));
example.add(jPanel2, "JPanel");
jPanel2.add(jSplitPane1, BorderLayout.CENTER);
jSplitPane1.add(jScrollPane1, JSplitPane.LEFT);
jSplitPane1.add(jScrollPane2, JSplitPane.RIGHT);
jPanelFlat.setName("FlatP");
jPanelGradient.setName("GradientP");
jPanelTexture.setName("TextureP");
jPanelLines.setName("LineP");
example.add(jPanelFlat, "jPanel Flat");
jPanelFlat.add(jButtonFlat, null);
jPanelFlat.add(jComboBoxFlat, null);
example.add(jPanelGradient, "jPanel Gradient 1");
jPanelGradient.add(jButtonGardient, null);
jPanelGradient.add(jComboBoxGradient, null);
jPanelGradient.add(jLabelGradient, null);
jPanelGradient.add(jTextFieldGradient, null);
example.add(jPanelTexture, "jPanel Texture 2");
jPanelTexture.add(jButtonTexture, null);
jPanelTexture.add(jComboBoxTexture, null);
jPanelTexture.add(jLabelTexture, null);
jPanelTexture.add(jTextFieldTexture, null);
example.add(jPanelLines, "jPanel Lines 1");
jPanelLines.add(jButtonLines, null);
jPanelLines.add(jComboBoxLines, null);
jPanelLines.add(jLabelLines, null);
jPanelLines.add(jTextFieldLines, null);
jScrollPane2.getViewport().add(jTable1, null);
jScrollPane1.getViewport().add(jTree1, null);
jPanelFlat.add(jLabelFlat, null);
jPanelFlat.add(jTextFieldFlat, null);
jPanelLines.add(jCheckBoxLines, null);
jPanelTexture.add(jCheckBoxTexture, null);
jPanelGradient.add(jCheckBoxGradient, null);
jPanelFlat.add(jCheckBoxFlat, null);
} // jbInit
/**
* Dynamic Init
*/
private void dynInit()
{
setLFSelection();
//
jPanelGradient.setTabLevel(1);
jPanelTexture.setTabLevel(2);
jPanelLines.setTabLevel(1);
//
jComboBoxFlat.addActionListener(this);
jComboBoxGradient.addActionListener(this);
jComboBoxTexture.addActionListener(this);
jComboBoxLines.addActionListener(this);
//
jButton1.addActionListener(this);
jButtonFlat.addActionListener(this);
jButtonGardient.addActionListener(this);
jButtonTexture.addActionListener(this);
jButtonLines.addActionListener(this);
//
} // dynInit
/**
* Set Picks From Environment
*/
private void setLFSelection()
{
m_setting = true;
// Search for PLAF
ValueNamePair plaf = null;
LookAndFeel lookFeel = UIManager.getLookAndFeel();
String look = lookFeel.getClass().getName();
for (int i = 0; i < AdempierePLAF.getPLAFs().length; i++)
{
ValueNamePair vp = AdempierePLAF.getPLAFs()[i];
if (vp.getValue().equals(look))
{
plaf = vp;
break;
}
}
if (plaf != null)
lfField.setSelectedItem(plaf);
// Search for Theme
MetalTheme metalTheme = null;
ValueNamePair theme = null;
boolean metal = UIManager.getLookAndFeel() instanceof MetalLookAndFeel;
themeField.setModel(new DefaultComboBoxModel(AdempierePLAF.getThemes()));
if (metal)
{
theme = null;
metalTheme = MetalLookAndFeel.getCurrentTheme();
if (metalTheme != null)
{
String lookTheme = metalTheme.getName();
for (int i = 0; i < AdempierePLAF.getThemes().length; i++)
{
ValueNamePair vp = AdempierePLAF.getThemes()[i];
if (vp.getName().equals(lookTheme))
{
theme = vp;
break;
}
}
}
if (theme != null)
themeField.setSelectedItem(theme);
}
m_setting = false;
log.info(lookFeel + " - " + metalTheme);
} // setLFSelection
/**************************************************************************
* ActionListener
* @param e
*/
public void actionPerformed(ActionEvent e)
{
setCursor(Cursor.getPredefinedCursor(Cursor.WAIT_CURSOR));
// OK - Save & Finish
if (e.getSource() == bOK)
{
Ini.saveProperties(true);
dispose();
}
// Cancel - Finish
else if (e.getSource() == bCancel)
{
dispose();
}
else if (e.getSource() == bHelp)
{
new MiniBrowser("https://gitter.im/adempiere/adempiere");
}
// Look & Feel changed
else if (e.getSource() == lfField && !m_setting)
{
m_setting = true; // disable Theme setting
// set new theme
AdempierePLAF.setPLAF((ValueNamePair)lfField.getSelectedItem(), null, true);
AdempierePLAF.updateUI(this);
setLFSelection();
m_setting = false; // enable Theme setting
}
// Theme Field Changed
else if (e.getSource() == themeField && !m_setting)
{
Ini.setProperty(Ini.P_UI_THEME, themeField.getSelectedItem().toString());
AdempierePLAF.setPLAF((ValueNamePair)lfField.getSelectedItem(), (ValueNamePair)themeField.getSelectedItem(),true);
AdempierePLAF.updateUI(this);
}
// Reset PLAFs
else if (e.getSource() == rButton)
{
AdempierePLAF.reset();
AdempierePLAF.updateUI(this);
setLFSelection();
ColorBlind.setColorType(ColorBlind.NORMAL);
}
// ColorBlind
else if (e.getSource() == blindField)
{
int sel = blindField.getSelectedIndex();
if (sel != ColorBlind.getColorType())
{
// Test for True color
if (!m_colorTest)
{
m_colorTest = true;
int size = Toolkit.getDefaultToolkit().getColorModel().getPixelSize();
if (size < 24)
JOptionPane.showMessageDialog(this,
"Your environment has only a pixel size of " + size
+ ".\nTo see the effect, you need to have a pixel size of 24 (true color)",
"Insufficient Color Capabilities",
JOptionPane.ERROR_MESSAGE);
}
ColorBlind.setColorType(sel);
AdempierePLAF.updateUI(this);
}
}
// Change Tab Pacement
else if (e.getSource() == jComboBoxFlat || e.getSource() == jComboBoxGradient
|| e.getSource() == jComboBoxTexture || e.getSource() == jComboBoxLines)
{
if (!m_setting)
{
m_setting = true;
int index = ((JComboBox)e.getSource()).getSelectedIndex();
example.setTabPlacement(index+1);
jComboBoxFlat.setSelectedIndex(index);
jComboBoxGradient.setSelectedIndex(index);
jComboBoxTexture.setSelectedIndex(index);
jComboBoxLines.setSelectedIndex(index);
m_setting = false;
}
}
// Display Options
else if (e.getSource() == jButtonFlat)
JOptionPane.showConfirmDialog(this, "Confirm Dialog");
else if (e.getSource() == jButtonGardient)
JOptionPane.showInputDialog(this, "Input Dialog");
else if (e.getSource() == jButtonTexture)
JOptionPane.showMessageDialog(this, "Message Dialog");
else if (e.getSource() == jButtonLines)
JOptionPane.showMessageDialog(this, "Message Dialog - Error", "Error", JOptionPane.ERROR_MESSAGE);
// Test
else if (e.getSource() == jButton1)
{
}
/********************/
// Metal
boolean metal = UIManager.getLookAndFeel() instanceof MetalLookAndFeel;
themeField.setEnabled(metal);
themeLabel.setEnabled(metal);
boolean adempiere = UIManager.getLookAndFeel() instanceof CompiereLookAndFeel;
// ColorBlind - only with Adempiere L&F & Theme
boolean enableBlind = adempiere
&& themeField.getSelectedItem() != null
&& themeField.getSelectedItem().toString().indexOf("Adempiere") != -1;
blindField.setEnabled(enableBlind);
blindLabel.setEnabled(enableBlind);
if (e.getSource() != blindField && !enableBlind)
blindField.setSelectedIndex(0);
// done
setCursor(Cursor.getDefaultCursor());
} // actionPerformed
/**
* Dispose
* Exit, if there is no real owning parent (not modal) - shortcut
*/
public void dispose()
{
super.dispose();
if (!isModal())
System.exit(0);
} // dispose
} // AdempierePLAFEditor
| elsiosanchez/adempiere-box | client/src/org/adempiere/plaf/PLAFEditor.java | 7,230 | // Look & Feel changed
| line_comment | nl | /******************************************************************************
* Product: Adempiere ERP & CRM Smart Business Solution *
* Copyright (C) 1999-2006 ComPiere, Inc. All Rights Reserved. *
* This program is free software; you can redistribute it and/or modify it *
* under the terms version 2 of the GNU General Public License as published *
* by the Free Software Foundation. This program is distributed in the hope *
* that it will be useful, but WITHOUT ANY WARRANTY; without even the implied *
* warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. *
* See the GNU General Public License for more details. *
* You should have received a copy of the GNU General Public License along *
* with this program; if not, write to the Free Software Foundation, Inc., *
* 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. *
* For the text or an alternative of this public license, you may reach us *
* ComPiere, Inc., 2620 Augustine Dr. #245, Santa Clara, CA 95054, USA *
* or via [email protected] or http://www.compiere.org/license.html *
*****************************************************************************/
package org.adempiere.plaf;
import java.awt.BorderLayout;
import java.awt.Color;
import java.awt.Cursor;
import java.awt.Dialog;
import java.awt.Dimension;
import java.awt.FlowLayout;
import java.awt.Frame;
import java.awt.GridBagConstraints;
import java.awt.GridBagLayout;
import java.awt.Insets;
import java.awt.Toolkit;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.util.ResourceBundle;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.swing.DefaultComboBoxModel;
import javax.swing.JButton;
import javax.swing.JCheckBox;
import javax.swing.JComboBox;
import javax.swing.JDialog;
import javax.swing.JEditorPane;
import javax.swing.JLabel;
import javax.swing.JList;
import javax.swing.JOptionPane;
import javax.swing.JPasswordField;
import javax.swing.JRadioButton;
import javax.swing.JScrollPane;
import javax.swing.JSplitPane;
import javax.swing.JTable;
import javax.swing.JTextArea;
import javax.swing.JTextField;
import javax.swing.JTextPane;
import javax.swing.JTree;
import javax.swing.LookAndFeel;
import javax.swing.UIManager;
import javax.swing.WindowConstants;
import javax.swing.border.TitledBorder;
import javax.swing.plaf.metal.MetalLookAndFeel;
import javax.swing.plaf.metal.MetalTheme;
import org.compiere.plaf.CompiereColor;
import org.compiere.plaf.CompiereLookAndFeel;
import org.compiere.swing.CButton;
import org.compiere.swing.CCheckBox;
import org.compiere.swing.CComboBox;
import org.compiere.swing.CLabel;
import org.compiere.swing.CPanel;
import org.compiere.swing.CTabbedPane;
import org.compiere.swing.CTextField;
import org.compiere.swing.CToggleButton;
import org.compiere.swing.ColorBlind;
import org.compiere.util.Ini;
import org.compiere.util.MiniBrowser;
import org.compiere.util.ValueNamePair;
/**
* Adempiere PLAF Editor.
* <p>
* start with <code>new AdempierePLAFEditor()</code>
*
* @author Jorg Janke
* @author Marek Mosiewicz - switching to correct way of detecting theme
* @version $Id: AdempierePLAFEditor.java,v 1.3 2006/07/30 00:52:24 jjanke Exp $
*/
public class PLAFEditor extends JDialog
implements ActionListener
{
/**
*
*/
private static final long serialVersionUID = -6010229234801706748L;
/**
* Default Constructor
* Don't Show Example
*/
public PLAFEditor()
{
super();
init(false);
} // PLAFEditor
/**
* Constructor
* @param showExample if true, show Example
*/
public PLAFEditor (boolean showExample)
{
super();
init(true);
} // PLAFEditor
/**
* Modal Dialog Constructor
* @param owner
* @param showExample if true, show Example
*/
public PLAFEditor(Dialog owner, boolean showExample)
{
super(owner, "", true);
init(true);
} // PLAFEditor
/**
* Modal Frame Constructor
* @param owner
* @param showExample if true, show Example
*/
public PLAFEditor(Frame owner, boolean showExample)
{
super(owner, "", true);
init(true);
} // PLAFEditor
/** Logger */
private static Logger log = Logger.getLogger(PLAFEditor.class.getName());
/**************************************************************************
* Init Editor
* @param showExample if true, show Example
*/
private void init (boolean showExample)
{
try
{
jbInit();
dynInit();
// Display
example.setVisible(showExample);
blindLabel.setVisible(showExample);
blindField.setVisible(showExample);
AdempierePLAF.showCenterScreen(this);
}
catch(Exception e)
{
log.log(Level.SEVERE, "", e);
}
} // PLAFEditor
/** Diable Theme Field */
private boolean m_setting = false;
/** We did test for true color */
private boolean m_colorTest = false;
static ResourceBundle s_res = ResourceBundle.getBundle("org.compiere.plaf.PlafRes");
static Object[] s_columns = new Object[] {"-0-", "-1-", "-2-", "-3-", "-O-", "-l-"};
static Object[][] s_data = new Object[][] {
{"-00-", "-01-", "-02-", "-03-", "-0O-", "-0l-"},
{"-10-", "-11-", "-12-", "-13-", "-1O-", "-1l-"},
{"-20-", "-21-", "-22-", "-23-", "-2O-", "-2l-"},
{"-30-", "-31-", "-32-", "-33-", "-3O-", "-3l-"},
{"-O0-", "-O1-", "-O2-", "-O3-", "-OO-", "-Ol-"},
{"-l0-", "-l1-", "-l2-", "-l3-", "-lO-", "-ll-"}};
static Object[] s_pos = new Object[] {"Top", "Left", "Bottom", "Right"};
private CPanel mainPanel = new CPanel(new BorderLayout());
private CPanel northPanel = new CPanel();
private CPanel southPanel = new CPanel();
private CButton bOK = AdempierePLAF.getOKButton();
private CButton bCancel = AdempierePLAF.getCancelButton();
private CButton bHelp = new CButton(); /** @todo Help Button */
private GridBagLayout northLayout = new GridBagLayout();
private CLabel lfLabel = new CLabel();
private CComboBox lfField = new CComboBox(AdempierePLAF.getPLAFs());
private CLabel themeLabel = new CLabel();
private CComboBox themeField = new CComboBox(AdempierePLAF.getThemes());
private FlowLayout southLayout = new FlowLayout();
private CButton rButton = new CButton();
private CComboBox blindField = new CComboBox(ColorBlind.COLORBLIND_TYPE);
private CLabel blindLabel = new CLabel();
private BorderLayout mainLayout = new BorderLayout();
//
private CTabbedPane example = new CTabbedPane();
private CPanel jPanel1 = new CPanel();
private TitledBorder exampleBorder;
private CPanel jPanel2 = new CPanel();
private JLabel jLabel1 = new JLabel();
private JTextField jTextField1 = new JTextField();
private JCheckBox jCheckBox1 = new JCheckBox();
private JRadioButton jRadioButton1 = new JRadioButton();
private CButton jButton1 = new CButton();
private CToggleButton jToggleButton1 = new CToggleButton();
private CComboBox jComboBox1 = new CComboBox(s_columns);
private JTextArea jTextArea1 = new JTextArea();
private JTextPane jTextPane1 = new JTextPane();
private JEditorPane jEditorPane1 = new JEditorPane();
private JPasswordField jPasswordField1 = new JPasswordField();
private JList jList1 = new JList(s_columns);
private JSplitPane jSplitPane1 = new JSplitPane();
private BorderLayout borderLayout1 = new BorderLayout();
private JScrollPane jScrollPane1 = new JScrollPane();
private JTree jTree1 = new JTree();
private JScrollPane jScrollPane2 = new JScrollPane();
private JTable jTable1 = new JTable(s_data, s_columns);
private GridBagLayout gridBagLayout1 = new GridBagLayout();
private CPanel jPanelFlat = new CPanel(new CompiereColor(new Color(255,205,255), true));
private CPanel jPanelGradient = new CPanel(new CompiereColor(new Color(233,210,210), new Color(217,210,233)));
private CPanel jPanelTexture = new CPanel(new CompiereColor(CompiereColor.class.getResource("vincent.jpg"), Color.lightGray, 0.7f));
private CPanel jPanelLines = new CPanel(new CompiereColor(new Color(178,181,205), new Color(193,193,205), 1.0f, 5));
private JButton jButtonFlat = new JButton();
private CButton jButtonGardient = new CButton();
private JButton jButtonTexture = new JButton();
private CButton jButtonLines = new CButton();
private JComboBox jComboBoxFlat = new JComboBox(s_pos);
private JTextField jTextFieldFlat = new JTextField();
private JLabel jLabelFlat = new JLabel();
private CComboBox jComboBoxGradient = new CComboBox(s_pos);
private CTextField jTextFieldGradient = new CTextField();
private CLabel jLabelGradient = new CLabel();
private JComboBox jComboBoxTexture = new JComboBox(s_pos);
private JTextField jTextFieldTexture = new JTextField();
private JLabel jLabelTexture = new JLabel();
private CComboBox jComboBoxLines = new CComboBox(s_pos);
private CTextField jTextFieldLines = new CTextField();
private CLabel jLabelLines = new CLabel();
private CCheckBox jCheckBoxLines = new CCheckBox();
private JCheckBox jCheckBoxTexture = new JCheckBox();
private CCheckBox jCheckBoxGradient = new CCheckBox();
private JCheckBox jCheckBoxFlat = new JCheckBox();
/**
* Static Layout
* @throws Exception
*/
private void jbInit() throws Exception
{
this.setDefaultCloseOperation(WindowConstants.DISPOSE_ON_CLOSE);
this.setTitle(s_res.getString("LookAndFeelEditor"));
mainPanel.setLayout(mainLayout);
mainLayout.setHgap(5);
mainLayout.setVgap(5);
jTextFieldFlat.setColumns(10);
jTextFieldGradient.setColumns(10);
jTextFieldTexture.setColumns(10);
jTextFieldLines.setColumns(10);
jCheckBoxLines.setText("jCheckBox");
jCheckBoxTexture.setText("jCheckBox");
jCheckBoxGradient.setText("jCheckBox");
jCheckBoxFlat.setText("jCheckBox");
jPanelGradient.setToolTipText("Indented Level 1");
jPanelTexture.setToolTipText("Indented Level 2");
jPanelLines.setToolTipText("Indented Level 1");
this.getContentPane().add(mainPanel, BorderLayout.CENTER);
//
lfLabel.setText(s_res.getString("LookAndFeel"));
lfField.addActionListener(this);
themeLabel.setText(s_res.getString("Theme"));
themeField.addActionListener(this);
rButton.setText(s_res.getString("Reset"));
rButton.addActionListener(this);
blindLabel.setText(s_res.getString("ColorBlind"));
blindField.addActionListener(this);
//
bOK.addActionListener(this);
bCancel.addActionListener(this);
bHelp.addActionListener(this);
//
northPanel.setLayout(northLayout);
southPanel.setLayout(southLayout);
southLayout.setAlignment(FlowLayout.RIGHT);
//
exampleBorder = new TitledBorder(s_res.getString("Example"));
example.setBorder(exampleBorder);
jLabel1.setText("jLabel");
jTextField1.setText("jTextField");
jCheckBox1.setText("jCheckBox");
jRadioButton1.setText("jRadioButton");
jButton1.setText("jButton");
jToggleButton1.setText("jToggleButton");
jTextArea1.setText("jTextArea");
jTextPane1.setText("jTextPane");
jEditorPane1.setText("jEditorPane");
jPasswordField1.setText("jPasswordField");
jPanel2.setLayout(borderLayout1);
jPanel1.setLayout(gridBagLayout1);
jScrollPane1.setPreferredSize(new Dimension(100, 200));
jScrollPane2.setPreferredSize(new Dimension(100, 200));
jButtonFlat.setText("Confirm");
jButtonGardient.setText("Input");
jButtonTexture.setText("Message");
jButtonLines.setText("Error");
jTextFieldFlat.setText("jTextField");
jLabelFlat.setText("jLabel");
jTextFieldGradient.setText("jTextField");
jLabelGradient.setText("jLabel");
jTextFieldTexture.setText("jTextField");
jLabelTexture.setText("jLabel");
jTextFieldLines.setText("jTextField");
jLabelLines.setText("jLabel");
mainPanel.add(northPanel, BorderLayout.NORTH);
northPanel.add(lfLabel, new GridBagConstraints(0, 0, 1, 1, 0.0, 0.0
,GridBagConstraints.EAST, GridBagConstraints.NONE, new Insets(12, 12, 5, 5), 0, 0));
northPanel.add(lfField, new GridBagConstraints(1, 0, 1, 1, 0.0, 0.0
,GridBagConstraints.WEST, GridBagConstraints.HORIZONTAL, new Insets(12, 0, 5, 12), 0, 0));
northPanel.add(themeLabel, new GridBagConstraints(0, 1, 1, 1, 0.0, 0.0
,GridBagConstraints.EAST, GridBagConstraints.NONE, new Insets(0, 12, 5, 5), 0, 0));
northPanel.add(themeField, new GridBagConstraints(1, 1, 1, 1, 0.0, 0.0
,GridBagConstraints.WEST, GridBagConstraints.HORIZONTAL, new Insets(0, 0, 5, 12), 0, 0));
northPanel.add(rButton, new GridBagConstraints(0, 2, 1, 1, 0.0, 0.0
,GridBagConstraints.EAST, GridBagConstraints.NONE, new Insets(5, 12, 5, 5), 0, 0));
northPanel.add(blindLabel, new GridBagConstraints(0, 5, 1, 1, 0.0, 0.0
,GridBagConstraints.EAST, GridBagConstraints.NONE, new Insets(5, 12, 5, 5), 0, 0));
northPanel.add(blindField, new GridBagConstraints(1, 5, 1, 1, 0.0, 0.0
,GridBagConstraints.WEST, GridBagConstraints.NONE, new Insets(5, 0, 5, 12), 0, 0));
mainPanel.add(southPanel, BorderLayout.SOUTH);
southPanel.add(bCancel, null);
southPanel.add(bOK, null);
mainPanel.add(example, BorderLayout.CENTER);
example.add(jPanel1, "JPanel");
jPanel1.add(jTextPane1, new GridBagConstraints(2, 3, 1, 1, 0.0, 0.2
,GridBagConstraints.CENTER, GridBagConstraints.BOTH, new Insets(5, 5, 5, 5), 0, 0));
jPanel1.add(jEditorPane1, new GridBagConstraints(1, 3, 1, 1, 0.0, 0.2
,GridBagConstraints.CENTER, GridBagConstraints.BOTH, new Insets(5, 5, 5, 5), 0, 0));
jPanel1.add(jList1, new GridBagConstraints(1, 2, 1, 1, 0.0, 0.2
,GridBagConstraints.CENTER, GridBagConstraints.BOTH, new Insets(5, 5, 5, 5), 0, 0));
jPanel1.add(jLabel1, new GridBagConstraints(0, 0, 1, 1, 0.0, 0.0
,GridBagConstraints.CENTER, GridBagConstraints.NONE, new Insets(5, 5, 5, 5), 0, 0));
jPanel1.add(jTextField1, new GridBagConstraints(1, 0, 1, 1, 0.0, 0.0
,GridBagConstraints.CENTER, GridBagConstraints.HORIZONTAL, new Insets(5, 5, 5, 5), 0, 0));
jPanel1.add(jCheckBox1, new GridBagConstraints(0, 1, 1, 1, 0.0, 0.0
,GridBagConstraints.CENTER, GridBagConstraints.NONE, new Insets(1, 1, 1, 1), 0, 0));
jPanel1.add(jRadioButton1, new GridBagConstraints(1, 1, 1, 1, 0.0, 0.0
,GridBagConstraints.CENTER, GridBagConstraints.NONE, new Insets(5, 5, 5, 5), 0, 0));
jPanel1.add(jButton1, new GridBagConstraints(2, 0, 1, 1, 0.0, 0.1
,GridBagConstraints.CENTER, GridBagConstraints.NONE, new Insets(5, 5, 5, 5), 0, 0));
jPanel1.add(jToggleButton1, new GridBagConstraints(2, 1, 1, 1, 0.0, 0.1
,GridBagConstraints.CENTER, GridBagConstraints.NONE, new Insets(5, 5, 5, 5), 0, 0));
jPanel1.add(jTextArea1, new GridBagConstraints(0, 3, 1, 1, 0.0, 0.2
,GridBagConstraints.CENTER, GridBagConstraints.BOTH, new Insets(5, 5, 5, 5), 0, 0));
jPanel1.add(jComboBox1, new GridBagConstraints(0, 2, 1, 1, 0.0, 0.0
,GridBagConstraints.CENTER, GridBagConstraints.NONE, new Insets(5, 5, 5, 5), 0, 0));
jPanel1.add(jPasswordField1, new GridBagConstraints(2, 2, 1, 1, 0.0, 0.0
,GridBagConstraints.CENTER, GridBagConstraints.HORIZONTAL, new Insets(5, 5, 5, 5), 0, 0));
example.add(jPanel2, "JPanel");
jPanel2.add(jSplitPane1, BorderLayout.CENTER);
jSplitPane1.add(jScrollPane1, JSplitPane.LEFT);
jSplitPane1.add(jScrollPane2, JSplitPane.RIGHT);
jPanelFlat.setName("FlatP");
jPanelGradient.setName("GradientP");
jPanelTexture.setName("TextureP");
jPanelLines.setName("LineP");
example.add(jPanelFlat, "jPanel Flat");
jPanelFlat.add(jButtonFlat, null);
jPanelFlat.add(jComboBoxFlat, null);
example.add(jPanelGradient, "jPanel Gradient 1");
jPanelGradient.add(jButtonGardient, null);
jPanelGradient.add(jComboBoxGradient, null);
jPanelGradient.add(jLabelGradient, null);
jPanelGradient.add(jTextFieldGradient, null);
example.add(jPanelTexture, "jPanel Texture 2");
jPanelTexture.add(jButtonTexture, null);
jPanelTexture.add(jComboBoxTexture, null);
jPanelTexture.add(jLabelTexture, null);
jPanelTexture.add(jTextFieldTexture, null);
example.add(jPanelLines, "jPanel Lines 1");
jPanelLines.add(jButtonLines, null);
jPanelLines.add(jComboBoxLines, null);
jPanelLines.add(jLabelLines, null);
jPanelLines.add(jTextFieldLines, null);
jScrollPane2.getViewport().add(jTable1, null);
jScrollPane1.getViewport().add(jTree1, null);
jPanelFlat.add(jLabelFlat, null);
jPanelFlat.add(jTextFieldFlat, null);
jPanelLines.add(jCheckBoxLines, null);
jPanelTexture.add(jCheckBoxTexture, null);
jPanelGradient.add(jCheckBoxGradient, null);
jPanelFlat.add(jCheckBoxFlat, null);
} // jbInit
/**
* Dynamic Init
*/
private void dynInit()
{
setLFSelection();
//
jPanelGradient.setTabLevel(1);
jPanelTexture.setTabLevel(2);
jPanelLines.setTabLevel(1);
//
jComboBoxFlat.addActionListener(this);
jComboBoxGradient.addActionListener(this);
jComboBoxTexture.addActionListener(this);
jComboBoxLines.addActionListener(this);
//
jButton1.addActionListener(this);
jButtonFlat.addActionListener(this);
jButtonGardient.addActionListener(this);
jButtonTexture.addActionListener(this);
jButtonLines.addActionListener(this);
//
} // dynInit
/**
* Set Picks From Environment
*/
private void setLFSelection()
{
m_setting = true;
// Search for PLAF
ValueNamePair plaf = null;
LookAndFeel lookFeel = UIManager.getLookAndFeel();
String look = lookFeel.getClass().getName();
for (int i = 0; i < AdempierePLAF.getPLAFs().length; i++)
{
ValueNamePair vp = AdempierePLAF.getPLAFs()[i];
if (vp.getValue().equals(look))
{
plaf = vp;
break;
}
}
if (plaf != null)
lfField.setSelectedItem(plaf);
// Search for Theme
MetalTheme metalTheme = null;
ValueNamePair theme = null;
boolean metal = UIManager.getLookAndFeel() instanceof MetalLookAndFeel;
themeField.setModel(new DefaultComboBoxModel(AdempierePLAF.getThemes()));
if (metal)
{
theme = null;
metalTheme = MetalLookAndFeel.getCurrentTheme();
if (metalTheme != null)
{
String lookTheme = metalTheme.getName();
for (int i = 0; i < AdempierePLAF.getThemes().length; i++)
{
ValueNamePair vp = AdempierePLAF.getThemes()[i];
if (vp.getName().equals(lookTheme))
{
theme = vp;
break;
}
}
}
if (theme != null)
themeField.setSelectedItem(theme);
}
m_setting = false;
log.info(lookFeel + " - " + metalTheme);
} // setLFSelection
/**************************************************************************
* ActionListener
* @param e
*/
public void actionPerformed(ActionEvent e)
{
setCursor(Cursor.getPredefinedCursor(Cursor.WAIT_CURSOR));
// OK - Save & Finish
if (e.getSource() == bOK)
{
Ini.saveProperties(true);
dispose();
}
// Cancel - Finish
else if (e.getSource() == bCancel)
{
dispose();
}
else if (e.getSource() == bHelp)
{
new MiniBrowser("https://gitter.im/adempiere/adempiere");
}
// Look &<SUF>
else if (e.getSource() == lfField && !m_setting)
{
m_setting = true; // disable Theme setting
// set new theme
AdempierePLAF.setPLAF((ValueNamePair)lfField.getSelectedItem(), null, true);
AdempierePLAF.updateUI(this);
setLFSelection();
m_setting = false; // enable Theme setting
}
// Theme Field Changed
else if (e.getSource() == themeField && !m_setting)
{
Ini.setProperty(Ini.P_UI_THEME, themeField.getSelectedItem().toString());
AdempierePLAF.setPLAF((ValueNamePair)lfField.getSelectedItem(), (ValueNamePair)themeField.getSelectedItem(),true);
AdempierePLAF.updateUI(this);
}
// Reset PLAFs
else if (e.getSource() == rButton)
{
AdempierePLAF.reset();
AdempierePLAF.updateUI(this);
setLFSelection();
ColorBlind.setColorType(ColorBlind.NORMAL);
}
// ColorBlind
else if (e.getSource() == blindField)
{
int sel = blindField.getSelectedIndex();
if (sel != ColorBlind.getColorType())
{
// Test for True color
if (!m_colorTest)
{
m_colorTest = true;
int size = Toolkit.getDefaultToolkit().getColorModel().getPixelSize();
if (size < 24)
JOptionPane.showMessageDialog(this,
"Your environment has only a pixel size of " + size
+ ".\nTo see the effect, you need to have a pixel size of 24 (true color)",
"Insufficient Color Capabilities",
JOptionPane.ERROR_MESSAGE);
}
ColorBlind.setColorType(sel);
AdempierePLAF.updateUI(this);
}
}
// Change Tab Pacement
else if (e.getSource() == jComboBoxFlat || e.getSource() == jComboBoxGradient
|| e.getSource() == jComboBoxTexture || e.getSource() == jComboBoxLines)
{
if (!m_setting)
{
m_setting = true;
int index = ((JComboBox)e.getSource()).getSelectedIndex();
example.setTabPlacement(index+1);
jComboBoxFlat.setSelectedIndex(index);
jComboBoxGradient.setSelectedIndex(index);
jComboBoxTexture.setSelectedIndex(index);
jComboBoxLines.setSelectedIndex(index);
m_setting = false;
}
}
// Display Options
else if (e.getSource() == jButtonFlat)
JOptionPane.showConfirmDialog(this, "Confirm Dialog");
else if (e.getSource() == jButtonGardient)
JOptionPane.showInputDialog(this, "Input Dialog");
else if (e.getSource() == jButtonTexture)
JOptionPane.showMessageDialog(this, "Message Dialog");
else if (e.getSource() == jButtonLines)
JOptionPane.showMessageDialog(this, "Message Dialog - Error", "Error", JOptionPane.ERROR_MESSAGE);
// Test
else if (e.getSource() == jButton1)
{
}
/********************/
// Metal
boolean metal = UIManager.getLookAndFeel() instanceof MetalLookAndFeel;
themeField.setEnabled(metal);
themeLabel.setEnabled(metal);
boolean adempiere = UIManager.getLookAndFeel() instanceof CompiereLookAndFeel;
// ColorBlind - only with Adempiere L&F & Theme
boolean enableBlind = adempiere
&& themeField.getSelectedItem() != null
&& themeField.getSelectedItem().toString().indexOf("Adempiere") != -1;
blindField.setEnabled(enableBlind);
blindLabel.setEnabled(enableBlind);
if (e.getSource() != blindField && !enableBlind)
blindField.setSelectedIndex(0);
// done
setCursor(Cursor.getDefaultCursor());
} // actionPerformed
/**
* Dispose
* Exit, if there is no real owning parent (not modal) - shortcut
*/
public void dispose()
{
super.dispose();
if (!isModal())
System.exit(0);
} // dispose
} // AdempierePLAFEditor
|
202034_7 | /*
* Copyright (c) 1999, 2011, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package com.sun.jndi.ldap.sasl;
import java.io.*;
import java.security.cert.X509Certificate;
import java.util.Vector;
import java.util.Hashtable;
import java.util.StringTokenizer;
import javax.naming.AuthenticationException;
import javax.naming.AuthenticationNotSupportedException;
import javax.naming.NamingException;
import javax.naming.ldap.Control;
import javax.security.auth.callback.CallbackHandler;
import javax.security.sasl.*;
import com.sun.jndi.ldap.Connection;
import com.sun.jndi.ldap.LdapClient;
import com.sun.jndi.ldap.LdapResult;
import com.sun.jndi.ldap.sasl.TlsChannelBinding.TlsChannelBindingType;
/**
* Handles SASL support.
*
* @author Vincent Ryan
* @author Rosanna Lee
*/
final public class LdapSasl {
// SASL stuff
private static final String SASL_CALLBACK = "java.naming.security.sasl.callback";
private static final String SASL_AUTHZ_ID =
"java.naming.security.sasl.authorizationId";
private static final String SASL_REALM =
"java.naming.security.sasl.realm";
private static final int LDAP_SUCCESS = 0;
private static final int LDAP_SASL_BIND_IN_PROGRESS = 14; // LDAPv3
private LdapSasl() {
}
/**
* Performs SASL bind.
* Creates a SaslClient by using a default CallbackHandler
* that uses the Context.SECURITY_PRINCIPAL and Context.SECURITY_CREDENTIALS
* properties to satisfy the callbacks, and by using the
* SASL_AUTHZ_ID property as the authorization id. If the SASL_AUTHZ_ID
* property has not been set, Context.SECURITY_PRINCIPAL is used.
* If SASL_CALLBACK has been set, use that instead of the default
* CallbackHandler.
* <p>
* If bind is successful and the selected SASL mechanism has a security
* layer, set inStream and outStream to be filter streams that use
* the security layer. These will be used for subsequent communication
* with the server.
*
* @param conn The non-null connection to use for sending an LDAP BIND
* @param server Non-null string name of host to connect to
* @param dn Non-null DN to bind as; also used as authentication ID
* @param pw Possibly null password; can be byte[], char[] or String
* @param authMech A non-null space-separated list of SASL authentication
* mechanisms.
* @param env The possibly null environment of the context, possibly containing
* properties for used by SASL mechanisms
* @param bindCtls The possibly null controls to accompany the bind
* @return LdapResult containing status of the bind
*/
@SuppressWarnings("unchecked")
public static LdapResult saslBind(LdapClient clnt, Connection conn,
String server, String dn, Object pw,
String authMech, Hashtable<?,?> env, Control[] bindCtls)
throws IOException, NamingException {
SaslClient saslClnt = null;
boolean cleanupHandler = false;
// Use supplied callback handler or create default
CallbackHandler cbh =
(env != null) ? (CallbackHandler)env.get(SASL_CALLBACK) : null;
if (cbh == null) {
cbh = new DefaultCallbackHandler(dn, pw, (String)env.get(SASL_REALM));
cleanupHandler = true;
}
// Prepare parameters for creating SASL client
String authzId = (env != null) ? (String)env.get(SASL_AUTHZ_ID) : null;
String[] mechs = getSaslMechanismNames(authMech);
// Internal TLS Channel Binding property cannot be set explicitly
if (env.get(TlsChannelBinding.CHANNEL_BINDING) != null) {
throw new NamingException(TlsChannelBinding.CHANNEL_BINDING +
" property cannot be set explicitly");
}
Hashtable<String, Object> envProps = (Hashtable<String, Object>) env;
try {
// Prepare TLS Channel Binding data
if (conn.isTlsConnection()) {
TlsChannelBindingType cbType =
TlsChannelBinding.parseType(
(String)env.get(TlsChannelBinding.CHANNEL_BINDING_TYPE));
if (cbType == TlsChannelBindingType.TLS_SERVER_END_POINT) {
// set tls-server-end-point channel binding
X509Certificate cert = conn.getTlsServerCertificate();
if (cert != null) {
TlsChannelBinding tlsCB =
TlsChannelBinding.create(cert);
envProps = (Hashtable<String, Object>) env.clone();
envProps.put(TlsChannelBinding.CHANNEL_BINDING, tlsCB.getData());
} else {
throw new SaslException("No suitable certificate to generate " +
"TLS Channel Binding data");
}
}
}
// Create SASL client to use using SASL package
saslClnt = Sasl.createSaslClient(
mechs, authzId, "ldap", server, envProps, cbh);
if (saslClnt == null) {
throw new AuthenticationNotSupportedException(authMech);
}
LdapResult res;
String mechName = saslClnt.getMechanismName();
byte[] response = saslClnt.hasInitialResponse() ?
saslClnt.evaluateChallenge(NO_BYTES) : null;
res = clnt.ldapBind(null, response, bindCtls, mechName, true);
while (!saslClnt.isComplete() &&
(res.status == LDAP_SASL_BIND_IN_PROGRESS ||
res.status == LDAP_SUCCESS)) {
response = saslClnt.evaluateChallenge(
res.serverCreds != null? res.serverCreds : NO_BYTES);
if (res.status == LDAP_SUCCESS) {
if (response != null) {
throw new AuthenticationException(
"SASL client generated response after success");
}
break;
}
res = clnt.ldapBind(null, response, bindCtls, mechName, true);
}
if (res.status == LDAP_SUCCESS) {
if (!saslClnt.isComplete()) {
throw new AuthenticationException(
"SASL authentication not complete despite server claims");
}
String qop = (String) saslClnt.getNegotiatedProperty(Sasl.QOP);
// If negotiated integrity or privacy,
if (qop != null && (qop.equalsIgnoreCase("auth-int")
|| qop.equalsIgnoreCase("auth-conf"))) {
InputStream newIn = new SaslInputStream(saslClnt,
conn.inStream);
OutputStream newOut = new SaslOutputStream(saslClnt,
conn.outStream);
conn.replaceStreams(newIn, newOut);
} else {
saslClnt.dispose();
}
}
return res;
} catch (SaslException e) {
NamingException ne = new AuthenticationException(
authMech);
ne.setRootCause(e);
throw ne;
} finally {
if (cleanupHandler) {
((DefaultCallbackHandler)cbh).clearPassword();
}
}
}
/**
* Returns an array of SASL mechanisms given a string of space
* separated SASL mechanism names.
* @param The non-null string containing the mechanism names
* @return A non-null array of String; each element of the array
* contains a single mechanism name.
*/
private static String[] getSaslMechanismNames(String str) {
StringTokenizer parser = new StringTokenizer(str);
Vector<String> mechs = new Vector<>(10);
while (parser.hasMoreTokens()) {
mechs.addElement(parser.nextToken());
}
String[] mechNames = new String[mechs.size()];
for (int i = 0; i < mechs.size(); i++) {
mechNames[i] = mechs.elementAt(i);
}
return mechNames;
}
private static final byte[] NO_BYTES = new byte[0];
}
| adoptium/jdk11u-fast-startup-incubator | src/java.naming/share/classes/com/sun/jndi/ldap/sasl/LdapSasl.java | 2,324 | // set tls-server-end-point channel binding | line_comment | nl | /*
* Copyright (c) 1999, 2011, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package com.sun.jndi.ldap.sasl;
import java.io.*;
import java.security.cert.X509Certificate;
import java.util.Vector;
import java.util.Hashtable;
import java.util.StringTokenizer;
import javax.naming.AuthenticationException;
import javax.naming.AuthenticationNotSupportedException;
import javax.naming.NamingException;
import javax.naming.ldap.Control;
import javax.security.auth.callback.CallbackHandler;
import javax.security.sasl.*;
import com.sun.jndi.ldap.Connection;
import com.sun.jndi.ldap.LdapClient;
import com.sun.jndi.ldap.LdapResult;
import com.sun.jndi.ldap.sasl.TlsChannelBinding.TlsChannelBindingType;
/**
* Handles SASL support.
*
* @author Vincent Ryan
* @author Rosanna Lee
*/
final public class LdapSasl {
// SASL stuff
private static final String SASL_CALLBACK = "java.naming.security.sasl.callback";
private static final String SASL_AUTHZ_ID =
"java.naming.security.sasl.authorizationId";
private static final String SASL_REALM =
"java.naming.security.sasl.realm";
private static final int LDAP_SUCCESS = 0;
private static final int LDAP_SASL_BIND_IN_PROGRESS = 14; // LDAPv3
private LdapSasl() {
}
/**
* Performs SASL bind.
* Creates a SaslClient by using a default CallbackHandler
* that uses the Context.SECURITY_PRINCIPAL and Context.SECURITY_CREDENTIALS
* properties to satisfy the callbacks, and by using the
* SASL_AUTHZ_ID property as the authorization id. If the SASL_AUTHZ_ID
* property has not been set, Context.SECURITY_PRINCIPAL is used.
* If SASL_CALLBACK has been set, use that instead of the default
* CallbackHandler.
* <p>
* If bind is successful and the selected SASL mechanism has a security
* layer, set inStream and outStream to be filter streams that use
* the security layer. These will be used for subsequent communication
* with the server.
*
* @param conn The non-null connection to use for sending an LDAP BIND
* @param server Non-null string name of host to connect to
* @param dn Non-null DN to bind as; also used as authentication ID
* @param pw Possibly null password; can be byte[], char[] or String
* @param authMech A non-null space-separated list of SASL authentication
* mechanisms.
* @param env The possibly null environment of the context, possibly containing
* properties for used by SASL mechanisms
* @param bindCtls The possibly null controls to accompany the bind
* @return LdapResult containing status of the bind
*/
@SuppressWarnings("unchecked")
public static LdapResult saslBind(LdapClient clnt, Connection conn,
String server, String dn, Object pw,
String authMech, Hashtable<?,?> env, Control[] bindCtls)
throws IOException, NamingException {
SaslClient saslClnt = null;
boolean cleanupHandler = false;
// Use supplied callback handler or create default
CallbackHandler cbh =
(env != null) ? (CallbackHandler)env.get(SASL_CALLBACK) : null;
if (cbh == null) {
cbh = new DefaultCallbackHandler(dn, pw, (String)env.get(SASL_REALM));
cleanupHandler = true;
}
// Prepare parameters for creating SASL client
String authzId = (env != null) ? (String)env.get(SASL_AUTHZ_ID) : null;
String[] mechs = getSaslMechanismNames(authMech);
// Internal TLS Channel Binding property cannot be set explicitly
if (env.get(TlsChannelBinding.CHANNEL_BINDING) != null) {
throw new NamingException(TlsChannelBinding.CHANNEL_BINDING +
" property cannot be set explicitly");
}
Hashtable<String, Object> envProps = (Hashtable<String, Object>) env;
try {
// Prepare TLS Channel Binding data
if (conn.isTlsConnection()) {
TlsChannelBindingType cbType =
TlsChannelBinding.parseType(
(String)env.get(TlsChannelBinding.CHANNEL_BINDING_TYPE));
if (cbType == TlsChannelBindingType.TLS_SERVER_END_POINT) {
// set tls-server-end-point<SUF>
X509Certificate cert = conn.getTlsServerCertificate();
if (cert != null) {
TlsChannelBinding tlsCB =
TlsChannelBinding.create(cert);
envProps = (Hashtable<String, Object>) env.clone();
envProps.put(TlsChannelBinding.CHANNEL_BINDING, tlsCB.getData());
} else {
throw new SaslException("No suitable certificate to generate " +
"TLS Channel Binding data");
}
}
}
// Create SASL client to use using SASL package
saslClnt = Sasl.createSaslClient(
mechs, authzId, "ldap", server, envProps, cbh);
if (saslClnt == null) {
throw new AuthenticationNotSupportedException(authMech);
}
LdapResult res;
String mechName = saslClnt.getMechanismName();
byte[] response = saslClnt.hasInitialResponse() ?
saslClnt.evaluateChallenge(NO_BYTES) : null;
res = clnt.ldapBind(null, response, bindCtls, mechName, true);
while (!saslClnt.isComplete() &&
(res.status == LDAP_SASL_BIND_IN_PROGRESS ||
res.status == LDAP_SUCCESS)) {
response = saslClnt.evaluateChallenge(
res.serverCreds != null? res.serverCreds : NO_BYTES);
if (res.status == LDAP_SUCCESS) {
if (response != null) {
throw new AuthenticationException(
"SASL client generated response after success");
}
break;
}
res = clnt.ldapBind(null, response, bindCtls, mechName, true);
}
if (res.status == LDAP_SUCCESS) {
if (!saslClnt.isComplete()) {
throw new AuthenticationException(
"SASL authentication not complete despite server claims");
}
String qop = (String) saslClnt.getNegotiatedProperty(Sasl.QOP);
// If negotiated integrity or privacy,
if (qop != null && (qop.equalsIgnoreCase("auth-int")
|| qop.equalsIgnoreCase("auth-conf"))) {
InputStream newIn = new SaslInputStream(saslClnt,
conn.inStream);
OutputStream newOut = new SaslOutputStream(saslClnt,
conn.outStream);
conn.replaceStreams(newIn, newOut);
} else {
saslClnt.dispose();
}
}
return res;
} catch (SaslException e) {
NamingException ne = new AuthenticationException(
authMech);
ne.setRootCause(e);
throw ne;
} finally {
if (cleanupHandler) {
((DefaultCallbackHandler)cbh).clearPassword();
}
}
}
/**
* Returns an array of SASL mechanisms given a string of space
* separated SASL mechanism names.
* @param The non-null string containing the mechanism names
* @return A non-null array of String; each element of the array
* contains a single mechanism name.
*/
private static String[] getSaslMechanismNames(String str) {
StringTokenizer parser = new StringTokenizer(str);
Vector<String> mechs = new Vector<>(10);
while (parser.hasMoreTokens()) {
mechs.addElement(parser.nextToken());
}
String[] mechNames = new String[mechs.size()];
for (int i = 0; i < mechs.size(); i++) {
mechNames[i] = mechs.elementAt(i);
}
return mechNames;
}
private static final byte[] NO_BYTES = new byte[0];
}
|
202068_30 | /*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.proxydroid;
import org.proxydroid.utils.RegexValidator;
import java.io.Serializable;
import java.util.Arrays;
import java.util.List;
/**
* <p>
* <b>Domain name</b> validation routines.
* </p>
*
* <p>
* This validator provides methods for validating Internet domain names and
* top-level domains.
* </p>
*
* <p>
* Domain names are evaluated according to the standards <a
* href="http://www.ietf.org/rfc/rfc1034.txt">RFC1034</a>, section 3, and <a
* href="http://www.ietf.org/rfc/rfc1123.txt">RFC1123</a>, section 2.1. No
* accomodation is provided for the specialized needs of other applications; if
* the domain name has been URL-encoded, for example, validation will fail even
* though the equivalent plaintext version of the same name would have passed.
* </p>
*
* <p>
* Validation is also provided for top-level domains (TLDs) as defined and
* maintained by the Internet Assigned Numbers Authority (IANA):
* </p>
*
* <ul>
* <li>{@link #isValidInfrastructureTld} - validates infrastructure TLDs (
* <code>.arpa</code>, etc.)</li>
* <li>{@link #isValidGenericTld} - validates generic TLDs (
* <code>.com, .org</code>, etc.)</li>
* <li>{@link #isValidCountryCodeTld} - validates country code TLDs (
* <code>.us, .uk, .cn</code>, etc.)</li>
* </ul>
*
* <p>
* (<b>NOTE</b>: This class does not provide IP address lookup for domain names
* or methods to ensure that a given domain name matches a specific IP; see
* {@link java.net.InetAddress} for that functionality.)
* </p>
*
* @version $Revision$ $Date$
* @since Validator 1.4
*/
public class DomainValidator implements Serializable {
// Regular expression strings for hostnames (derived from RFC2396 and RFC
// 1123)
private static final String DOMAIN_LABEL_REGEX = "\\p{Alnum}(?>[\\p{Alnum}-]*\\p{Alnum})*";
private static final String TOP_LABEL_REGEX = "\\p{Alpha}{2,}";
private static final String DOMAIN_NAME_REGEX = "^(?:" + DOMAIN_LABEL_REGEX
+ "\\.)+" + "(" + TOP_LABEL_REGEX + ")$";
/**
* Singleton instance of this validator.
*/
private static final DomainValidator DOMAIN_VALIDATOR = new DomainValidator();
/**
* RegexValidator for matching domains.
*/
private final RegexValidator domainRegex = new RegexValidator(
DOMAIN_NAME_REGEX);
/**
* Returns the singleton instance of this validator.
*
* @return the singleton instance of this validator
*/
public static DomainValidator getInstance() {
return DOMAIN_VALIDATOR;
}
/** Private constructor. */
private DomainValidator() {
}
/**
* Returns true if the specified <code>String</code> parses as a valid
* domain name with a recognized top-level domain. The parsing is
* case-sensitive.
*
* @param domain
* the parameter to check for domain name syntax
* @return true if the parameter is a valid domain name
*/
public boolean isValid(String domain) {
String[] groups = domainRegex.match(domain);
if (groups != null && groups.length > 0) {
return isValidTld(groups[0]);
} else {
return false;
}
}
/**
* Returns true if the specified <code>String</code> matches any
* IANA-defined top-level domain. Leading dots are ignored if present. The
* search is case-sensitive.
*
* @param tld
* the parameter to check for TLD status
* @return true if the parameter is a TLD
*/
public boolean isValidTld(String tld) {
return isValidInfrastructureTld(tld) || isValidGenericTld(tld)
|| isValidCountryCodeTld(tld);
}
/**
* Returns true if the specified <code>String</code> matches any
* IANA-defined infrastructure top-level domain. Leading dots are ignored if
* present. The search is case-sensitive.
*
* @param iTld
* the parameter to check for infrastructure TLD status
* @return true if the parameter is an infrastructure TLD
*/
public boolean isValidInfrastructureTld(String iTld) {
return INFRASTRUCTURE_TLD_LIST.contains(chompLeadingDot(iTld
.toLowerCase()));
}
/**
* Returns true if the specified <code>String</code> matches any
* IANA-defined generic top-level domain. Leading dots are ignored if
* present. The search is case-sensitive.
*
* @param gTld
* the parameter to check for generic TLD status
* @return true if the parameter is a generic TLD
*/
public boolean isValidGenericTld(String gTld) {
return GENERIC_TLD_LIST.contains(chompLeadingDot(gTld.toLowerCase()));
}
/**
* Returns true if the specified <code>String</code> matches any
* IANA-defined country code top-level domain. Leading dots are ignored if
* present. The search is case-sensitive.
*
* @param ccTld
* the parameter to check for country code TLD status
* @return true if the parameter is a country code TLD
*/
public boolean isValidCountryCodeTld(String ccTld) {
return COUNTRY_CODE_TLD_LIST.contains(chompLeadingDot(ccTld
.toLowerCase()));
}
private String chompLeadingDot(String str) {
if (str.startsWith(".")) {
return str.substring(1);
} else {
return str;
}
}
// ---------------------------------------------
// ----- TLDs defined by IANA
// ----- Authoritative and comprehensive list at:
// ----- http://data.iana.org/TLD/tlds-alpha-by-domain.txt
private static final String[] INFRASTRUCTURE_TLDS = new String[] { "arpa", // internet
// infrastructure
"root" // diagnostic marker for non-truncated root zone
};
private static final String[] GENERIC_TLDS = new String[] { "aero", // air
// transport
// industry
"asia", // Pan-Asia/Asia Pacific
"biz", // businesses
"cat", // Catalan linguistic/cultural community
"com", // commercial enterprises
"coop", // cooperative associations
"info", // informational sites
"jobs", // Human Resource managers
"mobi", // mobile products and services
"museum", // museums, surprisingly enough
"name", // individuals' sites
"net", // internet support infrastructure/business
"org", // noncommercial organizations
"pro", // credentialed professionals and entities
"tel", // contact data for businesses and individuals
"travel", // entities in the travel industry
"gov", // United States Government
"edu", // accredited postsecondary US education entities
"mil", // United States Military
"int" // organizations established by international treaty
};
private static final String[] COUNTRY_CODE_TLDS = new String[] { "ac", // Ascension
// Island
"ad", // Andorra
"ae", // United Arab Emirates
"af", // Afghanistan
"ag", // Antigua and Barbuda
"ai", // Anguilla
"al", // Albania
"am", // Armenia
"an", // Netherlands Antilles
"ao", // Angola
"aq", // Antarctica
"ar", // Argentina
"as", // American Samoa
"at", // Austria
"au", // Australia (includes Ashmore and Cartier Islands and Coral
// Sea Islands)
"aw", // Aruba
"ax", // 脙鈥and
"az", // Azerbaijan
"ba", // Bosnia and Herzegovina
"bb", // Barbados
"bd", // Bangladesh
"be", // Belgium
"bf", // Burkina Faso
"bg", // Bulgaria
"bh", // Bahrain
"bi", // Burundi
"bj", // Benin
"bm", // Bermuda
"bn", // Brunei Darussalam
"bo", // Bolivia
"br", // Brazil
"bs", // Bahamas
"bt", // Bhutan
"bv", // Bouvet Island
"bw", // Botswana
"by", // Belarus
"bz", // Belize
"ca", // Canada
"cc", // Cocos (Keeling) Islands
"cd", // Democratic Republic of the Congo (formerly Zaire)
"cf", // Central African Republic
"cg", // Republic of the Congo
"ch", // Switzerland
"ci", // C脙麓te d'Ivoire
"ck", // Cook Islands
"cl", // Chile
"cm", // Cameroon
"cn", // China, mainland
"co", // Colombia
"cr", // Costa Rica
"cu", // Cuba
"cv", // Cape Verde
"cx", // Christmas Island
"cy", // Cyprus
"cz", // Czech Republic
"de", // Germany
"dj", // Djibouti
"dk", // Denmark
"dm", // Dominica
"do", // Dominican Republic
"dz", // Algeria
"ec", // Ecuador
"ee", // Estonia
"eg", // Egypt
"er", // Eritrea
"es", // Spain
"et", // Ethiopia
"eu", // European Union
"fi", // Finland
"fj", // Fiji
"fk", // Falkland Islands
"fm", // Federated States of Micronesia
"fo", // Faroe Islands
"fr", // France
"ga", // Gabon
"gb", // Great Britain (United Kingdom)
"gd", // Grenada
"ge", // Georgia
"gf", // French Guiana
"gg", // Guernsey
"gh", // Ghana
"gi", // Gibraltar
"gl", // Greenland
"gm", // The Gambia
"gn", // Guinea
"gp", // Guadeloupe
"gq", // Equatorial Guinea
"gr", // Greece
"gs", // South Georgia and the South Sandwich Islands
"gt", // Guatemala
"gu", // Guam
"gw", // Guinea-Bissau
"gy", // Guyana
"hk", // Hong Kong
"hm", // Heard Island and McDonald Islands
"hn", // Honduras
"hr", // Croatia (Hrvatska)
"ht", // Haiti
"hu", // Hungary
"id", // Indonesia
"ie", // Ireland (脙鈥癷re)
"il", // Israel
"im", // Isle of Man
"in", // India
"io", // British Indian Ocean Territory
"iq", // Iraq
"ir", // Iran
"is", // Iceland
"it", // Italy
"je", // Jersey
"jm", // Jamaica
"jo", // Jordan
"jp", // Japan
"ke", // Kenya
"kg", // Kyrgyzstan
"kh", // Cambodia (Khmer)
"ki", // Kiribati
"km", // Comoros
"kn", // Saint Kitts and Nevis
"kp", // North Korea
"kr", // South Korea
"kw", // Kuwait
"ky", // Cayman Islands
"kz", // Kazakhstan
"la", // Laos (currently being marketed as the official domain for
// Los Angeles)
"lb", // Lebanon
"lc", // Saint Lucia
"li", // Liechtenstein
"lk", // Sri Lanka
"lr", // Liberia
"ls", // Lesotho
"lt", // Lithuania
"lu", // Luxembourg
"lv", // Latvia
"ly", // Libya
"ma", // Morocco
"mc", // Monaco
"md", // Moldova
"me", // Montenegro
"mg", // Madagascar
"mh", // Marshall Islands
"mk", // Republic of Macedonia
"ml", // Mali
"mm", // Myanmar
"mn", // Mongolia
"mo", // Macau
"mp", // Northern Mariana Islands
"mq", // Martinique
"mr", // Mauritania
"ms", // Montserrat
"mt", // Malta
"mu", // Mauritius
"mv", // Maldives
"mw", // Malawi
"mx", // Mexico
"my", // Malaysia
"mz", // Mozambique
"na", // Namibia
"nc", // New Caledonia
"ne", // Niger
"nf", // Norfolk Island
"ng", // Nigeria
"ni", // Nicaragua
"nl", // Netherlands
"no", // Norway
"np", // Nepal
"nr", // Nauru
"nu", // Niue
"nz", // New Zealand
"om", // Oman
"pa", // Panama
"pe", // Peru
"pf", // French Polynesia With Clipperton Island
"pg", // Papua New Guinea
"ph", // Philippines
"pk", // Pakistan
"pl", // Poland
"pm", // Saint-Pierre and Miquelon
"pn", // Pitcairn Islands
"pr", // Puerto Rico
"ps", // Palestinian territories (PA-controlled West Bank and Gaza
// Strip)
"pt", // Portugal
"pw", // Palau
"py", // Paraguay
"qa", // Qatar
"re", // R脙漏union
"ro", // Romania
"rs", // Serbia
"ru", // Russia
"rw", // Rwanda
"sa", // Saudi Arabia
"sb", // Solomon Islands
"sc", // Seychelles
"sd", // Sudan
"se", // Sweden
"sg", // Singapore
"sh", // Saint Helena
"si", // Slovenia
"sj", // Svalbard and Jan Mayen Islands Not in use (Norwegian
// dependencies; see .no)
"sk", // Slovakia
"sl", // Sierra Leone
"sm", // San Marino
"sn", // Senegal
"so", // Somalia
"sr", // Suriname
"st", // S脙拢o Tom脙漏 and Pr脙颅ncipe
"su", // Soviet Union (deprecated)
"sv", // El Salvador
"sy", // Syria
"sz", // Swaziland
"tc", // Turks and Caicos Islands
"td", // Chad
"tf", // French Southern and Antarctic Lands
"tg", // Togo
"th", // Thailand
"tj", // Tajikistan
"tk", // Tokelau
"tl", // East Timor (deprecated old code)
"tm", // Turkmenistan
"tn", // Tunisia
"to", // Tonga
"tp", // East Timor
"tr", // Turkey
"tt", // Trinidad and Tobago
"tv", // Tuvalu
"tw", // Taiwan, Republic of China
"tz", // Tanzania
"ua", // Ukraine
"ug", // Uganda
"uk", // United Kingdom
"um", // United States Minor Outlying Islands
"us", // United States of America
"uy", // Uruguay
"uz", // Uzbekistan
"va", // Vatican City State
"vc", // Saint Vincent and the Grenadines
"ve", // Venezuela
"vg", // British Virgin Islands
"vi", // U.S. Virgin Islands
"vn", // Vietnam
"vu", // Vanuatu
"wf", // Wallis and Futuna
"ws", // Samoa (formerly Western Samoa)
"ye", // Yemen
"yt", // Mayotte
"yu", // Serbia and Montenegro (originally Yugoslavia)
"za", // South Africa
"zm", // Zambia
"zw", // Zimbabwe
};
private static final List INFRASTRUCTURE_TLD_LIST = Arrays
.asList(INFRASTRUCTURE_TLDS);
private static final List GENERIC_TLD_LIST = Arrays.asList(GENERIC_TLDS);
private static final List COUNTRY_CODE_TLD_LIST = Arrays
.asList(COUNTRY_CODE_TLDS);
}
| PinkDiamond1/proxydroid | app/src/main/java/org/proxydroid/DomainValidator.java | 4,495 | // Cocos (Keeling) Islands
| line_comment | nl | /*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.proxydroid;
import org.proxydroid.utils.RegexValidator;
import java.io.Serializable;
import java.util.Arrays;
import java.util.List;
/**
* <p>
* <b>Domain name</b> validation routines.
* </p>
*
* <p>
* This validator provides methods for validating Internet domain names and
* top-level domains.
* </p>
*
* <p>
* Domain names are evaluated according to the standards <a
* href="http://www.ietf.org/rfc/rfc1034.txt">RFC1034</a>, section 3, and <a
* href="http://www.ietf.org/rfc/rfc1123.txt">RFC1123</a>, section 2.1. No
* accomodation is provided for the specialized needs of other applications; if
* the domain name has been URL-encoded, for example, validation will fail even
* though the equivalent plaintext version of the same name would have passed.
* </p>
*
* <p>
* Validation is also provided for top-level domains (TLDs) as defined and
* maintained by the Internet Assigned Numbers Authority (IANA):
* </p>
*
* <ul>
* <li>{@link #isValidInfrastructureTld} - validates infrastructure TLDs (
* <code>.arpa</code>, etc.)</li>
* <li>{@link #isValidGenericTld} - validates generic TLDs (
* <code>.com, .org</code>, etc.)</li>
* <li>{@link #isValidCountryCodeTld} - validates country code TLDs (
* <code>.us, .uk, .cn</code>, etc.)</li>
* </ul>
*
* <p>
* (<b>NOTE</b>: This class does not provide IP address lookup for domain names
* or methods to ensure that a given domain name matches a specific IP; see
* {@link java.net.InetAddress} for that functionality.)
* </p>
*
* @version $Revision$ $Date$
* @since Validator 1.4
*/
public class DomainValidator implements Serializable {
// Regular expression strings for hostnames (derived from RFC2396 and RFC
// 1123)
private static final String DOMAIN_LABEL_REGEX = "\\p{Alnum}(?>[\\p{Alnum}-]*\\p{Alnum})*";
private static final String TOP_LABEL_REGEX = "\\p{Alpha}{2,}";
private static final String DOMAIN_NAME_REGEX = "^(?:" + DOMAIN_LABEL_REGEX
+ "\\.)+" + "(" + TOP_LABEL_REGEX + ")$";
/**
* Singleton instance of this validator.
*/
private static final DomainValidator DOMAIN_VALIDATOR = new DomainValidator();
/**
* RegexValidator for matching domains.
*/
private final RegexValidator domainRegex = new RegexValidator(
DOMAIN_NAME_REGEX);
/**
* Returns the singleton instance of this validator.
*
* @return the singleton instance of this validator
*/
public static DomainValidator getInstance() {
return DOMAIN_VALIDATOR;
}
/** Private constructor. */
private DomainValidator() {
}
/**
* Returns true if the specified <code>String</code> parses as a valid
* domain name with a recognized top-level domain. The parsing is
* case-sensitive.
*
* @param domain
* the parameter to check for domain name syntax
* @return true if the parameter is a valid domain name
*/
public boolean isValid(String domain) {
String[] groups = domainRegex.match(domain);
if (groups != null && groups.length > 0) {
return isValidTld(groups[0]);
} else {
return false;
}
}
/**
* Returns true if the specified <code>String</code> matches any
* IANA-defined top-level domain. Leading dots are ignored if present. The
* search is case-sensitive.
*
* @param tld
* the parameter to check for TLD status
* @return true if the parameter is a TLD
*/
public boolean isValidTld(String tld) {
return isValidInfrastructureTld(tld) || isValidGenericTld(tld)
|| isValidCountryCodeTld(tld);
}
/**
* Returns true if the specified <code>String</code> matches any
* IANA-defined infrastructure top-level domain. Leading dots are ignored if
* present. The search is case-sensitive.
*
* @param iTld
* the parameter to check for infrastructure TLD status
* @return true if the parameter is an infrastructure TLD
*/
public boolean isValidInfrastructureTld(String iTld) {
return INFRASTRUCTURE_TLD_LIST.contains(chompLeadingDot(iTld
.toLowerCase()));
}
/**
* Returns true if the specified <code>String</code> matches any
* IANA-defined generic top-level domain. Leading dots are ignored if
* present. The search is case-sensitive.
*
* @param gTld
* the parameter to check for generic TLD status
* @return true if the parameter is a generic TLD
*/
public boolean isValidGenericTld(String gTld) {
return GENERIC_TLD_LIST.contains(chompLeadingDot(gTld.toLowerCase()));
}
/**
* Returns true if the specified <code>String</code> matches any
* IANA-defined country code top-level domain. Leading dots are ignored if
* present. The search is case-sensitive.
*
* @param ccTld
* the parameter to check for country code TLD status
* @return true if the parameter is a country code TLD
*/
public boolean isValidCountryCodeTld(String ccTld) {
return COUNTRY_CODE_TLD_LIST.contains(chompLeadingDot(ccTld
.toLowerCase()));
}
private String chompLeadingDot(String str) {
if (str.startsWith(".")) {
return str.substring(1);
} else {
return str;
}
}
// ---------------------------------------------
// ----- TLDs defined by IANA
// ----- Authoritative and comprehensive list at:
// ----- http://data.iana.org/TLD/tlds-alpha-by-domain.txt
private static final String[] INFRASTRUCTURE_TLDS = new String[] { "arpa", // internet
// infrastructure
"root" // diagnostic marker for non-truncated root zone
};
private static final String[] GENERIC_TLDS = new String[] { "aero", // air
// transport
// industry
"asia", // Pan-Asia/Asia Pacific
"biz", // businesses
"cat", // Catalan linguistic/cultural community
"com", // commercial enterprises
"coop", // cooperative associations
"info", // informational sites
"jobs", // Human Resource managers
"mobi", // mobile products and services
"museum", // museums, surprisingly enough
"name", // individuals' sites
"net", // internet support infrastructure/business
"org", // noncommercial organizations
"pro", // credentialed professionals and entities
"tel", // contact data for businesses and individuals
"travel", // entities in the travel industry
"gov", // United States Government
"edu", // accredited postsecondary US education entities
"mil", // United States Military
"int" // organizations established by international treaty
};
private static final String[] COUNTRY_CODE_TLDS = new String[] { "ac", // Ascension
// Island
"ad", // Andorra
"ae", // United Arab Emirates
"af", // Afghanistan
"ag", // Antigua and Barbuda
"ai", // Anguilla
"al", // Albania
"am", // Armenia
"an", // Netherlands Antilles
"ao", // Angola
"aq", // Antarctica
"ar", // Argentina
"as", // American Samoa
"at", // Austria
"au", // Australia (includes Ashmore and Cartier Islands and Coral
// Sea Islands)
"aw", // Aruba
"ax", // 脙鈥and
"az", // Azerbaijan
"ba", // Bosnia and Herzegovina
"bb", // Barbados
"bd", // Bangladesh
"be", // Belgium
"bf", // Burkina Faso
"bg", // Bulgaria
"bh", // Bahrain
"bi", // Burundi
"bj", // Benin
"bm", // Bermuda
"bn", // Brunei Darussalam
"bo", // Bolivia
"br", // Brazil
"bs", // Bahamas
"bt", // Bhutan
"bv", // Bouvet Island
"bw", // Botswana
"by", // Belarus
"bz", // Belize
"ca", // Canada
"cc", // Cocos (Keeling)<SUF>
"cd", // Democratic Republic of the Congo (formerly Zaire)
"cf", // Central African Republic
"cg", // Republic of the Congo
"ch", // Switzerland
"ci", // C脙麓te d'Ivoire
"ck", // Cook Islands
"cl", // Chile
"cm", // Cameroon
"cn", // China, mainland
"co", // Colombia
"cr", // Costa Rica
"cu", // Cuba
"cv", // Cape Verde
"cx", // Christmas Island
"cy", // Cyprus
"cz", // Czech Republic
"de", // Germany
"dj", // Djibouti
"dk", // Denmark
"dm", // Dominica
"do", // Dominican Republic
"dz", // Algeria
"ec", // Ecuador
"ee", // Estonia
"eg", // Egypt
"er", // Eritrea
"es", // Spain
"et", // Ethiopia
"eu", // European Union
"fi", // Finland
"fj", // Fiji
"fk", // Falkland Islands
"fm", // Federated States of Micronesia
"fo", // Faroe Islands
"fr", // France
"ga", // Gabon
"gb", // Great Britain (United Kingdom)
"gd", // Grenada
"ge", // Georgia
"gf", // French Guiana
"gg", // Guernsey
"gh", // Ghana
"gi", // Gibraltar
"gl", // Greenland
"gm", // The Gambia
"gn", // Guinea
"gp", // Guadeloupe
"gq", // Equatorial Guinea
"gr", // Greece
"gs", // South Georgia and the South Sandwich Islands
"gt", // Guatemala
"gu", // Guam
"gw", // Guinea-Bissau
"gy", // Guyana
"hk", // Hong Kong
"hm", // Heard Island and McDonald Islands
"hn", // Honduras
"hr", // Croatia (Hrvatska)
"ht", // Haiti
"hu", // Hungary
"id", // Indonesia
"ie", // Ireland (脙鈥癷re)
"il", // Israel
"im", // Isle of Man
"in", // India
"io", // British Indian Ocean Territory
"iq", // Iraq
"ir", // Iran
"is", // Iceland
"it", // Italy
"je", // Jersey
"jm", // Jamaica
"jo", // Jordan
"jp", // Japan
"ke", // Kenya
"kg", // Kyrgyzstan
"kh", // Cambodia (Khmer)
"ki", // Kiribati
"km", // Comoros
"kn", // Saint Kitts and Nevis
"kp", // North Korea
"kr", // South Korea
"kw", // Kuwait
"ky", // Cayman Islands
"kz", // Kazakhstan
"la", // Laos (currently being marketed as the official domain for
// Los Angeles)
"lb", // Lebanon
"lc", // Saint Lucia
"li", // Liechtenstein
"lk", // Sri Lanka
"lr", // Liberia
"ls", // Lesotho
"lt", // Lithuania
"lu", // Luxembourg
"lv", // Latvia
"ly", // Libya
"ma", // Morocco
"mc", // Monaco
"md", // Moldova
"me", // Montenegro
"mg", // Madagascar
"mh", // Marshall Islands
"mk", // Republic of Macedonia
"ml", // Mali
"mm", // Myanmar
"mn", // Mongolia
"mo", // Macau
"mp", // Northern Mariana Islands
"mq", // Martinique
"mr", // Mauritania
"ms", // Montserrat
"mt", // Malta
"mu", // Mauritius
"mv", // Maldives
"mw", // Malawi
"mx", // Mexico
"my", // Malaysia
"mz", // Mozambique
"na", // Namibia
"nc", // New Caledonia
"ne", // Niger
"nf", // Norfolk Island
"ng", // Nigeria
"ni", // Nicaragua
"nl", // Netherlands
"no", // Norway
"np", // Nepal
"nr", // Nauru
"nu", // Niue
"nz", // New Zealand
"om", // Oman
"pa", // Panama
"pe", // Peru
"pf", // French Polynesia With Clipperton Island
"pg", // Papua New Guinea
"ph", // Philippines
"pk", // Pakistan
"pl", // Poland
"pm", // Saint-Pierre and Miquelon
"pn", // Pitcairn Islands
"pr", // Puerto Rico
"ps", // Palestinian territories (PA-controlled West Bank and Gaza
// Strip)
"pt", // Portugal
"pw", // Palau
"py", // Paraguay
"qa", // Qatar
"re", // R脙漏union
"ro", // Romania
"rs", // Serbia
"ru", // Russia
"rw", // Rwanda
"sa", // Saudi Arabia
"sb", // Solomon Islands
"sc", // Seychelles
"sd", // Sudan
"se", // Sweden
"sg", // Singapore
"sh", // Saint Helena
"si", // Slovenia
"sj", // Svalbard and Jan Mayen Islands Not in use (Norwegian
// dependencies; see .no)
"sk", // Slovakia
"sl", // Sierra Leone
"sm", // San Marino
"sn", // Senegal
"so", // Somalia
"sr", // Suriname
"st", // S脙拢o Tom脙漏 and Pr脙颅ncipe
"su", // Soviet Union (deprecated)
"sv", // El Salvador
"sy", // Syria
"sz", // Swaziland
"tc", // Turks and Caicos Islands
"td", // Chad
"tf", // French Southern and Antarctic Lands
"tg", // Togo
"th", // Thailand
"tj", // Tajikistan
"tk", // Tokelau
"tl", // East Timor (deprecated old code)
"tm", // Turkmenistan
"tn", // Tunisia
"to", // Tonga
"tp", // East Timor
"tr", // Turkey
"tt", // Trinidad and Tobago
"tv", // Tuvalu
"tw", // Taiwan, Republic of China
"tz", // Tanzania
"ua", // Ukraine
"ug", // Uganda
"uk", // United Kingdom
"um", // United States Minor Outlying Islands
"us", // United States of America
"uy", // Uruguay
"uz", // Uzbekistan
"va", // Vatican City State
"vc", // Saint Vincent and the Grenadines
"ve", // Venezuela
"vg", // British Virgin Islands
"vi", // U.S. Virgin Islands
"vn", // Vietnam
"vu", // Vanuatu
"wf", // Wallis and Futuna
"ws", // Samoa (formerly Western Samoa)
"ye", // Yemen
"yt", // Mayotte
"yu", // Serbia and Montenegro (originally Yugoslavia)
"za", // South Africa
"zm", // Zambia
"zw", // Zimbabwe
};
private static final List INFRASTRUCTURE_TLD_LIST = Arrays
.asList(INFRASTRUCTURE_TLDS);
private static final List GENERIC_TLD_LIST = Arrays.asList(GENERIC_TLDS);
private static final List COUNTRY_CODE_TLD_LIST = Arrays
.asList(COUNTRY_CODE_TLDS);
}
|
202108_0 | package verkiezingsuitslagen;
public class Partijuitslag {
private String partijnaam;
private int aantalStemmen;
private int aantalBasisZetels;
private boolean haaltDrempel;
private int aantalRestzetels;
public Partijuitslag(String pn, int a) {
partijnaam = pn;
aantalStemmen = a;
aantalBasisZetels = 0;
haaltDrempel = false;
aantalRestzetels = 0;
}
public String getNaam() {
return partijnaam;
}
public int getStemmen() {
return aantalStemmen;
}
public int getBasisZetels() {
return aantalBasisZetels;
}
public boolean haaltKiesdrempel() {
return haaltDrempel;
}
public void berekenBasiszetels(int kiesdeler) {
// berekent de afronding naar beneden van de deling, dat is juist goed
aantalBasisZetels = aantalStemmen / kiesdeler;
haaltDrempel = (aantalBasisZetels > 0);
}
public int getStemmenPerPluszetel() {
// returnt de afronding naar beneden van de deling, dat is juist goed
if (haaltDrempel) {
return aantalStemmen / (aantalBasisZetels + aantalRestzetels + 1);
} else {
return 0;
}
}
public void ontvangRestzetel() {
aantalRestzetels++;
}
public String getResultaat() {
return partijnaam + ": " + aantalStemmen + " stemmen, " + (aantalBasisZetels + aantalRestzetels) + " zetels";
}
} | hanaim-oopd/Code | Startcode/Verkiezingsuitslag/src/verkiezingsuitslagen/Partijuitslag.java | 435 | // berekent de afronding naar beneden van de deling, dat is juist goed | line_comment | nl | package verkiezingsuitslagen;
public class Partijuitslag {
private String partijnaam;
private int aantalStemmen;
private int aantalBasisZetels;
private boolean haaltDrempel;
private int aantalRestzetels;
public Partijuitslag(String pn, int a) {
partijnaam = pn;
aantalStemmen = a;
aantalBasisZetels = 0;
haaltDrempel = false;
aantalRestzetels = 0;
}
public String getNaam() {
return partijnaam;
}
public int getStemmen() {
return aantalStemmen;
}
public int getBasisZetels() {
return aantalBasisZetels;
}
public boolean haaltKiesdrempel() {
return haaltDrempel;
}
public void berekenBasiszetels(int kiesdeler) {
// berekent de<SUF>
aantalBasisZetels = aantalStemmen / kiesdeler;
haaltDrempel = (aantalBasisZetels > 0);
}
public int getStemmenPerPluszetel() {
// returnt de afronding naar beneden van de deling, dat is juist goed
if (haaltDrempel) {
return aantalStemmen / (aantalBasisZetels + aantalRestzetels + 1);
} else {
return 0;
}
}
public void ontvangRestzetel() {
aantalRestzetels++;
}
public String getResultaat() {
return partijnaam + ": " + aantalStemmen + " stemmen, " + (aantalBasisZetels + aantalRestzetels) + " zetels";
}
} |
202108_1 | package verkiezingsuitslagen;
public class Partijuitslag {
private String partijnaam;
private int aantalStemmen;
private int aantalBasisZetels;
private boolean haaltDrempel;
private int aantalRestzetels;
public Partijuitslag(String pn, int a) {
partijnaam = pn;
aantalStemmen = a;
aantalBasisZetels = 0;
haaltDrempel = false;
aantalRestzetels = 0;
}
public String getNaam() {
return partijnaam;
}
public int getStemmen() {
return aantalStemmen;
}
public int getBasisZetels() {
return aantalBasisZetels;
}
public boolean haaltKiesdrempel() {
return haaltDrempel;
}
public void berekenBasiszetels(int kiesdeler) {
// berekent de afronding naar beneden van de deling, dat is juist goed
aantalBasisZetels = aantalStemmen / kiesdeler;
haaltDrempel = (aantalBasisZetels > 0);
}
public int getStemmenPerPluszetel() {
// returnt de afronding naar beneden van de deling, dat is juist goed
if (haaltDrempel) {
return aantalStemmen / (aantalBasisZetels + aantalRestzetels + 1);
} else {
return 0;
}
}
public void ontvangRestzetel() {
aantalRestzetels++;
}
public String getResultaat() {
return partijnaam + ": " + aantalStemmen + " stemmen, " + (aantalBasisZetels + aantalRestzetels) + " zetels";
}
} | hanaim-oopd/Code | Startcode/Verkiezingsuitslag/src/verkiezingsuitslagen/Partijuitslag.java | 435 | // returnt de afronding naar beneden van de deling, dat is juist goed | line_comment | nl | package verkiezingsuitslagen;
public class Partijuitslag {
private String partijnaam;
private int aantalStemmen;
private int aantalBasisZetels;
private boolean haaltDrempel;
private int aantalRestzetels;
public Partijuitslag(String pn, int a) {
partijnaam = pn;
aantalStemmen = a;
aantalBasisZetels = 0;
haaltDrempel = false;
aantalRestzetels = 0;
}
public String getNaam() {
return partijnaam;
}
public int getStemmen() {
return aantalStemmen;
}
public int getBasisZetels() {
return aantalBasisZetels;
}
public boolean haaltKiesdrempel() {
return haaltDrempel;
}
public void berekenBasiszetels(int kiesdeler) {
// berekent de afronding naar beneden van de deling, dat is juist goed
aantalBasisZetels = aantalStemmen / kiesdeler;
haaltDrempel = (aantalBasisZetels > 0);
}
public int getStemmenPerPluszetel() {
// returnt de<SUF>
if (haaltDrempel) {
return aantalStemmen / (aantalBasisZetels + aantalRestzetels + 1);
} else {
return 0;
}
}
public void ontvangRestzetel() {
aantalRestzetels++;
}
public String getResultaat() {
return partijnaam + ": " + aantalStemmen + " stemmen, " + (aantalBasisZetels + aantalRestzetels) + " zetels";
}
} |
202122_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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.beheer.webapp.configuratie.json.modules;
import com.fasterxml.jackson.core.Version;
import com.fasterxml.jackson.databind.module.SimpleModule;
import javax.inject.Inject;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijRol;
import org.springframework.stereotype.Component;
/**
* Dienstbundel module voor serializen en deserializen van Dienstbundel.
*/
@Component
public class PartijRolModule extends SimpleModule {
/** veld id. */
public static final String ID = "id";
/** veld partij. */
public static final String PARTIJ = "partij";
/** veld rol. */
public static final String ROL = "rol";
/** veld naam. */
public static final String NAAM = "naam";
/** veld datum ingang. */
public static final String DATUM_INGANG = "datumIngang";
/** veld datum einde. */
public static final String DATUM_EINDE = "datumEinde";
private static final long serialVersionUID = 1L;
/**
* Constructor.
*
* @param partijRolDeserializer
* specifieke deserializer voor partij rol
* @param partijRolSerializer
* specifieke serializer voor partij rol
*/
@Inject
public PartijRolModule(final PartijRolDeserializer partijRolDeserializer, final PartijRolSerializer partijRolSerializer) {
addDeserializer(PartijRol.class, partijRolDeserializer);
addSerializer(PartijRol.class, partijRolSerializer);
}
@Override
public final String getModuleName() {
return "PartijRolModule";
}
@Override
public final Version version() {
return new Version(1, 0, 0, null, null, null);
}
}
| DDDNL/OperatieBRP | Broncode/operatiebrp-code-145.3/brp/beheer/beheer-api/src/main/java/nl/bzk/brp/beheer/webapp/configuratie/json/modules/PartijRolModule.java | 536 | /**
* Constructor.
*
* @param partijRolDeserializer
* specifieke deserializer voor partij rol
* @param partijRolSerializer
* specifieke serializer voor partij rol
*/ | 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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.beheer.webapp.configuratie.json.modules;
import com.fasterxml.jackson.core.Version;
import com.fasterxml.jackson.databind.module.SimpleModule;
import javax.inject.Inject;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijRol;
import org.springframework.stereotype.Component;
/**
* Dienstbundel module voor serializen en deserializen van Dienstbundel.
*/
@Component
public class PartijRolModule extends SimpleModule {
/** veld id. */
public static final String ID = "id";
/** veld partij. */
public static final String PARTIJ = "partij";
/** veld rol. */
public static final String ROL = "rol";
/** veld naam. */
public static final String NAAM = "naam";
/** veld datum ingang. */
public static final String DATUM_INGANG = "datumIngang";
/** veld datum einde. */
public static final String DATUM_EINDE = "datumEinde";
private static final long serialVersionUID = 1L;
/**
* Constructor.
<SUF>*/
@Inject
public PartijRolModule(final PartijRolDeserializer partijRolDeserializer, final PartijRolSerializer partijRolSerializer) {
addDeserializer(PartijRol.class, partijRolDeserializer);
addSerializer(PartijRol.class, partijRolSerializer);
}
@Override
public final String getModuleName() {
return "PartijRolModule";
}
@Override
public final Version version() {
return new Version(1, 0, 0, null, null, null);
}
}
|
202124_1 | /**
* 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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.beheer.webapp.controllers.stamgegevens.kern;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.Partij;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijBijhoudingHistorie;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijHistorie;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijRol;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijVrijBerichtHistorie;
import nl.bzk.brp.beheer.webapp.configuratie.ControllerConstants;
import nl.bzk.brp.beheer.webapp.controllers.AbstractHistorieVerwerker;
import nl.bzk.brp.beheer.webapp.controllers.AbstractReadWriteController;
import nl.bzk.brp.beheer.webapp.controllers.ErrorHandler;
import nl.bzk.brp.beheer.webapp.controllers.ErrorHandler.NotFoundException;
import nl.bzk.brp.beheer.webapp.controllers.ReadWriteController;
import nl.bzk.brp.beheer.webapp.controllers.query.BooleanValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.EqualPredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.Filter;
import nl.bzk.brp.beheer.webapp.controllers.query.IntegerValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.LessOrEqualPredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.LikePredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.ShortValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.StringValueAdapter;
import nl.bzk.brp.beheer.webapp.repository.stamgegevens.kern.PartijRepository;
import nl.bzk.brp.beheer.webapp.repository.stamgegevens.kern.SoortPartijRepository;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.domain.Sort;
import org.springframework.data.web.PageableDefault;
import org.springframework.data.web.SortDefault;
import org.springframework.http.HttpStatus;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestController;
/**
* Partij controller.
*/
@RestController
@RequestMapping(value = ControllerConstants.PARTIJ_URI)
public class PartijController extends AbstractReadWriteController<Partij, Short> {
private static final String NAAM = "naam";
private static final String CODE = "code";
private static final String DATUM_INGANG = "datumIngang";
private static final String DATUM_EINDE = "datumEinde";
private static final String AUTOMATISCH_FIATTEREN = "indicatieAutomatischFiatteren";
private static final String DATUM_OVERGANG_BRP = "datumOvergangNaarBrp";
private static final String PARTIJ_ROL = "partijRolSet.rolId";
private static final Filter<?> FILTER_CODE = new Filter<>("filterCode", new StringValueAdapter(), new EqualPredicateBuilderFactory(CODE));
private static final Filter<?> FILTER_NAAM = new Filter<>("filterNaam", new StringValueAdapter(), new LikePredicateBuilderFactory(NAAM));
private static final Filter<?> FILTER_OIN = new Filter<>("filterOin", new StringValueAdapter(), new LikePredicateBuilderFactory("oin"));
private static final Filter<?> FILTER_SOORT = new Filter<>("filterSoort", new ShortValueAdapter(), new EqualPredicateBuilderFactory("soortPartij.id"));
private static final Filter<?> FILTER_ROL = new Filter<>("filterPartijRol", new ShortValueAdapter(), new EqualPredicateBuilderFactory(PARTIJ_ROL));
private static final Filter<?> FILTER_DATUM_INGANG =
new Filter<>("filterDatumIngang", new IntegerValueAdapter(), new EqualPredicateBuilderFactory(DATUM_INGANG));
private static final Filter<?> FILTER_DATUM_EINDE =
new Filter<>("filterDatumEinde", new IntegerValueAdapter(), new EqualPredicateBuilderFactory(DATUM_EINDE));
private static final Filter<?> FILTER_DATUM_OVERGANG_BRP =
new Filter<>("filterDatumOvergangNaarBrp", new IntegerValueAdapter(), new LessOrEqualPredicateBuilderFactory<>(DATUM_OVERGANG_BRP));
private static final Filter<?> FILTER_INDICATIE =
new Filter<>("filterIndicatie", new BooleanValueAdapter(), new EqualPredicateBuilderFactory("indicatieVerstrekkingsbeperkingMogelijk"));
private static final Filter<?> FILTER_AUTOMATISCH_FIATTEREN =
new Filter<>("filterIndicatieAutomatischFiatteren", new BooleanValueAdapter(), new EqualPredicateBuilderFactory(AUTOMATISCH_FIATTEREN));
private static final List<String> SORTERINGEN = Arrays.asList(CODE, NAAM, DATUM_INGANG, DATUM_EINDE);
private final SoortPartijRepository soortPartijRepository;
private final ReadWriteController<PartijRol, Integer> partijRolController;
/**
* Constructor.
* @param repository repository
* @param soortPartijRepository repository voor soort partij
* @param partijRolController controller voor partijrol
*/
@Inject
protected PartijController(final PartijRepository repository, final SoortPartijRepository soortPartijRepository,
final ReadWriteController<PartijRol, Integer> partijRolController) {
super(repository,
Arrays.asList(
FILTER_CODE,
FILTER_NAAM,
FILTER_OIN,
FILTER_SOORT,
FILTER_DATUM_INGANG,
FILTER_DATUM_EINDE,
FILTER_INDICATIE,
FILTER_DATUM_OVERGANG_BRP,
FILTER_ROL,
FILTER_AUTOMATISCH_FIATTEREN
),
Arrays.asList(new PartijHistorieVerwerker(), new PartijBijhoudingHistorieVerwerker(), new PartijVrijBerichtHistorieVerwerker()),
SORTERINGEN);
this.soortPartijRepository = soortPartijRepository;
this.partijRolController = partijRolController;
}
@Override
protected final void wijzigObjectVoorOpslag(final Partij partij) throws ErrorHandler.NotFoundException {
if (partij.getSoortPartij() != null && partij.getSoortPartij().getId() != null) {
partij.setSoortPartij(soortPartijRepository.getOne(partij.getSoortPartij().getId()));
}
// Lege OIN's mogen niet, sla deze als null op.
if ("".equals(partij.getOin())) {
partij.setOin(null);
}
// Indicatieverstrekkingsbeperkingmogelijk mag niet leeg zijn, zet deze op FALSE indien leeg.
if (partij.isIndicatieVerstrekkingsbeperkingMogelijk() == null) {
partij.setIndicatieVerstrekkingsbeperkingMogelijk(Boolean.FALSE);
}
}
/**
* Haal een specifiek partijrol op.
* @param id id
* @param partijRolId partijRolId
* @return item
* @throws ErrorHandler.NotFoundException wanneer het item niet gevonden kan worden
*/
@RequestMapping(value = "/{id}/partijrollen/{pid}", method = RequestMethod.GET)
@ResponseStatus(HttpStatus.OK)
public final PartijRol getPartijRol(@PathVariable("id") final Long id, @PathVariable("pid") final Integer partijRolId)
throws ErrorHandler.NotFoundException {
return partijRolController.get(partijRolId);
}
/**
* Haal een lijst van partijrollen op.
* @param id id van actie
* @param parameters request parameters
* @param pageable paginering
* @return lijst van partijrol (inclusief paginering en sortering)
*/
@RequestMapping(value = "/{id}/partijrollen", method = RequestMethod.GET)
@ResponseStatus(HttpStatus.OK)
public final Page<PartijRol> listPartijRol(
@PathVariable(value = "id") final String id,
@RequestParam final Map<String, String> parameters,
@PageableDefault(size = 10) @SortDefault(sort = "datumIngang", direction = Sort.Direction.ASC) final Pageable pageable) {
parameters.put("partij", id);
return partijRolController.list(parameters, pageable);
}
/**
* Bewaar een partijrol.
* @param partijId Id van de partij
* @param item request body
* @return item
* @throws ErrorHandler.NotFoundException indien Partij niet gevonden wordt.
*/
@RequestMapping(value = "/{id}/partijrollen", method = RequestMethod.POST)
@ResponseStatus(HttpStatus.OK)
public final PartijRol savePartijRol(@PathVariable(value = "id") final Integer partijId, @Validated @RequestBody final PartijRol item)
throws NotFoundException {
item.setPartij(get(partijId.shortValue()));
return partijRolController.save(item);
}
/**
* Partij historie verwerker.
*/
static final class PartijHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijHistorie> {
@Override
public Class<PartijHistorie> historieClass() {
return PartijHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
/**
* PartijBijhouding historie verwerker.
*/
static final class PartijBijhoudingHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijBijhoudingHistorie> {
@Override
public Class<PartijBijhoudingHistorie> historieClass() {
return PartijBijhoudingHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
/**
* PartijVrijBericht historie verwerker.
*/
static final class PartijVrijBerichtHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijVrijBerichtHistorie> {
@Override
public Class<PartijVrijBerichtHistorie> historieClass() {
return PartijVrijBerichtHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
}
| DDDNL/OperatieBRP | Broncode/operatiebrp-code-145.3/brp/beheer/beheer-api/src/main/java/nl/bzk/brp/beheer/webapp/controllers/stamgegevens/kern/PartijController.java | 2,714 | /**
* Partij controller.
*/ | 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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.beheer.webapp.controllers.stamgegevens.kern;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.Partij;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijBijhoudingHistorie;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijHistorie;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijRol;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijVrijBerichtHistorie;
import nl.bzk.brp.beheer.webapp.configuratie.ControllerConstants;
import nl.bzk.brp.beheer.webapp.controllers.AbstractHistorieVerwerker;
import nl.bzk.brp.beheer.webapp.controllers.AbstractReadWriteController;
import nl.bzk.brp.beheer.webapp.controllers.ErrorHandler;
import nl.bzk.brp.beheer.webapp.controllers.ErrorHandler.NotFoundException;
import nl.bzk.brp.beheer.webapp.controllers.ReadWriteController;
import nl.bzk.brp.beheer.webapp.controllers.query.BooleanValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.EqualPredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.Filter;
import nl.bzk.brp.beheer.webapp.controllers.query.IntegerValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.LessOrEqualPredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.LikePredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.ShortValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.StringValueAdapter;
import nl.bzk.brp.beheer.webapp.repository.stamgegevens.kern.PartijRepository;
import nl.bzk.brp.beheer.webapp.repository.stamgegevens.kern.SoortPartijRepository;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.domain.Sort;
import org.springframework.data.web.PageableDefault;
import org.springframework.data.web.SortDefault;
import org.springframework.http.HttpStatus;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestController;
/**
* Partij controller.
<SUF>*/
@RestController
@RequestMapping(value = ControllerConstants.PARTIJ_URI)
public class PartijController extends AbstractReadWriteController<Partij, Short> {
private static final String NAAM = "naam";
private static final String CODE = "code";
private static final String DATUM_INGANG = "datumIngang";
private static final String DATUM_EINDE = "datumEinde";
private static final String AUTOMATISCH_FIATTEREN = "indicatieAutomatischFiatteren";
private static final String DATUM_OVERGANG_BRP = "datumOvergangNaarBrp";
private static final String PARTIJ_ROL = "partijRolSet.rolId";
private static final Filter<?> FILTER_CODE = new Filter<>("filterCode", new StringValueAdapter(), new EqualPredicateBuilderFactory(CODE));
private static final Filter<?> FILTER_NAAM = new Filter<>("filterNaam", new StringValueAdapter(), new LikePredicateBuilderFactory(NAAM));
private static final Filter<?> FILTER_OIN = new Filter<>("filterOin", new StringValueAdapter(), new LikePredicateBuilderFactory("oin"));
private static final Filter<?> FILTER_SOORT = new Filter<>("filterSoort", new ShortValueAdapter(), new EqualPredicateBuilderFactory("soortPartij.id"));
private static final Filter<?> FILTER_ROL = new Filter<>("filterPartijRol", new ShortValueAdapter(), new EqualPredicateBuilderFactory(PARTIJ_ROL));
private static final Filter<?> FILTER_DATUM_INGANG =
new Filter<>("filterDatumIngang", new IntegerValueAdapter(), new EqualPredicateBuilderFactory(DATUM_INGANG));
private static final Filter<?> FILTER_DATUM_EINDE =
new Filter<>("filterDatumEinde", new IntegerValueAdapter(), new EqualPredicateBuilderFactory(DATUM_EINDE));
private static final Filter<?> FILTER_DATUM_OVERGANG_BRP =
new Filter<>("filterDatumOvergangNaarBrp", new IntegerValueAdapter(), new LessOrEqualPredicateBuilderFactory<>(DATUM_OVERGANG_BRP));
private static final Filter<?> FILTER_INDICATIE =
new Filter<>("filterIndicatie", new BooleanValueAdapter(), new EqualPredicateBuilderFactory("indicatieVerstrekkingsbeperkingMogelijk"));
private static final Filter<?> FILTER_AUTOMATISCH_FIATTEREN =
new Filter<>("filterIndicatieAutomatischFiatteren", new BooleanValueAdapter(), new EqualPredicateBuilderFactory(AUTOMATISCH_FIATTEREN));
private static final List<String> SORTERINGEN = Arrays.asList(CODE, NAAM, DATUM_INGANG, DATUM_EINDE);
private final SoortPartijRepository soortPartijRepository;
private final ReadWriteController<PartijRol, Integer> partijRolController;
/**
* Constructor.
* @param repository repository
* @param soortPartijRepository repository voor soort partij
* @param partijRolController controller voor partijrol
*/
@Inject
protected PartijController(final PartijRepository repository, final SoortPartijRepository soortPartijRepository,
final ReadWriteController<PartijRol, Integer> partijRolController) {
super(repository,
Arrays.asList(
FILTER_CODE,
FILTER_NAAM,
FILTER_OIN,
FILTER_SOORT,
FILTER_DATUM_INGANG,
FILTER_DATUM_EINDE,
FILTER_INDICATIE,
FILTER_DATUM_OVERGANG_BRP,
FILTER_ROL,
FILTER_AUTOMATISCH_FIATTEREN
),
Arrays.asList(new PartijHistorieVerwerker(), new PartijBijhoudingHistorieVerwerker(), new PartijVrijBerichtHistorieVerwerker()),
SORTERINGEN);
this.soortPartijRepository = soortPartijRepository;
this.partijRolController = partijRolController;
}
@Override
protected final void wijzigObjectVoorOpslag(final Partij partij) throws ErrorHandler.NotFoundException {
if (partij.getSoortPartij() != null && partij.getSoortPartij().getId() != null) {
partij.setSoortPartij(soortPartijRepository.getOne(partij.getSoortPartij().getId()));
}
// Lege OIN's mogen niet, sla deze als null op.
if ("".equals(partij.getOin())) {
partij.setOin(null);
}
// Indicatieverstrekkingsbeperkingmogelijk mag niet leeg zijn, zet deze op FALSE indien leeg.
if (partij.isIndicatieVerstrekkingsbeperkingMogelijk() == null) {
partij.setIndicatieVerstrekkingsbeperkingMogelijk(Boolean.FALSE);
}
}
/**
* Haal een specifiek partijrol op.
* @param id id
* @param partijRolId partijRolId
* @return item
* @throws ErrorHandler.NotFoundException wanneer het item niet gevonden kan worden
*/
@RequestMapping(value = "/{id}/partijrollen/{pid}", method = RequestMethod.GET)
@ResponseStatus(HttpStatus.OK)
public final PartijRol getPartijRol(@PathVariable("id") final Long id, @PathVariable("pid") final Integer partijRolId)
throws ErrorHandler.NotFoundException {
return partijRolController.get(partijRolId);
}
/**
* Haal een lijst van partijrollen op.
* @param id id van actie
* @param parameters request parameters
* @param pageable paginering
* @return lijst van partijrol (inclusief paginering en sortering)
*/
@RequestMapping(value = "/{id}/partijrollen", method = RequestMethod.GET)
@ResponseStatus(HttpStatus.OK)
public final Page<PartijRol> listPartijRol(
@PathVariable(value = "id") final String id,
@RequestParam final Map<String, String> parameters,
@PageableDefault(size = 10) @SortDefault(sort = "datumIngang", direction = Sort.Direction.ASC) final Pageable pageable) {
parameters.put("partij", id);
return partijRolController.list(parameters, pageable);
}
/**
* Bewaar een partijrol.
* @param partijId Id van de partij
* @param item request body
* @return item
* @throws ErrorHandler.NotFoundException indien Partij niet gevonden wordt.
*/
@RequestMapping(value = "/{id}/partijrollen", method = RequestMethod.POST)
@ResponseStatus(HttpStatus.OK)
public final PartijRol savePartijRol(@PathVariable(value = "id") final Integer partijId, @Validated @RequestBody final PartijRol item)
throws NotFoundException {
item.setPartij(get(partijId.shortValue()));
return partijRolController.save(item);
}
/**
* Partij historie verwerker.
*/
static final class PartijHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijHistorie> {
@Override
public Class<PartijHistorie> historieClass() {
return PartijHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
/**
* PartijBijhouding historie verwerker.
*/
static final class PartijBijhoudingHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijBijhoudingHistorie> {
@Override
public Class<PartijBijhoudingHistorie> historieClass() {
return PartijBijhoudingHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
/**
* PartijVrijBericht historie verwerker.
*/
static final class PartijVrijBerichtHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijVrijBerichtHistorie> {
@Override
public Class<PartijVrijBerichtHistorie> historieClass() {
return PartijVrijBerichtHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
}
|
202124_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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.beheer.webapp.controllers.stamgegevens.kern;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.Partij;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijBijhoudingHistorie;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijHistorie;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijRol;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijVrijBerichtHistorie;
import nl.bzk.brp.beheer.webapp.configuratie.ControllerConstants;
import nl.bzk.brp.beheer.webapp.controllers.AbstractHistorieVerwerker;
import nl.bzk.brp.beheer.webapp.controllers.AbstractReadWriteController;
import nl.bzk.brp.beheer.webapp.controllers.ErrorHandler;
import nl.bzk.brp.beheer.webapp.controllers.ErrorHandler.NotFoundException;
import nl.bzk.brp.beheer.webapp.controllers.ReadWriteController;
import nl.bzk.brp.beheer.webapp.controllers.query.BooleanValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.EqualPredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.Filter;
import nl.bzk.brp.beheer.webapp.controllers.query.IntegerValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.LessOrEqualPredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.LikePredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.ShortValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.StringValueAdapter;
import nl.bzk.brp.beheer.webapp.repository.stamgegevens.kern.PartijRepository;
import nl.bzk.brp.beheer.webapp.repository.stamgegevens.kern.SoortPartijRepository;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.domain.Sort;
import org.springframework.data.web.PageableDefault;
import org.springframework.data.web.SortDefault;
import org.springframework.http.HttpStatus;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestController;
/**
* Partij controller.
*/
@RestController
@RequestMapping(value = ControllerConstants.PARTIJ_URI)
public class PartijController extends AbstractReadWriteController<Partij, Short> {
private static final String NAAM = "naam";
private static final String CODE = "code";
private static final String DATUM_INGANG = "datumIngang";
private static final String DATUM_EINDE = "datumEinde";
private static final String AUTOMATISCH_FIATTEREN = "indicatieAutomatischFiatteren";
private static final String DATUM_OVERGANG_BRP = "datumOvergangNaarBrp";
private static final String PARTIJ_ROL = "partijRolSet.rolId";
private static final Filter<?> FILTER_CODE = new Filter<>("filterCode", new StringValueAdapter(), new EqualPredicateBuilderFactory(CODE));
private static final Filter<?> FILTER_NAAM = new Filter<>("filterNaam", new StringValueAdapter(), new LikePredicateBuilderFactory(NAAM));
private static final Filter<?> FILTER_OIN = new Filter<>("filterOin", new StringValueAdapter(), new LikePredicateBuilderFactory("oin"));
private static final Filter<?> FILTER_SOORT = new Filter<>("filterSoort", new ShortValueAdapter(), new EqualPredicateBuilderFactory("soortPartij.id"));
private static final Filter<?> FILTER_ROL = new Filter<>("filterPartijRol", new ShortValueAdapter(), new EqualPredicateBuilderFactory(PARTIJ_ROL));
private static final Filter<?> FILTER_DATUM_INGANG =
new Filter<>("filterDatumIngang", new IntegerValueAdapter(), new EqualPredicateBuilderFactory(DATUM_INGANG));
private static final Filter<?> FILTER_DATUM_EINDE =
new Filter<>("filterDatumEinde", new IntegerValueAdapter(), new EqualPredicateBuilderFactory(DATUM_EINDE));
private static final Filter<?> FILTER_DATUM_OVERGANG_BRP =
new Filter<>("filterDatumOvergangNaarBrp", new IntegerValueAdapter(), new LessOrEqualPredicateBuilderFactory<>(DATUM_OVERGANG_BRP));
private static final Filter<?> FILTER_INDICATIE =
new Filter<>("filterIndicatie", new BooleanValueAdapter(), new EqualPredicateBuilderFactory("indicatieVerstrekkingsbeperkingMogelijk"));
private static final Filter<?> FILTER_AUTOMATISCH_FIATTEREN =
new Filter<>("filterIndicatieAutomatischFiatteren", new BooleanValueAdapter(), new EqualPredicateBuilderFactory(AUTOMATISCH_FIATTEREN));
private static final List<String> SORTERINGEN = Arrays.asList(CODE, NAAM, DATUM_INGANG, DATUM_EINDE);
private final SoortPartijRepository soortPartijRepository;
private final ReadWriteController<PartijRol, Integer> partijRolController;
/**
* Constructor.
* @param repository repository
* @param soortPartijRepository repository voor soort partij
* @param partijRolController controller voor partijrol
*/
@Inject
protected PartijController(final PartijRepository repository, final SoortPartijRepository soortPartijRepository,
final ReadWriteController<PartijRol, Integer> partijRolController) {
super(repository,
Arrays.asList(
FILTER_CODE,
FILTER_NAAM,
FILTER_OIN,
FILTER_SOORT,
FILTER_DATUM_INGANG,
FILTER_DATUM_EINDE,
FILTER_INDICATIE,
FILTER_DATUM_OVERGANG_BRP,
FILTER_ROL,
FILTER_AUTOMATISCH_FIATTEREN
),
Arrays.asList(new PartijHistorieVerwerker(), new PartijBijhoudingHistorieVerwerker(), new PartijVrijBerichtHistorieVerwerker()),
SORTERINGEN);
this.soortPartijRepository = soortPartijRepository;
this.partijRolController = partijRolController;
}
@Override
protected final void wijzigObjectVoorOpslag(final Partij partij) throws ErrorHandler.NotFoundException {
if (partij.getSoortPartij() != null && partij.getSoortPartij().getId() != null) {
partij.setSoortPartij(soortPartijRepository.getOne(partij.getSoortPartij().getId()));
}
// Lege OIN's mogen niet, sla deze als null op.
if ("".equals(partij.getOin())) {
partij.setOin(null);
}
// Indicatieverstrekkingsbeperkingmogelijk mag niet leeg zijn, zet deze op FALSE indien leeg.
if (partij.isIndicatieVerstrekkingsbeperkingMogelijk() == null) {
partij.setIndicatieVerstrekkingsbeperkingMogelijk(Boolean.FALSE);
}
}
/**
* Haal een specifiek partijrol op.
* @param id id
* @param partijRolId partijRolId
* @return item
* @throws ErrorHandler.NotFoundException wanneer het item niet gevonden kan worden
*/
@RequestMapping(value = "/{id}/partijrollen/{pid}", method = RequestMethod.GET)
@ResponseStatus(HttpStatus.OK)
public final PartijRol getPartijRol(@PathVariable("id") final Long id, @PathVariable("pid") final Integer partijRolId)
throws ErrorHandler.NotFoundException {
return partijRolController.get(partijRolId);
}
/**
* Haal een lijst van partijrollen op.
* @param id id van actie
* @param parameters request parameters
* @param pageable paginering
* @return lijst van partijrol (inclusief paginering en sortering)
*/
@RequestMapping(value = "/{id}/partijrollen", method = RequestMethod.GET)
@ResponseStatus(HttpStatus.OK)
public final Page<PartijRol> listPartijRol(
@PathVariable(value = "id") final String id,
@RequestParam final Map<String, String> parameters,
@PageableDefault(size = 10) @SortDefault(sort = "datumIngang", direction = Sort.Direction.ASC) final Pageable pageable) {
parameters.put("partij", id);
return partijRolController.list(parameters, pageable);
}
/**
* Bewaar een partijrol.
* @param partijId Id van de partij
* @param item request body
* @return item
* @throws ErrorHandler.NotFoundException indien Partij niet gevonden wordt.
*/
@RequestMapping(value = "/{id}/partijrollen", method = RequestMethod.POST)
@ResponseStatus(HttpStatus.OK)
public final PartijRol savePartijRol(@PathVariable(value = "id") final Integer partijId, @Validated @RequestBody final PartijRol item)
throws NotFoundException {
item.setPartij(get(partijId.shortValue()));
return partijRolController.save(item);
}
/**
* Partij historie verwerker.
*/
static final class PartijHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijHistorie> {
@Override
public Class<PartijHistorie> historieClass() {
return PartijHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
/**
* PartijBijhouding historie verwerker.
*/
static final class PartijBijhoudingHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijBijhoudingHistorie> {
@Override
public Class<PartijBijhoudingHistorie> historieClass() {
return PartijBijhoudingHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
/**
* PartijVrijBericht historie verwerker.
*/
static final class PartijVrijBerichtHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijVrijBerichtHistorie> {
@Override
public Class<PartijVrijBerichtHistorie> historieClass() {
return PartijVrijBerichtHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
}
| DDDNL/OperatieBRP | Broncode/operatiebrp-code-145.3/brp/beheer/beheer-api/src/main/java/nl/bzk/brp/beheer/webapp/controllers/stamgegevens/kern/PartijController.java | 2,714 | // Lege OIN's mogen niet, sla deze als null 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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.beheer.webapp.controllers.stamgegevens.kern;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.Partij;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijBijhoudingHistorie;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijHistorie;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijRol;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijVrijBerichtHistorie;
import nl.bzk.brp.beheer.webapp.configuratie.ControllerConstants;
import nl.bzk.brp.beheer.webapp.controllers.AbstractHistorieVerwerker;
import nl.bzk.brp.beheer.webapp.controllers.AbstractReadWriteController;
import nl.bzk.brp.beheer.webapp.controllers.ErrorHandler;
import nl.bzk.brp.beheer.webapp.controllers.ErrorHandler.NotFoundException;
import nl.bzk.brp.beheer.webapp.controllers.ReadWriteController;
import nl.bzk.brp.beheer.webapp.controllers.query.BooleanValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.EqualPredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.Filter;
import nl.bzk.brp.beheer.webapp.controllers.query.IntegerValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.LessOrEqualPredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.LikePredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.ShortValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.StringValueAdapter;
import nl.bzk.brp.beheer.webapp.repository.stamgegevens.kern.PartijRepository;
import nl.bzk.brp.beheer.webapp.repository.stamgegevens.kern.SoortPartijRepository;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.domain.Sort;
import org.springframework.data.web.PageableDefault;
import org.springframework.data.web.SortDefault;
import org.springframework.http.HttpStatus;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestController;
/**
* Partij controller.
*/
@RestController
@RequestMapping(value = ControllerConstants.PARTIJ_URI)
public class PartijController extends AbstractReadWriteController<Partij, Short> {
private static final String NAAM = "naam";
private static final String CODE = "code";
private static final String DATUM_INGANG = "datumIngang";
private static final String DATUM_EINDE = "datumEinde";
private static final String AUTOMATISCH_FIATTEREN = "indicatieAutomatischFiatteren";
private static final String DATUM_OVERGANG_BRP = "datumOvergangNaarBrp";
private static final String PARTIJ_ROL = "partijRolSet.rolId";
private static final Filter<?> FILTER_CODE = new Filter<>("filterCode", new StringValueAdapter(), new EqualPredicateBuilderFactory(CODE));
private static final Filter<?> FILTER_NAAM = new Filter<>("filterNaam", new StringValueAdapter(), new LikePredicateBuilderFactory(NAAM));
private static final Filter<?> FILTER_OIN = new Filter<>("filterOin", new StringValueAdapter(), new LikePredicateBuilderFactory("oin"));
private static final Filter<?> FILTER_SOORT = new Filter<>("filterSoort", new ShortValueAdapter(), new EqualPredicateBuilderFactory("soortPartij.id"));
private static final Filter<?> FILTER_ROL = new Filter<>("filterPartijRol", new ShortValueAdapter(), new EqualPredicateBuilderFactory(PARTIJ_ROL));
private static final Filter<?> FILTER_DATUM_INGANG =
new Filter<>("filterDatumIngang", new IntegerValueAdapter(), new EqualPredicateBuilderFactory(DATUM_INGANG));
private static final Filter<?> FILTER_DATUM_EINDE =
new Filter<>("filterDatumEinde", new IntegerValueAdapter(), new EqualPredicateBuilderFactory(DATUM_EINDE));
private static final Filter<?> FILTER_DATUM_OVERGANG_BRP =
new Filter<>("filterDatumOvergangNaarBrp", new IntegerValueAdapter(), new LessOrEqualPredicateBuilderFactory<>(DATUM_OVERGANG_BRP));
private static final Filter<?> FILTER_INDICATIE =
new Filter<>("filterIndicatie", new BooleanValueAdapter(), new EqualPredicateBuilderFactory("indicatieVerstrekkingsbeperkingMogelijk"));
private static final Filter<?> FILTER_AUTOMATISCH_FIATTEREN =
new Filter<>("filterIndicatieAutomatischFiatteren", new BooleanValueAdapter(), new EqualPredicateBuilderFactory(AUTOMATISCH_FIATTEREN));
private static final List<String> SORTERINGEN = Arrays.asList(CODE, NAAM, DATUM_INGANG, DATUM_EINDE);
private final SoortPartijRepository soortPartijRepository;
private final ReadWriteController<PartijRol, Integer> partijRolController;
/**
* Constructor.
* @param repository repository
* @param soortPartijRepository repository voor soort partij
* @param partijRolController controller voor partijrol
*/
@Inject
protected PartijController(final PartijRepository repository, final SoortPartijRepository soortPartijRepository,
final ReadWriteController<PartijRol, Integer> partijRolController) {
super(repository,
Arrays.asList(
FILTER_CODE,
FILTER_NAAM,
FILTER_OIN,
FILTER_SOORT,
FILTER_DATUM_INGANG,
FILTER_DATUM_EINDE,
FILTER_INDICATIE,
FILTER_DATUM_OVERGANG_BRP,
FILTER_ROL,
FILTER_AUTOMATISCH_FIATTEREN
),
Arrays.asList(new PartijHistorieVerwerker(), new PartijBijhoudingHistorieVerwerker(), new PartijVrijBerichtHistorieVerwerker()),
SORTERINGEN);
this.soortPartijRepository = soortPartijRepository;
this.partijRolController = partijRolController;
}
@Override
protected final void wijzigObjectVoorOpslag(final Partij partij) throws ErrorHandler.NotFoundException {
if (partij.getSoortPartij() != null && partij.getSoortPartij().getId() != null) {
partij.setSoortPartij(soortPartijRepository.getOne(partij.getSoortPartij().getId()));
}
// Lege OIN's<SUF>
if ("".equals(partij.getOin())) {
partij.setOin(null);
}
// Indicatieverstrekkingsbeperkingmogelijk mag niet leeg zijn, zet deze op FALSE indien leeg.
if (partij.isIndicatieVerstrekkingsbeperkingMogelijk() == null) {
partij.setIndicatieVerstrekkingsbeperkingMogelijk(Boolean.FALSE);
}
}
/**
* Haal een specifiek partijrol op.
* @param id id
* @param partijRolId partijRolId
* @return item
* @throws ErrorHandler.NotFoundException wanneer het item niet gevonden kan worden
*/
@RequestMapping(value = "/{id}/partijrollen/{pid}", method = RequestMethod.GET)
@ResponseStatus(HttpStatus.OK)
public final PartijRol getPartijRol(@PathVariable("id") final Long id, @PathVariable("pid") final Integer partijRolId)
throws ErrorHandler.NotFoundException {
return partijRolController.get(partijRolId);
}
/**
* Haal een lijst van partijrollen op.
* @param id id van actie
* @param parameters request parameters
* @param pageable paginering
* @return lijst van partijrol (inclusief paginering en sortering)
*/
@RequestMapping(value = "/{id}/partijrollen", method = RequestMethod.GET)
@ResponseStatus(HttpStatus.OK)
public final Page<PartijRol> listPartijRol(
@PathVariable(value = "id") final String id,
@RequestParam final Map<String, String> parameters,
@PageableDefault(size = 10) @SortDefault(sort = "datumIngang", direction = Sort.Direction.ASC) final Pageable pageable) {
parameters.put("partij", id);
return partijRolController.list(parameters, pageable);
}
/**
* Bewaar een partijrol.
* @param partijId Id van de partij
* @param item request body
* @return item
* @throws ErrorHandler.NotFoundException indien Partij niet gevonden wordt.
*/
@RequestMapping(value = "/{id}/partijrollen", method = RequestMethod.POST)
@ResponseStatus(HttpStatus.OK)
public final PartijRol savePartijRol(@PathVariable(value = "id") final Integer partijId, @Validated @RequestBody final PartijRol item)
throws NotFoundException {
item.setPartij(get(partijId.shortValue()));
return partijRolController.save(item);
}
/**
* Partij historie verwerker.
*/
static final class PartijHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijHistorie> {
@Override
public Class<PartijHistorie> historieClass() {
return PartijHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
/**
* PartijBijhouding historie verwerker.
*/
static final class PartijBijhoudingHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijBijhoudingHistorie> {
@Override
public Class<PartijBijhoudingHistorie> historieClass() {
return PartijBijhoudingHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
/**
* PartijVrijBericht historie verwerker.
*/
static final class PartijVrijBerichtHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijVrijBerichtHistorie> {
@Override
public Class<PartijVrijBerichtHistorie> historieClass() {
return PartijVrijBerichtHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
}
|
202124_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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.beheer.webapp.controllers.stamgegevens.kern;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.Partij;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijBijhoudingHistorie;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijHistorie;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijRol;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijVrijBerichtHistorie;
import nl.bzk.brp.beheer.webapp.configuratie.ControllerConstants;
import nl.bzk.brp.beheer.webapp.controllers.AbstractHistorieVerwerker;
import nl.bzk.brp.beheer.webapp.controllers.AbstractReadWriteController;
import nl.bzk.brp.beheer.webapp.controllers.ErrorHandler;
import nl.bzk.brp.beheer.webapp.controllers.ErrorHandler.NotFoundException;
import nl.bzk.brp.beheer.webapp.controllers.ReadWriteController;
import nl.bzk.brp.beheer.webapp.controllers.query.BooleanValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.EqualPredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.Filter;
import nl.bzk.brp.beheer.webapp.controllers.query.IntegerValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.LessOrEqualPredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.LikePredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.ShortValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.StringValueAdapter;
import nl.bzk.brp.beheer.webapp.repository.stamgegevens.kern.PartijRepository;
import nl.bzk.brp.beheer.webapp.repository.stamgegevens.kern.SoortPartijRepository;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.domain.Sort;
import org.springframework.data.web.PageableDefault;
import org.springframework.data.web.SortDefault;
import org.springframework.http.HttpStatus;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestController;
/**
* Partij controller.
*/
@RestController
@RequestMapping(value = ControllerConstants.PARTIJ_URI)
public class PartijController extends AbstractReadWriteController<Partij, Short> {
private static final String NAAM = "naam";
private static final String CODE = "code";
private static final String DATUM_INGANG = "datumIngang";
private static final String DATUM_EINDE = "datumEinde";
private static final String AUTOMATISCH_FIATTEREN = "indicatieAutomatischFiatteren";
private static final String DATUM_OVERGANG_BRP = "datumOvergangNaarBrp";
private static final String PARTIJ_ROL = "partijRolSet.rolId";
private static final Filter<?> FILTER_CODE = new Filter<>("filterCode", new StringValueAdapter(), new EqualPredicateBuilderFactory(CODE));
private static final Filter<?> FILTER_NAAM = new Filter<>("filterNaam", new StringValueAdapter(), new LikePredicateBuilderFactory(NAAM));
private static final Filter<?> FILTER_OIN = new Filter<>("filterOin", new StringValueAdapter(), new LikePredicateBuilderFactory("oin"));
private static final Filter<?> FILTER_SOORT = new Filter<>("filterSoort", new ShortValueAdapter(), new EqualPredicateBuilderFactory("soortPartij.id"));
private static final Filter<?> FILTER_ROL = new Filter<>("filterPartijRol", new ShortValueAdapter(), new EqualPredicateBuilderFactory(PARTIJ_ROL));
private static final Filter<?> FILTER_DATUM_INGANG =
new Filter<>("filterDatumIngang", new IntegerValueAdapter(), new EqualPredicateBuilderFactory(DATUM_INGANG));
private static final Filter<?> FILTER_DATUM_EINDE =
new Filter<>("filterDatumEinde", new IntegerValueAdapter(), new EqualPredicateBuilderFactory(DATUM_EINDE));
private static final Filter<?> FILTER_DATUM_OVERGANG_BRP =
new Filter<>("filterDatumOvergangNaarBrp", new IntegerValueAdapter(), new LessOrEqualPredicateBuilderFactory<>(DATUM_OVERGANG_BRP));
private static final Filter<?> FILTER_INDICATIE =
new Filter<>("filterIndicatie", new BooleanValueAdapter(), new EqualPredicateBuilderFactory("indicatieVerstrekkingsbeperkingMogelijk"));
private static final Filter<?> FILTER_AUTOMATISCH_FIATTEREN =
new Filter<>("filterIndicatieAutomatischFiatteren", new BooleanValueAdapter(), new EqualPredicateBuilderFactory(AUTOMATISCH_FIATTEREN));
private static final List<String> SORTERINGEN = Arrays.asList(CODE, NAAM, DATUM_INGANG, DATUM_EINDE);
private final SoortPartijRepository soortPartijRepository;
private final ReadWriteController<PartijRol, Integer> partijRolController;
/**
* Constructor.
* @param repository repository
* @param soortPartijRepository repository voor soort partij
* @param partijRolController controller voor partijrol
*/
@Inject
protected PartijController(final PartijRepository repository, final SoortPartijRepository soortPartijRepository,
final ReadWriteController<PartijRol, Integer> partijRolController) {
super(repository,
Arrays.asList(
FILTER_CODE,
FILTER_NAAM,
FILTER_OIN,
FILTER_SOORT,
FILTER_DATUM_INGANG,
FILTER_DATUM_EINDE,
FILTER_INDICATIE,
FILTER_DATUM_OVERGANG_BRP,
FILTER_ROL,
FILTER_AUTOMATISCH_FIATTEREN
),
Arrays.asList(new PartijHistorieVerwerker(), new PartijBijhoudingHistorieVerwerker(), new PartijVrijBerichtHistorieVerwerker()),
SORTERINGEN);
this.soortPartijRepository = soortPartijRepository;
this.partijRolController = partijRolController;
}
@Override
protected final void wijzigObjectVoorOpslag(final Partij partij) throws ErrorHandler.NotFoundException {
if (partij.getSoortPartij() != null && partij.getSoortPartij().getId() != null) {
partij.setSoortPartij(soortPartijRepository.getOne(partij.getSoortPartij().getId()));
}
// Lege OIN's mogen niet, sla deze als null op.
if ("".equals(partij.getOin())) {
partij.setOin(null);
}
// Indicatieverstrekkingsbeperkingmogelijk mag niet leeg zijn, zet deze op FALSE indien leeg.
if (partij.isIndicatieVerstrekkingsbeperkingMogelijk() == null) {
partij.setIndicatieVerstrekkingsbeperkingMogelijk(Boolean.FALSE);
}
}
/**
* Haal een specifiek partijrol op.
* @param id id
* @param partijRolId partijRolId
* @return item
* @throws ErrorHandler.NotFoundException wanneer het item niet gevonden kan worden
*/
@RequestMapping(value = "/{id}/partijrollen/{pid}", method = RequestMethod.GET)
@ResponseStatus(HttpStatus.OK)
public final PartijRol getPartijRol(@PathVariable("id") final Long id, @PathVariable("pid") final Integer partijRolId)
throws ErrorHandler.NotFoundException {
return partijRolController.get(partijRolId);
}
/**
* Haal een lijst van partijrollen op.
* @param id id van actie
* @param parameters request parameters
* @param pageable paginering
* @return lijst van partijrol (inclusief paginering en sortering)
*/
@RequestMapping(value = "/{id}/partijrollen", method = RequestMethod.GET)
@ResponseStatus(HttpStatus.OK)
public final Page<PartijRol> listPartijRol(
@PathVariable(value = "id") final String id,
@RequestParam final Map<String, String> parameters,
@PageableDefault(size = 10) @SortDefault(sort = "datumIngang", direction = Sort.Direction.ASC) final Pageable pageable) {
parameters.put("partij", id);
return partijRolController.list(parameters, pageable);
}
/**
* Bewaar een partijrol.
* @param partijId Id van de partij
* @param item request body
* @return item
* @throws ErrorHandler.NotFoundException indien Partij niet gevonden wordt.
*/
@RequestMapping(value = "/{id}/partijrollen", method = RequestMethod.POST)
@ResponseStatus(HttpStatus.OK)
public final PartijRol savePartijRol(@PathVariable(value = "id") final Integer partijId, @Validated @RequestBody final PartijRol item)
throws NotFoundException {
item.setPartij(get(partijId.shortValue()));
return partijRolController.save(item);
}
/**
* Partij historie verwerker.
*/
static final class PartijHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijHistorie> {
@Override
public Class<PartijHistorie> historieClass() {
return PartijHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
/**
* PartijBijhouding historie verwerker.
*/
static final class PartijBijhoudingHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijBijhoudingHistorie> {
@Override
public Class<PartijBijhoudingHistorie> historieClass() {
return PartijBijhoudingHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
/**
* PartijVrijBericht historie verwerker.
*/
static final class PartijVrijBerichtHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijVrijBerichtHistorie> {
@Override
public Class<PartijVrijBerichtHistorie> historieClass() {
return PartijVrijBerichtHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
}
| DDDNL/OperatieBRP | Broncode/operatiebrp-code-145.3/brp/beheer/beheer-api/src/main/java/nl/bzk/brp/beheer/webapp/controllers/stamgegevens/kern/PartijController.java | 2,714 | // Indicatieverstrekkingsbeperkingmogelijk mag niet leeg zijn, zet deze op FALSE indien leeg. | 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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.beheer.webapp.controllers.stamgegevens.kern;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.Partij;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijBijhoudingHistorie;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijHistorie;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijRol;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijVrijBerichtHistorie;
import nl.bzk.brp.beheer.webapp.configuratie.ControllerConstants;
import nl.bzk.brp.beheer.webapp.controllers.AbstractHistorieVerwerker;
import nl.bzk.brp.beheer.webapp.controllers.AbstractReadWriteController;
import nl.bzk.brp.beheer.webapp.controllers.ErrorHandler;
import nl.bzk.brp.beheer.webapp.controllers.ErrorHandler.NotFoundException;
import nl.bzk.brp.beheer.webapp.controllers.ReadWriteController;
import nl.bzk.brp.beheer.webapp.controllers.query.BooleanValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.EqualPredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.Filter;
import nl.bzk.brp.beheer.webapp.controllers.query.IntegerValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.LessOrEqualPredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.LikePredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.ShortValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.StringValueAdapter;
import nl.bzk.brp.beheer.webapp.repository.stamgegevens.kern.PartijRepository;
import nl.bzk.brp.beheer.webapp.repository.stamgegevens.kern.SoortPartijRepository;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.domain.Sort;
import org.springframework.data.web.PageableDefault;
import org.springframework.data.web.SortDefault;
import org.springframework.http.HttpStatus;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestController;
/**
* Partij controller.
*/
@RestController
@RequestMapping(value = ControllerConstants.PARTIJ_URI)
public class PartijController extends AbstractReadWriteController<Partij, Short> {
private static final String NAAM = "naam";
private static final String CODE = "code";
private static final String DATUM_INGANG = "datumIngang";
private static final String DATUM_EINDE = "datumEinde";
private static final String AUTOMATISCH_FIATTEREN = "indicatieAutomatischFiatteren";
private static final String DATUM_OVERGANG_BRP = "datumOvergangNaarBrp";
private static final String PARTIJ_ROL = "partijRolSet.rolId";
private static final Filter<?> FILTER_CODE = new Filter<>("filterCode", new StringValueAdapter(), new EqualPredicateBuilderFactory(CODE));
private static final Filter<?> FILTER_NAAM = new Filter<>("filterNaam", new StringValueAdapter(), new LikePredicateBuilderFactory(NAAM));
private static final Filter<?> FILTER_OIN = new Filter<>("filterOin", new StringValueAdapter(), new LikePredicateBuilderFactory("oin"));
private static final Filter<?> FILTER_SOORT = new Filter<>("filterSoort", new ShortValueAdapter(), new EqualPredicateBuilderFactory("soortPartij.id"));
private static final Filter<?> FILTER_ROL = new Filter<>("filterPartijRol", new ShortValueAdapter(), new EqualPredicateBuilderFactory(PARTIJ_ROL));
private static final Filter<?> FILTER_DATUM_INGANG =
new Filter<>("filterDatumIngang", new IntegerValueAdapter(), new EqualPredicateBuilderFactory(DATUM_INGANG));
private static final Filter<?> FILTER_DATUM_EINDE =
new Filter<>("filterDatumEinde", new IntegerValueAdapter(), new EqualPredicateBuilderFactory(DATUM_EINDE));
private static final Filter<?> FILTER_DATUM_OVERGANG_BRP =
new Filter<>("filterDatumOvergangNaarBrp", new IntegerValueAdapter(), new LessOrEqualPredicateBuilderFactory<>(DATUM_OVERGANG_BRP));
private static final Filter<?> FILTER_INDICATIE =
new Filter<>("filterIndicatie", new BooleanValueAdapter(), new EqualPredicateBuilderFactory("indicatieVerstrekkingsbeperkingMogelijk"));
private static final Filter<?> FILTER_AUTOMATISCH_FIATTEREN =
new Filter<>("filterIndicatieAutomatischFiatteren", new BooleanValueAdapter(), new EqualPredicateBuilderFactory(AUTOMATISCH_FIATTEREN));
private static final List<String> SORTERINGEN = Arrays.asList(CODE, NAAM, DATUM_INGANG, DATUM_EINDE);
private final SoortPartijRepository soortPartijRepository;
private final ReadWriteController<PartijRol, Integer> partijRolController;
/**
* Constructor.
* @param repository repository
* @param soortPartijRepository repository voor soort partij
* @param partijRolController controller voor partijrol
*/
@Inject
protected PartijController(final PartijRepository repository, final SoortPartijRepository soortPartijRepository,
final ReadWriteController<PartijRol, Integer> partijRolController) {
super(repository,
Arrays.asList(
FILTER_CODE,
FILTER_NAAM,
FILTER_OIN,
FILTER_SOORT,
FILTER_DATUM_INGANG,
FILTER_DATUM_EINDE,
FILTER_INDICATIE,
FILTER_DATUM_OVERGANG_BRP,
FILTER_ROL,
FILTER_AUTOMATISCH_FIATTEREN
),
Arrays.asList(new PartijHistorieVerwerker(), new PartijBijhoudingHistorieVerwerker(), new PartijVrijBerichtHistorieVerwerker()),
SORTERINGEN);
this.soortPartijRepository = soortPartijRepository;
this.partijRolController = partijRolController;
}
@Override
protected final void wijzigObjectVoorOpslag(final Partij partij) throws ErrorHandler.NotFoundException {
if (partij.getSoortPartij() != null && partij.getSoortPartij().getId() != null) {
partij.setSoortPartij(soortPartijRepository.getOne(partij.getSoortPartij().getId()));
}
// Lege OIN's mogen niet, sla deze als null op.
if ("".equals(partij.getOin())) {
partij.setOin(null);
}
// Indicatieverstrekkingsbeperkingmogelijk mag<SUF>
if (partij.isIndicatieVerstrekkingsbeperkingMogelijk() == null) {
partij.setIndicatieVerstrekkingsbeperkingMogelijk(Boolean.FALSE);
}
}
/**
* Haal een specifiek partijrol op.
* @param id id
* @param partijRolId partijRolId
* @return item
* @throws ErrorHandler.NotFoundException wanneer het item niet gevonden kan worden
*/
@RequestMapping(value = "/{id}/partijrollen/{pid}", method = RequestMethod.GET)
@ResponseStatus(HttpStatus.OK)
public final PartijRol getPartijRol(@PathVariable("id") final Long id, @PathVariable("pid") final Integer partijRolId)
throws ErrorHandler.NotFoundException {
return partijRolController.get(partijRolId);
}
/**
* Haal een lijst van partijrollen op.
* @param id id van actie
* @param parameters request parameters
* @param pageable paginering
* @return lijst van partijrol (inclusief paginering en sortering)
*/
@RequestMapping(value = "/{id}/partijrollen", method = RequestMethod.GET)
@ResponseStatus(HttpStatus.OK)
public final Page<PartijRol> listPartijRol(
@PathVariable(value = "id") final String id,
@RequestParam final Map<String, String> parameters,
@PageableDefault(size = 10) @SortDefault(sort = "datumIngang", direction = Sort.Direction.ASC) final Pageable pageable) {
parameters.put("partij", id);
return partijRolController.list(parameters, pageable);
}
/**
* Bewaar een partijrol.
* @param partijId Id van de partij
* @param item request body
* @return item
* @throws ErrorHandler.NotFoundException indien Partij niet gevonden wordt.
*/
@RequestMapping(value = "/{id}/partijrollen", method = RequestMethod.POST)
@ResponseStatus(HttpStatus.OK)
public final PartijRol savePartijRol(@PathVariable(value = "id") final Integer partijId, @Validated @RequestBody final PartijRol item)
throws NotFoundException {
item.setPartij(get(partijId.shortValue()));
return partijRolController.save(item);
}
/**
* Partij historie verwerker.
*/
static final class PartijHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijHistorie> {
@Override
public Class<PartijHistorie> historieClass() {
return PartijHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
/**
* PartijBijhouding historie verwerker.
*/
static final class PartijBijhoudingHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijBijhoudingHistorie> {
@Override
public Class<PartijBijhoudingHistorie> historieClass() {
return PartijBijhoudingHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
/**
* PartijVrijBericht historie verwerker.
*/
static final class PartijVrijBerichtHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijVrijBerichtHistorie> {
@Override
public Class<PartijVrijBerichtHistorie> historieClass() {
return PartijVrijBerichtHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
}
|
202124_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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.beheer.webapp.controllers.stamgegevens.kern;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.Partij;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijBijhoudingHistorie;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijHistorie;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijRol;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijVrijBerichtHistorie;
import nl.bzk.brp.beheer.webapp.configuratie.ControllerConstants;
import nl.bzk.brp.beheer.webapp.controllers.AbstractHistorieVerwerker;
import nl.bzk.brp.beheer.webapp.controllers.AbstractReadWriteController;
import nl.bzk.brp.beheer.webapp.controllers.ErrorHandler;
import nl.bzk.brp.beheer.webapp.controllers.ErrorHandler.NotFoundException;
import nl.bzk.brp.beheer.webapp.controllers.ReadWriteController;
import nl.bzk.brp.beheer.webapp.controllers.query.BooleanValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.EqualPredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.Filter;
import nl.bzk.brp.beheer.webapp.controllers.query.IntegerValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.LessOrEqualPredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.LikePredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.ShortValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.StringValueAdapter;
import nl.bzk.brp.beheer.webapp.repository.stamgegevens.kern.PartijRepository;
import nl.bzk.brp.beheer.webapp.repository.stamgegevens.kern.SoortPartijRepository;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.domain.Sort;
import org.springframework.data.web.PageableDefault;
import org.springframework.data.web.SortDefault;
import org.springframework.http.HttpStatus;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestController;
/**
* Partij controller.
*/
@RestController
@RequestMapping(value = ControllerConstants.PARTIJ_URI)
public class PartijController extends AbstractReadWriteController<Partij, Short> {
private static final String NAAM = "naam";
private static final String CODE = "code";
private static final String DATUM_INGANG = "datumIngang";
private static final String DATUM_EINDE = "datumEinde";
private static final String AUTOMATISCH_FIATTEREN = "indicatieAutomatischFiatteren";
private static final String DATUM_OVERGANG_BRP = "datumOvergangNaarBrp";
private static final String PARTIJ_ROL = "partijRolSet.rolId";
private static final Filter<?> FILTER_CODE = new Filter<>("filterCode", new StringValueAdapter(), new EqualPredicateBuilderFactory(CODE));
private static final Filter<?> FILTER_NAAM = new Filter<>("filterNaam", new StringValueAdapter(), new LikePredicateBuilderFactory(NAAM));
private static final Filter<?> FILTER_OIN = new Filter<>("filterOin", new StringValueAdapter(), new LikePredicateBuilderFactory("oin"));
private static final Filter<?> FILTER_SOORT = new Filter<>("filterSoort", new ShortValueAdapter(), new EqualPredicateBuilderFactory("soortPartij.id"));
private static final Filter<?> FILTER_ROL = new Filter<>("filterPartijRol", new ShortValueAdapter(), new EqualPredicateBuilderFactory(PARTIJ_ROL));
private static final Filter<?> FILTER_DATUM_INGANG =
new Filter<>("filterDatumIngang", new IntegerValueAdapter(), new EqualPredicateBuilderFactory(DATUM_INGANG));
private static final Filter<?> FILTER_DATUM_EINDE =
new Filter<>("filterDatumEinde", new IntegerValueAdapter(), new EqualPredicateBuilderFactory(DATUM_EINDE));
private static final Filter<?> FILTER_DATUM_OVERGANG_BRP =
new Filter<>("filterDatumOvergangNaarBrp", new IntegerValueAdapter(), new LessOrEqualPredicateBuilderFactory<>(DATUM_OVERGANG_BRP));
private static final Filter<?> FILTER_INDICATIE =
new Filter<>("filterIndicatie", new BooleanValueAdapter(), new EqualPredicateBuilderFactory("indicatieVerstrekkingsbeperkingMogelijk"));
private static final Filter<?> FILTER_AUTOMATISCH_FIATTEREN =
new Filter<>("filterIndicatieAutomatischFiatteren", new BooleanValueAdapter(), new EqualPredicateBuilderFactory(AUTOMATISCH_FIATTEREN));
private static final List<String> SORTERINGEN = Arrays.asList(CODE, NAAM, DATUM_INGANG, DATUM_EINDE);
private final SoortPartijRepository soortPartijRepository;
private final ReadWriteController<PartijRol, Integer> partijRolController;
/**
* Constructor.
* @param repository repository
* @param soortPartijRepository repository voor soort partij
* @param partijRolController controller voor partijrol
*/
@Inject
protected PartijController(final PartijRepository repository, final SoortPartijRepository soortPartijRepository,
final ReadWriteController<PartijRol, Integer> partijRolController) {
super(repository,
Arrays.asList(
FILTER_CODE,
FILTER_NAAM,
FILTER_OIN,
FILTER_SOORT,
FILTER_DATUM_INGANG,
FILTER_DATUM_EINDE,
FILTER_INDICATIE,
FILTER_DATUM_OVERGANG_BRP,
FILTER_ROL,
FILTER_AUTOMATISCH_FIATTEREN
),
Arrays.asList(new PartijHistorieVerwerker(), new PartijBijhoudingHistorieVerwerker(), new PartijVrijBerichtHistorieVerwerker()),
SORTERINGEN);
this.soortPartijRepository = soortPartijRepository;
this.partijRolController = partijRolController;
}
@Override
protected final void wijzigObjectVoorOpslag(final Partij partij) throws ErrorHandler.NotFoundException {
if (partij.getSoortPartij() != null && partij.getSoortPartij().getId() != null) {
partij.setSoortPartij(soortPartijRepository.getOne(partij.getSoortPartij().getId()));
}
// Lege OIN's mogen niet, sla deze als null op.
if ("".equals(partij.getOin())) {
partij.setOin(null);
}
// Indicatieverstrekkingsbeperkingmogelijk mag niet leeg zijn, zet deze op FALSE indien leeg.
if (partij.isIndicatieVerstrekkingsbeperkingMogelijk() == null) {
partij.setIndicatieVerstrekkingsbeperkingMogelijk(Boolean.FALSE);
}
}
/**
* Haal een specifiek partijrol op.
* @param id id
* @param partijRolId partijRolId
* @return item
* @throws ErrorHandler.NotFoundException wanneer het item niet gevonden kan worden
*/
@RequestMapping(value = "/{id}/partijrollen/{pid}", method = RequestMethod.GET)
@ResponseStatus(HttpStatus.OK)
public final PartijRol getPartijRol(@PathVariable("id") final Long id, @PathVariable("pid") final Integer partijRolId)
throws ErrorHandler.NotFoundException {
return partijRolController.get(partijRolId);
}
/**
* Haal een lijst van partijrollen op.
* @param id id van actie
* @param parameters request parameters
* @param pageable paginering
* @return lijst van partijrol (inclusief paginering en sortering)
*/
@RequestMapping(value = "/{id}/partijrollen", method = RequestMethod.GET)
@ResponseStatus(HttpStatus.OK)
public final Page<PartijRol> listPartijRol(
@PathVariable(value = "id") final String id,
@RequestParam final Map<String, String> parameters,
@PageableDefault(size = 10) @SortDefault(sort = "datumIngang", direction = Sort.Direction.ASC) final Pageable pageable) {
parameters.put("partij", id);
return partijRolController.list(parameters, pageable);
}
/**
* Bewaar een partijrol.
* @param partijId Id van de partij
* @param item request body
* @return item
* @throws ErrorHandler.NotFoundException indien Partij niet gevonden wordt.
*/
@RequestMapping(value = "/{id}/partijrollen", method = RequestMethod.POST)
@ResponseStatus(HttpStatus.OK)
public final PartijRol savePartijRol(@PathVariable(value = "id") final Integer partijId, @Validated @RequestBody final PartijRol item)
throws NotFoundException {
item.setPartij(get(partijId.shortValue()));
return partijRolController.save(item);
}
/**
* Partij historie verwerker.
*/
static final class PartijHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijHistorie> {
@Override
public Class<PartijHistorie> historieClass() {
return PartijHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
/**
* PartijBijhouding historie verwerker.
*/
static final class PartijBijhoudingHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijBijhoudingHistorie> {
@Override
public Class<PartijBijhoudingHistorie> historieClass() {
return PartijBijhoudingHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
/**
* PartijVrijBericht historie verwerker.
*/
static final class PartijVrijBerichtHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijVrijBerichtHistorie> {
@Override
public Class<PartijVrijBerichtHistorie> historieClass() {
return PartijVrijBerichtHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
}
| DDDNL/OperatieBRP | Broncode/operatiebrp-code-145.3/brp/beheer/beheer-api/src/main/java/nl/bzk/brp/beheer/webapp/controllers/stamgegevens/kern/PartijController.java | 2,714 | /**
* Haal een specifiek partijrol op.
* @param id id
* @param partijRolId partijRolId
* @return item
* @throws ErrorHandler.NotFoundException wanneer het item niet gevonden kan 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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.beheer.webapp.controllers.stamgegevens.kern;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.Partij;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijBijhoudingHistorie;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijHistorie;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijRol;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijVrijBerichtHistorie;
import nl.bzk.brp.beheer.webapp.configuratie.ControllerConstants;
import nl.bzk.brp.beheer.webapp.controllers.AbstractHistorieVerwerker;
import nl.bzk.brp.beheer.webapp.controllers.AbstractReadWriteController;
import nl.bzk.brp.beheer.webapp.controllers.ErrorHandler;
import nl.bzk.brp.beheer.webapp.controllers.ErrorHandler.NotFoundException;
import nl.bzk.brp.beheer.webapp.controllers.ReadWriteController;
import nl.bzk.brp.beheer.webapp.controllers.query.BooleanValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.EqualPredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.Filter;
import nl.bzk.brp.beheer.webapp.controllers.query.IntegerValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.LessOrEqualPredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.LikePredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.ShortValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.StringValueAdapter;
import nl.bzk.brp.beheer.webapp.repository.stamgegevens.kern.PartijRepository;
import nl.bzk.brp.beheer.webapp.repository.stamgegevens.kern.SoortPartijRepository;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.domain.Sort;
import org.springframework.data.web.PageableDefault;
import org.springframework.data.web.SortDefault;
import org.springframework.http.HttpStatus;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestController;
/**
* Partij controller.
*/
@RestController
@RequestMapping(value = ControllerConstants.PARTIJ_URI)
public class PartijController extends AbstractReadWriteController<Partij, Short> {
private static final String NAAM = "naam";
private static final String CODE = "code";
private static final String DATUM_INGANG = "datumIngang";
private static final String DATUM_EINDE = "datumEinde";
private static final String AUTOMATISCH_FIATTEREN = "indicatieAutomatischFiatteren";
private static final String DATUM_OVERGANG_BRP = "datumOvergangNaarBrp";
private static final String PARTIJ_ROL = "partijRolSet.rolId";
private static final Filter<?> FILTER_CODE = new Filter<>("filterCode", new StringValueAdapter(), new EqualPredicateBuilderFactory(CODE));
private static final Filter<?> FILTER_NAAM = new Filter<>("filterNaam", new StringValueAdapter(), new LikePredicateBuilderFactory(NAAM));
private static final Filter<?> FILTER_OIN = new Filter<>("filterOin", new StringValueAdapter(), new LikePredicateBuilderFactory("oin"));
private static final Filter<?> FILTER_SOORT = new Filter<>("filterSoort", new ShortValueAdapter(), new EqualPredicateBuilderFactory("soortPartij.id"));
private static final Filter<?> FILTER_ROL = new Filter<>("filterPartijRol", new ShortValueAdapter(), new EqualPredicateBuilderFactory(PARTIJ_ROL));
private static final Filter<?> FILTER_DATUM_INGANG =
new Filter<>("filterDatumIngang", new IntegerValueAdapter(), new EqualPredicateBuilderFactory(DATUM_INGANG));
private static final Filter<?> FILTER_DATUM_EINDE =
new Filter<>("filterDatumEinde", new IntegerValueAdapter(), new EqualPredicateBuilderFactory(DATUM_EINDE));
private static final Filter<?> FILTER_DATUM_OVERGANG_BRP =
new Filter<>("filterDatumOvergangNaarBrp", new IntegerValueAdapter(), new LessOrEqualPredicateBuilderFactory<>(DATUM_OVERGANG_BRP));
private static final Filter<?> FILTER_INDICATIE =
new Filter<>("filterIndicatie", new BooleanValueAdapter(), new EqualPredicateBuilderFactory("indicatieVerstrekkingsbeperkingMogelijk"));
private static final Filter<?> FILTER_AUTOMATISCH_FIATTEREN =
new Filter<>("filterIndicatieAutomatischFiatteren", new BooleanValueAdapter(), new EqualPredicateBuilderFactory(AUTOMATISCH_FIATTEREN));
private static final List<String> SORTERINGEN = Arrays.asList(CODE, NAAM, DATUM_INGANG, DATUM_EINDE);
private final SoortPartijRepository soortPartijRepository;
private final ReadWriteController<PartijRol, Integer> partijRolController;
/**
* Constructor.
* @param repository repository
* @param soortPartijRepository repository voor soort partij
* @param partijRolController controller voor partijrol
*/
@Inject
protected PartijController(final PartijRepository repository, final SoortPartijRepository soortPartijRepository,
final ReadWriteController<PartijRol, Integer> partijRolController) {
super(repository,
Arrays.asList(
FILTER_CODE,
FILTER_NAAM,
FILTER_OIN,
FILTER_SOORT,
FILTER_DATUM_INGANG,
FILTER_DATUM_EINDE,
FILTER_INDICATIE,
FILTER_DATUM_OVERGANG_BRP,
FILTER_ROL,
FILTER_AUTOMATISCH_FIATTEREN
),
Arrays.asList(new PartijHistorieVerwerker(), new PartijBijhoudingHistorieVerwerker(), new PartijVrijBerichtHistorieVerwerker()),
SORTERINGEN);
this.soortPartijRepository = soortPartijRepository;
this.partijRolController = partijRolController;
}
@Override
protected final void wijzigObjectVoorOpslag(final Partij partij) throws ErrorHandler.NotFoundException {
if (partij.getSoortPartij() != null && partij.getSoortPartij().getId() != null) {
partij.setSoortPartij(soortPartijRepository.getOne(partij.getSoortPartij().getId()));
}
// Lege OIN's mogen niet, sla deze als null op.
if ("".equals(partij.getOin())) {
partij.setOin(null);
}
// Indicatieverstrekkingsbeperkingmogelijk mag niet leeg zijn, zet deze op FALSE indien leeg.
if (partij.isIndicatieVerstrekkingsbeperkingMogelijk() == null) {
partij.setIndicatieVerstrekkingsbeperkingMogelijk(Boolean.FALSE);
}
}
/**
* Haal een specifiek<SUF>*/
@RequestMapping(value = "/{id}/partijrollen/{pid}", method = RequestMethod.GET)
@ResponseStatus(HttpStatus.OK)
public final PartijRol getPartijRol(@PathVariable("id") final Long id, @PathVariable("pid") final Integer partijRolId)
throws ErrorHandler.NotFoundException {
return partijRolController.get(partijRolId);
}
/**
* Haal een lijst van partijrollen op.
* @param id id van actie
* @param parameters request parameters
* @param pageable paginering
* @return lijst van partijrol (inclusief paginering en sortering)
*/
@RequestMapping(value = "/{id}/partijrollen", method = RequestMethod.GET)
@ResponseStatus(HttpStatus.OK)
public final Page<PartijRol> listPartijRol(
@PathVariable(value = "id") final String id,
@RequestParam final Map<String, String> parameters,
@PageableDefault(size = 10) @SortDefault(sort = "datumIngang", direction = Sort.Direction.ASC) final Pageable pageable) {
parameters.put("partij", id);
return partijRolController.list(parameters, pageable);
}
/**
* Bewaar een partijrol.
* @param partijId Id van de partij
* @param item request body
* @return item
* @throws ErrorHandler.NotFoundException indien Partij niet gevonden wordt.
*/
@RequestMapping(value = "/{id}/partijrollen", method = RequestMethod.POST)
@ResponseStatus(HttpStatus.OK)
public final PartijRol savePartijRol(@PathVariable(value = "id") final Integer partijId, @Validated @RequestBody final PartijRol item)
throws NotFoundException {
item.setPartij(get(partijId.shortValue()));
return partijRolController.save(item);
}
/**
* Partij historie verwerker.
*/
static final class PartijHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijHistorie> {
@Override
public Class<PartijHistorie> historieClass() {
return PartijHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
/**
* PartijBijhouding historie verwerker.
*/
static final class PartijBijhoudingHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijBijhoudingHistorie> {
@Override
public Class<PartijBijhoudingHistorie> historieClass() {
return PartijBijhoudingHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
/**
* PartijVrijBericht historie verwerker.
*/
static final class PartijVrijBerichtHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijVrijBerichtHistorie> {
@Override
public Class<PartijVrijBerichtHistorie> historieClass() {
return PartijVrijBerichtHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
}
|
202124_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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.beheer.webapp.controllers.stamgegevens.kern;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.Partij;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijBijhoudingHistorie;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijHistorie;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijRol;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijVrijBerichtHistorie;
import nl.bzk.brp.beheer.webapp.configuratie.ControllerConstants;
import nl.bzk.brp.beheer.webapp.controllers.AbstractHistorieVerwerker;
import nl.bzk.brp.beheer.webapp.controllers.AbstractReadWriteController;
import nl.bzk.brp.beheer.webapp.controllers.ErrorHandler;
import nl.bzk.brp.beheer.webapp.controllers.ErrorHandler.NotFoundException;
import nl.bzk.brp.beheer.webapp.controllers.ReadWriteController;
import nl.bzk.brp.beheer.webapp.controllers.query.BooleanValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.EqualPredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.Filter;
import nl.bzk.brp.beheer.webapp.controllers.query.IntegerValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.LessOrEqualPredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.LikePredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.ShortValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.StringValueAdapter;
import nl.bzk.brp.beheer.webapp.repository.stamgegevens.kern.PartijRepository;
import nl.bzk.brp.beheer.webapp.repository.stamgegevens.kern.SoortPartijRepository;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.domain.Sort;
import org.springframework.data.web.PageableDefault;
import org.springframework.data.web.SortDefault;
import org.springframework.http.HttpStatus;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestController;
/**
* Partij controller.
*/
@RestController
@RequestMapping(value = ControllerConstants.PARTIJ_URI)
public class PartijController extends AbstractReadWriteController<Partij, Short> {
private static final String NAAM = "naam";
private static final String CODE = "code";
private static final String DATUM_INGANG = "datumIngang";
private static final String DATUM_EINDE = "datumEinde";
private static final String AUTOMATISCH_FIATTEREN = "indicatieAutomatischFiatteren";
private static final String DATUM_OVERGANG_BRP = "datumOvergangNaarBrp";
private static final String PARTIJ_ROL = "partijRolSet.rolId";
private static final Filter<?> FILTER_CODE = new Filter<>("filterCode", new StringValueAdapter(), new EqualPredicateBuilderFactory(CODE));
private static final Filter<?> FILTER_NAAM = new Filter<>("filterNaam", new StringValueAdapter(), new LikePredicateBuilderFactory(NAAM));
private static final Filter<?> FILTER_OIN = new Filter<>("filterOin", new StringValueAdapter(), new LikePredicateBuilderFactory("oin"));
private static final Filter<?> FILTER_SOORT = new Filter<>("filterSoort", new ShortValueAdapter(), new EqualPredicateBuilderFactory("soortPartij.id"));
private static final Filter<?> FILTER_ROL = new Filter<>("filterPartijRol", new ShortValueAdapter(), new EqualPredicateBuilderFactory(PARTIJ_ROL));
private static final Filter<?> FILTER_DATUM_INGANG =
new Filter<>("filterDatumIngang", new IntegerValueAdapter(), new EqualPredicateBuilderFactory(DATUM_INGANG));
private static final Filter<?> FILTER_DATUM_EINDE =
new Filter<>("filterDatumEinde", new IntegerValueAdapter(), new EqualPredicateBuilderFactory(DATUM_EINDE));
private static final Filter<?> FILTER_DATUM_OVERGANG_BRP =
new Filter<>("filterDatumOvergangNaarBrp", new IntegerValueAdapter(), new LessOrEqualPredicateBuilderFactory<>(DATUM_OVERGANG_BRP));
private static final Filter<?> FILTER_INDICATIE =
new Filter<>("filterIndicatie", new BooleanValueAdapter(), new EqualPredicateBuilderFactory("indicatieVerstrekkingsbeperkingMogelijk"));
private static final Filter<?> FILTER_AUTOMATISCH_FIATTEREN =
new Filter<>("filterIndicatieAutomatischFiatteren", new BooleanValueAdapter(), new EqualPredicateBuilderFactory(AUTOMATISCH_FIATTEREN));
private static final List<String> SORTERINGEN = Arrays.asList(CODE, NAAM, DATUM_INGANG, DATUM_EINDE);
private final SoortPartijRepository soortPartijRepository;
private final ReadWriteController<PartijRol, Integer> partijRolController;
/**
* Constructor.
* @param repository repository
* @param soortPartijRepository repository voor soort partij
* @param partijRolController controller voor partijrol
*/
@Inject
protected PartijController(final PartijRepository repository, final SoortPartijRepository soortPartijRepository,
final ReadWriteController<PartijRol, Integer> partijRolController) {
super(repository,
Arrays.asList(
FILTER_CODE,
FILTER_NAAM,
FILTER_OIN,
FILTER_SOORT,
FILTER_DATUM_INGANG,
FILTER_DATUM_EINDE,
FILTER_INDICATIE,
FILTER_DATUM_OVERGANG_BRP,
FILTER_ROL,
FILTER_AUTOMATISCH_FIATTEREN
),
Arrays.asList(new PartijHistorieVerwerker(), new PartijBijhoudingHistorieVerwerker(), new PartijVrijBerichtHistorieVerwerker()),
SORTERINGEN);
this.soortPartijRepository = soortPartijRepository;
this.partijRolController = partijRolController;
}
@Override
protected final void wijzigObjectVoorOpslag(final Partij partij) throws ErrorHandler.NotFoundException {
if (partij.getSoortPartij() != null && partij.getSoortPartij().getId() != null) {
partij.setSoortPartij(soortPartijRepository.getOne(partij.getSoortPartij().getId()));
}
// Lege OIN's mogen niet, sla deze als null op.
if ("".equals(partij.getOin())) {
partij.setOin(null);
}
// Indicatieverstrekkingsbeperkingmogelijk mag niet leeg zijn, zet deze op FALSE indien leeg.
if (partij.isIndicatieVerstrekkingsbeperkingMogelijk() == null) {
partij.setIndicatieVerstrekkingsbeperkingMogelijk(Boolean.FALSE);
}
}
/**
* Haal een specifiek partijrol op.
* @param id id
* @param partijRolId partijRolId
* @return item
* @throws ErrorHandler.NotFoundException wanneer het item niet gevonden kan worden
*/
@RequestMapping(value = "/{id}/partijrollen/{pid}", method = RequestMethod.GET)
@ResponseStatus(HttpStatus.OK)
public final PartijRol getPartijRol(@PathVariable("id") final Long id, @PathVariable("pid") final Integer partijRolId)
throws ErrorHandler.NotFoundException {
return partijRolController.get(partijRolId);
}
/**
* Haal een lijst van partijrollen op.
* @param id id van actie
* @param parameters request parameters
* @param pageable paginering
* @return lijst van partijrol (inclusief paginering en sortering)
*/
@RequestMapping(value = "/{id}/partijrollen", method = RequestMethod.GET)
@ResponseStatus(HttpStatus.OK)
public final Page<PartijRol> listPartijRol(
@PathVariable(value = "id") final String id,
@RequestParam final Map<String, String> parameters,
@PageableDefault(size = 10) @SortDefault(sort = "datumIngang", direction = Sort.Direction.ASC) final Pageable pageable) {
parameters.put("partij", id);
return partijRolController.list(parameters, pageable);
}
/**
* Bewaar een partijrol.
* @param partijId Id van de partij
* @param item request body
* @return item
* @throws ErrorHandler.NotFoundException indien Partij niet gevonden wordt.
*/
@RequestMapping(value = "/{id}/partijrollen", method = RequestMethod.POST)
@ResponseStatus(HttpStatus.OK)
public final PartijRol savePartijRol(@PathVariable(value = "id") final Integer partijId, @Validated @RequestBody final PartijRol item)
throws NotFoundException {
item.setPartij(get(partijId.shortValue()));
return partijRolController.save(item);
}
/**
* Partij historie verwerker.
*/
static final class PartijHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijHistorie> {
@Override
public Class<PartijHistorie> historieClass() {
return PartijHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
/**
* PartijBijhouding historie verwerker.
*/
static final class PartijBijhoudingHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijBijhoudingHistorie> {
@Override
public Class<PartijBijhoudingHistorie> historieClass() {
return PartijBijhoudingHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
/**
* PartijVrijBericht historie verwerker.
*/
static final class PartijVrijBerichtHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijVrijBerichtHistorie> {
@Override
public Class<PartijVrijBerichtHistorie> historieClass() {
return PartijVrijBerichtHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
}
| DDDNL/OperatieBRP | Broncode/operatiebrp-code-145.3/brp/beheer/beheer-api/src/main/java/nl/bzk/brp/beheer/webapp/controllers/stamgegevens/kern/PartijController.java | 2,714 | /**
* Haal een lijst van partijrollen op.
* @param id id van actie
* @param parameters request parameters
* @param pageable paginering
* @return lijst van partijrol (inclusief paginering en sortering)
*/ | 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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.beheer.webapp.controllers.stamgegevens.kern;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.Partij;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijBijhoudingHistorie;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijHistorie;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijRol;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijVrijBerichtHistorie;
import nl.bzk.brp.beheer.webapp.configuratie.ControllerConstants;
import nl.bzk.brp.beheer.webapp.controllers.AbstractHistorieVerwerker;
import nl.bzk.brp.beheer.webapp.controllers.AbstractReadWriteController;
import nl.bzk.brp.beheer.webapp.controllers.ErrorHandler;
import nl.bzk.brp.beheer.webapp.controllers.ErrorHandler.NotFoundException;
import nl.bzk.brp.beheer.webapp.controllers.ReadWriteController;
import nl.bzk.brp.beheer.webapp.controllers.query.BooleanValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.EqualPredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.Filter;
import nl.bzk.brp.beheer.webapp.controllers.query.IntegerValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.LessOrEqualPredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.LikePredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.ShortValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.StringValueAdapter;
import nl.bzk.brp.beheer.webapp.repository.stamgegevens.kern.PartijRepository;
import nl.bzk.brp.beheer.webapp.repository.stamgegevens.kern.SoortPartijRepository;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.domain.Sort;
import org.springframework.data.web.PageableDefault;
import org.springframework.data.web.SortDefault;
import org.springframework.http.HttpStatus;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestController;
/**
* Partij controller.
*/
@RestController
@RequestMapping(value = ControllerConstants.PARTIJ_URI)
public class PartijController extends AbstractReadWriteController<Partij, Short> {
private static final String NAAM = "naam";
private static final String CODE = "code";
private static final String DATUM_INGANG = "datumIngang";
private static final String DATUM_EINDE = "datumEinde";
private static final String AUTOMATISCH_FIATTEREN = "indicatieAutomatischFiatteren";
private static final String DATUM_OVERGANG_BRP = "datumOvergangNaarBrp";
private static final String PARTIJ_ROL = "partijRolSet.rolId";
private static final Filter<?> FILTER_CODE = new Filter<>("filterCode", new StringValueAdapter(), new EqualPredicateBuilderFactory(CODE));
private static final Filter<?> FILTER_NAAM = new Filter<>("filterNaam", new StringValueAdapter(), new LikePredicateBuilderFactory(NAAM));
private static final Filter<?> FILTER_OIN = new Filter<>("filterOin", new StringValueAdapter(), new LikePredicateBuilderFactory("oin"));
private static final Filter<?> FILTER_SOORT = new Filter<>("filterSoort", new ShortValueAdapter(), new EqualPredicateBuilderFactory("soortPartij.id"));
private static final Filter<?> FILTER_ROL = new Filter<>("filterPartijRol", new ShortValueAdapter(), new EqualPredicateBuilderFactory(PARTIJ_ROL));
private static final Filter<?> FILTER_DATUM_INGANG =
new Filter<>("filterDatumIngang", new IntegerValueAdapter(), new EqualPredicateBuilderFactory(DATUM_INGANG));
private static final Filter<?> FILTER_DATUM_EINDE =
new Filter<>("filterDatumEinde", new IntegerValueAdapter(), new EqualPredicateBuilderFactory(DATUM_EINDE));
private static final Filter<?> FILTER_DATUM_OVERGANG_BRP =
new Filter<>("filterDatumOvergangNaarBrp", new IntegerValueAdapter(), new LessOrEqualPredicateBuilderFactory<>(DATUM_OVERGANG_BRP));
private static final Filter<?> FILTER_INDICATIE =
new Filter<>("filterIndicatie", new BooleanValueAdapter(), new EqualPredicateBuilderFactory("indicatieVerstrekkingsbeperkingMogelijk"));
private static final Filter<?> FILTER_AUTOMATISCH_FIATTEREN =
new Filter<>("filterIndicatieAutomatischFiatteren", new BooleanValueAdapter(), new EqualPredicateBuilderFactory(AUTOMATISCH_FIATTEREN));
private static final List<String> SORTERINGEN = Arrays.asList(CODE, NAAM, DATUM_INGANG, DATUM_EINDE);
private final SoortPartijRepository soortPartijRepository;
private final ReadWriteController<PartijRol, Integer> partijRolController;
/**
* Constructor.
* @param repository repository
* @param soortPartijRepository repository voor soort partij
* @param partijRolController controller voor partijrol
*/
@Inject
protected PartijController(final PartijRepository repository, final SoortPartijRepository soortPartijRepository,
final ReadWriteController<PartijRol, Integer> partijRolController) {
super(repository,
Arrays.asList(
FILTER_CODE,
FILTER_NAAM,
FILTER_OIN,
FILTER_SOORT,
FILTER_DATUM_INGANG,
FILTER_DATUM_EINDE,
FILTER_INDICATIE,
FILTER_DATUM_OVERGANG_BRP,
FILTER_ROL,
FILTER_AUTOMATISCH_FIATTEREN
),
Arrays.asList(new PartijHistorieVerwerker(), new PartijBijhoudingHistorieVerwerker(), new PartijVrijBerichtHistorieVerwerker()),
SORTERINGEN);
this.soortPartijRepository = soortPartijRepository;
this.partijRolController = partijRolController;
}
@Override
protected final void wijzigObjectVoorOpslag(final Partij partij) throws ErrorHandler.NotFoundException {
if (partij.getSoortPartij() != null && partij.getSoortPartij().getId() != null) {
partij.setSoortPartij(soortPartijRepository.getOne(partij.getSoortPartij().getId()));
}
// Lege OIN's mogen niet, sla deze als null op.
if ("".equals(partij.getOin())) {
partij.setOin(null);
}
// Indicatieverstrekkingsbeperkingmogelijk mag niet leeg zijn, zet deze op FALSE indien leeg.
if (partij.isIndicatieVerstrekkingsbeperkingMogelijk() == null) {
partij.setIndicatieVerstrekkingsbeperkingMogelijk(Boolean.FALSE);
}
}
/**
* Haal een specifiek partijrol op.
* @param id id
* @param partijRolId partijRolId
* @return item
* @throws ErrorHandler.NotFoundException wanneer het item niet gevonden kan worden
*/
@RequestMapping(value = "/{id}/partijrollen/{pid}", method = RequestMethod.GET)
@ResponseStatus(HttpStatus.OK)
public final PartijRol getPartijRol(@PathVariable("id") final Long id, @PathVariable("pid") final Integer partijRolId)
throws ErrorHandler.NotFoundException {
return partijRolController.get(partijRolId);
}
/**
* Haal een lijst<SUF>*/
@RequestMapping(value = "/{id}/partijrollen", method = RequestMethod.GET)
@ResponseStatus(HttpStatus.OK)
public final Page<PartijRol> listPartijRol(
@PathVariable(value = "id") final String id,
@RequestParam final Map<String, String> parameters,
@PageableDefault(size = 10) @SortDefault(sort = "datumIngang", direction = Sort.Direction.ASC) final Pageable pageable) {
parameters.put("partij", id);
return partijRolController.list(parameters, pageable);
}
/**
* Bewaar een partijrol.
* @param partijId Id van de partij
* @param item request body
* @return item
* @throws ErrorHandler.NotFoundException indien Partij niet gevonden wordt.
*/
@RequestMapping(value = "/{id}/partijrollen", method = RequestMethod.POST)
@ResponseStatus(HttpStatus.OK)
public final PartijRol savePartijRol(@PathVariable(value = "id") final Integer partijId, @Validated @RequestBody final PartijRol item)
throws NotFoundException {
item.setPartij(get(partijId.shortValue()));
return partijRolController.save(item);
}
/**
* Partij historie verwerker.
*/
static final class PartijHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijHistorie> {
@Override
public Class<PartijHistorie> historieClass() {
return PartijHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
/**
* PartijBijhouding historie verwerker.
*/
static final class PartijBijhoudingHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijBijhoudingHistorie> {
@Override
public Class<PartijBijhoudingHistorie> historieClass() {
return PartijBijhoudingHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
/**
* PartijVrijBericht historie verwerker.
*/
static final class PartijVrijBerichtHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijVrijBerichtHistorie> {
@Override
public Class<PartijVrijBerichtHistorie> historieClass() {
return PartijVrijBerichtHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
}
|
202124_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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.beheer.webapp.controllers.stamgegevens.kern;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.Partij;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijBijhoudingHistorie;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijHistorie;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijRol;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijVrijBerichtHistorie;
import nl.bzk.brp.beheer.webapp.configuratie.ControllerConstants;
import nl.bzk.brp.beheer.webapp.controllers.AbstractHistorieVerwerker;
import nl.bzk.brp.beheer.webapp.controllers.AbstractReadWriteController;
import nl.bzk.brp.beheer.webapp.controllers.ErrorHandler;
import nl.bzk.brp.beheer.webapp.controllers.ErrorHandler.NotFoundException;
import nl.bzk.brp.beheer.webapp.controllers.ReadWriteController;
import nl.bzk.brp.beheer.webapp.controllers.query.BooleanValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.EqualPredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.Filter;
import nl.bzk.brp.beheer.webapp.controllers.query.IntegerValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.LessOrEqualPredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.LikePredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.ShortValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.StringValueAdapter;
import nl.bzk.brp.beheer.webapp.repository.stamgegevens.kern.PartijRepository;
import nl.bzk.brp.beheer.webapp.repository.stamgegevens.kern.SoortPartijRepository;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.domain.Sort;
import org.springframework.data.web.PageableDefault;
import org.springframework.data.web.SortDefault;
import org.springframework.http.HttpStatus;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestController;
/**
* Partij controller.
*/
@RestController
@RequestMapping(value = ControllerConstants.PARTIJ_URI)
public class PartijController extends AbstractReadWriteController<Partij, Short> {
private static final String NAAM = "naam";
private static final String CODE = "code";
private static final String DATUM_INGANG = "datumIngang";
private static final String DATUM_EINDE = "datumEinde";
private static final String AUTOMATISCH_FIATTEREN = "indicatieAutomatischFiatteren";
private static final String DATUM_OVERGANG_BRP = "datumOvergangNaarBrp";
private static final String PARTIJ_ROL = "partijRolSet.rolId";
private static final Filter<?> FILTER_CODE = new Filter<>("filterCode", new StringValueAdapter(), new EqualPredicateBuilderFactory(CODE));
private static final Filter<?> FILTER_NAAM = new Filter<>("filterNaam", new StringValueAdapter(), new LikePredicateBuilderFactory(NAAM));
private static final Filter<?> FILTER_OIN = new Filter<>("filterOin", new StringValueAdapter(), new LikePredicateBuilderFactory("oin"));
private static final Filter<?> FILTER_SOORT = new Filter<>("filterSoort", new ShortValueAdapter(), new EqualPredicateBuilderFactory("soortPartij.id"));
private static final Filter<?> FILTER_ROL = new Filter<>("filterPartijRol", new ShortValueAdapter(), new EqualPredicateBuilderFactory(PARTIJ_ROL));
private static final Filter<?> FILTER_DATUM_INGANG =
new Filter<>("filterDatumIngang", new IntegerValueAdapter(), new EqualPredicateBuilderFactory(DATUM_INGANG));
private static final Filter<?> FILTER_DATUM_EINDE =
new Filter<>("filterDatumEinde", new IntegerValueAdapter(), new EqualPredicateBuilderFactory(DATUM_EINDE));
private static final Filter<?> FILTER_DATUM_OVERGANG_BRP =
new Filter<>("filterDatumOvergangNaarBrp", new IntegerValueAdapter(), new LessOrEqualPredicateBuilderFactory<>(DATUM_OVERGANG_BRP));
private static final Filter<?> FILTER_INDICATIE =
new Filter<>("filterIndicatie", new BooleanValueAdapter(), new EqualPredicateBuilderFactory("indicatieVerstrekkingsbeperkingMogelijk"));
private static final Filter<?> FILTER_AUTOMATISCH_FIATTEREN =
new Filter<>("filterIndicatieAutomatischFiatteren", new BooleanValueAdapter(), new EqualPredicateBuilderFactory(AUTOMATISCH_FIATTEREN));
private static final List<String> SORTERINGEN = Arrays.asList(CODE, NAAM, DATUM_INGANG, DATUM_EINDE);
private final SoortPartijRepository soortPartijRepository;
private final ReadWriteController<PartijRol, Integer> partijRolController;
/**
* Constructor.
* @param repository repository
* @param soortPartijRepository repository voor soort partij
* @param partijRolController controller voor partijrol
*/
@Inject
protected PartijController(final PartijRepository repository, final SoortPartijRepository soortPartijRepository,
final ReadWriteController<PartijRol, Integer> partijRolController) {
super(repository,
Arrays.asList(
FILTER_CODE,
FILTER_NAAM,
FILTER_OIN,
FILTER_SOORT,
FILTER_DATUM_INGANG,
FILTER_DATUM_EINDE,
FILTER_INDICATIE,
FILTER_DATUM_OVERGANG_BRP,
FILTER_ROL,
FILTER_AUTOMATISCH_FIATTEREN
),
Arrays.asList(new PartijHistorieVerwerker(), new PartijBijhoudingHistorieVerwerker(), new PartijVrijBerichtHistorieVerwerker()),
SORTERINGEN);
this.soortPartijRepository = soortPartijRepository;
this.partijRolController = partijRolController;
}
@Override
protected final void wijzigObjectVoorOpslag(final Partij partij) throws ErrorHandler.NotFoundException {
if (partij.getSoortPartij() != null && partij.getSoortPartij().getId() != null) {
partij.setSoortPartij(soortPartijRepository.getOne(partij.getSoortPartij().getId()));
}
// Lege OIN's mogen niet, sla deze als null op.
if ("".equals(partij.getOin())) {
partij.setOin(null);
}
// Indicatieverstrekkingsbeperkingmogelijk mag niet leeg zijn, zet deze op FALSE indien leeg.
if (partij.isIndicatieVerstrekkingsbeperkingMogelijk() == null) {
partij.setIndicatieVerstrekkingsbeperkingMogelijk(Boolean.FALSE);
}
}
/**
* Haal een specifiek partijrol op.
* @param id id
* @param partijRolId partijRolId
* @return item
* @throws ErrorHandler.NotFoundException wanneer het item niet gevonden kan worden
*/
@RequestMapping(value = "/{id}/partijrollen/{pid}", method = RequestMethod.GET)
@ResponseStatus(HttpStatus.OK)
public final PartijRol getPartijRol(@PathVariable("id") final Long id, @PathVariable("pid") final Integer partijRolId)
throws ErrorHandler.NotFoundException {
return partijRolController.get(partijRolId);
}
/**
* Haal een lijst van partijrollen op.
* @param id id van actie
* @param parameters request parameters
* @param pageable paginering
* @return lijst van partijrol (inclusief paginering en sortering)
*/
@RequestMapping(value = "/{id}/partijrollen", method = RequestMethod.GET)
@ResponseStatus(HttpStatus.OK)
public final Page<PartijRol> listPartijRol(
@PathVariable(value = "id") final String id,
@RequestParam final Map<String, String> parameters,
@PageableDefault(size = 10) @SortDefault(sort = "datumIngang", direction = Sort.Direction.ASC) final Pageable pageable) {
parameters.put("partij", id);
return partijRolController.list(parameters, pageable);
}
/**
* Bewaar een partijrol.
* @param partijId Id van de partij
* @param item request body
* @return item
* @throws ErrorHandler.NotFoundException indien Partij niet gevonden wordt.
*/
@RequestMapping(value = "/{id}/partijrollen", method = RequestMethod.POST)
@ResponseStatus(HttpStatus.OK)
public final PartijRol savePartijRol(@PathVariable(value = "id") final Integer partijId, @Validated @RequestBody final PartijRol item)
throws NotFoundException {
item.setPartij(get(partijId.shortValue()));
return partijRolController.save(item);
}
/**
* Partij historie verwerker.
*/
static final class PartijHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijHistorie> {
@Override
public Class<PartijHistorie> historieClass() {
return PartijHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
/**
* PartijBijhouding historie verwerker.
*/
static final class PartijBijhoudingHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijBijhoudingHistorie> {
@Override
public Class<PartijBijhoudingHistorie> historieClass() {
return PartijBijhoudingHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
/**
* PartijVrijBericht historie verwerker.
*/
static final class PartijVrijBerichtHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijVrijBerichtHistorie> {
@Override
public Class<PartijVrijBerichtHistorie> historieClass() {
return PartijVrijBerichtHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
}
| DDDNL/OperatieBRP | Broncode/operatiebrp-code-145.3/brp/beheer/beheer-api/src/main/java/nl/bzk/brp/beheer/webapp/controllers/stamgegevens/kern/PartijController.java | 2,714 | /**
* Bewaar een partijrol.
* @param partijId Id van de partij
* @param item request body
* @return item
* @throws ErrorHandler.NotFoundException indien Partij niet gevonden wordt.
*/ | 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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.beheer.webapp.controllers.stamgegevens.kern;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.Partij;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijBijhoudingHistorie;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijHistorie;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijRol;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijVrijBerichtHistorie;
import nl.bzk.brp.beheer.webapp.configuratie.ControllerConstants;
import nl.bzk.brp.beheer.webapp.controllers.AbstractHistorieVerwerker;
import nl.bzk.brp.beheer.webapp.controllers.AbstractReadWriteController;
import nl.bzk.brp.beheer.webapp.controllers.ErrorHandler;
import nl.bzk.brp.beheer.webapp.controllers.ErrorHandler.NotFoundException;
import nl.bzk.brp.beheer.webapp.controllers.ReadWriteController;
import nl.bzk.brp.beheer.webapp.controllers.query.BooleanValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.EqualPredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.Filter;
import nl.bzk.brp.beheer.webapp.controllers.query.IntegerValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.LessOrEqualPredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.LikePredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.ShortValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.StringValueAdapter;
import nl.bzk.brp.beheer.webapp.repository.stamgegevens.kern.PartijRepository;
import nl.bzk.brp.beheer.webapp.repository.stamgegevens.kern.SoortPartijRepository;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.domain.Sort;
import org.springframework.data.web.PageableDefault;
import org.springframework.data.web.SortDefault;
import org.springframework.http.HttpStatus;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestController;
/**
* Partij controller.
*/
@RestController
@RequestMapping(value = ControllerConstants.PARTIJ_URI)
public class PartijController extends AbstractReadWriteController<Partij, Short> {
private static final String NAAM = "naam";
private static final String CODE = "code";
private static final String DATUM_INGANG = "datumIngang";
private static final String DATUM_EINDE = "datumEinde";
private static final String AUTOMATISCH_FIATTEREN = "indicatieAutomatischFiatteren";
private static final String DATUM_OVERGANG_BRP = "datumOvergangNaarBrp";
private static final String PARTIJ_ROL = "partijRolSet.rolId";
private static final Filter<?> FILTER_CODE = new Filter<>("filterCode", new StringValueAdapter(), new EqualPredicateBuilderFactory(CODE));
private static final Filter<?> FILTER_NAAM = new Filter<>("filterNaam", new StringValueAdapter(), new LikePredicateBuilderFactory(NAAM));
private static final Filter<?> FILTER_OIN = new Filter<>("filterOin", new StringValueAdapter(), new LikePredicateBuilderFactory("oin"));
private static final Filter<?> FILTER_SOORT = new Filter<>("filterSoort", new ShortValueAdapter(), new EqualPredicateBuilderFactory("soortPartij.id"));
private static final Filter<?> FILTER_ROL = new Filter<>("filterPartijRol", new ShortValueAdapter(), new EqualPredicateBuilderFactory(PARTIJ_ROL));
private static final Filter<?> FILTER_DATUM_INGANG =
new Filter<>("filterDatumIngang", new IntegerValueAdapter(), new EqualPredicateBuilderFactory(DATUM_INGANG));
private static final Filter<?> FILTER_DATUM_EINDE =
new Filter<>("filterDatumEinde", new IntegerValueAdapter(), new EqualPredicateBuilderFactory(DATUM_EINDE));
private static final Filter<?> FILTER_DATUM_OVERGANG_BRP =
new Filter<>("filterDatumOvergangNaarBrp", new IntegerValueAdapter(), new LessOrEqualPredicateBuilderFactory<>(DATUM_OVERGANG_BRP));
private static final Filter<?> FILTER_INDICATIE =
new Filter<>("filterIndicatie", new BooleanValueAdapter(), new EqualPredicateBuilderFactory("indicatieVerstrekkingsbeperkingMogelijk"));
private static final Filter<?> FILTER_AUTOMATISCH_FIATTEREN =
new Filter<>("filterIndicatieAutomatischFiatteren", new BooleanValueAdapter(), new EqualPredicateBuilderFactory(AUTOMATISCH_FIATTEREN));
private static final List<String> SORTERINGEN = Arrays.asList(CODE, NAAM, DATUM_INGANG, DATUM_EINDE);
private final SoortPartijRepository soortPartijRepository;
private final ReadWriteController<PartijRol, Integer> partijRolController;
/**
* Constructor.
* @param repository repository
* @param soortPartijRepository repository voor soort partij
* @param partijRolController controller voor partijrol
*/
@Inject
protected PartijController(final PartijRepository repository, final SoortPartijRepository soortPartijRepository,
final ReadWriteController<PartijRol, Integer> partijRolController) {
super(repository,
Arrays.asList(
FILTER_CODE,
FILTER_NAAM,
FILTER_OIN,
FILTER_SOORT,
FILTER_DATUM_INGANG,
FILTER_DATUM_EINDE,
FILTER_INDICATIE,
FILTER_DATUM_OVERGANG_BRP,
FILTER_ROL,
FILTER_AUTOMATISCH_FIATTEREN
),
Arrays.asList(new PartijHistorieVerwerker(), new PartijBijhoudingHistorieVerwerker(), new PartijVrijBerichtHistorieVerwerker()),
SORTERINGEN);
this.soortPartijRepository = soortPartijRepository;
this.partijRolController = partijRolController;
}
@Override
protected final void wijzigObjectVoorOpslag(final Partij partij) throws ErrorHandler.NotFoundException {
if (partij.getSoortPartij() != null && partij.getSoortPartij().getId() != null) {
partij.setSoortPartij(soortPartijRepository.getOne(partij.getSoortPartij().getId()));
}
// Lege OIN's mogen niet, sla deze als null op.
if ("".equals(partij.getOin())) {
partij.setOin(null);
}
// Indicatieverstrekkingsbeperkingmogelijk mag niet leeg zijn, zet deze op FALSE indien leeg.
if (partij.isIndicatieVerstrekkingsbeperkingMogelijk() == null) {
partij.setIndicatieVerstrekkingsbeperkingMogelijk(Boolean.FALSE);
}
}
/**
* Haal een specifiek partijrol op.
* @param id id
* @param partijRolId partijRolId
* @return item
* @throws ErrorHandler.NotFoundException wanneer het item niet gevonden kan worden
*/
@RequestMapping(value = "/{id}/partijrollen/{pid}", method = RequestMethod.GET)
@ResponseStatus(HttpStatus.OK)
public final PartijRol getPartijRol(@PathVariable("id") final Long id, @PathVariable("pid") final Integer partijRolId)
throws ErrorHandler.NotFoundException {
return partijRolController.get(partijRolId);
}
/**
* Haal een lijst van partijrollen op.
* @param id id van actie
* @param parameters request parameters
* @param pageable paginering
* @return lijst van partijrol (inclusief paginering en sortering)
*/
@RequestMapping(value = "/{id}/partijrollen", method = RequestMethod.GET)
@ResponseStatus(HttpStatus.OK)
public final Page<PartijRol> listPartijRol(
@PathVariable(value = "id") final String id,
@RequestParam final Map<String, String> parameters,
@PageableDefault(size = 10) @SortDefault(sort = "datumIngang", direction = Sort.Direction.ASC) final Pageable pageable) {
parameters.put("partij", id);
return partijRolController.list(parameters, pageable);
}
/**
* Bewaar een partijrol.<SUF>*/
@RequestMapping(value = "/{id}/partijrollen", method = RequestMethod.POST)
@ResponseStatus(HttpStatus.OK)
public final PartijRol savePartijRol(@PathVariable(value = "id") final Integer partijId, @Validated @RequestBody final PartijRol item)
throws NotFoundException {
item.setPartij(get(partijId.shortValue()));
return partijRolController.save(item);
}
/**
* Partij historie verwerker.
*/
static final class PartijHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijHistorie> {
@Override
public Class<PartijHistorie> historieClass() {
return PartijHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
/**
* PartijBijhouding historie verwerker.
*/
static final class PartijBijhoudingHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijBijhoudingHistorie> {
@Override
public Class<PartijBijhoudingHistorie> historieClass() {
return PartijBijhoudingHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
/**
* PartijVrijBericht historie verwerker.
*/
static final class PartijVrijBerichtHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijVrijBerichtHistorie> {
@Override
public Class<PartijVrijBerichtHistorie> historieClass() {
return PartijVrijBerichtHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
}
|
202124_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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.beheer.webapp.controllers.stamgegevens.kern;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.Partij;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijBijhoudingHistorie;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijHistorie;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijRol;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijVrijBerichtHistorie;
import nl.bzk.brp.beheer.webapp.configuratie.ControllerConstants;
import nl.bzk.brp.beheer.webapp.controllers.AbstractHistorieVerwerker;
import nl.bzk.brp.beheer.webapp.controllers.AbstractReadWriteController;
import nl.bzk.brp.beheer.webapp.controllers.ErrorHandler;
import nl.bzk.brp.beheer.webapp.controllers.ErrorHandler.NotFoundException;
import nl.bzk.brp.beheer.webapp.controllers.ReadWriteController;
import nl.bzk.brp.beheer.webapp.controllers.query.BooleanValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.EqualPredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.Filter;
import nl.bzk.brp.beheer.webapp.controllers.query.IntegerValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.LessOrEqualPredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.LikePredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.ShortValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.StringValueAdapter;
import nl.bzk.brp.beheer.webapp.repository.stamgegevens.kern.PartijRepository;
import nl.bzk.brp.beheer.webapp.repository.stamgegevens.kern.SoortPartijRepository;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.domain.Sort;
import org.springframework.data.web.PageableDefault;
import org.springframework.data.web.SortDefault;
import org.springframework.http.HttpStatus;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestController;
/**
* Partij controller.
*/
@RestController
@RequestMapping(value = ControllerConstants.PARTIJ_URI)
public class PartijController extends AbstractReadWriteController<Partij, Short> {
private static final String NAAM = "naam";
private static final String CODE = "code";
private static final String DATUM_INGANG = "datumIngang";
private static final String DATUM_EINDE = "datumEinde";
private static final String AUTOMATISCH_FIATTEREN = "indicatieAutomatischFiatteren";
private static final String DATUM_OVERGANG_BRP = "datumOvergangNaarBrp";
private static final String PARTIJ_ROL = "partijRolSet.rolId";
private static final Filter<?> FILTER_CODE = new Filter<>("filterCode", new StringValueAdapter(), new EqualPredicateBuilderFactory(CODE));
private static final Filter<?> FILTER_NAAM = new Filter<>("filterNaam", new StringValueAdapter(), new LikePredicateBuilderFactory(NAAM));
private static final Filter<?> FILTER_OIN = new Filter<>("filterOin", new StringValueAdapter(), new LikePredicateBuilderFactory("oin"));
private static final Filter<?> FILTER_SOORT = new Filter<>("filterSoort", new ShortValueAdapter(), new EqualPredicateBuilderFactory("soortPartij.id"));
private static final Filter<?> FILTER_ROL = new Filter<>("filterPartijRol", new ShortValueAdapter(), new EqualPredicateBuilderFactory(PARTIJ_ROL));
private static final Filter<?> FILTER_DATUM_INGANG =
new Filter<>("filterDatumIngang", new IntegerValueAdapter(), new EqualPredicateBuilderFactory(DATUM_INGANG));
private static final Filter<?> FILTER_DATUM_EINDE =
new Filter<>("filterDatumEinde", new IntegerValueAdapter(), new EqualPredicateBuilderFactory(DATUM_EINDE));
private static final Filter<?> FILTER_DATUM_OVERGANG_BRP =
new Filter<>("filterDatumOvergangNaarBrp", new IntegerValueAdapter(), new LessOrEqualPredicateBuilderFactory<>(DATUM_OVERGANG_BRP));
private static final Filter<?> FILTER_INDICATIE =
new Filter<>("filterIndicatie", new BooleanValueAdapter(), new EqualPredicateBuilderFactory("indicatieVerstrekkingsbeperkingMogelijk"));
private static final Filter<?> FILTER_AUTOMATISCH_FIATTEREN =
new Filter<>("filterIndicatieAutomatischFiatteren", new BooleanValueAdapter(), new EqualPredicateBuilderFactory(AUTOMATISCH_FIATTEREN));
private static final List<String> SORTERINGEN = Arrays.asList(CODE, NAAM, DATUM_INGANG, DATUM_EINDE);
private final SoortPartijRepository soortPartijRepository;
private final ReadWriteController<PartijRol, Integer> partijRolController;
/**
* Constructor.
* @param repository repository
* @param soortPartijRepository repository voor soort partij
* @param partijRolController controller voor partijrol
*/
@Inject
protected PartijController(final PartijRepository repository, final SoortPartijRepository soortPartijRepository,
final ReadWriteController<PartijRol, Integer> partijRolController) {
super(repository,
Arrays.asList(
FILTER_CODE,
FILTER_NAAM,
FILTER_OIN,
FILTER_SOORT,
FILTER_DATUM_INGANG,
FILTER_DATUM_EINDE,
FILTER_INDICATIE,
FILTER_DATUM_OVERGANG_BRP,
FILTER_ROL,
FILTER_AUTOMATISCH_FIATTEREN
),
Arrays.asList(new PartijHistorieVerwerker(), new PartijBijhoudingHistorieVerwerker(), new PartijVrijBerichtHistorieVerwerker()),
SORTERINGEN);
this.soortPartijRepository = soortPartijRepository;
this.partijRolController = partijRolController;
}
@Override
protected final void wijzigObjectVoorOpslag(final Partij partij) throws ErrorHandler.NotFoundException {
if (partij.getSoortPartij() != null && partij.getSoortPartij().getId() != null) {
partij.setSoortPartij(soortPartijRepository.getOne(partij.getSoortPartij().getId()));
}
// Lege OIN's mogen niet, sla deze als null op.
if ("".equals(partij.getOin())) {
partij.setOin(null);
}
// Indicatieverstrekkingsbeperkingmogelijk mag niet leeg zijn, zet deze op FALSE indien leeg.
if (partij.isIndicatieVerstrekkingsbeperkingMogelijk() == null) {
partij.setIndicatieVerstrekkingsbeperkingMogelijk(Boolean.FALSE);
}
}
/**
* Haal een specifiek partijrol op.
* @param id id
* @param partijRolId partijRolId
* @return item
* @throws ErrorHandler.NotFoundException wanneer het item niet gevonden kan worden
*/
@RequestMapping(value = "/{id}/partijrollen/{pid}", method = RequestMethod.GET)
@ResponseStatus(HttpStatus.OK)
public final PartijRol getPartijRol(@PathVariable("id") final Long id, @PathVariable("pid") final Integer partijRolId)
throws ErrorHandler.NotFoundException {
return partijRolController.get(partijRolId);
}
/**
* Haal een lijst van partijrollen op.
* @param id id van actie
* @param parameters request parameters
* @param pageable paginering
* @return lijst van partijrol (inclusief paginering en sortering)
*/
@RequestMapping(value = "/{id}/partijrollen", method = RequestMethod.GET)
@ResponseStatus(HttpStatus.OK)
public final Page<PartijRol> listPartijRol(
@PathVariable(value = "id") final String id,
@RequestParam final Map<String, String> parameters,
@PageableDefault(size = 10) @SortDefault(sort = "datumIngang", direction = Sort.Direction.ASC) final Pageable pageable) {
parameters.put("partij", id);
return partijRolController.list(parameters, pageable);
}
/**
* Bewaar een partijrol.
* @param partijId Id van de partij
* @param item request body
* @return item
* @throws ErrorHandler.NotFoundException indien Partij niet gevonden wordt.
*/
@RequestMapping(value = "/{id}/partijrollen", method = RequestMethod.POST)
@ResponseStatus(HttpStatus.OK)
public final PartijRol savePartijRol(@PathVariable(value = "id") final Integer partijId, @Validated @RequestBody final PartijRol item)
throws NotFoundException {
item.setPartij(get(partijId.shortValue()));
return partijRolController.save(item);
}
/**
* Partij historie verwerker.
*/
static final class PartijHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijHistorie> {
@Override
public Class<PartijHistorie> historieClass() {
return PartijHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
/**
* PartijBijhouding historie verwerker.
*/
static final class PartijBijhoudingHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijBijhoudingHistorie> {
@Override
public Class<PartijBijhoudingHistorie> historieClass() {
return PartijBijhoudingHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
/**
* PartijVrijBericht historie verwerker.
*/
static final class PartijVrijBerichtHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijVrijBerichtHistorie> {
@Override
public Class<PartijVrijBerichtHistorie> historieClass() {
return PartijVrijBerichtHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
}
| DDDNL/OperatieBRP | Broncode/operatiebrp-code-145.3/brp/beheer/beheer-api/src/main/java/nl/bzk/brp/beheer/webapp/controllers/stamgegevens/kern/PartijController.java | 2,714 | /**
* Partij historie verwerker.
*/ | 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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.beheer.webapp.controllers.stamgegevens.kern;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.Partij;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijBijhoudingHistorie;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijHistorie;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijRol;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijVrijBerichtHistorie;
import nl.bzk.brp.beheer.webapp.configuratie.ControllerConstants;
import nl.bzk.brp.beheer.webapp.controllers.AbstractHistorieVerwerker;
import nl.bzk.brp.beheer.webapp.controllers.AbstractReadWriteController;
import nl.bzk.brp.beheer.webapp.controllers.ErrorHandler;
import nl.bzk.brp.beheer.webapp.controllers.ErrorHandler.NotFoundException;
import nl.bzk.brp.beheer.webapp.controllers.ReadWriteController;
import nl.bzk.brp.beheer.webapp.controllers.query.BooleanValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.EqualPredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.Filter;
import nl.bzk.brp.beheer.webapp.controllers.query.IntegerValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.LessOrEqualPredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.LikePredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.ShortValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.StringValueAdapter;
import nl.bzk.brp.beheer.webapp.repository.stamgegevens.kern.PartijRepository;
import nl.bzk.brp.beheer.webapp.repository.stamgegevens.kern.SoortPartijRepository;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.domain.Sort;
import org.springframework.data.web.PageableDefault;
import org.springframework.data.web.SortDefault;
import org.springframework.http.HttpStatus;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestController;
/**
* Partij controller.
*/
@RestController
@RequestMapping(value = ControllerConstants.PARTIJ_URI)
public class PartijController extends AbstractReadWriteController<Partij, Short> {
private static final String NAAM = "naam";
private static final String CODE = "code";
private static final String DATUM_INGANG = "datumIngang";
private static final String DATUM_EINDE = "datumEinde";
private static final String AUTOMATISCH_FIATTEREN = "indicatieAutomatischFiatteren";
private static final String DATUM_OVERGANG_BRP = "datumOvergangNaarBrp";
private static final String PARTIJ_ROL = "partijRolSet.rolId";
private static final Filter<?> FILTER_CODE = new Filter<>("filterCode", new StringValueAdapter(), new EqualPredicateBuilderFactory(CODE));
private static final Filter<?> FILTER_NAAM = new Filter<>("filterNaam", new StringValueAdapter(), new LikePredicateBuilderFactory(NAAM));
private static final Filter<?> FILTER_OIN = new Filter<>("filterOin", new StringValueAdapter(), new LikePredicateBuilderFactory("oin"));
private static final Filter<?> FILTER_SOORT = new Filter<>("filterSoort", new ShortValueAdapter(), new EqualPredicateBuilderFactory("soortPartij.id"));
private static final Filter<?> FILTER_ROL = new Filter<>("filterPartijRol", new ShortValueAdapter(), new EqualPredicateBuilderFactory(PARTIJ_ROL));
private static final Filter<?> FILTER_DATUM_INGANG =
new Filter<>("filterDatumIngang", new IntegerValueAdapter(), new EqualPredicateBuilderFactory(DATUM_INGANG));
private static final Filter<?> FILTER_DATUM_EINDE =
new Filter<>("filterDatumEinde", new IntegerValueAdapter(), new EqualPredicateBuilderFactory(DATUM_EINDE));
private static final Filter<?> FILTER_DATUM_OVERGANG_BRP =
new Filter<>("filterDatumOvergangNaarBrp", new IntegerValueAdapter(), new LessOrEqualPredicateBuilderFactory<>(DATUM_OVERGANG_BRP));
private static final Filter<?> FILTER_INDICATIE =
new Filter<>("filterIndicatie", new BooleanValueAdapter(), new EqualPredicateBuilderFactory("indicatieVerstrekkingsbeperkingMogelijk"));
private static final Filter<?> FILTER_AUTOMATISCH_FIATTEREN =
new Filter<>("filterIndicatieAutomatischFiatteren", new BooleanValueAdapter(), new EqualPredicateBuilderFactory(AUTOMATISCH_FIATTEREN));
private static final List<String> SORTERINGEN = Arrays.asList(CODE, NAAM, DATUM_INGANG, DATUM_EINDE);
private final SoortPartijRepository soortPartijRepository;
private final ReadWriteController<PartijRol, Integer> partijRolController;
/**
* Constructor.
* @param repository repository
* @param soortPartijRepository repository voor soort partij
* @param partijRolController controller voor partijrol
*/
@Inject
protected PartijController(final PartijRepository repository, final SoortPartijRepository soortPartijRepository,
final ReadWriteController<PartijRol, Integer> partijRolController) {
super(repository,
Arrays.asList(
FILTER_CODE,
FILTER_NAAM,
FILTER_OIN,
FILTER_SOORT,
FILTER_DATUM_INGANG,
FILTER_DATUM_EINDE,
FILTER_INDICATIE,
FILTER_DATUM_OVERGANG_BRP,
FILTER_ROL,
FILTER_AUTOMATISCH_FIATTEREN
),
Arrays.asList(new PartijHistorieVerwerker(), new PartijBijhoudingHistorieVerwerker(), new PartijVrijBerichtHistorieVerwerker()),
SORTERINGEN);
this.soortPartijRepository = soortPartijRepository;
this.partijRolController = partijRolController;
}
@Override
protected final void wijzigObjectVoorOpslag(final Partij partij) throws ErrorHandler.NotFoundException {
if (partij.getSoortPartij() != null && partij.getSoortPartij().getId() != null) {
partij.setSoortPartij(soortPartijRepository.getOne(partij.getSoortPartij().getId()));
}
// Lege OIN's mogen niet, sla deze als null op.
if ("".equals(partij.getOin())) {
partij.setOin(null);
}
// Indicatieverstrekkingsbeperkingmogelijk mag niet leeg zijn, zet deze op FALSE indien leeg.
if (partij.isIndicatieVerstrekkingsbeperkingMogelijk() == null) {
partij.setIndicatieVerstrekkingsbeperkingMogelijk(Boolean.FALSE);
}
}
/**
* Haal een specifiek partijrol op.
* @param id id
* @param partijRolId partijRolId
* @return item
* @throws ErrorHandler.NotFoundException wanneer het item niet gevonden kan worden
*/
@RequestMapping(value = "/{id}/partijrollen/{pid}", method = RequestMethod.GET)
@ResponseStatus(HttpStatus.OK)
public final PartijRol getPartijRol(@PathVariable("id") final Long id, @PathVariable("pid") final Integer partijRolId)
throws ErrorHandler.NotFoundException {
return partijRolController.get(partijRolId);
}
/**
* Haal een lijst van partijrollen op.
* @param id id van actie
* @param parameters request parameters
* @param pageable paginering
* @return lijst van partijrol (inclusief paginering en sortering)
*/
@RequestMapping(value = "/{id}/partijrollen", method = RequestMethod.GET)
@ResponseStatus(HttpStatus.OK)
public final Page<PartijRol> listPartijRol(
@PathVariable(value = "id") final String id,
@RequestParam final Map<String, String> parameters,
@PageableDefault(size = 10) @SortDefault(sort = "datumIngang", direction = Sort.Direction.ASC) final Pageable pageable) {
parameters.put("partij", id);
return partijRolController.list(parameters, pageable);
}
/**
* Bewaar een partijrol.
* @param partijId Id van de partij
* @param item request body
* @return item
* @throws ErrorHandler.NotFoundException indien Partij niet gevonden wordt.
*/
@RequestMapping(value = "/{id}/partijrollen", method = RequestMethod.POST)
@ResponseStatus(HttpStatus.OK)
public final PartijRol savePartijRol(@PathVariable(value = "id") final Integer partijId, @Validated @RequestBody final PartijRol item)
throws NotFoundException {
item.setPartij(get(partijId.shortValue()));
return partijRolController.save(item);
}
/**
* Partij historie verwerker.<SUF>*/
static final class PartijHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijHistorie> {
@Override
public Class<PartijHistorie> historieClass() {
return PartijHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
/**
* PartijBijhouding historie verwerker.
*/
static final class PartijBijhoudingHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijBijhoudingHistorie> {
@Override
public Class<PartijBijhoudingHistorie> historieClass() {
return PartijBijhoudingHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
/**
* PartijVrijBericht historie verwerker.
*/
static final class PartijVrijBerichtHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijVrijBerichtHistorie> {
@Override
public Class<PartijVrijBerichtHistorie> historieClass() {
return PartijVrijBerichtHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
}
|
202124_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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.beheer.webapp.controllers.stamgegevens.kern;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.Partij;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijBijhoudingHistorie;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijHistorie;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijRol;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijVrijBerichtHistorie;
import nl.bzk.brp.beheer.webapp.configuratie.ControllerConstants;
import nl.bzk.brp.beheer.webapp.controllers.AbstractHistorieVerwerker;
import nl.bzk.brp.beheer.webapp.controllers.AbstractReadWriteController;
import nl.bzk.brp.beheer.webapp.controllers.ErrorHandler;
import nl.bzk.brp.beheer.webapp.controllers.ErrorHandler.NotFoundException;
import nl.bzk.brp.beheer.webapp.controllers.ReadWriteController;
import nl.bzk.brp.beheer.webapp.controllers.query.BooleanValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.EqualPredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.Filter;
import nl.bzk.brp.beheer.webapp.controllers.query.IntegerValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.LessOrEqualPredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.LikePredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.ShortValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.StringValueAdapter;
import nl.bzk.brp.beheer.webapp.repository.stamgegevens.kern.PartijRepository;
import nl.bzk.brp.beheer.webapp.repository.stamgegevens.kern.SoortPartijRepository;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.domain.Sort;
import org.springframework.data.web.PageableDefault;
import org.springframework.data.web.SortDefault;
import org.springframework.http.HttpStatus;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestController;
/**
* Partij controller.
*/
@RestController
@RequestMapping(value = ControllerConstants.PARTIJ_URI)
public class PartijController extends AbstractReadWriteController<Partij, Short> {
private static final String NAAM = "naam";
private static final String CODE = "code";
private static final String DATUM_INGANG = "datumIngang";
private static final String DATUM_EINDE = "datumEinde";
private static final String AUTOMATISCH_FIATTEREN = "indicatieAutomatischFiatteren";
private static final String DATUM_OVERGANG_BRP = "datumOvergangNaarBrp";
private static final String PARTIJ_ROL = "partijRolSet.rolId";
private static final Filter<?> FILTER_CODE = new Filter<>("filterCode", new StringValueAdapter(), new EqualPredicateBuilderFactory(CODE));
private static final Filter<?> FILTER_NAAM = new Filter<>("filterNaam", new StringValueAdapter(), new LikePredicateBuilderFactory(NAAM));
private static final Filter<?> FILTER_OIN = new Filter<>("filterOin", new StringValueAdapter(), new LikePredicateBuilderFactory("oin"));
private static final Filter<?> FILTER_SOORT = new Filter<>("filterSoort", new ShortValueAdapter(), new EqualPredicateBuilderFactory("soortPartij.id"));
private static final Filter<?> FILTER_ROL = new Filter<>("filterPartijRol", new ShortValueAdapter(), new EqualPredicateBuilderFactory(PARTIJ_ROL));
private static final Filter<?> FILTER_DATUM_INGANG =
new Filter<>("filterDatumIngang", new IntegerValueAdapter(), new EqualPredicateBuilderFactory(DATUM_INGANG));
private static final Filter<?> FILTER_DATUM_EINDE =
new Filter<>("filterDatumEinde", new IntegerValueAdapter(), new EqualPredicateBuilderFactory(DATUM_EINDE));
private static final Filter<?> FILTER_DATUM_OVERGANG_BRP =
new Filter<>("filterDatumOvergangNaarBrp", new IntegerValueAdapter(), new LessOrEqualPredicateBuilderFactory<>(DATUM_OVERGANG_BRP));
private static final Filter<?> FILTER_INDICATIE =
new Filter<>("filterIndicatie", new BooleanValueAdapter(), new EqualPredicateBuilderFactory("indicatieVerstrekkingsbeperkingMogelijk"));
private static final Filter<?> FILTER_AUTOMATISCH_FIATTEREN =
new Filter<>("filterIndicatieAutomatischFiatteren", new BooleanValueAdapter(), new EqualPredicateBuilderFactory(AUTOMATISCH_FIATTEREN));
private static final List<String> SORTERINGEN = Arrays.asList(CODE, NAAM, DATUM_INGANG, DATUM_EINDE);
private final SoortPartijRepository soortPartijRepository;
private final ReadWriteController<PartijRol, Integer> partijRolController;
/**
* Constructor.
* @param repository repository
* @param soortPartijRepository repository voor soort partij
* @param partijRolController controller voor partijrol
*/
@Inject
protected PartijController(final PartijRepository repository, final SoortPartijRepository soortPartijRepository,
final ReadWriteController<PartijRol, Integer> partijRolController) {
super(repository,
Arrays.asList(
FILTER_CODE,
FILTER_NAAM,
FILTER_OIN,
FILTER_SOORT,
FILTER_DATUM_INGANG,
FILTER_DATUM_EINDE,
FILTER_INDICATIE,
FILTER_DATUM_OVERGANG_BRP,
FILTER_ROL,
FILTER_AUTOMATISCH_FIATTEREN
),
Arrays.asList(new PartijHistorieVerwerker(), new PartijBijhoudingHistorieVerwerker(), new PartijVrijBerichtHistorieVerwerker()),
SORTERINGEN);
this.soortPartijRepository = soortPartijRepository;
this.partijRolController = partijRolController;
}
@Override
protected final void wijzigObjectVoorOpslag(final Partij partij) throws ErrorHandler.NotFoundException {
if (partij.getSoortPartij() != null && partij.getSoortPartij().getId() != null) {
partij.setSoortPartij(soortPartijRepository.getOne(partij.getSoortPartij().getId()));
}
// Lege OIN's mogen niet, sla deze als null op.
if ("".equals(partij.getOin())) {
partij.setOin(null);
}
// Indicatieverstrekkingsbeperkingmogelijk mag niet leeg zijn, zet deze op FALSE indien leeg.
if (partij.isIndicatieVerstrekkingsbeperkingMogelijk() == null) {
partij.setIndicatieVerstrekkingsbeperkingMogelijk(Boolean.FALSE);
}
}
/**
* Haal een specifiek partijrol op.
* @param id id
* @param partijRolId partijRolId
* @return item
* @throws ErrorHandler.NotFoundException wanneer het item niet gevonden kan worden
*/
@RequestMapping(value = "/{id}/partijrollen/{pid}", method = RequestMethod.GET)
@ResponseStatus(HttpStatus.OK)
public final PartijRol getPartijRol(@PathVariable("id") final Long id, @PathVariable("pid") final Integer partijRolId)
throws ErrorHandler.NotFoundException {
return partijRolController.get(partijRolId);
}
/**
* Haal een lijst van partijrollen op.
* @param id id van actie
* @param parameters request parameters
* @param pageable paginering
* @return lijst van partijrol (inclusief paginering en sortering)
*/
@RequestMapping(value = "/{id}/partijrollen", method = RequestMethod.GET)
@ResponseStatus(HttpStatus.OK)
public final Page<PartijRol> listPartijRol(
@PathVariable(value = "id") final String id,
@RequestParam final Map<String, String> parameters,
@PageableDefault(size = 10) @SortDefault(sort = "datumIngang", direction = Sort.Direction.ASC) final Pageable pageable) {
parameters.put("partij", id);
return partijRolController.list(parameters, pageable);
}
/**
* Bewaar een partijrol.
* @param partijId Id van de partij
* @param item request body
* @return item
* @throws ErrorHandler.NotFoundException indien Partij niet gevonden wordt.
*/
@RequestMapping(value = "/{id}/partijrollen", method = RequestMethod.POST)
@ResponseStatus(HttpStatus.OK)
public final PartijRol savePartijRol(@PathVariable(value = "id") final Integer partijId, @Validated @RequestBody final PartijRol item)
throws NotFoundException {
item.setPartij(get(partijId.shortValue()));
return partijRolController.save(item);
}
/**
* Partij historie verwerker.
*/
static final class PartijHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijHistorie> {
@Override
public Class<PartijHistorie> historieClass() {
return PartijHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
/**
* PartijBijhouding historie verwerker.
*/
static final class PartijBijhoudingHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijBijhoudingHistorie> {
@Override
public Class<PartijBijhoudingHistorie> historieClass() {
return PartijBijhoudingHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
/**
* PartijVrijBericht historie verwerker.
*/
static final class PartijVrijBerichtHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijVrijBerichtHistorie> {
@Override
public Class<PartijVrijBerichtHistorie> historieClass() {
return PartijVrijBerichtHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
}
| DDDNL/OperatieBRP | Broncode/operatiebrp-code-145.3/brp/beheer/beheer-api/src/main/java/nl/bzk/brp/beheer/webapp/controllers/stamgegevens/kern/PartijController.java | 2,714 | /**
* PartijBijhouding historie verwerker.
*/ | 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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.beheer.webapp.controllers.stamgegevens.kern;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.Partij;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijBijhoudingHistorie;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijHistorie;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijRol;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijVrijBerichtHistorie;
import nl.bzk.brp.beheer.webapp.configuratie.ControllerConstants;
import nl.bzk.brp.beheer.webapp.controllers.AbstractHistorieVerwerker;
import nl.bzk.brp.beheer.webapp.controllers.AbstractReadWriteController;
import nl.bzk.brp.beheer.webapp.controllers.ErrorHandler;
import nl.bzk.brp.beheer.webapp.controllers.ErrorHandler.NotFoundException;
import nl.bzk.brp.beheer.webapp.controllers.ReadWriteController;
import nl.bzk.brp.beheer.webapp.controllers.query.BooleanValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.EqualPredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.Filter;
import nl.bzk.brp.beheer.webapp.controllers.query.IntegerValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.LessOrEqualPredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.LikePredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.ShortValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.StringValueAdapter;
import nl.bzk.brp.beheer.webapp.repository.stamgegevens.kern.PartijRepository;
import nl.bzk.brp.beheer.webapp.repository.stamgegevens.kern.SoortPartijRepository;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.domain.Sort;
import org.springframework.data.web.PageableDefault;
import org.springframework.data.web.SortDefault;
import org.springframework.http.HttpStatus;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestController;
/**
* Partij controller.
*/
@RestController
@RequestMapping(value = ControllerConstants.PARTIJ_URI)
public class PartijController extends AbstractReadWriteController<Partij, Short> {
private static final String NAAM = "naam";
private static final String CODE = "code";
private static final String DATUM_INGANG = "datumIngang";
private static final String DATUM_EINDE = "datumEinde";
private static final String AUTOMATISCH_FIATTEREN = "indicatieAutomatischFiatteren";
private static final String DATUM_OVERGANG_BRP = "datumOvergangNaarBrp";
private static final String PARTIJ_ROL = "partijRolSet.rolId";
private static final Filter<?> FILTER_CODE = new Filter<>("filterCode", new StringValueAdapter(), new EqualPredicateBuilderFactory(CODE));
private static final Filter<?> FILTER_NAAM = new Filter<>("filterNaam", new StringValueAdapter(), new LikePredicateBuilderFactory(NAAM));
private static final Filter<?> FILTER_OIN = new Filter<>("filterOin", new StringValueAdapter(), new LikePredicateBuilderFactory("oin"));
private static final Filter<?> FILTER_SOORT = new Filter<>("filterSoort", new ShortValueAdapter(), new EqualPredicateBuilderFactory("soortPartij.id"));
private static final Filter<?> FILTER_ROL = new Filter<>("filterPartijRol", new ShortValueAdapter(), new EqualPredicateBuilderFactory(PARTIJ_ROL));
private static final Filter<?> FILTER_DATUM_INGANG =
new Filter<>("filterDatumIngang", new IntegerValueAdapter(), new EqualPredicateBuilderFactory(DATUM_INGANG));
private static final Filter<?> FILTER_DATUM_EINDE =
new Filter<>("filterDatumEinde", new IntegerValueAdapter(), new EqualPredicateBuilderFactory(DATUM_EINDE));
private static final Filter<?> FILTER_DATUM_OVERGANG_BRP =
new Filter<>("filterDatumOvergangNaarBrp", new IntegerValueAdapter(), new LessOrEqualPredicateBuilderFactory<>(DATUM_OVERGANG_BRP));
private static final Filter<?> FILTER_INDICATIE =
new Filter<>("filterIndicatie", new BooleanValueAdapter(), new EqualPredicateBuilderFactory("indicatieVerstrekkingsbeperkingMogelijk"));
private static final Filter<?> FILTER_AUTOMATISCH_FIATTEREN =
new Filter<>("filterIndicatieAutomatischFiatteren", new BooleanValueAdapter(), new EqualPredicateBuilderFactory(AUTOMATISCH_FIATTEREN));
private static final List<String> SORTERINGEN = Arrays.asList(CODE, NAAM, DATUM_INGANG, DATUM_EINDE);
private final SoortPartijRepository soortPartijRepository;
private final ReadWriteController<PartijRol, Integer> partijRolController;
/**
* Constructor.
* @param repository repository
* @param soortPartijRepository repository voor soort partij
* @param partijRolController controller voor partijrol
*/
@Inject
protected PartijController(final PartijRepository repository, final SoortPartijRepository soortPartijRepository,
final ReadWriteController<PartijRol, Integer> partijRolController) {
super(repository,
Arrays.asList(
FILTER_CODE,
FILTER_NAAM,
FILTER_OIN,
FILTER_SOORT,
FILTER_DATUM_INGANG,
FILTER_DATUM_EINDE,
FILTER_INDICATIE,
FILTER_DATUM_OVERGANG_BRP,
FILTER_ROL,
FILTER_AUTOMATISCH_FIATTEREN
),
Arrays.asList(new PartijHistorieVerwerker(), new PartijBijhoudingHistorieVerwerker(), new PartijVrijBerichtHistorieVerwerker()),
SORTERINGEN);
this.soortPartijRepository = soortPartijRepository;
this.partijRolController = partijRolController;
}
@Override
protected final void wijzigObjectVoorOpslag(final Partij partij) throws ErrorHandler.NotFoundException {
if (partij.getSoortPartij() != null && partij.getSoortPartij().getId() != null) {
partij.setSoortPartij(soortPartijRepository.getOne(partij.getSoortPartij().getId()));
}
// Lege OIN's mogen niet, sla deze als null op.
if ("".equals(partij.getOin())) {
partij.setOin(null);
}
// Indicatieverstrekkingsbeperkingmogelijk mag niet leeg zijn, zet deze op FALSE indien leeg.
if (partij.isIndicatieVerstrekkingsbeperkingMogelijk() == null) {
partij.setIndicatieVerstrekkingsbeperkingMogelijk(Boolean.FALSE);
}
}
/**
* Haal een specifiek partijrol op.
* @param id id
* @param partijRolId partijRolId
* @return item
* @throws ErrorHandler.NotFoundException wanneer het item niet gevonden kan worden
*/
@RequestMapping(value = "/{id}/partijrollen/{pid}", method = RequestMethod.GET)
@ResponseStatus(HttpStatus.OK)
public final PartijRol getPartijRol(@PathVariable("id") final Long id, @PathVariable("pid") final Integer partijRolId)
throws ErrorHandler.NotFoundException {
return partijRolController.get(partijRolId);
}
/**
* Haal een lijst van partijrollen op.
* @param id id van actie
* @param parameters request parameters
* @param pageable paginering
* @return lijst van partijrol (inclusief paginering en sortering)
*/
@RequestMapping(value = "/{id}/partijrollen", method = RequestMethod.GET)
@ResponseStatus(HttpStatus.OK)
public final Page<PartijRol> listPartijRol(
@PathVariable(value = "id") final String id,
@RequestParam final Map<String, String> parameters,
@PageableDefault(size = 10) @SortDefault(sort = "datumIngang", direction = Sort.Direction.ASC) final Pageable pageable) {
parameters.put("partij", id);
return partijRolController.list(parameters, pageable);
}
/**
* Bewaar een partijrol.
* @param partijId Id van de partij
* @param item request body
* @return item
* @throws ErrorHandler.NotFoundException indien Partij niet gevonden wordt.
*/
@RequestMapping(value = "/{id}/partijrollen", method = RequestMethod.POST)
@ResponseStatus(HttpStatus.OK)
public final PartijRol savePartijRol(@PathVariable(value = "id") final Integer partijId, @Validated @RequestBody final PartijRol item)
throws NotFoundException {
item.setPartij(get(partijId.shortValue()));
return partijRolController.save(item);
}
/**
* Partij historie verwerker.
*/
static final class PartijHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijHistorie> {
@Override
public Class<PartijHistorie> historieClass() {
return PartijHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
/**
* PartijBijhouding historie verwerker.<SUF>*/
static final class PartijBijhoudingHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijBijhoudingHistorie> {
@Override
public Class<PartijBijhoudingHistorie> historieClass() {
return PartijBijhoudingHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
/**
* PartijVrijBericht historie verwerker.
*/
static final class PartijVrijBerichtHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijVrijBerichtHistorie> {
@Override
public Class<PartijVrijBerichtHistorie> historieClass() {
return PartijVrijBerichtHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
}
|
202124_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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.beheer.webapp.controllers.stamgegevens.kern;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.Partij;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijBijhoudingHistorie;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijHistorie;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijRol;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijVrijBerichtHistorie;
import nl.bzk.brp.beheer.webapp.configuratie.ControllerConstants;
import nl.bzk.brp.beheer.webapp.controllers.AbstractHistorieVerwerker;
import nl.bzk.brp.beheer.webapp.controllers.AbstractReadWriteController;
import nl.bzk.brp.beheer.webapp.controllers.ErrorHandler;
import nl.bzk.brp.beheer.webapp.controllers.ErrorHandler.NotFoundException;
import nl.bzk.brp.beheer.webapp.controllers.ReadWriteController;
import nl.bzk.brp.beheer.webapp.controllers.query.BooleanValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.EqualPredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.Filter;
import nl.bzk.brp.beheer.webapp.controllers.query.IntegerValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.LessOrEqualPredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.LikePredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.ShortValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.StringValueAdapter;
import nl.bzk.brp.beheer.webapp.repository.stamgegevens.kern.PartijRepository;
import nl.bzk.brp.beheer.webapp.repository.stamgegevens.kern.SoortPartijRepository;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.domain.Sort;
import org.springframework.data.web.PageableDefault;
import org.springframework.data.web.SortDefault;
import org.springframework.http.HttpStatus;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestController;
/**
* Partij controller.
*/
@RestController
@RequestMapping(value = ControllerConstants.PARTIJ_URI)
public class PartijController extends AbstractReadWriteController<Partij, Short> {
private static final String NAAM = "naam";
private static final String CODE = "code";
private static final String DATUM_INGANG = "datumIngang";
private static final String DATUM_EINDE = "datumEinde";
private static final String AUTOMATISCH_FIATTEREN = "indicatieAutomatischFiatteren";
private static final String DATUM_OVERGANG_BRP = "datumOvergangNaarBrp";
private static final String PARTIJ_ROL = "partijRolSet.rolId";
private static final Filter<?> FILTER_CODE = new Filter<>("filterCode", new StringValueAdapter(), new EqualPredicateBuilderFactory(CODE));
private static final Filter<?> FILTER_NAAM = new Filter<>("filterNaam", new StringValueAdapter(), new LikePredicateBuilderFactory(NAAM));
private static final Filter<?> FILTER_OIN = new Filter<>("filterOin", new StringValueAdapter(), new LikePredicateBuilderFactory("oin"));
private static final Filter<?> FILTER_SOORT = new Filter<>("filterSoort", new ShortValueAdapter(), new EqualPredicateBuilderFactory("soortPartij.id"));
private static final Filter<?> FILTER_ROL = new Filter<>("filterPartijRol", new ShortValueAdapter(), new EqualPredicateBuilderFactory(PARTIJ_ROL));
private static final Filter<?> FILTER_DATUM_INGANG =
new Filter<>("filterDatumIngang", new IntegerValueAdapter(), new EqualPredicateBuilderFactory(DATUM_INGANG));
private static final Filter<?> FILTER_DATUM_EINDE =
new Filter<>("filterDatumEinde", new IntegerValueAdapter(), new EqualPredicateBuilderFactory(DATUM_EINDE));
private static final Filter<?> FILTER_DATUM_OVERGANG_BRP =
new Filter<>("filterDatumOvergangNaarBrp", new IntegerValueAdapter(), new LessOrEqualPredicateBuilderFactory<>(DATUM_OVERGANG_BRP));
private static final Filter<?> FILTER_INDICATIE =
new Filter<>("filterIndicatie", new BooleanValueAdapter(), new EqualPredicateBuilderFactory("indicatieVerstrekkingsbeperkingMogelijk"));
private static final Filter<?> FILTER_AUTOMATISCH_FIATTEREN =
new Filter<>("filterIndicatieAutomatischFiatteren", new BooleanValueAdapter(), new EqualPredicateBuilderFactory(AUTOMATISCH_FIATTEREN));
private static final List<String> SORTERINGEN = Arrays.asList(CODE, NAAM, DATUM_INGANG, DATUM_EINDE);
private final SoortPartijRepository soortPartijRepository;
private final ReadWriteController<PartijRol, Integer> partijRolController;
/**
* Constructor.
* @param repository repository
* @param soortPartijRepository repository voor soort partij
* @param partijRolController controller voor partijrol
*/
@Inject
protected PartijController(final PartijRepository repository, final SoortPartijRepository soortPartijRepository,
final ReadWriteController<PartijRol, Integer> partijRolController) {
super(repository,
Arrays.asList(
FILTER_CODE,
FILTER_NAAM,
FILTER_OIN,
FILTER_SOORT,
FILTER_DATUM_INGANG,
FILTER_DATUM_EINDE,
FILTER_INDICATIE,
FILTER_DATUM_OVERGANG_BRP,
FILTER_ROL,
FILTER_AUTOMATISCH_FIATTEREN
),
Arrays.asList(new PartijHistorieVerwerker(), new PartijBijhoudingHistorieVerwerker(), new PartijVrijBerichtHistorieVerwerker()),
SORTERINGEN);
this.soortPartijRepository = soortPartijRepository;
this.partijRolController = partijRolController;
}
@Override
protected final void wijzigObjectVoorOpslag(final Partij partij) throws ErrorHandler.NotFoundException {
if (partij.getSoortPartij() != null && partij.getSoortPartij().getId() != null) {
partij.setSoortPartij(soortPartijRepository.getOne(partij.getSoortPartij().getId()));
}
// Lege OIN's mogen niet, sla deze als null op.
if ("".equals(partij.getOin())) {
partij.setOin(null);
}
// Indicatieverstrekkingsbeperkingmogelijk mag niet leeg zijn, zet deze op FALSE indien leeg.
if (partij.isIndicatieVerstrekkingsbeperkingMogelijk() == null) {
partij.setIndicatieVerstrekkingsbeperkingMogelijk(Boolean.FALSE);
}
}
/**
* Haal een specifiek partijrol op.
* @param id id
* @param partijRolId partijRolId
* @return item
* @throws ErrorHandler.NotFoundException wanneer het item niet gevonden kan worden
*/
@RequestMapping(value = "/{id}/partijrollen/{pid}", method = RequestMethod.GET)
@ResponseStatus(HttpStatus.OK)
public final PartijRol getPartijRol(@PathVariable("id") final Long id, @PathVariable("pid") final Integer partijRolId)
throws ErrorHandler.NotFoundException {
return partijRolController.get(partijRolId);
}
/**
* Haal een lijst van partijrollen op.
* @param id id van actie
* @param parameters request parameters
* @param pageable paginering
* @return lijst van partijrol (inclusief paginering en sortering)
*/
@RequestMapping(value = "/{id}/partijrollen", method = RequestMethod.GET)
@ResponseStatus(HttpStatus.OK)
public final Page<PartijRol> listPartijRol(
@PathVariable(value = "id") final String id,
@RequestParam final Map<String, String> parameters,
@PageableDefault(size = 10) @SortDefault(sort = "datumIngang", direction = Sort.Direction.ASC) final Pageable pageable) {
parameters.put("partij", id);
return partijRolController.list(parameters, pageable);
}
/**
* Bewaar een partijrol.
* @param partijId Id van de partij
* @param item request body
* @return item
* @throws ErrorHandler.NotFoundException indien Partij niet gevonden wordt.
*/
@RequestMapping(value = "/{id}/partijrollen", method = RequestMethod.POST)
@ResponseStatus(HttpStatus.OK)
public final PartijRol savePartijRol(@PathVariable(value = "id") final Integer partijId, @Validated @RequestBody final PartijRol item)
throws NotFoundException {
item.setPartij(get(partijId.shortValue()));
return partijRolController.save(item);
}
/**
* Partij historie verwerker.
*/
static final class PartijHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijHistorie> {
@Override
public Class<PartijHistorie> historieClass() {
return PartijHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
/**
* PartijBijhouding historie verwerker.
*/
static final class PartijBijhoudingHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijBijhoudingHistorie> {
@Override
public Class<PartijBijhoudingHistorie> historieClass() {
return PartijBijhoudingHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
/**
* PartijVrijBericht historie verwerker.
*/
static final class PartijVrijBerichtHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijVrijBerichtHistorie> {
@Override
public Class<PartijVrijBerichtHistorie> historieClass() {
return PartijVrijBerichtHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
}
| DDDNL/OperatieBRP | Broncode/operatiebrp-code-145.3/brp/beheer/beheer-api/src/main/java/nl/bzk/brp/beheer/webapp/controllers/stamgegevens/kern/PartijController.java | 2,714 | /**
* PartijVrijBericht historie verwerker.
*/ | 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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.beheer.webapp.controllers.stamgegevens.kern;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.Partij;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijBijhoudingHistorie;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijHistorie;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijRol;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.PartijVrijBerichtHistorie;
import nl.bzk.brp.beheer.webapp.configuratie.ControllerConstants;
import nl.bzk.brp.beheer.webapp.controllers.AbstractHistorieVerwerker;
import nl.bzk.brp.beheer.webapp.controllers.AbstractReadWriteController;
import nl.bzk.brp.beheer.webapp.controllers.ErrorHandler;
import nl.bzk.brp.beheer.webapp.controllers.ErrorHandler.NotFoundException;
import nl.bzk.brp.beheer.webapp.controllers.ReadWriteController;
import nl.bzk.brp.beheer.webapp.controllers.query.BooleanValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.EqualPredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.Filter;
import nl.bzk.brp.beheer.webapp.controllers.query.IntegerValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.LessOrEqualPredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.LikePredicateBuilderFactory;
import nl.bzk.brp.beheer.webapp.controllers.query.ShortValueAdapter;
import nl.bzk.brp.beheer.webapp.controllers.query.StringValueAdapter;
import nl.bzk.brp.beheer.webapp.repository.stamgegevens.kern.PartijRepository;
import nl.bzk.brp.beheer.webapp.repository.stamgegevens.kern.SoortPartijRepository;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.domain.Sort;
import org.springframework.data.web.PageableDefault;
import org.springframework.data.web.SortDefault;
import org.springframework.http.HttpStatus;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestController;
/**
* Partij controller.
*/
@RestController
@RequestMapping(value = ControllerConstants.PARTIJ_URI)
public class PartijController extends AbstractReadWriteController<Partij, Short> {
private static final String NAAM = "naam";
private static final String CODE = "code";
private static final String DATUM_INGANG = "datumIngang";
private static final String DATUM_EINDE = "datumEinde";
private static final String AUTOMATISCH_FIATTEREN = "indicatieAutomatischFiatteren";
private static final String DATUM_OVERGANG_BRP = "datumOvergangNaarBrp";
private static final String PARTIJ_ROL = "partijRolSet.rolId";
private static final Filter<?> FILTER_CODE = new Filter<>("filterCode", new StringValueAdapter(), new EqualPredicateBuilderFactory(CODE));
private static final Filter<?> FILTER_NAAM = new Filter<>("filterNaam", new StringValueAdapter(), new LikePredicateBuilderFactory(NAAM));
private static final Filter<?> FILTER_OIN = new Filter<>("filterOin", new StringValueAdapter(), new LikePredicateBuilderFactory("oin"));
private static final Filter<?> FILTER_SOORT = new Filter<>("filterSoort", new ShortValueAdapter(), new EqualPredicateBuilderFactory("soortPartij.id"));
private static final Filter<?> FILTER_ROL = new Filter<>("filterPartijRol", new ShortValueAdapter(), new EqualPredicateBuilderFactory(PARTIJ_ROL));
private static final Filter<?> FILTER_DATUM_INGANG =
new Filter<>("filterDatumIngang", new IntegerValueAdapter(), new EqualPredicateBuilderFactory(DATUM_INGANG));
private static final Filter<?> FILTER_DATUM_EINDE =
new Filter<>("filterDatumEinde", new IntegerValueAdapter(), new EqualPredicateBuilderFactory(DATUM_EINDE));
private static final Filter<?> FILTER_DATUM_OVERGANG_BRP =
new Filter<>("filterDatumOvergangNaarBrp", new IntegerValueAdapter(), new LessOrEqualPredicateBuilderFactory<>(DATUM_OVERGANG_BRP));
private static final Filter<?> FILTER_INDICATIE =
new Filter<>("filterIndicatie", new BooleanValueAdapter(), new EqualPredicateBuilderFactory("indicatieVerstrekkingsbeperkingMogelijk"));
private static final Filter<?> FILTER_AUTOMATISCH_FIATTEREN =
new Filter<>("filterIndicatieAutomatischFiatteren", new BooleanValueAdapter(), new EqualPredicateBuilderFactory(AUTOMATISCH_FIATTEREN));
private static final List<String> SORTERINGEN = Arrays.asList(CODE, NAAM, DATUM_INGANG, DATUM_EINDE);
private final SoortPartijRepository soortPartijRepository;
private final ReadWriteController<PartijRol, Integer> partijRolController;
/**
* Constructor.
* @param repository repository
* @param soortPartijRepository repository voor soort partij
* @param partijRolController controller voor partijrol
*/
@Inject
protected PartijController(final PartijRepository repository, final SoortPartijRepository soortPartijRepository,
final ReadWriteController<PartijRol, Integer> partijRolController) {
super(repository,
Arrays.asList(
FILTER_CODE,
FILTER_NAAM,
FILTER_OIN,
FILTER_SOORT,
FILTER_DATUM_INGANG,
FILTER_DATUM_EINDE,
FILTER_INDICATIE,
FILTER_DATUM_OVERGANG_BRP,
FILTER_ROL,
FILTER_AUTOMATISCH_FIATTEREN
),
Arrays.asList(new PartijHistorieVerwerker(), new PartijBijhoudingHistorieVerwerker(), new PartijVrijBerichtHistorieVerwerker()),
SORTERINGEN);
this.soortPartijRepository = soortPartijRepository;
this.partijRolController = partijRolController;
}
@Override
protected final void wijzigObjectVoorOpslag(final Partij partij) throws ErrorHandler.NotFoundException {
if (partij.getSoortPartij() != null && partij.getSoortPartij().getId() != null) {
partij.setSoortPartij(soortPartijRepository.getOne(partij.getSoortPartij().getId()));
}
// Lege OIN's mogen niet, sla deze als null op.
if ("".equals(partij.getOin())) {
partij.setOin(null);
}
// Indicatieverstrekkingsbeperkingmogelijk mag niet leeg zijn, zet deze op FALSE indien leeg.
if (partij.isIndicatieVerstrekkingsbeperkingMogelijk() == null) {
partij.setIndicatieVerstrekkingsbeperkingMogelijk(Boolean.FALSE);
}
}
/**
* Haal een specifiek partijrol op.
* @param id id
* @param partijRolId partijRolId
* @return item
* @throws ErrorHandler.NotFoundException wanneer het item niet gevonden kan worden
*/
@RequestMapping(value = "/{id}/partijrollen/{pid}", method = RequestMethod.GET)
@ResponseStatus(HttpStatus.OK)
public final PartijRol getPartijRol(@PathVariable("id") final Long id, @PathVariable("pid") final Integer partijRolId)
throws ErrorHandler.NotFoundException {
return partijRolController.get(partijRolId);
}
/**
* Haal een lijst van partijrollen op.
* @param id id van actie
* @param parameters request parameters
* @param pageable paginering
* @return lijst van partijrol (inclusief paginering en sortering)
*/
@RequestMapping(value = "/{id}/partijrollen", method = RequestMethod.GET)
@ResponseStatus(HttpStatus.OK)
public final Page<PartijRol> listPartijRol(
@PathVariable(value = "id") final String id,
@RequestParam final Map<String, String> parameters,
@PageableDefault(size = 10) @SortDefault(sort = "datumIngang", direction = Sort.Direction.ASC) final Pageable pageable) {
parameters.put("partij", id);
return partijRolController.list(parameters, pageable);
}
/**
* Bewaar een partijrol.
* @param partijId Id van de partij
* @param item request body
* @return item
* @throws ErrorHandler.NotFoundException indien Partij niet gevonden wordt.
*/
@RequestMapping(value = "/{id}/partijrollen", method = RequestMethod.POST)
@ResponseStatus(HttpStatus.OK)
public final PartijRol savePartijRol(@PathVariable(value = "id") final Integer partijId, @Validated @RequestBody final PartijRol item)
throws NotFoundException {
item.setPartij(get(partijId.shortValue()));
return partijRolController.save(item);
}
/**
* Partij historie verwerker.
*/
static final class PartijHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijHistorie> {
@Override
public Class<PartijHistorie> historieClass() {
return PartijHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
/**
* PartijBijhouding historie verwerker.
*/
static final class PartijBijhoudingHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijBijhoudingHistorie> {
@Override
public Class<PartijBijhoudingHistorie> historieClass() {
return PartijBijhoudingHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
/**
* PartijVrijBericht historie verwerker.<SUF>*/
static final class PartijVrijBerichtHistorieVerwerker extends AbstractHistorieVerwerker<Partij, PartijVrijBerichtHistorie> {
@Override
public Class<PartijVrijBerichtHistorie> historieClass() {
return PartijVrijBerichtHistorie.class;
}
@Override
public Class<Partij> entiteitClass() {
return Partij.class;
}
}
}
|
202128_0 | package ss.week6.voteMachine.gui;
import java.awt.Container;
import java.awt.FlowLayout;
import java.util.Map;
import javax.swing.JFrame;
import javax.swing.JLabel;
import javax.swing.JTextArea;
/**
* P2 prac wk3.
* UitslagJFrame: GUI voor een Uitslag.
* @author Arend Rensink en Theo Ruys
* @version 2005.02.15
*/
public class ResultJFrame extends JFrame {
// Grafische componenten
private JTextArea resultField;
private JLabel messageLabel;
/** Construeert een UitslagJFrame die een gegeven uitslag observeert. */
public ResultJFrame(VoteGUIView view) {
// Initialisatie grafische componenten
super("Result");
Container cc = getContentPane();
cc.setLayout(new FlowLayout());
messageLabel = new JLabel("Votes:");
cc.add(messageLabel);
resultField = new JTextArea("", 10, 20);
resultField.setEditable(false);
cc.add(resultField);
setSize(250, 255);
}
/** Zet de uitslag op het tekstveld, met 1 regel per partij. */
public void update(Map<String,Integer> votes) {
resultField.setText("");
for(Map.Entry<String,Integer> entry: votes.entrySet()){
resultField.append(entry.getKey() + ": " + entry.getValue() + "\n");
}
}
}
| GerjanWielink/software-systems | ss/src/main/java/ss/week6/voteMachine/gui/ResultJFrame.java | 370 | /**
* P2 prac wk3.
* UitslagJFrame: GUI voor een Uitslag.
* @author Arend Rensink en Theo Ruys
* @version 2005.02.15
*/ | block_comment | nl | package ss.week6.voteMachine.gui;
import java.awt.Container;
import java.awt.FlowLayout;
import java.util.Map;
import javax.swing.JFrame;
import javax.swing.JLabel;
import javax.swing.JTextArea;
/**
* P2 prac wk3.<SUF>*/
public class ResultJFrame extends JFrame {
// Grafische componenten
private JTextArea resultField;
private JLabel messageLabel;
/** Construeert een UitslagJFrame die een gegeven uitslag observeert. */
public ResultJFrame(VoteGUIView view) {
// Initialisatie grafische componenten
super("Result");
Container cc = getContentPane();
cc.setLayout(new FlowLayout());
messageLabel = new JLabel("Votes:");
cc.add(messageLabel);
resultField = new JTextArea("", 10, 20);
resultField.setEditable(false);
cc.add(resultField);
setSize(250, 255);
}
/** Zet de uitslag op het tekstveld, met 1 regel per partij. */
public void update(Map<String,Integer> votes) {
resultField.setText("");
for(Map.Entry<String,Integer> entry: votes.entrySet()){
resultField.append(entry.getKey() + ": " + entry.getValue() + "\n");
}
}
}
|
202128_1 | package ss.week6.voteMachine.gui;
import java.awt.Container;
import java.awt.FlowLayout;
import java.util.Map;
import javax.swing.JFrame;
import javax.swing.JLabel;
import javax.swing.JTextArea;
/**
* P2 prac wk3.
* UitslagJFrame: GUI voor een Uitslag.
* @author Arend Rensink en Theo Ruys
* @version 2005.02.15
*/
public class ResultJFrame extends JFrame {
// Grafische componenten
private JTextArea resultField;
private JLabel messageLabel;
/** Construeert een UitslagJFrame die een gegeven uitslag observeert. */
public ResultJFrame(VoteGUIView view) {
// Initialisatie grafische componenten
super("Result");
Container cc = getContentPane();
cc.setLayout(new FlowLayout());
messageLabel = new JLabel("Votes:");
cc.add(messageLabel);
resultField = new JTextArea("", 10, 20);
resultField.setEditable(false);
cc.add(resultField);
setSize(250, 255);
}
/** Zet de uitslag op het tekstveld, met 1 regel per partij. */
public void update(Map<String,Integer> votes) {
resultField.setText("");
for(Map.Entry<String,Integer> entry: votes.entrySet()){
resultField.append(entry.getKey() + ": " + entry.getValue() + "\n");
}
}
}
| GerjanWielink/software-systems | ss/src/main/java/ss/week6/voteMachine/gui/ResultJFrame.java | 370 | /** Construeert een UitslagJFrame die een gegeven uitslag observeert. */ | block_comment | nl | package ss.week6.voteMachine.gui;
import java.awt.Container;
import java.awt.FlowLayout;
import java.util.Map;
import javax.swing.JFrame;
import javax.swing.JLabel;
import javax.swing.JTextArea;
/**
* P2 prac wk3.
* UitslagJFrame: GUI voor een Uitslag.
* @author Arend Rensink en Theo Ruys
* @version 2005.02.15
*/
public class ResultJFrame extends JFrame {
// Grafische componenten
private JTextArea resultField;
private JLabel messageLabel;
/** Construeert een UitslagJFrame<SUF>*/
public ResultJFrame(VoteGUIView view) {
// Initialisatie grafische componenten
super("Result");
Container cc = getContentPane();
cc.setLayout(new FlowLayout());
messageLabel = new JLabel("Votes:");
cc.add(messageLabel);
resultField = new JTextArea("", 10, 20);
resultField.setEditable(false);
cc.add(resultField);
setSize(250, 255);
}
/** Zet de uitslag op het tekstveld, met 1 regel per partij. */
public void update(Map<String,Integer> votes) {
resultField.setText("");
for(Map.Entry<String,Integer> entry: votes.entrySet()){
resultField.append(entry.getKey() + ": " + entry.getValue() + "\n");
}
}
}
|
202128_3 | package ss.week6.voteMachine.gui;
import java.awt.Container;
import java.awt.FlowLayout;
import java.util.Map;
import javax.swing.JFrame;
import javax.swing.JLabel;
import javax.swing.JTextArea;
/**
* P2 prac wk3.
* UitslagJFrame: GUI voor een Uitslag.
* @author Arend Rensink en Theo Ruys
* @version 2005.02.15
*/
public class ResultJFrame extends JFrame {
// Grafische componenten
private JTextArea resultField;
private JLabel messageLabel;
/** Construeert een UitslagJFrame die een gegeven uitslag observeert. */
public ResultJFrame(VoteGUIView view) {
// Initialisatie grafische componenten
super("Result");
Container cc = getContentPane();
cc.setLayout(new FlowLayout());
messageLabel = new JLabel("Votes:");
cc.add(messageLabel);
resultField = new JTextArea("", 10, 20);
resultField.setEditable(false);
cc.add(resultField);
setSize(250, 255);
}
/** Zet de uitslag op het tekstveld, met 1 regel per partij. */
public void update(Map<String,Integer> votes) {
resultField.setText("");
for(Map.Entry<String,Integer> entry: votes.entrySet()){
resultField.append(entry.getKey() + ": " + entry.getValue() + "\n");
}
}
}
| GerjanWielink/software-systems | ss/src/main/java/ss/week6/voteMachine/gui/ResultJFrame.java | 370 | /** Zet de uitslag op het tekstveld, met 1 regel per partij. */ | block_comment | nl | package ss.week6.voteMachine.gui;
import java.awt.Container;
import java.awt.FlowLayout;
import java.util.Map;
import javax.swing.JFrame;
import javax.swing.JLabel;
import javax.swing.JTextArea;
/**
* P2 prac wk3.
* UitslagJFrame: GUI voor een Uitslag.
* @author Arend Rensink en Theo Ruys
* @version 2005.02.15
*/
public class ResultJFrame extends JFrame {
// Grafische componenten
private JTextArea resultField;
private JLabel messageLabel;
/** Construeert een UitslagJFrame die een gegeven uitslag observeert. */
public ResultJFrame(VoteGUIView view) {
// Initialisatie grafische componenten
super("Result");
Container cc = getContentPane();
cc.setLayout(new FlowLayout());
messageLabel = new JLabel("Votes:");
cc.add(messageLabel);
resultField = new JTextArea("", 10, 20);
resultField.setEditable(false);
cc.add(resultField);
setSize(250, 255);
}
/** Zet de uitslag<SUF>*/
public void update(Map<String,Integer> votes) {
resultField.setText("");
for(Map.Entry<String,Integer> entry: votes.entrySet()){
resultField.append(entry.getKey() + ": " + entry.getValue() + "\n");
}
}
}
|
202134_0 |
package ss.week6.voteMachine.gui;
import java.awt.Container;
import java.awt.FlowLayout;
import java.util.Map;
import java.util.Observable;
import java.util.Observer;
import java.util.Set;
import javax.swing.JFrame;
import javax.swing.JLabel;
import javax.swing.JTextArea;
import ss.week6.voteMachine.VoteList;
/**
* P2 prac wk3.
* UitslagJFrame: GUI voor een Uitslag.
* @author Arend Rensink en Theo Ruys
* @version 2005.02.15
*/
public class ResultJFrame extends JFrame {
// Grafische componenten
private JTextArea resultField;
private JLabel messageLabel;
/** Construeert een UitslagJFrame die een gegeven uitslag observeert. */
public ResultJFrame(VoteGUIView view) {
// Initialisatie grafische componenten
super("Result");
Container cc = getContentPane();
cc.setLayout(new FlowLayout());
messageLabel = new JLabel("Votes:");
cc.add(messageLabel);
resultField = new JTextArea("", 10, 20);
resultField.setEditable(false);
cc.add(resultField);
setSize(250, 255);
}
/** Zet de uitslag op het tekstveld, met 1 regel per partij. */
public void update(Map<String,Integer> votes) {
resultField.setText("");
for(Map.Entry<String,Integer> entry: votes.entrySet()){
resultField.append(entry.getKey() + ": " + entry.getValue() + "\n");
}
}
}
| Janwillemtv/ProgrammingProject | softwaresystems/src/ss/week6/voteMachine/gui/ResultJFrame.java | 408 | /**
* P2 prac wk3.
* UitslagJFrame: GUI voor een Uitslag.
* @author Arend Rensink en Theo Ruys
* @version 2005.02.15
*/ | block_comment | nl |
package ss.week6.voteMachine.gui;
import java.awt.Container;
import java.awt.FlowLayout;
import java.util.Map;
import java.util.Observable;
import java.util.Observer;
import java.util.Set;
import javax.swing.JFrame;
import javax.swing.JLabel;
import javax.swing.JTextArea;
import ss.week6.voteMachine.VoteList;
/**
* P2 prac wk3.<SUF>*/
public class ResultJFrame extends JFrame {
// Grafische componenten
private JTextArea resultField;
private JLabel messageLabel;
/** Construeert een UitslagJFrame die een gegeven uitslag observeert. */
public ResultJFrame(VoteGUIView view) {
// Initialisatie grafische componenten
super("Result");
Container cc = getContentPane();
cc.setLayout(new FlowLayout());
messageLabel = new JLabel("Votes:");
cc.add(messageLabel);
resultField = new JTextArea("", 10, 20);
resultField.setEditable(false);
cc.add(resultField);
setSize(250, 255);
}
/** Zet de uitslag op het tekstveld, met 1 regel per partij. */
public void update(Map<String,Integer> votes) {
resultField.setText("");
for(Map.Entry<String,Integer> entry: votes.entrySet()){
resultField.append(entry.getKey() + ": " + entry.getValue() + "\n");
}
}
}
|
202134_1 |
package ss.week6.voteMachine.gui;
import java.awt.Container;
import java.awt.FlowLayout;
import java.util.Map;
import java.util.Observable;
import java.util.Observer;
import java.util.Set;
import javax.swing.JFrame;
import javax.swing.JLabel;
import javax.swing.JTextArea;
import ss.week6.voteMachine.VoteList;
/**
* P2 prac wk3.
* UitslagJFrame: GUI voor een Uitslag.
* @author Arend Rensink en Theo Ruys
* @version 2005.02.15
*/
public class ResultJFrame extends JFrame {
// Grafische componenten
private JTextArea resultField;
private JLabel messageLabel;
/** Construeert een UitslagJFrame die een gegeven uitslag observeert. */
public ResultJFrame(VoteGUIView view) {
// Initialisatie grafische componenten
super("Result");
Container cc = getContentPane();
cc.setLayout(new FlowLayout());
messageLabel = new JLabel("Votes:");
cc.add(messageLabel);
resultField = new JTextArea("", 10, 20);
resultField.setEditable(false);
cc.add(resultField);
setSize(250, 255);
}
/** Zet de uitslag op het tekstveld, met 1 regel per partij. */
public void update(Map<String,Integer> votes) {
resultField.setText("");
for(Map.Entry<String,Integer> entry: votes.entrySet()){
resultField.append(entry.getKey() + ": " + entry.getValue() + "\n");
}
}
}
| Janwillemtv/ProgrammingProject | softwaresystems/src/ss/week6/voteMachine/gui/ResultJFrame.java | 408 | /** Construeert een UitslagJFrame die een gegeven uitslag observeert. */ | block_comment | nl |
package ss.week6.voteMachine.gui;
import java.awt.Container;
import java.awt.FlowLayout;
import java.util.Map;
import java.util.Observable;
import java.util.Observer;
import java.util.Set;
import javax.swing.JFrame;
import javax.swing.JLabel;
import javax.swing.JTextArea;
import ss.week6.voteMachine.VoteList;
/**
* P2 prac wk3.
* UitslagJFrame: GUI voor een Uitslag.
* @author Arend Rensink en Theo Ruys
* @version 2005.02.15
*/
public class ResultJFrame extends JFrame {
// Grafische componenten
private JTextArea resultField;
private JLabel messageLabel;
/** Construeert een UitslagJFrame<SUF>*/
public ResultJFrame(VoteGUIView view) {
// Initialisatie grafische componenten
super("Result");
Container cc = getContentPane();
cc.setLayout(new FlowLayout());
messageLabel = new JLabel("Votes:");
cc.add(messageLabel);
resultField = new JTextArea("", 10, 20);
resultField.setEditable(false);
cc.add(resultField);
setSize(250, 255);
}
/** Zet de uitslag op het tekstveld, met 1 regel per partij. */
public void update(Map<String,Integer> votes) {
resultField.setText("");
for(Map.Entry<String,Integer> entry: votes.entrySet()){
resultField.append(entry.getKey() + ": " + entry.getValue() + "\n");
}
}
}
|
202134_3 |
package ss.week6.voteMachine.gui;
import java.awt.Container;
import java.awt.FlowLayout;
import java.util.Map;
import java.util.Observable;
import java.util.Observer;
import java.util.Set;
import javax.swing.JFrame;
import javax.swing.JLabel;
import javax.swing.JTextArea;
import ss.week6.voteMachine.VoteList;
/**
* P2 prac wk3.
* UitslagJFrame: GUI voor een Uitslag.
* @author Arend Rensink en Theo Ruys
* @version 2005.02.15
*/
public class ResultJFrame extends JFrame {
// Grafische componenten
private JTextArea resultField;
private JLabel messageLabel;
/** Construeert een UitslagJFrame die een gegeven uitslag observeert. */
public ResultJFrame(VoteGUIView view) {
// Initialisatie grafische componenten
super("Result");
Container cc = getContentPane();
cc.setLayout(new FlowLayout());
messageLabel = new JLabel("Votes:");
cc.add(messageLabel);
resultField = new JTextArea("", 10, 20);
resultField.setEditable(false);
cc.add(resultField);
setSize(250, 255);
}
/** Zet de uitslag op het tekstveld, met 1 regel per partij. */
public void update(Map<String,Integer> votes) {
resultField.setText("");
for(Map.Entry<String,Integer> entry: votes.entrySet()){
resultField.append(entry.getKey() + ": " + entry.getValue() + "\n");
}
}
}
| Janwillemtv/ProgrammingProject | softwaresystems/src/ss/week6/voteMachine/gui/ResultJFrame.java | 408 | /** Zet de uitslag op het tekstveld, met 1 regel per partij. */ | block_comment | nl |
package ss.week6.voteMachine.gui;
import java.awt.Container;
import java.awt.FlowLayout;
import java.util.Map;
import java.util.Observable;
import java.util.Observer;
import java.util.Set;
import javax.swing.JFrame;
import javax.swing.JLabel;
import javax.swing.JTextArea;
import ss.week6.voteMachine.VoteList;
/**
* P2 prac wk3.
* UitslagJFrame: GUI voor een Uitslag.
* @author Arend Rensink en Theo Ruys
* @version 2005.02.15
*/
public class ResultJFrame extends JFrame {
// Grafische componenten
private JTextArea resultField;
private JLabel messageLabel;
/** Construeert een UitslagJFrame die een gegeven uitslag observeert. */
public ResultJFrame(VoteGUIView view) {
// Initialisatie grafische componenten
super("Result");
Container cc = getContentPane();
cc.setLayout(new FlowLayout());
messageLabel = new JLabel("Votes:");
cc.add(messageLabel);
resultField = new JTextArea("", 10, 20);
resultField.setEditable(false);
cc.add(resultField);
setSize(250, 255);
}
/** Zet de uitslag<SUF>*/
public void update(Map<String,Integer> votes) {
resultField.setText("");
for(Map.Entry<String,Integer> entry: votes.entrySet()){
resultField.append(entry.getKey() + ": " + entry.getValue() + "\n");
}
}
}
|
202135_0 | package ss.week6.voteMachine.gui;
import java.awt.Container;
import java.awt.FlowLayout;
import java.util.Map;
import java.util.Observable;
import java.util.Observer;
import java.util.Set;
import javax.swing.JFrame;
import javax.swing.JLabel;
import javax.swing.JTextArea;
import ss.week6.voteMachine.VoteList;
/**
* P2 prac wk3.
* UitslagJFrame: GUI voor een Uitslag.
* @author Arend Rensink en Theo Ruys
* @version 2005.02.15
*/
public class ResultJFrame extends JFrame {
// Grafische componenten
private JTextArea resultField;
private JLabel messageLabel;
/** Construeert een UitslagJFrame die een gegeven uitslag observeert. */
public ResultJFrame(VoteGUIView view) {
// Initialisatie grafische componenten
super("Result");
Container cc = getContentPane();
cc.setLayout(new FlowLayout());
messageLabel = new JLabel("Votes:");
cc.add(messageLabel);
resultField = new JTextArea("", 10, 20);
resultField.setEditable(false);
cc.add(resultField);
setSize(250, 255);
}
/** Zet de uitslag op het tekstveld, met 1 regel per partij. */
public void update(Map<String,Integer> votes) {
resultField.setText("");
for(Map.Entry<String,Integer> entry: votes.entrySet()){
resultField.append(entry.getKey() + ": " + entry.getValue() + "\n");
}
}
}
| MerijnKleinreesink/SoftwareSystemen | ExtraTest/src/ss/week6/voteMachine/gui/ResultJFrame.java | 407 | /**
* P2 prac wk3.
* UitslagJFrame: GUI voor een Uitslag.
* @author Arend Rensink en Theo Ruys
* @version 2005.02.15
*/ | block_comment | nl | package ss.week6.voteMachine.gui;
import java.awt.Container;
import java.awt.FlowLayout;
import java.util.Map;
import java.util.Observable;
import java.util.Observer;
import java.util.Set;
import javax.swing.JFrame;
import javax.swing.JLabel;
import javax.swing.JTextArea;
import ss.week6.voteMachine.VoteList;
/**
* P2 prac wk3.<SUF>*/
public class ResultJFrame extends JFrame {
// Grafische componenten
private JTextArea resultField;
private JLabel messageLabel;
/** Construeert een UitslagJFrame die een gegeven uitslag observeert. */
public ResultJFrame(VoteGUIView view) {
// Initialisatie grafische componenten
super("Result");
Container cc = getContentPane();
cc.setLayout(new FlowLayout());
messageLabel = new JLabel("Votes:");
cc.add(messageLabel);
resultField = new JTextArea("", 10, 20);
resultField.setEditable(false);
cc.add(resultField);
setSize(250, 255);
}
/** Zet de uitslag op het tekstveld, met 1 regel per partij. */
public void update(Map<String,Integer> votes) {
resultField.setText("");
for(Map.Entry<String,Integer> entry: votes.entrySet()){
resultField.append(entry.getKey() + ": " + entry.getValue() + "\n");
}
}
}
|
202135_1 | package ss.week6.voteMachine.gui;
import java.awt.Container;
import java.awt.FlowLayout;
import java.util.Map;
import java.util.Observable;
import java.util.Observer;
import java.util.Set;
import javax.swing.JFrame;
import javax.swing.JLabel;
import javax.swing.JTextArea;
import ss.week6.voteMachine.VoteList;
/**
* P2 prac wk3.
* UitslagJFrame: GUI voor een Uitslag.
* @author Arend Rensink en Theo Ruys
* @version 2005.02.15
*/
public class ResultJFrame extends JFrame {
// Grafische componenten
private JTextArea resultField;
private JLabel messageLabel;
/** Construeert een UitslagJFrame die een gegeven uitslag observeert. */
public ResultJFrame(VoteGUIView view) {
// Initialisatie grafische componenten
super("Result");
Container cc = getContentPane();
cc.setLayout(new FlowLayout());
messageLabel = new JLabel("Votes:");
cc.add(messageLabel);
resultField = new JTextArea("", 10, 20);
resultField.setEditable(false);
cc.add(resultField);
setSize(250, 255);
}
/** Zet de uitslag op het tekstveld, met 1 regel per partij. */
public void update(Map<String,Integer> votes) {
resultField.setText("");
for(Map.Entry<String,Integer> entry: votes.entrySet()){
resultField.append(entry.getKey() + ": " + entry.getValue() + "\n");
}
}
}
| MerijnKleinreesink/SoftwareSystemen | ExtraTest/src/ss/week6/voteMachine/gui/ResultJFrame.java | 407 | /** Construeert een UitslagJFrame die een gegeven uitslag observeert. */ | block_comment | nl | package ss.week6.voteMachine.gui;
import java.awt.Container;
import java.awt.FlowLayout;
import java.util.Map;
import java.util.Observable;
import java.util.Observer;
import java.util.Set;
import javax.swing.JFrame;
import javax.swing.JLabel;
import javax.swing.JTextArea;
import ss.week6.voteMachine.VoteList;
/**
* P2 prac wk3.
* UitslagJFrame: GUI voor een Uitslag.
* @author Arend Rensink en Theo Ruys
* @version 2005.02.15
*/
public class ResultJFrame extends JFrame {
// Grafische componenten
private JTextArea resultField;
private JLabel messageLabel;
/** Construeert een UitslagJFrame<SUF>*/
public ResultJFrame(VoteGUIView view) {
// Initialisatie grafische componenten
super("Result");
Container cc = getContentPane();
cc.setLayout(new FlowLayout());
messageLabel = new JLabel("Votes:");
cc.add(messageLabel);
resultField = new JTextArea("", 10, 20);
resultField.setEditable(false);
cc.add(resultField);
setSize(250, 255);
}
/** Zet de uitslag op het tekstveld, met 1 regel per partij. */
public void update(Map<String,Integer> votes) {
resultField.setText("");
for(Map.Entry<String,Integer> entry: votes.entrySet()){
resultField.append(entry.getKey() + ": " + entry.getValue() + "\n");
}
}
}
|
202135_3 | package ss.week6.voteMachine.gui;
import java.awt.Container;
import java.awt.FlowLayout;
import java.util.Map;
import java.util.Observable;
import java.util.Observer;
import java.util.Set;
import javax.swing.JFrame;
import javax.swing.JLabel;
import javax.swing.JTextArea;
import ss.week6.voteMachine.VoteList;
/**
* P2 prac wk3.
* UitslagJFrame: GUI voor een Uitslag.
* @author Arend Rensink en Theo Ruys
* @version 2005.02.15
*/
public class ResultJFrame extends JFrame {
// Grafische componenten
private JTextArea resultField;
private JLabel messageLabel;
/** Construeert een UitslagJFrame die een gegeven uitslag observeert. */
public ResultJFrame(VoteGUIView view) {
// Initialisatie grafische componenten
super("Result");
Container cc = getContentPane();
cc.setLayout(new FlowLayout());
messageLabel = new JLabel("Votes:");
cc.add(messageLabel);
resultField = new JTextArea("", 10, 20);
resultField.setEditable(false);
cc.add(resultField);
setSize(250, 255);
}
/** Zet de uitslag op het tekstveld, met 1 regel per partij. */
public void update(Map<String,Integer> votes) {
resultField.setText("");
for(Map.Entry<String,Integer> entry: votes.entrySet()){
resultField.append(entry.getKey() + ": " + entry.getValue() + "\n");
}
}
}
| MerijnKleinreesink/SoftwareSystemen | ExtraTest/src/ss/week6/voteMachine/gui/ResultJFrame.java | 407 | /** Zet de uitslag op het tekstveld, met 1 regel per partij. */ | block_comment | nl | package ss.week6.voteMachine.gui;
import java.awt.Container;
import java.awt.FlowLayout;
import java.util.Map;
import java.util.Observable;
import java.util.Observer;
import java.util.Set;
import javax.swing.JFrame;
import javax.swing.JLabel;
import javax.swing.JTextArea;
import ss.week6.voteMachine.VoteList;
/**
* P2 prac wk3.
* UitslagJFrame: GUI voor een Uitslag.
* @author Arend Rensink en Theo Ruys
* @version 2005.02.15
*/
public class ResultJFrame extends JFrame {
// Grafische componenten
private JTextArea resultField;
private JLabel messageLabel;
/** Construeert een UitslagJFrame die een gegeven uitslag observeert. */
public ResultJFrame(VoteGUIView view) {
// Initialisatie grafische componenten
super("Result");
Container cc = getContentPane();
cc.setLayout(new FlowLayout());
messageLabel = new JLabel("Votes:");
cc.add(messageLabel);
resultField = new JTextArea("", 10, 20);
resultField.setEditable(false);
cc.add(resultField);
setSize(250, 255);
}
/** Zet de uitslag<SUF>*/
public void update(Map<String,Integer> votes) {
resultField.setText("");
for(Map.Entry<String,Integer> entry: votes.entrySet()){
resultField.append(entry.getKey() + ": " + entry.getValue() + "\n");
}
}
}
|
202145_1 |
package com.auce.monitor.clock;
import java.awt.AlphaComposite;
import java.awt.Color;
import java.awt.Font;
import java.awt.GradientPaint;
import java.awt.Graphics;
import java.awt.Graphics2D;
import java.awt.GraphicsConfiguration;
import java.awt.RenderingHints;
import java.awt.Transparency;
import java.awt.geom.Rectangle2D;
import java.awt.image.BufferedImage;
import javax.swing.JComponent;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.auce.auction.entity.Lot;
import com.auce.auction.entity.Product;
import com.auce.auction.entity.Supplier;
import com.auce.auction.entity.Trader;
import com.auce.auction.event.Purchase;
import com.auce.auction.event.Run;
public class ClockFace extends JComponent implements ClockModelListener
{
private static final long serialVersionUID = -4656800951220278621L;
private static final double TWO_PI = 2.0 * Math.PI;
private static final int MAX_VALUE = 100;
private int diameter;
private int centerX;
private int centerY;
private BufferedImage image;
protected int tickSize;
protected ClockModel model;
protected Logger logger;
protected Font smallFont;
protected Font largeFont;
public ClockFace( ClockModel model )
{
this.logger = LoggerFactory.getLogger(
this.getClass().getSimpleName() + "[" + model.getClock().getId() + "]" );
this.model = model;
this.model.addClockModelListener( this );
this.tickSize = 10;
}
public ClockModel getModel ()
{
return this.model;
}
public void paintComponent ( Graphics graphics )
{
Graphics2D g2 = (Graphics2D)graphics;
g2.setRenderingHint( RenderingHints.KEY_ANTIALIASING, RenderingHints.VALUE_ANTIALIAS_ON );
int w = getWidth();
int h = getHeight();
diameter = ( ( w < h ) ? w : h );
this.tickSize = (int)( 0.02 * diameter );
centerX = diameter / 2;
centerY = diameter / 2;
if ( this.image == null || this.image.getWidth() != w || this.image.getHeight() != h )
{
int fontSize = (int)( diameter / 20.0 );
this.smallFont = new Font( "SansSerif", Font.BOLD, fontSize );
fontSize = (int)( diameter / 7.0 );
this.largeFont = new Font( "SansSerif", Font.BOLD, fontSize );
GraphicsConfiguration gc = g2.getDeviceConfiguration();
this.image = gc.createCompatibleImage( w, h, Transparency.TRANSLUCENT );
Graphics2D g = this.image.createGraphics();
g.setComposite( AlphaComposite.Clear );
g.fillRect( 0, 0, w, h );
g.setComposite( AlphaComposite.Src );
g.setRenderingHint( RenderingHints.KEY_ANTIALIASING, RenderingHints.VALUE_ANTIALIAS_ON );
g.setColor( Color.WHITE );
g.fillOval( 0, 0, diameter, diameter );
g.setComposite( AlphaComposite.SrcAtop );
Color color = Color.LIGHT_GRAY;
g.setPaint( new GradientPaint( 0, 0, color, 0, h, Color.WHITE ) );
g.fillOval( 0, 0, diameter, diameter );
int radius = diameter / 2;
for ( int i = 0; i < MAX_VALUE; i++ )
{
drawTick( g, i / (double)MAX_VALUE, radius - this.tickSize, null );
if ( i % 5 == 0 )
{
drawTick( g, i / (double)MAX_VALUE, radius - (int)( this.tickSize * 2.5 ), Color.DARK_GRAY );
}
}
if ( this.model.getRun() != null )
{
this.drawInfo( g );
}
g.dispose();
g2.drawImage( this.image, 0, 0, null );
}
else
{
g2.drawImage( this.image, null, 0, 0 );
}
this.drawValue( g2 );
}
private void drawText ( Graphics2D g2, String text, int position )
{
Rectangle2D r = this.smallFont.getStringBounds( text, g2.getFontRenderContext() );
g2.drawString( text, centerX - (int)( (double)r.getWidth() / 2.0 ), centerY + (int)( (double)r.getHeight() / 2.0 ) + (int)( position * r.getHeight() ) );
}
private void drawInfo ( Graphics2D g2 )
{
g2.setColor( Color.DARK_GRAY );
g2.setFont( this.smallFont );
Run auction = this.model.getRun();
Lot lot = auction.getLot();
if ( lot != null )
{
Supplier supplier = lot.getSupplier();
if ( supplier != null )
{
this.drawText( g2, supplier.getName(), -3 );
}
Product product = lot.getProduct();
if ( product != null )
{
StringBuilder sb = new StringBuilder();
sb.append( Integer.toString( lot.getQuantity() ) );
sb.append( " units " );
sb.append( auction.getLot().getProduct().getName() );
this.drawText( g2, sb.toString(), -4 );
}
StringBuilder sb = new StringBuilder();
sb = new StringBuilder();
sb.append( "Partij " );
sb.append( lot.getId() );
this.drawText( g2, sb.toString(), -5 );
}
Purchase purchase = this.model.getPurchase();
if ( purchase != null )
{
String traderId = "unknown";
Trader trader = purchase.getTrader();
if ( trader != null )
{
traderId = purchase.getTrader().getId();
}
this.drawText( g2, traderId, 3 );
this.drawText( g2, purchase.getQuantity() + " units", 4 );
}
// else if ( this.model.getValue() == 0 )
// {
// this.drawText( g2, "doorgedraaid", 3 );
// this.drawText( g2, auction.getUnits() + " units", 4 );
// }
}
private void drawValue ( Graphics2D g2 )
{
int value = this.model.getValue();
String text = Integer.toString( value );
g2.setColor( this.model.getColor() );
g2.setFont( this.largeFont );
Rectangle2D r = this.largeFont.getStringBounds( text, g2.getFontRenderContext() );
g2.drawString( text,
centerX - (int)( (double)r.getWidth() / 2.0 ),
centerY + (int)( (double)r.getHeight() / 4.0 ) );
int handMax = this.diameter / 2;
double percent = ( (double)value ) / (double)MAX_VALUE;
drawTick( g2, percent, handMax - this.tickSize, Color.RED );
}
private void drawTick ( Graphics2D g2, double percent, int minRadius, Color color )
{
double radians = ( 0.5 - percent ) * TWO_PI;
double sine = Math.sin( radians );
double cosine = Math.cos( radians );
int dxmin = centerX + (int)( minRadius * sine );
int dymin = centerY + (int)( minRadius * cosine );
if ( color != null )
{
g2.setColor( color );
g2.fillOval( dxmin - 5, dymin - 5, tickSize + 1, tickSize + 1 );
}
else
{
g2.setColor( Color.WHITE );
g2.fillOval( dxmin - 5, dymin - 5, tickSize + 1, tickSize + 1 );
g2.setColor( Color.BLACK );
g2.drawOval( dxmin - 5, dymin - 5, tickSize, tickSize );
}
}
public void clockValueChanged ( ClockModelEvent event )
{
Run auction = this.model.getRun();
if ( auction != null )
{
if ( this.model.getValue() == 0 )
{
this.image = null;
}
}
this.repaint();
}
public void clockAuctionChanged ( ClockModelEvent event )
{
if ( this.model.getRun() != null )
{
this.image = null;
this.repaint();
}
}
}
| mamersfo/DutchAuction | monitor/src/main/java/com/auce/monitor/clock/ClockFace.java | 2,275 | // this.drawText( g2, "doorgedraaid", 3 ); | line_comment | nl |
package com.auce.monitor.clock;
import java.awt.AlphaComposite;
import java.awt.Color;
import java.awt.Font;
import java.awt.GradientPaint;
import java.awt.Graphics;
import java.awt.Graphics2D;
import java.awt.GraphicsConfiguration;
import java.awt.RenderingHints;
import java.awt.Transparency;
import java.awt.geom.Rectangle2D;
import java.awt.image.BufferedImage;
import javax.swing.JComponent;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.auce.auction.entity.Lot;
import com.auce.auction.entity.Product;
import com.auce.auction.entity.Supplier;
import com.auce.auction.entity.Trader;
import com.auce.auction.event.Purchase;
import com.auce.auction.event.Run;
public class ClockFace extends JComponent implements ClockModelListener
{
private static final long serialVersionUID = -4656800951220278621L;
private static final double TWO_PI = 2.0 * Math.PI;
private static final int MAX_VALUE = 100;
private int diameter;
private int centerX;
private int centerY;
private BufferedImage image;
protected int tickSize;
protected ClockModel model;
protected Logger logger;
protected Font smallFont;
protected Font largeFont;
public ClockFace( ClockModel model )
{
this.logger = LoggerFactory.getLogger(
this.getClass().getSimpleName() + "[" + model.getClock().getId() + "]" );
this.model = model;
this.model.addClockModelListener( this );
this.tickSize = 10;
}
public ClockModel getModel ()
{
return this.model;
}
public void paintComponent ( Graphics graphics )
{
Graphics2D g2 = (Graphics2D)graphics;
g2.setRenderingHint( RenderingHints.KEY_ANTIALIASING, RenderingHints.VALUE_ANTIALIAS_ON );
int w = getWidth();
int h = getHeight();
diameter = ( ( w < h ) ? w : h );
this.tickSize = (int)( 0.02 * diameter );
centerX = diameter / 2;
centerY = diameter / 2;
if ( this.image == null || this.image.getWidth() != w || this.image.getHeight() != h )
{
int fontSize = (int)( diameter / 20.0 );
this.smallFont = new Font( "SansSerif", Font.BOLD, fontSize );
fontSize = (int)( diameter / 7.0 );
this.largeFont = new Font( "SansSerif", Font.BOLD, fontSize );
GraphicsConfiguration gc = g2.getDeviceConfiguration();
this.image = gc.createCompatibleImage( w, h, Transparency.TRANSLUCENT );
Graphics2D g = this.image.createGraphics();
g.setComposite( AlphaComposite.Clear );
g.fillRect( 0, 0, w, h );
g.setComposite( AlphaComposite.Src );
g.setRenderingHint( RenderingHints.KEY_ANTIALIASING, RenderingHints.VALUE_ANTIALIAS_ON );
g.setColor( Color.WHITE );
g.fillOval( 0, 0, diameter, diameter );
g.setComposite( AlphaComposite.SrcAtop );
Color color = Color.LIGHT_GRAY;
g.setPaint( new GradientPaint( 0, 0, color, 0, h, Color.WHITE ) );
g.fillOval( 0, 0, diameter, diameter );
int radius = diameter / 2;
for ( int i = 0; i < MAX_VALUE; i++ )
{
drawTick( g, i / (double)MAX_VALUE, radius - this.tickSize, null );
if ( i % 5 == 0 )
{
drawTick( g, i / (double)MAX_VALUE, radius - (int)( this.tickSize * 2.5 ), Color.DARK_GRAY );
}
}
if ( this.model.getRun() != null )
{
this.drawInfo( g );
}
g.dispose();
g2.drawImage( this.image, 0, 0, null );
}
else
{
g2.drawImage( this.image, null, 0, 0 );
}
this.drawValue( g2 );
}
private void drawText ( Graphics2D g2, String text, int position )
{
Rectangle2D r = this.smallFont.getStringBounds( text, g2.getFontRenderContext() );
g2.drawString( text, centerX - (int)( (double)r.getWidth() / 2.0 ), centerY + (int)( (double)r.getHeight() / 2.0 ) + (int)( position * r.getHeight() ) );
}
private void drawInfo ( Graphics2D g2 )
{
g2.setColor( Color.DARK_GRAY );
g2.setFont( this.smallFont );
Run auction = this.model.getRun();
Lot lot = auction.getLot();
if ( lot != null )
{
Supplier supplier = lot.getSupplier();
if ( supplier != null )
{
this.drawText( g2, supplier.getName(), -3 );
}
Product product = lot.getProduct();
if ( product != null )
{
StringBuilder sb = new StringBuilder();
sb.append( Integer.toString( lot.getQuantity() ) );
sb.append( " units " );
sb.append( auction.getLot().getProduct().getName() );
this.drawText( g2, sb.toString(), -4 );
}
StringBuilder sb = new StringBuilder();
sb = new StringBuilder();
sb.append( "Partij " );
sb.append( lot.getId() );
this.drawText( g2, sb.toString(), -5 );
}
Purchase purchase = this.model.getPurchase();
if ( purchase != null )
{
String traderId = "unknown";
Trader trader = purchase.getTrader();
if ( trader != null )
{
traderId = purchase.getTrader().getId();
}
this.drawText( g2, traderId, 3 );
this.drawText( g2, purchase.getQuantity() + " units", 4 );
}
// else if ( this.model.getValue() == 0 )
// {
// this.drawText( g2,<SUF>
// this.drawText( g2, auction.getUnits() + " units", 4 );
// }
}
private void drawValue ( Graphics2D g2 )
{
int value = this.model.getValue();
String text = Integer.toString( value );
g2.setColor( this.model.getColor() );
g2.setFont( this.largeFont );
Rectangle2D r = this.largeFont.getStringBounds( text, g2.getFontRenderContext() );
g2.drawString( text,
centerX - (int)( (double)r.getWidth() / 2.0 ),
centerY + (int)( (double)r.getHeight() / 4.0 ) );
int handMax = this.diameter / 2;
double percent = ( (double)value ) / (double)MAX_VALUE;
drawTick( g2, percent, handMax - this.tickSize, Color.RED );
}
private void drawTick ( Graphics2D g2, double percent, int minRadius, Color color )
{
double radians = ( 0.5 - percent ) * TWO_PI;
double sine = Math.sin( radians );
double cosine = Math.cos( radians );
int dxmin = centerX + (int)( minRadius * sine );
int dymin = centerY + (int)( minRadius * cosine );
if ( color != null )
{
g2.setColor( color );
g2.fillOval( dxmin - 5, dymin - 5, tickSize + 1, tickSize + 1 );
}
else
{
g2.setColor( Color.WHITE );
g2.fillOval( dxmin - 5, dymin - 5, tickSize + 1, tickSize + 1 );
g2.setColor( Color.BLACK );
g2.drawOval( dxmin - 5, dymin - 5, tickSize, tickSize );
}
}
public void clockValueChanged ( ClockModelEvent event )
{
Run auction = this.model.getRun();
if ( auction != null )
{
if ( this.model.getValue() == 0 )
{
this.image = null;
}
}
this.repaint();
}
public void clockAuctionChanged ( ClockModelEvent event )
{
if ( this.model.getRun() != null )
{
this.image = null;
this.repaint();
}
}
}
|
202148_1 | /**
* 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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.beheer.webapp.validatie;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.Partij;
import org.springframework.stereotype.Component;
import org.springframework.validation.Errors;
/**
* Partij business regels.
*/
@Component
public final class PartijValidator extends GenericValidator<Partij> {
private static final String VELD_NAAM = "naam";
/**
* Default constructor.
*/
public PartijValidator() {
super(Partij.class);
}
/**
* Valideer de partij business regels.
* @param target de te valideren partij
* @param errors het errors object om errors in te registreren
*/
@Override
public void validate(final Object target, final Errors errors) {
final Partij partij = (Partij) target;
ValidatieUtils.valideerVerplichtVeld(errors, partij.getNaam(), VELD_NAAM);
super.validate(target, errors);
}
}
| DDDNL/OperatieBRP | Broncode/operatiebrp-code-145.3/brp/beheer/beheer-api/src/main/java/nl/bzk/brp/beheer/webapp/validatie/PartijValidator.java | 345 | /**
* Partij business regels.
*/ | 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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.beheer.webapp.validatie;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.Partij;
import org.springframework.stereotype.Component;
import org.springframework.validation.Errors;
/**
* Partij business regels.<SUF>*/
@Component
public final class PartijValidator extends GenericValidator<Partij> {
private static final String VELD_NAAM = "naam";
/**
* Default constructor.
*/
public PartijValidator() {
super(Partij.class);
}
/**
* Valideer de partij business regels.
* @param target de te valideren partij
* @param errors het errors object om errors in te registreren
*/
@Override
public void validate(final Object target, final Errors errors) {
final Partij partij = (Partij) target;
ValidatieUtils.valideerVerplichtVeld(errors, partij.getNaam(), VELD_NAAM);
super.validate(target, errors);
}
}
|
202148_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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.beheer.webapp.validatie;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.Partij;
import org.springframework.stereotype.Component;
import org.springframework.validation.Errors;
/**
* Partij business regels.
*/
@Component
public final class PartijValidator extends GenericValidator<Partij> {
private static final String VELD_NAAM = "naam";
/**
* Default constructor.
*/
public PartijValidator() {
super(Partij.class);
}
/**
* Valideer de partij business regels.
* @param target de te valideren partij
* @param errors het errors object om errors in te registreren
*/
@Override
public void validate(final Object target, final Errors errors) {
final Partij partij = (Partij) target;
ValidatieUtils.valideerVerplichtVeld(errors, partij.getNaam(), VELD_NAAM);
super.validate(target, errors);
}
}
| DDDNL/OperatieBRP | Broncode/operatiebrp-code-145.3/brp/beheer/beheer-api/src/main/java/nl/bzk/brp/beheer/webapp/validatie/PartijValidator.java | 345 | /**
* Valideer de partij business regels.
* @param target de te valideren partij
* @param errors het errors object om errors in te registreren
*/ | 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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.brp.beheer.webapp.validatie;
import nl.bzk.algemeenbrp.dal.domein.brp.entity.Partij;
import org.springframework.stereotype.Component;
import org.springframework.validation.Errors;
/**
* Partij business regels.
*/
@Component
public final class PartijValidator extends GenericValidator<Partij> {
private static final String VELD_NAAM = "naam";
/**
* Default constructor.
*/
public PartijValidator() {
super(Partij.class);
}
/**
* Valideer de partij<SUF>*/
@Override
public void validate(final Object target, final Errors errors) {
final Partij partij = (Partij) target;
ValidatieUtils.valideerVerplichtVeld(errors, partij.getNaam(), VELD_NAAM);
super.validate(target, errors);
}
}
|
202154_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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import javax.persistence.Cacheable;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.NamedQuery;
/**
* The persistent class for the srtpartij database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "srtpartij", schema = "kern")
@Cacheable
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
@NamedQuery(name = "SoortPartij" + Constanten.ZOEK_ALLES_VOOR_CACHE, query = "from SoortPartij")
public class SoortPartij extends AbstractEntiteit implements Serializable, DynamischeStamtabelMetGeldigheid {
private static final long serialVersionUID = 1L;
@Id
@SequenceGenerator(name = "srtpartij_id_generator", sequenceName = "kern.seq_srtpartij", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "srtpartij_id_generator")
@Column(updatable = false, nullable = false)
private Short id;
@Column(nullable = false, length = 80, unique = true)
private String naam;
@Column(name = "dataanvgel")
private Integer datumAanvangGeldigheid;
@Column(name = "dateindegel")
private Integer datumEindeGeldigheid;
/**
* JPA no-args constructor.
*/
protected SoortPartij() {}
/**
* Maak een nieuwe soort partij.
*
* @param naam naam
*/
public SoortPartij(final String naam) {
setNaam(naam);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Short getId() {
return id;
}
/**
* Zet de waarden voor id van SoortPartij.
*
* @param id de nieuwe waarde voor id van SoortPartij
*/
public void setId(final Short id) {
this.id = id;
}
/**
* Geef de waarde van naam van SoortPartij.
*
* @return de waarde van naam van SoortPartij
*/
public String getNaam() {
return naam;
}
/**
* Zet de waarden voor naam van SoortPartij.
*
* @param naam de nieuwe waarde voor naam van SoortPartij
*/
public void setNaam(final String naam) {
ValidationUtils.controleerOpNullWaarden("naam mag niet null zijn", naam);
ValidationUtils.controleerOpLegeWaarden("naam mag geen lege string zijn", naam);
this.naam = naam;
}
/**
* Geef de waarde van datum aanvang geldigheid van SoortPartij.
*
* @return de waarde van datum aanvang geldigheid van SoortPartij
*/
@Override
public Integer getDatumAanvangGeldigheid() {
return datumAanvangGeldigheid;
}
/**
* Zet de waarden voor datum aanvang geldigheid van SoortPartij.
*
* @param datumAanvangGeldigheid de nieuwe waarde voor datum aanvang geldigheid van SoortPartij
*/
public void setDatumAanvangGeldigheid(final Integer datumAanvangGeldigheid) {
this.datumAanvangGeldigheid = datumAanvangGeldigheid;
}
/**
* Geef de waarde van datum einde geldigheid van SoortPartij.
*
* @return de waarde van datum einde geldigheid van SoortPartij
*/
@Override
public Integer getDatumEindeGeldigheid() {
return datumEindeGeldigheid;
}
/**
* Zet de waarden voor datum einde geldigheid van SoortPartij.
*
* @param datumEindeGeldigheid de nieuwe waarde voor datum einde geldigheid van SoortPartij
*/
public void setDatumEindeGeldigheid(final Integer datumEindeGeldigheid) {
this.datumEindeGeldigheid = datumEindeGeldigheid;
}
}
| DDDNL/OperatieBRP | Broncode/operatiebrp-code-145.3/algemeen/alg-dal-entiteiten/src/main/java/nl/bzk/algemeenbrp/dal/domein/brp/entity/SoortPartij.java | 1,231 | /**
* Maak een nieuwe soort partij.
*
* @param naam naam
*/ | 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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import javax.persistence.Cacheable;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.NamedQuery;
/**
* The persistent class for the srtpartij database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "srtpartij", schema = "kern")
@Cacheable
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
@NamedQuery(name = "SoortPartij" + Constanten.ZOEK_ALLES_VOOR_CACHE, query = "from SoortPartij")
public class SoortPartij extends AbstractEntiteit implements Serializable, DynamischeStamtabelMetGeldigheid {
private static final long serialVersionUID = 1L;
@Id
@SequenceGenerator(name = "srtpartij_id_generator", sequenceName = "kern.seq_srtpartij", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "srtpartij_id_generator")
@Column(updatable = false, nullable = false)
private Short id;
@Column(nullable = false, length = 80, unique = true)
private String naam;
@Column(name = "dataanvgel")
private Integer datumAanvangGeldigheid;
@Column(name = "dateindegel")
private Integer datumEindeGeldigheid;
/**
* JPA no-args constructor.
*/
protected SoortPartij() {}
/**
* Maak een nieuwe<SUF>*/
public SoortPartij(final String naam) {
setNaam(naam);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Short getId() {
return id;
}
/**
* Zet de waarden voor id van SoortPartij.
*
* @param id de nieuwe waarde voor id van SoortPartij
*/
public void setId(final Short id) {
this.id = id;
}
/**
* Geef de waarde van naam van SoortPartij.
*
* @return de waarde van naam van SoortPartij
*/
public String getNaam() {
return naam;
}
/**
* Zet de waarden voor naam van SoortPartij.
*
* @param naam de nieuwe waarde voor naam van SoortPartij
*/
public void setNaam(final String naam) {
ValidationUtils.controleerOpNullWaarden("naam mag niet null zijn", naam);
ValidationUtils.controleerOpLegeWaarden("naam mag geen lege string zijn", naam);
this.naam = naam;
}
/**
* Geef de waarde van datum aanvang geldigheid van SoortPartij.
*
* @return de waarde van datum aanvang geldigheid van SoortPartij
*/
@Override
public Integer getDatumAanvangGeldigheid() {
return datumAanvangGeldigheid;
}
/**
* Zet de waarden voor datum aanvang geldigheid van SoortPartij.
*
* @param datumAanvangGeldigheid de nieuwe waarde voor datum aanvang geldigheid van SoortPartij
*/
public void setDatumAanvangGeldigheid(final Integer datumAanvangGeldigheid) {
this.datumAanvangGeldigheid = datumAanvangGeldigheid;
}
/**
* Geef de waarde van datum einde geldigheid van SoortPartij.
*
* @return de waarde van datum einde geldigheid van SoortPartij
*/
@Override
public Integer getDatumEindeGeldigheid() {
return datumEindeGeldigheid;
}
/**
* Zet de waarden voor datum einde geldigheid van SoortPartij.
*
* @param datumEindeGeldigheid de nieuwe waarde voor datum einde geldigheid van SoortPartij
*/
public void setDatumEindeGeldigheid(final Integer datumEindeGeldigheid) {
this.datumEindeGeldigheid = datumEindeGeldigheid;
}
}
|
202154_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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import javax.persistence.Cacheable;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.NamedQuery;
/**
* The persistent class for the srtpartij database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "srtpartij", schema = "kern")
@Cacheable
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
@NamedQuery(name = "SoortPartij" + Constanten.ZOEK_ALLES_VOOR_CACHE, query = "from SoortPartij")
public class SoortPartij extends AbstractEntiteit implements Serializable, DynamischeStamtabelMetGeldigheid {
private static final long serialVersionUID = 1L;
@Id
@SequenceGenerator(name = "srtpartij_id_generator", sequenceName = "kern.seq_srtpartij", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "srtpartij_id_generator")
@Column(updatable = false, nullable = false)
private Short id;
@Column(nullable = false, length = 80, unique = true)
private String naam;
@Column(name = "dataanvgel")
private Integer datumAanvangGeldigheid;
@Column(name = "dateindegel")
private Integer datumEindeGeldigheid;
/**
* JPA no-args constructor.
*/
protected SoortPartij() {}
/**
* Maak een nieuwe soort partij.
*
* @param naam naam
*/
public SoortPartij(final String naam) {
setNaam(naam);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Short getId() {
return id;
}
/**
* Zet de waarden voor id van SoortPartij.
*
* @param id de nieuwe waarde voor id van SoortPartij
*/
public void setId(final Short id) {
this.id = id;
}
/**
* Geef de waarde van naam van SoortPartij.
*
* @return de waarde van naam van SoortPartij
*/
public String getNaam() {
return naam;
}
/**
* Zet de waarden voor naam van SoortPartij.
*
* @param naam de nieuwe waarde voor naam van SoortPartij
*/
public void setNaam(final String naam) {
ValidationUtils.controleerOpNullWaarden("naam mag niet null zijn", naam);
ValidationUtils.controleerOpLegeWaarden("naam mag geen lege string zijn", naam);
this.naam = naam;
}
/**
* Geef de waarde van datum aanvang geldigheid van SoortPartij.
*
* @return de waarde van datum aanvang geldigheid van SoortPartij
*/
@Override
public Integer getDatumAanvangGeldigheid() {
return datumAanvangGeldigheid;
}
/**
* Zet de waarden voor datum aanvang geldigheid van SoortPartij.
*
* @param datumAanvangGeldigheid de nieuwe waarde voor datum aanvang geldigheid van SoortPartij
*/
public void setDatumAanvangGeldigheid(final Integer datumAanvangGeldigheid) {
this.datumAanvangGeldigheid = datumAanvangGeldigheid;
}
/**
* Geef de waarde van datum einde geldigheid van SoortPartij.
*
* @return de waarde van datum einde geldigheid van SoortPartij
*/
@Override
public Integer getDatumEindeGeldigheid() {
return datumEindeGeldigheid;
}
/**
* Zet de waarden voor datum einde geldigheid van SoortPartij.
*
* @param datumEindeGeldigheid de nieuwe waarde voor datum einde geldigheid van SoortPartij
*/
public void setDatumEindeGeldigheid(final Integer datumEindeGeldigheid) {
this.datumEindeGeldigheid = datumEindeGeldigheid;
}
}
| DDDNL/OperatieBRP | Broncode/operatiebrp-code-145.3/algemeen/alg-dal-entiteiten/src/main/java/nl/bzk/algemeenbrp/dal/domein/brp/entity/SoortPartij.java | 1,231 | /*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/ | 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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import javax.persistence.Cacheable;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.NamedQuery;
/**
* The persistent class for the srtpartij database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "srtpartij", schema = "kern")
@Cacheable
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
@NamedQuery(name = "SoortPartij" + Constanten.ZOEK_ALLES_VOOR_CACHE, query = "from SoortPartij")
public class SoortPartij extends AbstractEntiteit implements Serializable, DynamischeStamtabelMetGeldigheid {
private static final long serialVersionUID = 1L;
@Id
@SequenceGenerator(name = "srtpartij_id_generator", sequenceName = "kern.seq_srtpartij", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "srtpartij_id_generator")
@Column(updatable = false, nullable = false)
private Short id;
@Column(nullable = false, length = 80, unique = true)
private String naam;
@Column(name = "dataanvgel")
private Integer datumAanvangGeldigheid;
@Column(name = "dateindegel")
private Integer datumEindeGeldigheid;
/**
* JPA no-args constructor.
*/
protected SoortPartij() {}
/**
* Maak een nieuwe soort partij.
*
* @param naam naam
*/
public SoortPartij(final String naam) {
setNaam(naam);
}
/*
* (non-Javadoc)
<SUF>*/
@Override
public Short getId() {
return id;
}
/**
* Zet de waarden voor id van SoortPartij.
*
* @param id de nieuwe waarde voor id van SoortPartij
*/
public void setId(final Short id) {
this.id = id;
}
/**
* Geef de waarde van naam van SoortPartij.
*
* @return de waarde van naam van SoortPartij
*/
public String getNaam() {
return naam;
}
/**
* Zet de waarden voor naam van SoortPartij.
*
* @param naam de nieuwe waarde voor naam van SoortPartij
*/
public void setNaam(final String naam) {
ValidationUtils.controleerOpNullWaarden("naam mag niet null zijn", naam);
ValidationUtils.controleerOpLegeWaarden("naam mag geen lege string zijn", naam);
this.naam = naam;
}
/**
* Geef de waarde van datum aanvang geldigheid van SoortPartij.
*
* @return de waarde van datum aanvang geldigheid van SoortPartij
*/
@Override
public Integer getDatumAanvangGeldigheid() {
return datumAanvangGeldigheid;
}
/**
* Zet de waarden voor datum aanvang geldigheid van SoortPartij.
*
* @param datumAanvangGeldigheid de nieuwe waarde voor datum aanvang geldigheid van SoortPartij
*/
public void setDatumAanvangGeldigheid(final Integer datumAanvangGeldigheid) {
this.datumAanvangGeldigheid = datumAanvangGeldigheid;
}
/**
* Geef de waarde van datum einde geldigheid van SoortPartij.
*
* @return de waarde van datum einde geldigheid van SoortPartij
*/
@Override
public Integer getDatumEindeGeldigheid() {
return datumEindeGeldigheid;
}
/**
* Zet de waarden voor datum einde geldigheid van SoortPartij.
*
* @param datumEindeGeldigheid de nieuwe waarde voor datum einde geldigheid van SoortPartij
*/
public void setDatumEindeGeldigheid(final Integer datumEindeGeldigheid) {
this.datumEindeGeldigheid = datumEindeGeldigheid;
}
}
|
202154_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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import javax.persistence.Cacheable;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.NamedQuery;
/**
* The persistent class for the srtpartij database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "srtpartij", schema = "kern")
@Cacheable
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
@NamedQuery(name = "SoortPartij" + Constanten.ZOEK_ALLES_VOOR_CACHE, query = "from SoortPartij")
public class SoortPartij extends AbstractEntiteit implements Serializable, DynamischeStamtabelMetGeldigheid {
private static final long serialVersionUID = 1L;
@Id
@SequenceGenerator(name = "srtpartij_id_generator", sequenceName = "kern.seq_srtpartij", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "srtpartij_id_generator")
@Column(updatable = false, nullable = false)
private Short id;
@Column(nullable = false, length = 80, unique = true)
private String naam;
@Column(name = "dataanvgel")
private Integer datumAanvangGeldigheid;
@Column(name = "dateindegel")
private Integer datumEindeGeldigheid;
/**
* JPA no-args constructor.
*/
protected SoortPartij() {}
/**
* Maak een nieuwe soort partij.
*
* @param naam naam
*/
public SoortPartij(final String naam) {
setNaam(naam);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Short getId() {
return id;
}
/**
* Zet de waarden voor id van SoortPartij.
*
* @param id de nieuwe waarde voor id van SoortPartij
*/
public void setId(final Short id) {
this.id = id;
}
/**
* Geef de waarde van naam van SoortPartij.
*
* @return de waarde van naam van SoortPartij
*/
public String getNaam() {
return naam;
}
/**
* Zet de waarden voor naam van SoortPartij.
*
* @param naam de nieuwe waarde voor naam van SoortPartij
*/
public void setNaam(final String naam) {
ValidationUtils.controleerOpNullWaarden("naam mag niet null zijn", naam);
ValidationUtils.controleerOpLegeWaarden("naam mag geen lege string zijn", naam);
this.naam = naam;
}
/**
* Geef de waarde van datum aanvang geldigheid van SoortPartij.
*
* @return de waarde van datum aanvang geldigheid van SoortPartij
*/
@Override
public Integer getDatumAanvangGeldigheid() {
return datumAanvangGeldigheid;
}
/**
* Zet de waarden voor datum aanvang geldigheid van SoortPartij.
*
* @param datumAanvangGeldigheid de nieuwe waarde voor datum aanvang geldigheid van SoortPartij
*/
public void setDatumAanvangGeldigheid(final Integer datumAanvangGeldigheid) {
this.datumAanvangGeldigheid = datumAanvangGeldigheid;
}
/**
* Geef de waarde van datum einde geldigheid van SoortPartij.
*
* @return de waarde van datum einde geldigheid van SoortPartij
*/
@Override
public Integer getDatumEindeGeldigheid() {
return datumEindeGeldigheid;
}
/**
* Zet de waarden voor datum einde geldigheid van SoortPartij.
*
* @param datumEindeGeldigheid de nieuwe waarde voor datum einde geldigheid van SoortPartij
*/
public void setDatumEindeGeldigheid(final Integer datumEindeGeldigheid) {
this.datumEindeGeldigheid = datumEindeGeldigheid;
}
}
| DDDNL/OperatieBRP | Broncode/operatiebrp-code-145.3/algemeen/alg-dal-entiteiten/src/main/java/nl/bzk/algemeenbrp/dal/domein/brp/entity/SoortPartij.java | 1,231 | /**
* Zet de waarden voor id van SoortPartij.
*
* @param id de nieuwe waarde voor id van SoortPartij
*/ | 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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import javax.persistence.Cacheable;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.NamedQuery;
/**
* The persistent class for the srtpartij database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "srtpartij", schema = "kern")
@Cacheable
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
@NamedQuery(name = "SoortPartij" + Constanten.ZOEK_ALLES_VOOR_CACHE, query = "from SoortPartij")
public class SoortPartij extends AbstractEntiteit implements Serializable, DynamischeStamtabelMetGeldigheid {
private static final long serialVersionUID = 1L;
@Id
@SequenceGenerator(name = "srtpartij_id_generator", sequenceName = "kern.seq_srtpartij", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "srtpartij_id_generator")
@Column(updatable = false, nullable = false)
private Short id;
@Column(nullable = false, length = 80, unique = true)
private String naam;
@Column(name = "dataanvgel")
private Integer datumAanvangGeldigheid;
@Column(name = "dateindegel")
private Integer datumEindeGeldigheid;
/**
* JPA no-args constructor.
*/
protected SoortPartij() {}
/**
* Maak een nieuwe soort partij.
*
* @param naam naam
*/
public SoortPartij(final String naam) {
setNaam(naam);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Short getId() {
return id;
}
/**
* Zet de waarden<SUF>*/
public void setId(final Short id) {
this.id = id;
}
/**
* Geef de waarde van naam van SoortPartij.
*
* @return de waarde van naam van SoortPartij
*/
public String getNaam() {
return naam;
}
/**
* Zet de waarden voor naam van SoortPartij.
*
* @param naam de nieuwe waarde voor naam van SoortPartij
*/
public void setNaam(final String naam) {
ValidationUtils.controleerOpNullWaarden("naam mag niet null zijn", naam);
ValidationUtils.controleerOpLegeWaarden("naam mag geen lege string zijn", naam);
this.naam = naam;
}
/**
* Geef de waarde van datum aanvang geldigheid van SoortPartij.
*
* @return de waarde van datum aanvang geldigheid van SoortPartij
*/
@Override
public Integer getDatumAanvangGeldigheid() {
return datumAanvangGeldigheid;
}
/**
* Zet de waarden voor datum aanvang geldigheid van SoortPartij.
*
* @param datumAanvangGeldigheid de nieuwe waarde voor datum aanvang geldigheid van SoortPartij
*/
public void setDatumAanvangGeldigheid(final Integer datumAanvangGeldigheid) {
this.datumAanvangGeldigheid = datumAanvangGeldigheid;
}
/**
* Geef de waarde van datum einde geldigheid van SoortPartij.
*
* @return de waarde van datum einde geldigheid van SoortPartij
*/
@Override
public Integer getDatumEindeGeldigheid() {
return datumEindeGeldigheid;
}
/**
* Zet de waarden voor datum einde geldigheid van SoortPartij.
*
* @param datumEindeGeldigheid de nieuwe waarde voor datum einde geldigheid van SoortPartij
*/
public void setDatumEindeGeldigheid(final Integer datumEindeGeldigheid) {
this.datumEindeGeldigheid = datumEindeGeldigheid;
}
}
|
202154_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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import javax.persistence.Cacheable;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.NamedQuery;
/**
* The persistent class for the srtpartij database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "srtpartij", schema = "kern")
@Cacheable
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
@NamedQuery(name = "SoortPartij" + Constanten.ZOEK_ALLES_VOOR_CACHE, query = "from SoortPartij")
public class SoortPartij extends AbstractEntiteit implements Serializable, DynamischeStamtabelMetGeldigheid {
private static final long serialVersionUID = 1L;
@Id
@SequenceGenerator(name = "srtpartij_id_generator", sequenceName = "kern.seq_srtpartij", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "srtpartij_id_generator")
@Column(updatable = false, nullable = false)
private Short id;
@Column(nullable = false, length = 80, unique = true)
private String naam;
@Column(name = "dataanvgel")
private Integer datumAanvangGeldigheid;
@Column(name = "dateindegel")
private Integer datumEindeGeldigheid;
/**
* JPA no-args constructor.
*/
protected SoortPartij() {}
/**
* Maak een nieuwe soort partij.
*
* @param naam naam
*/
public SoortPartij(final String naam) {
setNaam(naam);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Short getId() {
return id;
}
/**
* Zet de waarden voor id van SoortPartij.
*
* @param id de nieuwe waarde voor id van SoortPartij
*/
public void setId(final Short id) {
this.id = id;
}
/**
* Geef de waarde van naam van SoortPartij.
*
* @return de waarde van naam van SoortPartij
*/
public String getNaam() {
return naam;
}
/**
* Zet de waarden voor naam van SoortPartij.
*
* @param naam de nieuwe waarde voor naam van SoortPartij
*/
public void setNaam(final String naam) {
ValidationUtils.controleerOpNullWaarden("naam mag niet null zijn", naam);
ValidationUtils.controleerOpLegeWaarden("naam mag geen lege string zijn", naam);
this.naam = naam;
}
/**
* Geef de waarde van datum aanvang geldigheid van SoortPartij.
*
* @return de waarde van datum aanvang geldigheid van SoortPartij
*/
@Override
public Integer getDatumAanvangGeldigheid() {
return datumAanvangGeldigheid;
}
/**
* Zet de waarden voor datum aanvang geldigheid van SoortPartij.
*
* @param datumAanvangGeldigheid de nieuwe waarde voor datum aanvang geldigheid van SoortPartij
*/
public void setDatumAanvangGeldigheid(final Integer datumAanvangGeldigheid) {
this.datumAanvangGeldigheid = datumAanvangGeldigheid;
}
/**
* Geef de waarde van datum einde geldigheid van SoortPartij.
*
* @return de waarde van datum einde geldigheid van SoortPartij
*/
@Override
public Integer getDatumEindeGeldigheid() {
return datumEindeGeldigheid;
}
/**
* Zet de waarden voor datum einde geldigheid van SoortPartij.
*
* @param datumEindeGeldigheid de nieuwe waarde voor datum einde geldigheid van SoortPartij
*/
public void setDatumEindeGeldigheid(final Integer datumEindeGeldigheid) {
this.datumEindeGeldigheid = datumEindeGeldigheid;
}
}
| DDDNL/OperatieBRP | Broncode/operatiebrp-code-145.3/algemeen/alg-dal-entiteiten/src/main/java/nl/bzk/algemeenbrp/dal/domein/brp/entity/SoortPartij.java | 1,231 | /**
* Geef de waarde van naam van SoortPartij.
*
* @return de waarde van naam van SoortPartij
*/ | 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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import javax.persistence.Cacheable;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.NamedQuery;
/**
* The persistent class for the srtpartij database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "srtpartij", schema = "kern")
@Cacheable
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
@NamedQuery(name = "SoortPartij" + Constanten.ZOEK_ALLES_VOOR_CACHE, query = "from SoortPartij")
public class SoortPartij extends AbstractEntiteit implements Serializable, DynamischeStamtabelMetGeldigheid {
private static final long serialVersionUID = 1L;
@Id
@SequenceGenerator(name = "srtpartij_id_generator", sequenceName = "kern.seq_srtpartij", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "srtpartij_id_generator")
@Column(updatable = false, nullable = false)
private Short id;
@Column(nullable = false, length = 80, unique = true)
private String naam;
@Column(name = "dataanvgel")
private Integer datumAanvangGeldigheid;
@Column(name = "dateindegel")
private Integer datumEindeGeldigheid;
/**
* JPA no-args constructor.
*/
protected SoortPartij() {}
/**
* Maak een nieuwe soort partij.
*
* @param naam naam
*/
public SoortPartij(final String naam) {
setNaam(naam);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Short getId() {
return id;
}
/**
* Zet de waarden voor id van SoortPartij.
*
* @param id de nieuwe waarde voor id van SoortPartij
*/
public void setId(final Short id) {
this.id = id;
}
/**
* Geef de waarde<SUF>*/
public String getNaam() {
return naam;
}
/**
* Zet de waarden voor naam van SoortPartij.
*
* @param naam de nieuwe waarde voor naam van SoortPartij
*/
public void setNaam(final String naam) {
ValidationUtils.controleerOpNullWaarden("naam mag niet null zijn", naam);
ValidationUtils.controleerOpLegeWaarden("naam mag geen lege string zijn", naam);
this.naam = naam;
}
/**
* Geef de waarde van datum aanvang geldigheid van SoortPartij.
*
* @return de waarde van datum aanvang geldigheid van SoortPartij
*/
@Override
public Integer getDatumAanvangGeldigheid() {
return datumAanvangGeldigheid;
}
/**
* Zet de waarden voor datum aanvang geldigheid van SoortPartij.
*
* @param datumAanvangGeldigheid de nieuwe waarde voor datum aanvang geldigheid van SoortPartij
*/
public void setDatumAanvangGeldigheid(final Integer datumAanvangGeldigheid) {
this.datumAanvangGeldigheid = datumAanvangGeldigheid;
}
/**
* Geef de waarde van datum einde geldigheid van SoortPartij.
*
* @return de waarde van datum einde geldigheid van SoortPartij
*/
@Override
public Integer getDatumEindeGeldigheid() {
return datumEindeGeldigheid;
}
/**
* Zet de waarden voor datum einde geldigheid van SoortPartij.
*
* @param datumEindeGeldigheid de nieuwe waarde voor datum einde geldigheid van SoortPartij
*/
public void setDatumEindeGeldigheid(final Integer datumEindeGeldigheid) {
this.datumEindeGeldigheid = datumEindeGeldigheid;
}
}
|
202154_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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import javax.persistence.Cacheable;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.NamedQuery;
/**
* The persistent class for the srtpartij database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "srtpartij", schema = "kern")
@Cacheable
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
@NamedQuery(name = "SoortPartij" + Constanten.ZOEK_ALLES_VOOR_CACHE, query = "from SoortPartij")
public class SoortPartij extends AbstractEntiteit implements Serializable, DynamischeStamtabelMetGeldigheid {
private static final long serialVersionUID = 1L;
@Id
@SequenceGenerator(name = "srtpartij_id_generator", sequenceName = "kern.seq_srtpartij", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "srtpartij_id_generator")
@Column(updatable = false, nullable = false)
private Short id;
@Column(nullable = false, length = 80, unique = true)
private String naam;
@Column(name = "dataanvgel")
private Integer datumAanvangGeldigheid;
@Column(name = "dateindegel")
private Integer datumEindeGeldigheid;
/**
* JPA no-args constructor.
*/
protected SoortPartij() {}
/**
* Maak een nieuwe soort partij.
*
* @param naam naam
*/
public SoortPartij(final String naam) {
setNaam(naam);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Short getId() {
return id;
}
/**
* Zet de waarden voor id van SoortPartij.
*
* @param id de nieuwe waarde voor id van SoortPartij
*/
public void setId(final Short id) {
this.id = id;
}
/**
* Geef de waarde van naam van SoortPartij.
*
* @return de waarde van naam van SoortPartij
*/
public String getNaam() {
return naam;
}
/**
* Zet de waarden voor naam van SoortPartij.
*
* @param naam de nieuwe waarde voor naam van SoortPartij
*/
public void setNaam(final String naam) {
ValidationUtils.controleerOpNullWaarden("naam mag niet null zijn", naam);
ValidationUtils.controleerOpLegeWaarden("naam mag geen lege string zijn", naam);
this.naam = naam;
}
/**
* Geef de waarde van datum aanvang geldigheid van SoortPartij.
*
* @return de waarde van datum aanvang geldigheid van SoortPartij
*/
@Override
public Integer getDatumAanvangGeldigheid() {
return datumAanvangGeldigheid;
}
/**
* Zet de waarden voor datum aanvang geldigheid van SoortPartij.
*
* @param datumAanvangGeldigheid de nieuwe waarde voor datum aanvang geldigheid van SoortPartij
*/
public void setDatumAanvangGeldigheid(final Integer datumAanvangGeldigheid) {
this.datumAanvangGeldigheid = datumAanvangGeldigheid;
}
/**
* Geef de waarde van datum einde geldigheid van SoortPartij.
*
* @return de waarde van datum einde geldigheid van SoortPartij
*/
@Override
public Integer getDatumEindeGeldigheid() {
return datumEindeGeldigheid;
}
/**
* Zet de waarden voor datum einde geldigheid van SoortPartij.
*
* @param datumEindeGeldigheid de nieuwe waarde voor datum einde geldigheid van SoortPartij
*/
public void setDatumEindeGeldigheid(final Integer datumEindeGeldigheid) {
this.datumEindeGeldigheid = datumEindeGeldigheid;
}
}
| DDDNL/OperatieBRP | Broncode/operatiebrp-code-145.3/algemeen/alg-dal-entiteiten/src/main/java/nl/bzk/algemeenbrp/dal/domein/brp/entity/SoortPartij.java | 1,231 | /**
* Zet de waarden voor naam van SoortPartij.
*
* @param naam de nieuwe waarde voor naam van SoortPartij
*/ | 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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import javax.persistence.Cacheable;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.NamedQuery;
/**
* The persistent class for the srtpartij database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "srtpartij", schema = "kern")
@Cacheable
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
@NamedQuery(name = "SoortPartij" + Constanten.ZOEK_ALLES_VOOR_CACHE, query = "from SoortPartij")
public class SoortPartij extends AbstractEntiteit implements Serializable, DynamischeStamtabelMetGeldigheid {
private static final long serialVersionUID = 1L;
@Id
@SequenceGenerator(name = "srtpartij_id_generator", sequenceName = "kern.seq_srtpartij", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "srtpartij_id_generator")
@Column(updatable = false, nullable = false)
private Short id;
@Column(nullable = false, length = 80, unique = true)
private String naam;
@Column(name = "dataanvgel")
private Integer datumAanvangGeldigheid;
@Column(name = "dateindegel")
private Integer datumEindeGeldigheid;
/**
* JPA no-args constructor.
*/
protected SoortPartij() {}
/**
* Maak een nieuwe soort partij.
*
* @param naam naam
*/
public SoortPartij(final String naam) {
setNaam(naam);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Short getId() {
return id;
}
/**
* Zet de waarden voor id van SoortPartij.
*
* @param id de nieuwe waarde voor id van SoortPartij
*/
public void setId(final Short id) {
this.id = id;
}
/**
* Geef de waarde van naam van SoortPartij.
*
* @return de waarde van naam van SoortPartij
*/
public String getNaam() {
return naam;
}
/**
* Zet de waarden<SUF>*/
public void setNaam(final String naam) {
ValidationUtils.controleerOpNullWaarden("naam mag niet null zijn", naam);
ValidationUtils.controleerOpLegeWaarden("naam mag geen lege string zijn", naam);
this.naam = naam;
}
/**
* Geef de waarde van datum aanvang geldigheid van SoortPartij.
*
* @return de waarde van datum aanvang geldigheid van SoortPartij
*/
@Override
public Integer getDatumAanvangGeldigheid() {
return datumAanvangGeldigheid;
}
/**
* Zet de waarden voor datum aanvang geldigheid van SoortPartij.
*
* @param datumAanvangGeldigheid de nieuwe waarde voor datum aanvang geldigheid van SoortPartij
*/
public void setDatumAanvangGeldigheid(final Integer datumAanvangGeldigheid) {
this.datumAanvangGeldigheid = datumAanvangGeldigheid;
}
/**
* Geef de waarde van datum einde geldigheid van SoortPartij.
*
* @return de waarde van datum einde geldigheid van SoortPartij
*/
@Override
public Integer getDatumEindeGeldigheid() {
return datumEindeGeldigheid;
}
/**
* Zet de waarden voor datum einde geldigheid van SoortPartij.
*
* @param datumEindeGeldigheid de nieuwe waarde voor datum einde geldigheid van SoortPartij
*/
public void setDatumEindeGeldigheid(final Integer datumEindeGeldigheid) {
this.datumEindeGeldigheid = datumEindeGeldigheid;
}
}
|
202154_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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import javax.persistence.Cacheable;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.NamedQuery;
/**
* The persistent class for the srtpartij database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "srtpartij", schema = "kern")
@Cacheable
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
@NamedQuery(name = "SoortPartij" + Constanten.ZOEK_ALLES_VOOR_CACHE, query = "from SoortPartij")
public class SoortPartij extends AbstractEntiteit implements Serializable, DynamischeStamtabelMetGeldigheid {
private static final long serialVersionUID = 1L;
@Id
@SequenceGenerator(name = "srtpartij_id_generator", sequenceName = "kern.seq_srtpartij", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "srtpartij_id_generator")
@Column(updatable = false, nullable = false)
private Short id;
@Column(nullable = false, length = 80, unique = true)
private String naam;
@Column(name = "dataanvgel")
private Integer datumAanvangGeldigheid;
@Column(name = "dateindegel")
private Integer datumEindeGeldigheid;
/**
* JPA no-args constructor.
*/
protected SoortPartij() {}
/**
* Maak een nieuwe soort partij.
*
* @param naam naam
*/
public SoortPartij(final String naam) {
setNaam(naam);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Short getId() {
return id;
}
/**
* Zet de waarden voor id van SoortPartij.
*
* @param id de nieuwe waarde voor id van SoortPartij
*/
public void setId(final Short id) {
this.id = id;
}
/**
* Geef de waarde van naam van SoortPartij.
*
* @return de waarde van naam van SoortPartij
*/
public String getNaam() {
return naam;
}
/**
* Zet de waarden voor naam van SoortPartij.
*
* @param naam de nieuwe waarde voor naam van SoortPartij
*/
public void setNaam(final String naam) {
ValidationUtils.controleerOpNullWaarden("naam mag niet null zijn", naam);
ValidationUtils.controleerOpLegeWaarden("naam mag geen lege string zijn", naam);
this.naam = naam;
}
/**
* Geef de waarde van datum aanvang geldigheid van SoortPartij.
*
* @return de waarde van datum aanvang geldigheid van SoortPartij
*/
@Override
public Integer getDatumAanvangGeldigheid() {
return datumAanvangGeldigheid;
}
/**
* Zet de waarden voor datum aanvang geldigheid van SoortPartij.
*
* @param datumAanvangGeldigheid de nieuwe waarde voor datum aanvang geldigheid van SoortPartij
*/
public void setDatumAanvangGeldigheid(final Integer datumAanvangGeldigheid) {
this.datumAanvangGeldigheid = datumAanvangGeldigheid;
}
/**
* Geef de waarde van datum einde geldigheid van SoortPartij.
*
* @return de waarde van datum einde geldigheid van SoortPartij
*/
@Override
public Integer getDatumEindeGeldigheid() {
return datumEindeGeldigheid;
}
/**
* Zet de waarden voor datum einde geldigheid van SoortPartij.
*
* @param datumEindeGeldigheid de nieuwe waarde voor datum einde geldigheid van SoortPartij
*/
public void setDatumEindeGeldigheid(final Integer datumEindeGeldigheid) {
this.datumEindeGeldigheid = datumEindeGeldigheid;
}
}
| DDDNL/OperatieBRP | Broncode/operatiebrp-code-145.3/algemeen/alg-dal-entiteiten/src/main/java/nl/bzk/algemeenbrp/dal/domein/brp/entity/SoortPartij.java | 1,231 | /**
* Geef de waarde van datum aanvang geldigheid van SoortPartij.
*
* @return de waarde van datum aanvang geldigheid van SoortPartij
*/ | 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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import javax.persistence.Cacheable;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.NamedQuery;
/**
* The persistent class for the srtpartij database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "srtpartij", schema = "kern")
@Cacheable
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
@NamedQuery(name = "SoortPartij" + Constanten.ZOEK_ALLES_VOOR_CACHE, query = "from SoortPartij")
public class SoortPartij extends AbstractEntiteit implements Serializable, DynamischeStamtabelMetGeldigheid {
private static final long serialVersionUID = 1L;
@Id
@SequenceGenerator(name = "srtpartij_id_generator", sequenceName = "kern.seq_srtpartij", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "srtpartij_id_generator")
@Column(updatable = false, nullable = false)
private Short id;
@Column(nullable = false, length = 80, unique = true)
private String naam;
@Column(name = "dataanvgel")
private Integer datumAanvangGeldigheid;
@Column(name = "dateindegel")
private Integer datumEindeGeldigheid;
/**
* JPA no-args constructor.
*/
protected SoortPartij() {}
/**
* Maak een nieuwe soort partij.
*
* @param naam naam
*/
public SoortPartij(final String naam) {
setNaam(naam);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Short getId() {
return id;
}
/**
* Zet de waarden voor id van SoortPartij.
*
* @param id de nieuwe waarde voor id van SoortPartij
*/
public void setId(final Short id) {
this.id = id;
}
/**
* Geef de waarde van naam van SoortPartij.
*
* @return de waarde van naam van SoortPartij
*/
public String getNaam() {
return naam;
}
/**
* Zet de waarden voor naam van SoortPartij.
*
* @param naam de nieuwe waarde voor naam van SoortPartij
*/
public void setNaam(final String naam) {
ValidationUtils.controleerOpNullWaarden("naam mag niet null zijn", naam);
ValidationUtils.controleerOpLegeWaarden("naam mag geen lege string zijn", naam);
this.naam = naam;
}
/**
* Geef de waarde<SUF>*/
@Override
public Integer getDatumAanvangGeldigheid() {
return datumAanvangGeldigheid;
}
/**
* Zet de waarden voor datum aanvang geldigheid van SoortPartij.
*
* @param datumAanvangGeldigheid de nieuwe waarde voor datum aanvang geldigheid van SoortPartij
*/
public void setDatumAanvangGeldigheid(final Integer datumAanvangGeldigheid) {
this.datumAanvangGeldigheid = datumAanvangGeldigheid;
}
/**
* Geef de waarde van datum einde geldigheid van SoortPartij.
*
* @return de waarde van datum einde geldigheid van SoortPartij
*/
@Override
public Integer getDatumEindeGeldigheid() {
return datumEindeGeldigheid;
}
/**
* Zet de waarden voor datum einde geldigheid van SoortPartij.
*
* @param datumEindeGeldigheid de nieuwe waarde voor datum einde geldigheid van SoortPartij
*/
public void setDatumEindeGeldigheid(final Integer datumEindeGeldigheid) {
this.datumEindeGeldigheid = datumEindeGeldigheid;
}
}
|
202154_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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import javax.persistence.Cacheable;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.NamedQuery;
/**
* The persistent class for the srtpartij database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "srtpartij", schema = "kern")
@Cacheable
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
@NamedQuery(name = "SoortPartij" + Constanten.ZOEK_ALLES_VOOR_CACHE, query = "from SoortPartij")
public class SoortPartij extends AbstractEntiteit implements Serializable, DynamischeStamtabelMetGeldigheid {
private static final long serialVersionUID = 1L;
@Id
@SequenceGenerator(name = "srtpartij_id_generator", sequenceName = "kern.seq_srtpartij", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "srtpartij_id_generator")
@Column(updatable = false, nullable = false)
private Short id;
@Column(nullable = false, length = 80, unique = true)
private String naam;
@Column(name = "dataanvgel")
private Integer datumAanvangGeldigheid;
@Column(name = "dateindegel")
private Integer datumEindeGeldigheid;
/**
* JPA no-args constructor.
*/
protected SoortPartij() {}
/**
* Maak een nieuwe soort partij.
*
* @param naam naam
*/
public SoortPartij(final String naam) {
setNaam(naam);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Short getId() {
return id;
}
/**
* Zet de waarden voor id van SoortPartij.
*
* @param id de nieuwe waarde voor id van SoortPartij
*/
public void setId(final Short id) {
this.id = id;
}
/**
* Geef de waarde van naam van SoortPartij.
*
* @return de waarde van naam van SoortPartij
*/
public String getNaam() {
return naam;
}
/**
* Zet de waarden voor naam van SoortPartij.
*
* @param naam de nieuwe waarde voor naam van SoortPartij
*/
public void setNaam(final String naam) {
ValidationUtils.controleerOpNullWaarden("naam mag niet null zijn", naam);
ValidationUtils.controleerOpLegeWaarden("naam mag geen lege string zijn", naam);
this.naam = naam;
}
/**
* Geef de waarde van datum aanvang geldigheid van SoortPartij.
*
* @return de waarde van datum aanvang geldigheid van SoortPartij
*/
@Override
public Integer getDatumAanvangGeldigheid() {
return datumAanvangGeldigheid;
}
/**
* Zet de waarden voor datum aanvang geldigheid van SoortPartij.
*
* @param datumAanvangGeldigheid de nieuwe waarde voor datum aanvang geldigheid van SoortPartij
*/
public void setDatumAanvangGeldigheid(final Integer datumAanvangGeldigheid) {
this.datumAanvangGeldigheid = datumAanvangGeldigheid;
}
/**
* Geef de waarde van datum einde geldigheid van SoortPartij.
*
* @return de waarde van datum einde geldigheid van SoortPartij
*/
@Override
public Integer getDatumEindeGeldigheid() {
return datumEindeGeldigheid;
}
/**
* Zet de waarden voor datum einde geldigheid van SoortPartij.
*
* @param datumEindeGeldigheid de nieuwe waarde voor datum einde geldigheid van SoortPartij
*/
public void setDatumEindeGeldigheid(final Integer datumEindeGeldigheid) {
this.datumEindeGeldigheid = datumEindeGeldigheid;
}
}
| DDDNL/OperatieBRP | Broncode/operatiebrp-code-145.3/algemeen/alg-dal-entiteiten/src/main/java/nl/bzk/algemeenbrp/dal/domein/brp/entity/SoortPartij.java | 1,231 | /**
* Zet de waarden voor datum aanvang geldigheid van SoortPartij.
*
* @param datumAanvangGeldigheid de nieuwe waarde voor datum aanvang geldigheid van SoortPartij
*/ | 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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import javax.persistence.Cacheable;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.NamedQuery;
/**
* The persistent class for the srtpartij database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "srtpartij", schema = "kern")
@Cacheable
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
@NamedQuery(name = "SoortPartij" + Constanten.ZOEK_ALLES_VOOR_CACHE, query = "from SoortPartij")
public class SoortPartij extends AbstractEntiteit implements Serializable, DynamischeStamtabelMetGeldigheid {
private static final long serialVersionUID = 1L;
@Id
@SequenceGenerator(name = "srtpartij_id_generator", sequenceName = "kern.seq_srtpartij", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "srtpartij_id_generator")
@Column(updatable = false, nullable = false)
private Short id;
@Column(nullable = false, length = 80, unique = true)
private String naam;
@Column(name = "dataanvgel")
private Integer datumAanvangGeldigheid;
@Column(name = "dateindegel")
private Integer datumEindeGeldigheid;
/**
* JPA no-args constructor.
*/
protected SoortPartij() {}
/**
* Maak een nieuwe soort partij.
*
* @param naam naam
*/
public SoortPartij(final String naam) {
setNaam(naam);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Short getId() {
return id;
}
/**
* Zet de waarden voor id van SoortPartij.
*
* @param id de nieuwe waarde voor id van SoortPartij
*/
public void setId(final Short id) {
this.id = id;
}
/**
* Geef de waarde van naam van SoortPartij.
*
* @return de waarde van naam van SoortPartij
*/
public String getNaam() {
return naam;
}
/**
* Zet de waarden voor naam van SoortPartij.
*
* @param naam de nieuwe waarde voor naam van SoortPartij
*/
public void setNaam(final String naam) {
ValidationUtils.controleerOpNullWaarden("naam mag niet null zijn", naam);
ValidationUtils.controleerOpLegeWaarden("naam mag geen lege string zijn", naam);
this.naam = naam;
}
/**
* Geef de waarde van datum aanvang geldigheid van SoortPartij.
*
* @return de waarde van datum aanvang geldigheid van SoortPartij
*/
@Override
public Integer getDatumAanvangGeldigheid() {
return datumAanvangGeldigheid;
}
/**
* Zet de waarden<SUF>*/
public void setDatumAanvangGeldigheid(final Integer datumAanvangGeldigheid) {
this.datumAanvangGeldigheid = datumAanvangGeldigheid;
}
/**
* Geef de waarde van datum einde geldigheid van SoortPartij.
*
* @return de waarde van datum einde geldigheid van SoortPartij
*/
@Override
public Integer getDatumEindeGeldigheid() {
return datumEindeGeldigheid;
}
/**
* Zet de waarden voor datum einde geldigheid van SoortPartij.
*
* @param datumEindeGeldigheid de nieuwe waarde voor datum einde geldigheid van SoortPartij
*/
public void setDatumEindeGeldigheid(final Integer datumEindeGeldigheid) {
this.datumEindeGeldigheid = datumEindeGeldigheid;
}
}
|
202154_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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import javax.persistence.Cacheable;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.NamedQuery;
/**
* The persistent class for the srtpartij database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "srtpartij", schema = "kern")
@Cacheable
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
@NamedQuery(name = "SoortPartij" + Constanten.ZOEK_ALLES_VOOR_CACHE, query = "from SoortPartij")
public class SoortPartij extends AbstractEntiteit implements Serializable, DynamischeStamtabelMetGeldigheid {
private static final long serialVersionUID = 1L;
@Id
@SequenceGenerator(name = "srtpartij_id_generator", sequenceName = "kern.seq_srtpartij", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "srtpartij_id_generator")
@Column(updatable = false, nullable = false)
private Short id;
@Column(nullable = false, length = 80, unique = true)
private String naam;
@Column(name = "dataanvgel")
private Integer datumAanvangGeldigheid;
@Column(name = "dateindegel")
private Integer datumEindeGeldigheid;
/**
* JPA no-args constructor.
*/
protected SoortPartij() {}
/**
* Maak een nieuwe soort partij.
*
* @param naam naam
*/
public SoortPartij(final String naam) {
setNaam(naam);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Short getId() {
return id;
}
/**
* Zet de waarden voor id van SoortPartij.
*
* @param id de nieuwe waarde voor id van SoortPartij
*/
public void setId(final Short id) {
this.id = id;
}
/**
* Geef de waarde van naam van SoortPartij.
*
* @return de waarde van naam van SoortPartij
*/
public String getNaam() {
return naam;
}
/**
* Zet de waarden voor naam van SoortPartij.
*
* @param naam de nieuwe waarde voor naam van SoortPartij
*/
public void setNaam(final String naam) {
ValidationUtils.controleerOpNullWaarden("naam mag niet null zijn", naam);
ValidationUtils.controleerOpLegeWaarden("naam mag geen lege string zijn", naam);
this.naam = naam;
}
/**
* Geef de waarde van datum aanvang geldigheid van SoortPartij.
*
* @return de waarde van datum aanvang geldigheid van SoortPartij
*/
@Override
public Integer getDatumAanvangGeldigheid() {
return datumAanvangGeldigheid;
}
/**
* Zet de waarden voor datum aanvang geldigheid van SoortPartij.
*
* @param datumAanvangGeldigheid de nieuwe waarde voor datum aanvang geldigheid van SoortPartij
*/
public void setDatumAanvangGeldigheid(final Integer datumAanvangGeldigheid) {
this.datumAanvangGeldigheid = datumAanvangGeldigheid;
}
/**
* Geef de waarde van datum einde geldigheid van SoortPartij.
*
* @return de waarde van datum einde geldigheid van SoortPartij
*/
@Override
public Integer getDatumEindeGeldigheid() {
return datumEindeGeldigheid;
}
/**
* Zet de waarden voor datum einde geldigheid van SoortPartij.
*
* @param datumEindeGeldigheid de nieuwe waarde voor datum einde geldigheid van SoortPartij
*/
public void setDatumEindeGeldigheid(final Integer datumEindeGeldigheid) {
this.datumEindeGeldigheid = datumEindeGeldigheid;
}
}
| DDDNL/OperatieBRP | Broncode/operatiebrp-code-145.3/algemeen/alg-dal-entiteiten/src/main/java/nl/bzk/algemeenbrp/dal/domein/brp/entity/SoortPartij.java | 1,231 | /**
* Geef de waarde van datum einde geldigheid van SoortPartij.
*
* @return de waarde van datum einde geldigheid van SoortPartij
*/ | 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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import javax.persistence.Cacheable;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.NamedQuery;
/**
* The persistent class for the srtpartij database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "srtpartij", schema = "kern")
@Cacheable
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
@NamedQuery(name = "SoortPartij" + Constanten.ZOEK_ALLES_VOOR_CACHE, query = "from SoortPartij")
public class SoortPartij extends AbstractEntiteit implements Serializable, DynamischeStamtabelMetGeldigheid {
private static final long serialVersionUID = 1L;
@Id
@SequenceGenerator(name = "srtpartij_id_generator", sequenceName = "kern.seq_srtpartij", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "srtpartij_id_generator")
@Column(updatable = false, nullable = false)
private Short id;
@Column(nullable = false, length = 80, unique = true)
private String naam;
@Column(name = "dataanvgel")
private Integer datumAanvangGeldigheid;
@Column(name = "dateindegel")
private Integer datumEindeGeldigheid;
/**
* JPA no-args constructor.
*/
protected SoortPartij() {}
/**
* Maak een nieuwe soort partij.
*
* @param naam naam
*/
public SoortPartij(final String naam) {
setNaam(naam);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Short getId() {
return id;
}
/**
* Zet de waarden voor id van SoortPartij.
*
* @param id de nieuwe waarde voor id van SoortPartij
*/
public void setId(final Short id) {
this.id = id;
}
/**
* Geef de waarde van naam van SoortPartij.
*
* @return de waarde van naam van SoortPartij
*/
public String getNaam() {
return naam;
}
/**
* Zet de waarden voor naam van SoortPartij.
*
* @param naam de nieuwe waarde voor naam van SoortPartij
*/
public void setNaam(final String naam) {
ValidationUtils.controleerOpNullWaarden("naam mag niet null zijn", naam);
ValidationUtils.controleerOpLegeWaarden("naam mag geen lege string zijn", naam);
this.naam = naam;
}
/**
* Geef de waarde van datum aanvang geldigheid van SoortPartij.
*
* @return de waarde van datum aanvang geldigheid van SoortPartij
*/
@Override
public Integer getDatumAanvangGeldigheid() {
return datumAanvangGeldigheid;
}
/**
* Zet de waarden voor datum aanvang geldigheid van SoortPartij.
*
* @param datumAanvangGeldigheid de nieuwe waarde voor datum aanvang geldigheid van SoortPartij
*/
public void setDatumAanvangGeldigheid(final Integer datumAanvangGeldigheid) {
this.datumAanvangGeldigheid = datumAanvangGeldigheid;
}
/**
* Geef de waarde<SUF>*/
@Override
public Integer getDatumEindeGeldigheid() {
return datumEindeGeldigheid;
}
/**
* Zet de waarden voor datum einde geldigheid van SoortPartij.
*
* @param datumEindeGeldigheid de nieuwe waarde voor datum einde geldigheid van SoortPartij
*/
public void setDatumEindeGeldigheid(final Integer datumEindeGeldigheid) {
this.datumEindeGeldigheid = datumEindeGeldigheid;
}
}
|
202154_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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import javax.persistence.Cacheable;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.NamedQuery;
/**
* The persistent class for the srtpartij database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "srtpartij", schema = "kern")
@Cacheable
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
@NamedQuery(name = "SoortPartij" + Constanten.ZOEK_ALLES_VOOR_CACHE, query = "from SoortPartij")
public class SoortPartij extends AbstractEntiteit implements Serializable, DynamischeStamtabelMetGeldigheid {
private static final long serialVersionUID = 1L;
@Id
@SequenceGenerator(name = "srtpartij_id_generator", sequenceName = "kern.seq_srtpartij", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "srtpartij_id_generator")
@Column(updatable = false, nullable = false)
private Short id;
@Column(nullable = false, length = 80, unique = true)
private String naam;
@Column(name = "dataanvgel")
private Integer datumAanvangGeldigheid;
@Column(name = "dateindegel")
private Integer datumEindeGeldigheid;
/**
* JPA no-args constructor.
*/
protected SoortPartij() {}
/**
* Maak een nieuwe soort partij.
*
* @param naam naam
*/
public SoortPartij(final String naam) {
setNaam(naam);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Short getId() {
return id;
}
/**
* Zet de waarden voor id van SoortPartij.
*
* @param id de nieuwe waarde voor id van SoortPartij
*/
public void setId(final Short id) {
this.id = id;
}
/**
* Geef de waarde van naam van SoortPartij.
*
* @return de waarde van naam van SoortPartij
*/
public String getNaam() {
return naam;
}
/**
* Zet de waarden voor naam van SoortPartij.
*
* @param naam de nieuwe waarde voor naam van SoortPartij
*/
public void setNaam(final String naam) {
ValidationUtils.controleerOpNullWaarden("naam mag niet null zijn", naam);
ValidationUtils.controleerOpLegeWaarden("naam mag geen lege string zijn", naam);
this.naam = naam;
}
/**
* Geef de waarde van datum aanvang geldigheid van SoortPartij.
*
* @return de waarde van datum aanvang geldigheid van SoortPartij
*/
@Override
public Integer getDatumAanvangGeldigheid() {
return datumAanvangGeldigheid;
}
/**
* Zet de waarden voor datum aanvang geldigheid van SoortPartij.
*
* @param datumAanvangGeldigheid de nieuwe waarde voor datum aanvang geldigheid van SoortPartij
*/
public void setDatumAanvangGeldigheid(final Integer datumAanvangGeldigheid) {
this.datumAanvangGeldigheid = datumAanvangGeldigheid;
}
/**
* Geef de waarde van datum einde geldigheid van SoortPartij.
*
* @return de waarde van datum einde geldigheid van SoortPartij
*/
@Override
public Integer getDatumEindeGeldigheid() {
return datumEindeGeldigheid;
}
/**
* Zet de waarden voor datum einde geldigheid van SoortPartij.
*
* @param datumEindeGeldigheid de nieuwe waarde voor datum einde geldigheid van SoortPartij
*/
public void setDatumEindeGeldigheid(final Integer datumEindeGeldigheid) {
this.datumEindeGeldigheid = datumEindeGeldigheid;
}
}
| DDDNL/OperatieBRP | Broncode/operatiebrp-code-145.3/algemeen/alg-dal-entiteiten/src/main/java/nl/bzk/algemeenbrp/dal/domein/brp/entity/SoortPartij.java | 1,231 | /**
* Zet de waarden voor datum einde geldigheid van SoortPartij.
*
* @param datumEindeGeldigheid de nieuwe waarde voor datum einde geldigheid van SoortPartij
*/ | 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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import javax.persistence.Cacheable;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.NamedQuery;
/**
* The persistent class for the srtpartij database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "srtpartij", schema = "kern")
@Cacheable
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
@NamedQuery(name = "SoortPartij" + Constanten.ZOEK_ALLES_VOOR_CACHE, query = "from SoortPartij")
public class SoortPartij extends AbstractEntiteit implements Serializable, DynamischeStamtabelMetGeldigheid {
private static final long serialVersionUID = 1L;
@Id
@SequenceGenerator(name = "srtpartij_id_generator", sequenceName = "kern.seq_srtpartij", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "srtpartij_id_generator")
@Column(updatable = false, nullable = false)
private Short id;
@Column(nullable = false, length = 80, unique = true)
private String naam;
@Column(name = "dataanvgel")
private Integer datumAanvangGeldigheid;
@Column(name = "dateindegel")
private Integer datumEindeGeldigheid;
/**
* JPA no-args constructor.
*/
protected SoortPartij() {}
/**
* Maak een nieuwe soort partij.
*
* @param naam naam
*/
public SoortPartij(final String naam) {
setNaam(naam);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Short getId() {
return id;
}
/**
* Zet de waarden voor id van SoortPartij.
*
* @param id de nieuwe waarde voor id van SoortPartij
*/
public void setId(final Short id) {
this.id = id;
}
/**
* Geef de waarde van naam van SoortPartij.
*
* @return de waarde van naam van SoortPartij
*/
public String getNaam() {
return naam;
}
/**
* Zet de waarden voor naam van SoortPartij.
*
* @param naam de nieuwe waarde voor naam van SoortPartij
*/
public void setNaam(final String naam) {
ValidationUtils.controleerOpNullWaarden("naam mag niet null zijn", naam);
ValidationUtils.controleerOpLegeWaarden("naam mag geen lege string zijn", naam);
this.naam = naam;
}
/**
* Geef de waarde van datum aanvang geldigheid van SoortPartij.
*
* @return de waarde van datum aanvang geldigheid van SoortPartij
*/
@Override
public Integer getDatumAanvangGeldigheid() {
return datumAanvangGeldigheid;
}
/**
* Zet de waarden voor datum aanvang geldigheid van SoortPartij.
*
* @param datumAanvangGeldigheid de nieuwe waarde voor datum aanvang geldigheid van SoortPartij
*/
public void setDatumAanvangGeldigheid(final Integer datumAanvangGeldigheid) {
this.datumAanvangGeldigheid = datumAanvangGeldigheid;
}
/**
* Geef de waarde van datum einde geldigheid van SoortPartij.
*
* @return de waarde van datum einde geldigheid van SoortPartij
*/
@Override
public Integer getDatumEindeGeldigheid() {
return datumEindeGeldigheid;
}
/**
* Zet de waarden<SUF>*/
public void setDatumEindeGeldigheid(final Integer datumEindeGeldigheid) {
this.datumEindeGeldigheid = datumEindeGeldigheid;
}
}
|
202160_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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import java.util.LinkedHashSet;
import java.util.Set;
import javax.persistence.Access;
import javax.persistence.AccessType;
import javax.persistence.Cacheable;
import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.OneToMany;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import javax.persistence.UniqueConstraint;
import nl.bzk.algemeenbrp.dal.domein.brp.annotation.IndicatieActueelEnGeldig;
import nl.bzk.algemeenbrp.dal.domein.brp.enums.Rol;
import nl.bzk.algemeenbrp.dal.domein.brp.util.Geldigheid;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.Fetch;
import org.hibernate.annotations.FetchMode;
/**
* The persistent class for the partijrol database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "partijrol", schema = "kern", uniqueConstraints = @UniqueConstraint(columnNames = {"partij", "rol"}))
@Cacheable
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
@Access(AccessType.FIELD)
public class PartijRol extends AbstractEntiteit implements Afleidbaar, Serializable, DynamischeStamtabel, Geldigheid {
private static final long serialVersionUID = 1L;
private static final String PARTIJ_MAG_NIET_NULL_ZIJN = "partij mag niet null zijn";
@Id
@SequenceGenerator(name = "partijrol_id_generator", sequenceName = "kern.seq_partijrol", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "partijrol_id_generator")
@Column(nullable = false, updatable = false)
@Access(AccessType.PROPERTY)
private Integer id;
@ManyToOne(fetch = FetchType.LAZY)
@JoinColumn(name = "partij", nullable = false)
private Partij partij;
@Column(name = "rol", nullable = false)
private int rolId;
@Column(name = "datingang")
private Integer datumIngang;
@Column(name = "dateinde")
private Integer datumEinde;
@Column(name = "indag", nullable = false)
private boolean isActueelEnGeldig;
@IndicatieActueelEnGeldig(naam = "isActueelEnGeldig")
@OneToMany(fetch = FetchType.LAZY, mappedBy = "partijRol", cascade = CascadeType.ALL)
@Fetch(value = FetchMode.SELECT)
private Set<PartijRolHistorie> partijRolHistorieSet = new LinkedHashSet<>(0);
/**
* JPA default constructor.
*/
protected PartijRol() {}
/**
* Maak een nieuwe partij rol.
*
* @param partij partij
* @param rol rol
*/
public PartijRol(final Partij partij, final Rol rol) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
setRol(rol);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Integer getId() {
return id;
}
/**
* Zet de waarden voor id van PartijRol.
*
* @param id de nieuwe waarde voor id van PartijRol
*/
public void setId(final Integer id) {
this.id = id;
}
/**
* Geef de waarde van partij van PartijRol.
*
* @return de waarde van partij van PartijRol
*/
public Partij getPartij() {
return partij;
}
/**
* Zet de waarden voor partij van PartijRol.
*
* @param partij de nieuwe waarde voor partij van PartijRol
*/
public void setPartij(final Partij partij) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
}
/**
* Geef de waarde van rol van PartijRol.
*
* @return de waarde van rol van PartijRol
*/
public Rol getRol() {
return Rol.parseId(rolId);
}
/**
* Zet de waarden voor rol van PartijRol.
*
* @param rol de nieuwe waarde voor rol van PartijRol
*/
public void setRol(final Rol rol) {
ValidationUtils.controleerOpNullWaarden("rol mag niet null zijn", rol);
rolId = rol.getId();
}
/**
* Geef de waarde van datum ingang van PartijRol.
*
* @return de waarde van datum ingang van PartijRol
*/
public Integer getDatumIngang() {
return datumIngang;
}
/**
* Zet de waarden voor datum ingang van PartijRol.
*
* @param datumIngang de nieuwe waarde voor datum ingang van PartijRol
*/
public void setDatumIngang(final Integer datumIngang) {
this.datumIngang = datumIngang;
}
/**
* Geef de waarde van datum einde van PartijRol.
*
* @return de waarde van datum einde van PartijRol
*/
public Integer getDatumEinde() {
return datumEinde;
}
/**
* Geef de waarde van isActueelEnGeldig.
*
* @return isActueelEnGeldig
*/
public boolean isActueelEnGeldig() {
return isActueelEnGeldig;
}
/**
* Zet de waarde van isActueelEnGeldig.
*
* @param actueelEnGeldig isActueelEnGeldig
*/
public void setActueelEnGeldig(final boolean actueelEnGeldig) {
isActueelEnGeldig = actueelEnGeldig;
}
/**
* Zet de waarden voor datum einde van PartijRol.
*
* @param datumEinde de nieuwe waarde voor datum einde van PartijRol
*/
public void setDatumEinde(final Integer datumEinde) {
this.datumEinde = datumEinde;
}
/**
* Geef de waarde van partij bijhouding historie set van PartijRol.
*
* @return de waarde van partij bijhouding historie set van PartijRol
*/
public Set<PartijRolHistorie> getPartijBijhoudingHistorieSet() {
return partijRolHistorieSet;
}
/**
* Toevoegen van een partijRolHistorie.
*
* @param partijRolHistorie partijRolHistorie
*/
public void addPartijBijhoudingHistorie(final PartijRolHistorie partijRolHistorie) {
partijRolHistorie.setPartijRol(this);
partijRolHistorieSet.add(partijRolHistorie);
}
/**
* Zet de waarden voor partijrol historie set van PartijRol.
*
* @param partijRolHistorieSet de nieuwe waarde voor partijrol historie set van PartijRol
*/
public void setPartijRolHistorieSet(final Set<PartijRolHistorie> partijRolHistorieSet) {
this.partijRolHistorieSet = partijRolHistorieSet;
}
}
| DDDNL/OperatieBRP | Broncode/operatiebrp-code-145.3/algemeen/alg-dal-entiteiten/src/main/java/nl/bzk/algemeenbrp/dal/domein/brp/entity/PartijRol.java | 2,055 | /**
* Maak een nieuwe partij rol.
*
* @param partij partij
* @param rol rol
*/ | 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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import java.util.LinkedHashSet;
import java.util.Set;
import javax.persistence.Access;
import javax.persistence.AccessType;
import javax.persistence.Cacheable;
import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.OneToMany;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import javax.persistence.UniqueConstraint;
import nl.bzk.algemeenbrp.dal.domein.brp.annotation.IndicatieActueelEnGeldig;
import nl.bzk.algemeenbrp.dal.domein.brp.enums.Rol;
import nl.bzk.algemeenbrp.dal.domein.brp.util.Geldigheid;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.Fetch;
import org.hibernate.annotations.FetchMode;
/**
* The persistent class for the partijrol database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "partijrol", schema = "kern", uniqueConstraints = @UniqueConstraint(columnNames = {"partij", "rol"}))
@Cacheable
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
@Access(AccessType.FIELD)
public class PartijRol extends AbstractEntiteit implements Afleidbaar, Serializable, DynamischeStamtabel, Geldigheid {
private static final long serialVersionUID = 1L;
private static final String PARTIJ_MAG_NIET_NULL_ZIJN = "partij mag niet null zijn";
@Id
@SequenceGenerator(name = "partijrol_id_generator", sequenceName = "kern.seq_partijrol", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "partijrol_id_generator")
@Column(nullable = false, updatable = false)
@Access(AccessType.PROPERTY)
private Integer id;
@ManyToOne(fetch = FetchType.LAZY)
@JoinColumn(name = "partij", nullable = false)
private Partij partij;
@Column(name = "rol", nullable = false)
private int rolId;
@Column(name = "datingang")
private Integer datumIngang;
@Column(name = "dateinde")
private Integer datumEinde;
@Column(name = "indag", nullable = false)
private boolean isActueelEnGeldig;
@IndicatieActueelEnGeldig(naam = "isActueelEnGeldig")
@OneToMany(fetch = FetchType.LAZY, mappedBy = "partijRol", cascade = CascadeType.ALL)
@Fetch(value = FetchMode.SELECT)
private Set<PartijRolHistorie> partijRolHistorieSet = new LinkedHashSet<>(0);
/**
* JPA default constructor.
*/
protected PartijRol() {}
/**
* Maak een nieuwe<SUF>*/
public PartijRol(final Partij partij, final Rol rol) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
setRol(rol);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Integer getId() {
return id;
}
/**
* Zet de waarden voor id van PartijRol.
*
* @param id de nieuwe waarde voor id van PartijRol
*/
public void setId(final Integer id) {
this.id = id;
}
/**
* Geef de waarde van partij van PartijRol.
*
* @return de waarde van partij van PartijRol
*/
public Partij getPartij() {
return partij;
}
/**
* Zet de waarden voor partij van PartijRol.
*
* @param partij de nieuwe waarde voor partij van PartijRol
*/
public void setPartij(final Partij partij) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
}
/**
* Geef de waarde van rol van PartijRol.
*
* @return de waarde van rol van PartijRol
*/
public Rol getRol() {
return Rol.parseId(rolId);
}
/**
* Zet de waarden voor rol van PartijRol.
*
* @param rol de nieuwe waarde voor rol van PartijRol
*/
public void setRol(final Rol rol) {
ValidationUtils.controleerOpNullWaarden("rol mag niet null zijn", rol);
rolId = rol.getId();
}
/**
* Geef de waarde van datum ingang van PartijRol.
*
* @return de waarde van datum ingang van PartijRol
*/
public Integer getDatumIngang() {
return datumIngang;
}
/**
* Zet de waarden voor datum ingang van PartijRol.
*
* @param datumIngang de nieuwe waarde voor datum ingang van PartijRol
*/
public void setDatumIngang(final Integer datumIngang) {
this.datumIngang = datumIngang;
}
/**
* Geef de waarde van datum einde van PartijRol.
*
* @return de waarde van datum einde van PartijRol
*/
public Integer getDatumEinde() {
return datumEinde;
}
/**
* Geef de waarde van isActueelEnGeldig.
*
* @return isActueelEnGeldig
*/
public boolean isActueelEnGeldig() {
return isActueelEnGeldig;
}
/**
* Zet de waarde van isActueelEnGeldig.
*
* @param actueelEnGeldig isActueelEnGeldig
*/
public void setActueelEnGeldig(final boolean actueelEnGeldig) {
isActueelEnGeldig = actueelEnGeldig;
}
/**
* Zet de waarden voor datum einde van PartijRol.
*
* @param datumEinde de nieuwe waarde voor datum einde van PartijRol
*/
public void setDatumEinde(final Integer datumEinde) {
this.datumEinde = datumEinde;
}
/**
* Geef de waarde van partij bijhouding historie set van PartijRol.
*
* @return de waarde van partij bijhouding historie set van PartijRol
*/
public Set<PartijRolHistorie> getPartijBijhoudingHistorieSet() {
return partijRolHistorieSet;
}
/**
* Toevoegen van een partijRolHistorie.
*
* @param partijRolHistorie partijRolHistorie
*/
public void addPartijBijhoudingHistorie(final PartijRolHistorie partijRolHistorie) {
partijRolHistorie.setPartijRol(this);
partijRolHistorieSet.add(partijRolHistorie);
}
/**
* Zet de waarden voor partijrol historie set van PartijRol.
*
* @param partijRolHistorieSet de nieuwe waarde voor partijrol historie set van PartijRol
*/
public void setPartijRolHistorieSet(final Set<PartijRolHistorie> partijRolHistorieSet) {
this.partijRolHistorieSet = partijRolHistorieSet;
}
}
|
202160_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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import java.util.LinkedHashSet;
import java.util.Set;
import javax.persistence.Access;
import javax.persistence.AccessType;
import javax.persistence.Cacheable;
import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.OneToMany;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import javax.persistence.UniqueConstraint;
import nl.bzk.algemeenbrp.dal.domein.brp.annotation.IndicatieActueelEnGeldig;
import nl.bzk.algemeenbrp.dal.domein.brp.enums.Rol;
import nl.bzk.algemeenbrp.dal.domein.brp.util.Geldigheid;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.Fetch;
import org.hibernate.annotations.FetchMode;
/**
* The persistent class for the partijrol database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "partijrol", schema = "kern", uniqueConstraints = @UniqueConstraint(columnNames = {"partij", "rol"}))
@Cacheable
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
@Access(AccessType.FIELD)
public class PartijRol extends AbstractEntiteit implements Afleidbaar, Serializable, DynamischeStamtabel, Geldigheid {
private static final long serialVersionUID = 1L;
private static final String PARTIJ_MAG_NIET_NULL_ZIJN = "partij mag niet null zijn";
@Id
@SequenceGenerator(name = "partijrol_id_generator", sequenceName = "kern.seq_partijrol", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "partijrol_id_generator")
@Column(nullable = false, updatable = false)
@Access(AccessType.PROPERTY)
private Integer id;
@ManyToOne(fetch = FetchType.LAZY)
@JoinColumn(name = "partij", nullable = false)
private Partij partij;
@Column(name = "rol", nullable = false)
private int rolId;
@Column(name = "datingang")
private Integer datumIngang;
@Column(name = "dateinde")
private Integer datumEinde;
@Column(name = "indag", nullable = false)
private boolean isActueelEnGeldig;
@IndicatieActueelEnGeldig(naam = "isActueelEnGeldig")
@OneToMany(fetch = FetchType.LAZY, mappedBy = "partijRol", cascade = CascadeType.ALL)
@Fetch(value = FetchMode.SELECT)
private Set<PartijRolHistorie> partijRolHistorieSet = new LinkedHashSet<>(0);
/**
* JPA default constructor.
*/
protected PartijRol() {}
/**
* Maak een nieuwe partij rol.
*
* @param partij partij
* @param rol rol
*/
public PartijRol(final Partij partij, final Rol rol) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
setRol(rol);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Integer getId() {
return id;
}
/**
* Zet de waarden voor id van PartijRol.
*
* @param id de nieuwe waarde voor id van PartijRol
*/
public void setId(final Integer id) {
this.id = id;
}
/**
* Geef de waarde van partij van PartijRol.
*
* @return de waarde van partij van PartijRol
*/
public Partij getPartij() {
return partij;
}
/**
* Zet de waarden voor partij van PartijRol.
*
* @param partij de nieuwe waarde voor partij van PartijRol
*/
public void setPartij(final Partij partij) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
}
/**
* Geef de waarde van rol van PartijRol.
*
* @return de waarde van rol van PartijRol
*/
public Rol getRol() {
return Rol.parseId(rolId);
}
/**
* Zet de waarden voor rol van PartijRol.
*
* @param rol de nieuwe waarde voor rol van PartijRol
*/
public void setRol(final Rol rol) {
ValidationUtils.controleerOpNullWaarden("rol mag niet null zijn", rol);
rolId = rol.getId();
}
/**
* Geef de waarde van datum ingang van PartijRol.
*
* @return de waarde van datum ingang van PartijRol
*/
public Integer getDatumIngang() {
return datumIngang;
}
/**
* Zet de waarden voor datum ingang van PartijRol.
*
* @param datumIngang de nieuwe waarde voor datum ingang van PartijRol
*/
public void setDatumIngang(final Integer datumIngang) {
this.datumIngang = datumIngang;
}
/**
* Geef de waarde van datum einde van PartijRol.
*
* @return de waarde van datum einde van PartijRol
*/
public Integer getDatumEinde() {
return datumEinde;
}
/**
* Geef de waarde van isActueelEnGeldig.
*
* @return isActueelEnGeldig
*/
public boolean isActueelEnGeldig() {
return isActueelEnGeldig;
}
/**
* Zet de waarde van isActueelEnGeldig.
*
* @param actueelEnGeldig isActueelEnGeldig
*/
public void setActueelEnGeldig(final boolean actueelEnGeldig) {
isActueelEnGeldig = actueelEnGeldig;
}
/**
* Zet de waarden voor datum einde van PartijRol.
*
* @param datumEinde de nieuwe waarde voor datum einde van PartijRol
*/
public void setDatumEinde(final Integer datumEinde) {
this.datumEinde = datumEinde;
}
/**
* Geef de waarde van partij bijhouding historie set van PartijRol.
*
* @return de waarde van partij bijhouding historie set van PartijRol
*/
public Set<PartijRolHistorie> getPartijBijhoudingHistorieSet() {
return partijRolHistorieSet;
}
/**
* Toevoegen van een partijRolHistorie.
*
* @param partijRolHistorie partijRolHistorie
*/
public void addPartijBijhoudingHistorie(final PartijRolHistorie partijRolHistorie) {
partijRolHistorie.setPartijRol(this);
partijRolHistorieSet.add(partijRolHistorie);
}
/**
* Zet de waarden voor partijrol historie set van PartijRol.
*
* @param partijRolHistorieSet de nieuwe waarde voor partijrol historie set van PartijRol
*/
public void setPartijRolHistorieSet(final Set<PartijRolHistorie> partijRolHistorieSet) {
this.partijRolHistorieSet = partijRolHistorieSet;
}
}
| DDDNL/OperatieBRP | Broncode/operatiebrp-code-145.3/algemeen/alg-dal-entiteiten/src/main/java/nl/bzk/algemeenbrp/dal/domein/brp/entity/PartijRol.java | 2,055 | /*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/ | 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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import java.util.LinkedHashSet;
import java.util.Set;
import javax.persistence.Access;
import javax.persistence.AccessType;
import javax.persistence.Cacheable;
import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.OneToMany;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import javax.persistence.UniqueConstraint;
import nl.bzk.algemeenbrp.dal.domein.brp.annotation.IndicatieActueelEnGeldig;
import nl.bzk.algemeenbrp.dal.domein.brp.enums.Rol;
import nl.bzk.algemeenbrp.dal.domein.brp.util.Geldigheid;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.Fetch;
import org.hibernate.annotations.FetchMode;
/**
* The persistent class for the partijrol database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "partijrol", schema = "kern", uniqueConstraints = @UniqueConstraint(columnNames = {"partij", "rol"}))
@Cacheable
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
@Access(AccessType.FIELD)
public class PartijRol extends AbstractEntiteit implements Afleidbaar, Serializable, DynamischeStamtabel, Geldigheid {
private static final long serialVersionUID = 1L;
private static final String PARTIJ_MAG_NIET_NULL_ZIJN = "partij mag niet null zijn";
@Id
@SequenceGenerator(name = "partijrol_id_generator", sequenceName = "kern.seq_partijrol", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "partijrol_id_generator")
@Column(nullable = false, updatable = false)
@Access(AccessType.PROPERTY)
private Integer id;
@ManyToOne(fetch = FetchType.LAZY)
@JoinColumn(name = "partij", nullable = false)
private Partij partij;
@Column(name = "rol", nullable = false)
private int rolId;
@Column(name = "datingang")
private Integer datumIngang;
@Column(name = "dateinde")
private Integer datumEinde;
@Column(name = "indag", nullable = false)
private boolean isActueelEnGeldig;
@IndicatieActueelEnGeldig(naam = "isActueelEnGeldig")
@OneToMany(fetch = FetchType.LAZY, mappedBy = "partijRol", cascade = CascadeType.ALL)
@Fetch(value = FetchMode.SELECT)
private Set<PartijRolHistorie> partijRolHistorieSet = new LinkedHashSet<>(0);
/**
* JPA default constructor.
*/
protected PartijRol() {}
/**
* Maak een nieuwe partij rol.
*
* @param partij partij
* @param rol rol
*/
public PartijRol(final Partij partij, final Rol rol) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
setRol(rol);
}
/*
* (non-Javadoc)
<SUF>*/
@Override
public Integer getId() {
return id;
}
/**
* Zet de waarden voor id van PartijRol.
*
* @param id de nieuwe waarde voor id van PartijRol
*/
public void setId(final Integer id) {
this.id = id;
}
/**
* Geef de waarde van partij van PartijRol.
*
* @return de waarde van partij van PartijRol
*/
public Partij getPartij() {
return partij;
}
/**
* Zet de waarden voor partij van PartijRol.
*
* @param partij de nieuwe waarde voor partij van PartijRol
*/
public void setPartij(final Partij partij) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
}
/**
* Geef de waarde van rol van PartijRol.
*
* @return de waarde van rol van PartijRol
*/
public Rol getRol() {
return Rol.parseId(rolId);
}
/**
* Zet de waarden voor rol van PartijRol.
*
* @param rol de nieuwe waarde voor rol van PartijRol
*/
public void setRol(final Rol rol) {
ValidationUtils.controleerOpNullWaarden("rol mag niet null zijn", rol);
rolId = rol.getId();
}
/**
* Geef de waarde van datum ingang van PartijRol.
*
* @return de waarde van datum ingang van PartijRol
*/
public Integer getDatumIngang() {
return datumIngang;
}
/**
* Zet de waarden voor datum ingang van PartijRol.
*
* @param datumIngang de nieuwe waarde voor datum ingang van PartijRol
*/
public void setDatumIngang(final Integer datumIngang) {
this.datumIngang = datumIngang;
}
/**
* Geef de waarde van datum einde van PartijRol.
*
* @return de waarde van datum einde van PartijRol
*/
public Integer getDatumEinde() {
return datumEinde;
}
/**
* Geef de waarde van isActueelEnGeldig.
*
* @return isActueelEnGeldig
*/
public boolean isActueelEnGeldig() {
return isActueelEnGeldig;
}
/**
* Zet de waarde van isActueelEnGeldig.
*
* @param actueelEnGeldig isActueelEnGeldig
*/
public void setActueelEnGeldig(final boolean actueelEnGeldig) {
isActueelEnGeldig = actueelEnGeldig;
}
/**
* Zet de waarden voor datum einde van PartijRol.
*
* @param datumEinde de nieuwe waarde voor datum einde van PartijRol
*/
public void setDatumEinde(final Integer datumEinde) {
this.datumEinde = datumEinde;
}
/**
* Geef de waarde van partij bijhouding historie set van PartijRol.
*
* @return de waarde van partij bijhouding historie set van PartijRol
*/
public Set<PartijRolHistorie> getPartijBijhoudingHistorieSet() {
return partijRolHistorieSet;
}
/**
* Toevoegen van een partijRolHistorie.
*
* @param partijRolHistorie partijRolHistorie
*/
public void addPartijBijhoudingHistorie(final PartijRolHistorie partijRolHistorie) {
partijRolHistorie.setPartijRol(this);
partijRolHistorieSet.add(partijRolHistorie);
}
/**
* Zet de waarden voor partijrol historie set van PartijRol.
*
* @param partijRolHistorieSet de nieuwe waarde voor partijrol historie set van PartijRol
*/
public void setPartijRolHistorieSet(final Set<PartijRolHistorie> partijRolHistorieSet) {
this.partijRolHistorieSet = partijRolHistorieSet;
}
}
|
202160_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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import java.util.LinkedHashSet;
import java.util.Set;
import javax.persistence.Access;
import javax.persistence.AccessType;
import javax.persistence.Cacheable;
import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.OneToMany;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import javax.persistence.UniqueConstraint;
import nl.bzk.algemeenbrp.dal.domein.brp.annotation.IndicatieActueelEnGeldig;
import nl.bzk.algemeenbrp.dal.domein.brp.enums.Rol;
import nl.bzk.algemeenbrp.dal.domein.brp.util.Geldigheid;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.Fetch;
import org.hibernate.annotations.FetchMode;
/**
* The persistent class for the partijrol database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "partijrol", schema = "kern", uniqueConstraints = @UniqueConstraint(columnNames = {"partij", "rol"}))
@Cacheable
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
@Access(AccessType.FIELD)
public class PartijRol extends AbstractEntiteit implements Afleidbaar, Serializable, DynamischeStamtabel, Geldigheid {
private static final long serialVersionUID = 1L;
private static final String PARTIJ_MAG_NIET_NULL_ZIJN = "partij mag niet null zijn";
@Id
@SequenceGenerator(name = "partijrol_id_generator", sequenceName = "kern.seq_partijrol", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "partijrol_id_generator")
@Column(nullable = false, updatable = false)
@Access(AccessType.PROPERTY)
private Integer id;
@ManyToOne(fetch = FetchType.LAZY)
@JoinColumn(name = "partij", nullable = false)
private Partij partij;
@Column(name = "rol", nullable = false)
private int rolId;
@Column(name = "datingang")
private Integer datumIngang;
@Column(name = "dateinde")
private Integer datumEinde;
@Column(name = "indag", nullable = false)
private boolean isActueelEnGeldig;
@IndicatieActueelEnGeldig(naam = "isActueelEnGeldig")
@OneToMany(fetch = FetchType.LAZY, mappedBy = "partijRol", cascade = CascadeType.ALL)
@Fetch(value = FetchMode.SELECT)
private Set<PartijRolHistorie> partijRolHistorieSet = new LinkedHashSet<>(0);
/**
* JPA default constructor.
*/
protected PartijRol() {}
/**
* Maak een nieuwe partij rol.
*
* @param partij partij
* @param rol rol
*/
public PartijRol(final Partij partij, final Rol rol) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
setRol(rol);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Integer getId() {
return id;
}
/**
* Zet de waarden voor id van PartijRol.
*
* @param id de nieuwe waarde voor id van PartijRol
*/
public void setId(final Integer id) {
this.id = id;
}
/**
* Geef de waarde van partij van PartijRol.
*
* @return de waarde van partij van PartijRol
*/
public Partij getPartij() {
return partij;
}
/**
* Zet de waarden voor partij van PartijRol.
*
* @param partij de nieuwe waarde voor partij van PartijRol
*/
public void setPartij(final Partij partij) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
}
/**
* Geef de waarde van rol van PartijRol.
*
* @return de waarde van rol van PartijRol
*/
public Rol getRol() {
return Rol.parseId(rolId);
}
/**
* Zet de waarden voor rol van PartijRol.
*
* @param rol de nieuwe waarde voor rol van PartijRol
*/
public void setRol(final Rol rol) {
ValidationUtils.controleerOpNullWaarden("rol mag niet null zijn", rol);
rolId = rol.getId();
}
/**
* Geef de waarde van datum ingang van PartijRol.
*
* @return de waarde van datum ingang van PartijRol
*/
public Integer getDatumIngang() {
return datumIngang;
}
/**
* Zet de waarden voor datum ingang van PartijRol.
*
* @param datumIngang de nieuwe waarde voor datum ingang van PartijRol
*/
public void setDatumIngang(final Integer datumIngang) {
this.datumIngang = datumIngang;
}
/**
* Geef de waarde van datum einde van PartijRol.
*
* @return de waarde van datum einde van PartijRol
*/
public Integer getDatumEinde() {
return datumEinde;
}
/**
* Geef de waarde van isActueelEnGeldig.
*
* @return isActueelEnGeldig
*/
public boolean isActueelEnGeldig() {
return isActueelEnGeldig;
}
/**
* Zet de waarde van isActueelEnGeldig.
*
* @param actueelEnGeldig isActueelEnGeldig
*/
public void setActueelEnGeldig(final boolean actueelEnGeldig) {
isActueelEnGeldig = actueelEnGeldig;
}
/**
* Zet de waarden voor datum einde van PartijRol.
*
* @param datumEinde de nieuwe waarde voor datum einde van PartijRol
*/
public void setDatumEinde(final Integer datumEinde) {
this.datumEinde = datumEinde;
}
/**
* Geef de waarde van partij bijhouding historie set van PartijRol.
*
* @return de waarde van partij bijhouding historie set van PartijRol
*/
public Set<PartijRolHistorie> getPartijBijhoudingHistorieSet() {
return partijRolHistorieSet;
}
/**
* Toevoegen van een partijRolHistorie.
*
* @param partijRolHistorie partijRolHistorie
*/
public void addPartijBijhoudingHistorie(final PartijRolHistorie partijRolHistorie) {
partijRolHistorie.setPartijRol(this);
partijRolHistorieSet.add(partijRolHistorie);
}
/**
* Zet de waarden voor partijrol historie set van PartijRol.
*
* @param partijRolHistorieSet de nieuwe waarde voor partijrol historie set van PartijRol
*/
public void setPartijRolHistorieSet(final Set<PartijRolHistorie> partijRolHistorieSet) {
this.partijRolHistorieSet = partijRolHistorieSet;
}
}
| DDDNL/OperatieBRP | Broncode/operatiebrp-code-145.3/algemeen/alg-dal-entiteiten/src/main/java/nl/bzk/algemeenbrp/dal/domein/brp/entity/PartijRol.java | 2,055 | /**
* Zet de waarden voor id van PartijRol.
*
* @param id de nieuwe waarde voor id van PartijRol
*/ | 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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import java.util.LinkedHashSet;
import java.util.Set;
import javax.persistence.Access;
import javax.persistence.AccessType;
import javax.persistence.Cacheable;
import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.OneToMany;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import javax.persistence.UniqueConstraint;
import nl.bzk.algemeenbrp.dal.domein.brp.annotation.IndicatieActueelEnGeldig;
import nl.bzk.algemeenbrp.dal.domein.brp.enums.Rol;
import nl.bzk.algemeenbrp.dal.domein.brp.util.Geldigheid;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.Fetch;
import org.hibernate.annotations.FetchMode;
/**
* The persistent class for the partijrol database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "partijrol", schema = "kern", uniqueConstraints = @UniqueConstraint(columnNames = {"partij", "rol"}))
@Cacheable
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
@Access(AccessType.FIELD)
public class PartijRol extends AbstractEntiteit implements Afleidbaar, Serializable, DynamischeStamtabel, Geldigheid {
private static final long serialVersionUID = 1L;
private static final String PARTIJ_MAG_NIET_NULL_ZIJN = "partij mag niet null zijn";
@Id
@SequenceGenerator(name = "partijrol_id_generator", sequenceName = "kern.seq_partijrol", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "partijrol_id_generator")
@Column(nullable = false, updatable = false)
@Access(AccessType.PROPERTY)
private Integer id;
@ManyToOne(fetch = FetchType.LAZY)
@JoinColumn(name = "partij", nullable = false)
private Partij partij;
@Column(name = "rol", nullable = false)
private int rolId;
@Column(name = "datingang")
private Integer datumIngang;
@Column(name = "dateinde")
private Integer datumEinde;
@Column(name = "indag", nullable = false)
private boolean isActueelEnGeldig;
@IndicatieActueelEnGeldig(naam = "isActueelEnGeldig")
@OneToMany(fetch = FetchType.LAZY, mappedBy = "partijRol", cascade = CascadeType.ALL)
@Fetch(value = FetchMode.SELECT)
private Set<PartijRolHistorie> partijRolHistorieSet = new LinkedHashSet<>(0);
/**
* JPA default constructor.
*/
protected PartijRol() {}
/**
* Maak een nieuwe partij rol.
*
* @param partij partij
* @param rol rol
*/
public PartijRol(final Partij partij, final Rol rol) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
setRol(rol);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Integer getId() {
return id;
}
/**
* Zet de waarden<SUF>*/
public void setId(final Integer id) {
this.id = id;
}
/**
* Geef de waarde van partij van PartijRol.
*
* @return de waarde van partij van PartijRol
*/
public Partij getPartij() {
return partij;
}
/**
* Zet de waarden voor partij van PartijRol.
*
* @param partij de nieuwe waarde voor partij van PartijRol
*/
public void setPartij(final Partij partij) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
}
/**
* Geef de waarde van rol van PartijRol.
*
* @return de waarde van rol van PartijRol
*/
public Rol getRol() {
return Rol.parseId(rolId);
}
/**
* Zet de waarden voor rol van PartijRol.
*
* @param rol de nieuwe waarde voor rol van PartijRol
*/
public void setRol(final Rol rol) {
ValidationUtils.controleerOpNullWaarden("rol mag niet null zijn", rol);
rolId = rol.getId();
}
/**
* Geef de waarde van datum ingang van PartijRol.
*
* @return de waarde van datum ingang van PartijRol
*/
public Integer getDatumIngang() {
return datumIngang;
}
/**
* Zet de waarden voor datum ingang van PartijRol.
*
* @param datumIngang de nieuwe waarde voor datum ingang van PartijRol
*/
public void setDatumIngang(final Integer datumIngang) {
this.datumIngang = datumIngang;
}
/**
* Geef de waarde van datum einde van PartijRol.
*
* @return de waarde van datum einde van PartijRol
*/
public Integer getDatumEinde() {
return datumEinde;
}
/**
* Geef de waarde van isActueelEnGeldig.
*
* @return isActueelEnGeldig
*/
public boolean isActueelEnGeldig() {
return isActueelEnGeldig;
}
/**
* Zet de waarde van isActueelEnGeldig.
*
* @param actueelEnGeldig isActueelEnGeldig
*/
public void setActueelEnGeldig(final boolean actueelEnGeldig) {
isActueelEnGeldig = actueelEnGeldig;
}
/**
* Zet de waarden voor datum einde van PartijRol.
*
* @param datumEinde de nieuwe waarde voor datum einde van PartijRol
*/
public void setDatumEinde(final Integer datumEinde) {
this.datumEinde = datumEinde;
}
/**
* Geef de waarde van partij bijhouding historie set van PartijRol.
*
* @return de waarde van partij bijhouding historie set van PartijRol
*/
public Set<PartijRolHistorie> getPartijBijhoudingHistorieSet() {
return partijRolHistorieSet;
}
/**
* Toevoegen van een partijRolHistorie.
*
* @param partijRolHistorie partijRolHistorie
*/
public void addPartijBijhoudingHistorie(final PartijRolHistorie partijRolHistorie) {
partijRolHistorie.setPartijRol(this);
partijRolHistorieSet.add(partijRolHistorie);
}
/**
* Zet de waarden voor partijrol historie set van PartijRol.
*
* @param partijRolHistorieSet de nieuwe waarde voor partijrol historie set van PartijRol
*/
public void setPartijRolHistorieSet(final Set<PartijRolHistorie> partijRolHistorieSet) {
this.partijRolHistorieSet = partijRolHistorieSet;
}
}
|
202160_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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import java.util.LinkedHashSet;
import java.util.Set;
import javax.persistence.Access;
import javax.persistence.AccessType;
import javax.persistence.Cacheable;
import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.OneToMany;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import javax.persistence.UniqueConstraint;
import nl.bzk.algemeenbrp.dal.domein.brp.annotation.IndicatieActueelEnGeldig;
import nl.bzk.algemeenbrp.dal.domein.brp.enums.Rol;
import nl.bzk.algemeenbrp.dal.domein.brp.util.Geldigheid;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.Fetch;
import org.hibernate.annotations.FetchMode;
/**
* The persistent class for the partijrol database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "partijrol", schema = "kern", uniqueConstraints = @UniqueConstraint(columnNames = {"partij", "rol"}))
@Cacheable
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
@Access(AccessType.FIELD)
public class PartijRol extends AbstractEntiteit implements Afleidbaar, Serializable, DynamischeStamtabel, Geldigheid {
private static final long serialVersionUID = 1L;
private static final String PARTIJ_MAG_NIET_NULL_ZIJN = "partij mag niet null zijn";
@Id
@SequenceGenerator(name = "partijrol_id_generator", sequenceName = "kern.seq_partijrol", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "partijrol_id_generator")
@Column(nullable = false, updatable = false)
@Access(AccessType.PROPERTY)
private Integer id;
@ManyToOne(fetch = FetchType.LAZY)
@JoinColumn(name = "partij", nullable = false)
private Partij partij;
@Column(name = "rol", nullable = false)
private int rolId;
@Column(name = "datingang")
private Integer datumIngang;
@Column(name = "dateinde")
private Integer datumEinde;
@Column(name = "indag", nullable = false)
private boolean isActueelEnGeldig;
@IndicatieActueelEnGeldig(naam = "isActueelEnGeldig")
@OneToMany(fetch = FetchType.LAZY, mappedBy = "partijRol", cascade = CascadeType.ALL)
@Fetch(value = FetchMode.SELECT)
private Set<PartijRolHistorie> partijRolHistorieSet = new LinkedHashSet<>(0);
/**
* JPA default constructor.
*/
protected PartijRol() {}
/**
* Maak een nieuwe partij rol.
*
* @param partij partij
* @param rol rol
*/
public PartijRol(final Partij partij, final Rol rol) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
setRol(rol);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Integer getId() {
return id;
}
/**
* Zet de waarden voor id van PartijRol.
*
* @param id de nieuwe waarde voor id van PartijRol
*/
public void setId(final Integer id) {
this.id = id;
}
/**
* Geef de waarde van partij van PartijRol.
*
* @return de waarde van partij van PartijRol
*/
public Partij getPartij() {
return partij;
}
/**
* Zet de waarden voor partij van PartijRol.
*
* @param partij de nieuwe waarde voor partij van PartijRol
*/
public void setPartij(final Partij partij) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
}
/**
* Geef de waarde van rol van PartijRol.
*
* @return de waarde van rol van PartijRol
*/
public Rol getRol() {
return Rol.parseId(rolId);
}
/**
* Zet de waarden voor rol van PartijRol.
*
* @param rol de nieuwe waarde voor rol van PartijRol
*/
public void setRol(final Rol rol) {
ValidationUtils.controleerOpNullWaarden("rol mag niet null zijn", rol);
rolId = rol.getId();
}
/**
* Geef de waarde van datum ingang van PartijRol.
*
* @return de waarde van datum ingang van PartijRol
*/
public Integer getDatumIngang() {
return datumIngang;
}
/**
* Zet de waarden voor datum ingang van PartijRol.
*
* @param datumIngang de nieuwe waarde voor datum ingang van PartijRol
*/
public void setDatumIngang(final Integer datumIngang) {
this.datumIngang = datumIngang;
}
/**
* Geef de waarde van datum einde van PartijRol.
*
* @return de waarde van datum einde van PartijRol
*/
public Integer getDatumEinde() {
return datumEinde;
}
/**
* Geef de waarde van isActueelEnGeldig.
*
* @return isActueelEnGeldig
*/
public boolean isActueelEnGeldig() {
return isActueelEnGeldig;
}
/**
* Zet de waarde van isActueelEnGeldig.
*
* @param actueelEnGeldig isActueelEnGeldig
*/
public void setActueelEnGeldig(final boolean actueelEnGeldig) {
isActueelEnGeldig = actueelEnGeldig;
}
/**
* Zet de waarden voor datum einde van PartijRol.
*
* @param datumEinde de nieuwe waarde voor datum einde van PartijRol
*/
public void setDatumEinde(final Integer datumEinde) {
this.datumEinde = datumEinde;
}
/**
* Geef de waarde van partij bijhouding historie set van PartijRol.
*
* @return de waarde van partij bijhouding historie set van PartijRol
*/
public Set<PartijRolHistorie> getPartijBijhoudingHistorieSet() {
return partijRolHistorieSet;
}
/**
* Toevoegen van een partijRolHistorie.
*
* @param partijRolHistorie partijRolHistorie
*/
public void addPartijBijhoudingHistorie(final PartijRolHistorie partijRolHistorie) {
partijRolHistorie.setPartijRol(this);
partijRolHistorieSet.add(partijRolHistorie);
}
/**
* Zet de waarden voor partijrol historie set van PartijRol.
*
* @param partijRolHistorieSet de nieuwe waarde voor partijrol historie set van PartijRol
*/
public void setPartijRolHistorieSet(final Set<PartijRolHistorie> partijRolHistorieSet) {
this.partijRolHistorieSet = partijRolHistorieSet;
}
}
| DDDNL/OperatieBRP | Broncode/operatiebrp-code-145.3/algemeen/alg-dal-entiteiten/src/main/java/nl/bzk/algemeenbrp/dal/domein/brp/entity/PartijRol.java | 2,055 | /**
* Geef de waarde van partij van PartijRol.
*
* @return de waarde van partij van PartijRol
*/ | 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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import java.util.LinkedHashSet;
import java.util.Set;
import javax.persistence.Access;
import javax.persistence.AccessType;
import javax.persistence.Cacheable;
import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.OneToMany;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import javax.persistence.UniqueConstraint;
import nl.bzk.algemeenbrp.dal.domein.brp.annotation.IndicatieActueelEnGeldig;
import nl.bzk.algemeenbrp.dal.domein.brp.enums.Rol;
import nl.bzk.algemeenbrp.dal.domein.brp.util.Geldigheid;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.Fetch;
import org.hibernate.annotations.FetchMode;
/**
* The persistent class for the partijrol database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "partijrol", schema = "kern", uniqueConstraints = @UniqueConstraint(columnNames = {"partij", "rol"}))
@Cacheable
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
@Access(AccessType.FIELD)
public class PartijRol extends AbstractEntiteit implements Afleidbaar, Serializable, DynamischeStamtabel, Geldigheid {
private static final long serialVersionUID = 1L;
private static final String PARTIJ_MAG_NIET_NULL_ZIJN = "partij mag niet null zijn";
@Id
@SequenceGenerator(name = "partijrol_id_generator", sequenceName = "kern.seq_partijrol", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "partijrol_id_generator")
@Column(nullable = false, updatable = false)
@Access(AccessType.PROPERTY)
private Integer id;
@ManyToOne(fetch = FetchType.LAZY)
@JoinColumn(name = "partij", nullable = false)
private Partij partij;
@Column(name = "rol", nullable = false)
private int rolId;
@Column(name = "datingang")
private Integer datumIngang;
@Column(name = "dateinde")
private Integer datumEinde;
@Column(name = "indag", nullable = false)
private boolean isActueelEnGeldig;
@IndicatieActueelEnGeldig(naam = "isActueelEnGeldig")
@OneToMany(fetch = FetchType.LAZY, mappedBy = "partijRol", cascade = CascadeType.ALL)
@Fetch(value = FetchMode.SELECT)
private Set<PartijRolHistorie> partijRolHistorieSet = new LinkedHashSet<>(0);
/**
* JPA default constructor.
*/
protected PartijRol() {}
/**
* Maak een nieuwe partij rol.
*
* @param partij partij
* @param rol rol
*/
public PartijRol(final Partij partij, final Rol rol) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
setRol(rol);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Integer getId() {
return id;
}
/**
* Zet de waarden voor id van PartijRol.
*
* @param id de nieuwe waarde voor id van PartijRol
*/
public void setId(final Integer id) {
this.id = id;
}
/**
* Geef de waarde<SUF>*/
public Partij getPartij() {
return partij;
}
/**
* Zet de waarden voor partij van PartijRol.
*
* @param partij de nieuwe waarde voor partij van PartijRol
*/
public void setPartij(final Partij partij) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
}
/**
* Geef de waarde van rol van PartijRol.
*
* @return de waarde van rol van PartijRol
*/
public Rol getRol() {
return Rol.parseId(rolId);
}
/**
* Zet de waarden voor rol van PartijRol.
*
* @param rol de nieuwe waarde voor rol van PartijRol
*/
public void setRol(final Rol rol) {
ValidationUtils.controleerOpNullWaarden("rol mag niet null zijn", rol);
rolId = rol.getId();
}
/**
* Geef de waarde van datum ingang van PartijRol.
*
* @return de waarde van datum ingang van PartijRol
*/
public Integer getDatumIngang() {
return datumIngang;
}
/**
* Zet de waarden voor datum ingang van PartijRol.
*
* @param datumIngang de nieuwe waarde voor datum ingang van PartijRol
*/
public void setDatumIngang(final Integer datumIngang) {
this.datumIngang = datumIngang;
}
/**
* Geef de waarde van datum einde van PartijRol.
*
* @return de waarde van datum einde van PartijRol
*/
public Integer getDatumEinde() {
return datumEinde;
}
/**
* Geef de waarde van isActueelEnGeldig.
*
* @return isActueelEnGeldig
*/
public boolean isActueelEnGeldig() {
return isActueelEnGeldig;
}
/**
* Zet de waarde van isActueelEnGeldig.
*
* @param actueelEnGeldig isActueelEnGeldig
*/
public void setActueelEnGeldig(final boolean actueelEnGeldig) {
isActueelEnGeldig = actueelEnGeldig;
}
/**
* Zet de waarden voor datum einde van PartijRol.
*
* @param datumEinde de nieuwe waarde voor datum einde van PartijRol
*/
public void setDatumEinde(final Integer datumEinde) {
this.datumEinde = datumEinde;
}
/**
* Geef de waarde van partij bijhouding historie set van PartijRol.
*
* @return de waarde van partij bijhouding historie set van PartijRol
*/
public Set<PartijRolHistorie> getPartijBijhoudingHistorieSet() {
return partijRolHistorieSet;
}
/**
* Toevoegen van een partijRolHistorie.
*
* @param partijRolHistorie partijRolHistorie
*/
public void addPartijBijhoudingHistorie(final PartijRolHistorie partijRolHistorie) {
partijRolHistorie.setPartijRol(this);
partijRolHistorieSet.add(partijRolHistorie);
}
/**
* Zet de waarden voor partijrol historie set van PartijRol.
*
* @param partijRolHistorieSet de nieuwe waarde voor partijrol historie set van PartijRol
*/
public void setPartijRolHistorieSet(final Set<PartijRolHistorie> partijRolHistorieSet) {
this.partijRolHistorieSet = partijRolHistorieSet;
}
}
|
202160_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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import java.util.LinkedHashSet;
import java.util.Set;
import javax.persistence.Access;
import javax.persistence.AccessType;
import javax.persistence.Cacheable;
import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.OneToMany;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import javax.persistence.UniqueConstraint;
import nl.bzk.algemeenbrp.dal.domein.brp.annotation.IndicatieActueelEnGeldig;
import nl.bzk.algemeenbrp.dal.domein.brp.enums.Rol;
import nl.bzk.algemeenbrp.dal.domein.brp.util.Geldigheid;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.Fetch;
import org.hibernate.annotations.FetchMode;
/**
* The persistent class for the partijrol database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "partijrol", schema = "kern", uniqueConstraints = @UniqueConstraint(columnNames = {"partij", "rol"}))
@Cacheable
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
@Access(AccessType.FIELD)
public class PartijRol extends AbstractEntiteit implements Afleidbaar, Serializable, DynamischeStamtabel, Geldigheid {
private static final long serialVersionUID = 1L;
private static final String PARTIJ_MAG_NIET_NULL_ZIJN = "partij mag niet null zijn";
@Id
@SequenceGenerator(name = "partijrol_id_generator", sequenceName = "kern.seq_partijrol", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "partijrol_id_generator")
@Column(nullable = false, updatable = false)
@Access(AccessType.PROPERTY)
private Integer id;
@ManyToOne(fetch = FetchType.LAZY)
@JoinColumn(name = "partij", nullable = false)
private Partij partij;
@Column(name = "rol", nullable = false)
private int rolId;
@Column(name = "datingang")
private Integer datumIngang;
@Column(name = "dateinde")
private Integer datumEinde;
@Column(name = "indag", nullable = false)
private boolean isActueelEnGeldig;
@IndicatieActueelEnGeldig(naam = "isActueelEnGeldig")
@OneToMany(fetch = FetchType.LAZY, mappedBy = "partijRol", cascade = CascadeType.ALL)
@Fetch(value = FetchMode.SELECT)
private Set<PartijRolHistorie> partijRolHistorieSet = new LinkedHashSet<>(0);
/**
* JPA default constructor.
*/
protected PartijRol() {}
/**
* Maak een nieuwe partij rol.
*
* @param partij partij
* @param rol rol
*/
public PartijRol(final Partij partij, final Rol rol) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
setRol(rol);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Integer getId() {
return id;
}
/**
* Zet de waarden voor id van PartijRol.
*
* @param id de nieuwe waarde voor id van PartijRol
*/
public void setId(final Integer id) {
this.id = id;
}
/**
* Geef de waarde van partij van PartijRol.
*
* @return de waarde van partij van PartijRol
*/
public Partij getPartij() {
return partij;
}
/**
* Zet de waarden voor partij van PartijRol.
*
* @param partij de nieuwe waarde voor partij van PartijRol
*/
public void setPartij(final Partij partij) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
}
/**
* Geef de waarde van rol van PartijRol.
*
* @return de waarde van rol van PartijRol
*/
public Rol getRol() {
return Rol.parseId(rolId);
}
/**
* Zet de waarden voor rol van PartijRol.
*
* @param rol de nieuwe waarde voor rol van PartijRol
*/
public void setRol(final Rol rol) {
ValidationUtils.controleerOpNullWaarden("rol mag niet null zijn", rol);
rolId = rol.getId();
}
/**
* Geef de waarde van datum ingang van PartijRol.
*
* @return de waarde van datum ingang van PartijRol
*/
public Integer getDatumIngang() {
return datumIngang;
}
/**
* Zet de waarden voor datum ingang van PartijRol.
*
* @param datumIngang de nieuwe waarde voor datum ingang van PartijRol
*/
public void setDatumIngang(final Integer datumIngang) {
this.datumIngang = datumIngang;
}
/**
* Geef de waarde van datum einde van PartijRol.
*
* @return de waarde van datum einde van PartijRol
*/
public Integer getDatumEinde() {
return datumEinde;
}
/**
* Geef de waarde van isActueelEnGeldig.
*
* @return isActueelEnGeldig
*/
public boolean isActueelEnGeldig() {
return isActueelEnGeldig;
}
/**
* Zet de waarde van isActueelEnGeldig.
*
* @param actueelEnGeldig isActueelEnGeldig
*/
public void setActueelEnGeldig(final boolean actueelEnGeldig) {
isActueelEnGeldig = actueelEnGeldig;
}
/**
* Zet de waarden voor datum einde van PartijRol.
*
* @param datumEinde de nieuwe waarde voor datum einde van PartijRol
*/
public void setDatumEinde(final Integer datumEinde) {
this.datumEinde = datumEinde;
}
/**
* Geef de waarde van partij bijhouding historie set van PartijRol.
*
* @return de waarde van partij bijhouding historie set van PartijRol
*/
public Set<PartijRolHistorie> getPartijBijhoudingHistorieSet() {
return partijRolHistorieSet;
}
/**
* Toevoegen van een partijRolHistorie.
*
* @param partijRolHistorie partijRolHistorie
*/
public void addPartijBijhoudingHistorie(final PartijRolHistorie partijRolHistorie) {
partijRolHistorie.setPartijRol(this);
partijRolHistorieSet.add(partijRolHistorie);
}
/**
* Zet de waarden voor partijrol historie set van PartijRol.
*
* @param partijRolHistorieSet de nieuwe waarde voor partijrol historie set van PartijRol
*/
public void setPartijRolHistorieSet(final Set<PartijRolHistorie> partijRolHistorieSet) {
this.partijRolHistorieSet = partijRolHistorieSet;
}
}
| DDDNL/OperatieBRP | Broncode/operatiebrp-code-145.3/algemeen/alg-dal-entiteiten/src/main/java/nl/bzk/algemeenbrp/dal/domein/brp/entity/PartijRol.java | 2,055 | /**
* Zet de waarden voor partij van PartijRol.
*
* @param partij de nieuwe waarde voor partij van PartijRol
*/ | 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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import java.util.LinkedHashSet;
import java.util.Set;
import javax.persistence.Access;
import javax.persistence.AccessType;
import javax.persistence.Cacheable;
import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.OneToMany;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import javax.persistence.UniqueConstraint;
import nl.bzk.algemeenbrp.dal.domein.brp.annotation.IndicatieActueelEnGeldig;
import nl.bzk.algemeenbrp.dal.domein.brp.enums.Rol;
import nl.bzk.algemeenbrp.dal.domein.brp.util.Geldigheid;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.Fetch;
import org.hibernate.annotations.FetchMode;
/**
* The persistent class for the partijrol database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "partijrol", schema = "kern", uniqueConstraints = @UniqueConstraint(columnNames = {"partij", "rol"}))
@Cacheable
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
@Access(AccessType.FIELD)
public class PartijRol extends AbstractEntiteit implements Afleidbaar, Serializable, DynamischeStamtabel, Geldigheid {
private static final long serialVersionUID = 1L;
private static final String PARTIJ_MAG_NIET_NULL_ZIJN = "partij mag niet null zijn";
@Id
@SequenceGenerator(name = "partijrol_id_generator", sequenceName = "kern.seq_partijrol", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "partijrol_id_generator")
@Column(nullable = false, updatable = false)
@Access(AccessType.PROPERTY)
private Integer id;
@ManyToOne(fetch = FetchType.LAZY)
@JoinColumn(name = "partij", nullable = false)
private Partij partij;
@Column(name = "rol", nullable = false)
private int rolId;
@Column(name = "datingang")
private Integer datumIngang;
@Column(name = "dateinde")
private Integer datumEinde;
@Column(name = "indag", nullable = false)
private boolean isActueelEnGeldig;
@IndicatieActueelEnGeldig(naam = "isActueelEnGeldig")
@OneToMany(fetch = FetchType.LAZY, mappedBy = "partijRol", cascade = CascadeType.ALL)
@Fetch(value = FetchMode.SELECT)
private Set<PartijRolHistorie> partijRolHistorieSet = new LinkedHashSet<>(0);
/**
* JPA default constructor.
*/
protected PartijRol() {}
/**
* Maak een nieuwe partij rol.
*
* @param partij partij
* @param rol rol
*/
public PartijRol(final Partij partij, final Rol rol) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
setRol(rol);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Integer getId() {
return id;
}
/**
* Zet de waarden voor id van PartijRol.
*
* @param id de nieuwe waarde voor id van PartijRol
*/
public void setId(final Integer id) {
this.id = id;
}
/**
* Geef de waarde van partij van PartijRol.
*
* @return de waarde van partij van PartijRol
*/
public Partij getPartij() {
return partij;
}
/**
* Zet de waarden<SUF>*/
public void setPartij(final Partij partij) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
}
/**
* Geef de waarde van rol van PartijRol.
*
* @return de waarde van rol van PartijRol
*/
public Rol getRol() {
return Rol.parseId(rolId);
}
/**
* Zet de waarden voor rol van PartijRol.
*
* @param rol de nieuwe waarde voor rol van PartijRol
*/
public void setRol(final Rol rol) {
ValidationUtils.controleerOpNullWaarden("rol mag niet null zijn", rol);
rolId = rol.getId();
}
/**
* Geef de waarde van datum ingang van PartijRol.
*
* @return de waarde van datum ingang van PartijRol
*/
public Integer getDatumIngang() {
return datumIngang;
}
/**
* Zet de waarden voor datum ingang van PartijRol.
*
* @param datumIngang de nieuwe waarde voor datum ingang van PartijRol
*/
public void setDatumIngang(final Integer datumIngang) {
this.datumIngang = datumIngang;
}
/**
* Geef de waarde van datum einde van PartijRol.
*
* @return de waarde van datum einde van PartijRol
*/
public Integer getDatumEinde() {
return datumEinde;
}
/**
* Geef de waarde van isActueelEnGeldig.
*
* @return isActueelEnGeldig
*/
public boolean isActueelEnGeldig() {
return isActueelEnGeldig;
}
/**
* Zet de waarde van isActueelEnGeldig.
*
* @param actueelEnGeldig isActueelEnGeldig
*/
public void setActueelEnGeldig(final boolean actueelEnGeldig) {
isActueelEnGeldig = actueelEnGeldig;
}
/**
* Zet de waarden voor datum einde van PartijRol.
*
* @param datumEinde de nieuwe waarde voor datum einde van PartijRol
*/
public void setDatumEinde(final Integer datumEinde) {
this.datumEinde = datumEinde;
}
/**
* Geef de waarde van partij bijhouding historie set van PartijRol.
*
* @return de waarde van partij bijhouding historie set van PartijRol
*/
public Set<PartijRolHistorie> getPartijBijhoudingHistorieSet() {
return partijRolHistorieSet;
}
/**
* Toevoegen van een partijRolHistorie.
*
* @param partijRolHistorie partijRolHistorie
*/
public void addPartijBijhoudingHistorie(final PartijRolHistorie partijRolHistorie) {
partijRolHistorie.setPartijRol(this);
partijRolHistorieSet.add(partijRolHistorie);
}
/**
* Zet de waarden voor partijrol historie set van PartijRol.
*
* @param partijRolHistorieSet de nieuwe waarde voor partijrol historie set van PartijRol
*/
public void setPartijRolHistorieSet(final Set<PartijRolHistorie> partijRolHistorieSet) {
this.partijRolHistorieSet = partijRolHistorieSet;
}
}
|
202160_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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import java.util.LinkedHashSet;
import java.util.Set;
import javax.persistence.Access;
import javax.persistence.AccessType;
import javax.persistence.Cacheable;
import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.OneToMany;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import javax.persistence.UniqueConstraint;
import nl.bzk.algemeenbrp.dal.domein.brp.annotation.IndicatieActueelEnGeldig;
import nl.bzk.algemeenbrp.dal.domein.brp.enums.Rol;
import nl.bzk.algemeenbrp.dal.domein.brp.util.Geldigheid;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.Fetch;
import org.hibernate.annotations.FetchMode;
/**
* The persistent class for the partijrol database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "partijrol", schema = "kern", uniqueConstraints = @UniqueConstraint(columnNames = {"partij", "rol"}))
@Cacheable
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
@Access(AccessType.FIELD)
public class PartijRol extends AbstractEntiteit implements Afleidbaar, Serializable, DynamischeStamtabel, Geldigheid {
private static final long serialVersionUID = 1L;
private static final String PARTIJ_MAG_NIET_NULL_ZIJN = "partij mag niet null zijn";
@Id
@SequenceGenerator(name = "partijrol_id_generator", sequenceName = "kern.seq_partijrol", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "partijrol_id_generator")
@Column(nullable = false, updatable = false)
@Access(AccessType.PROPERTY)
private Integer id;
@ManyToOne(fetch = FetchType.LAZY)
@JoinColumn(name = "partij", nullable = false)
private Partij partij;
@Column(name = "rol", nullable = false)
private int rolId;
@Column(name = "datingang")
private Integer datumIngang;
@Column(name = "dateinde")
private Integer datumEinde;
@Column(name = "indag", nullable = false)
private boolean isActueelEnGeldig;
@IndicatieActueelEnGeldig(naam = "isActueelEnGeldig")
@OneToMany(fetch = FetchType.LAZY, mappedBy = "partijRol", cascade = CascadeType.ALL)
@Fetch(value = FetchMode.SELECT)
private Set<PartijRolHistorie> partijRolHistorieSet = new LinkedHashSet<>(0);
/**
* JPA default constructor.
*/
protected PartijRol() {}
/**
* Maak een nieuwe partij rol.
*
* @param partij partij
* @param rol rol
*/
public PartijRol(final Partij partij, final Rol rol) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
setRol(rol);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Integer getId() {
return id;
}
/**
* Zet de waarden voor id van PartijRol.
*
* @param id de nieuwe waarde voor id van PartijRol
*/
public void setId(final Integer id) {
this.id = id;
}
/**
* Geef de waarde van partij van PartijRol.
*
* @return de waarde van partij van PartijRol
*/
public Partij getPartij() {
return partij;
}
/**
* Zet de waarden voor partij van PartijRol.
*
* @param partij de nieuwe waarde voor partij van PartijRol
*/
public void setPartij(final Partij partij) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
}
/**
* Geef de waarde van rol van PartijRol.
*
* @return de waarde van rol van PartijRol
*/
public Rol getRol() {
return Rol.parseId(rolId);
}
/**
* Zet de waarden voor rol van PartijRol.
*
* @param rol de nieuwe waarde voor rol van PartijRol
*/
public void setRol(final Rol rol) {
ValidationUtils.controleerOpNullWaarden("rol mag niet null zijn", rol);
rolId = rol.getId();
}
/**
* Geef de waarde van datum ingang van PartijRol.
*
* @return de waarde van datum ingang van PartijRol
*/
public Integer getDatumIngang() {
return datumIngang;
}
/**
* Zet de waarden voor datum ingang van PartijRol.
*
* @param datumIngang de nieuwe waarde voor datum ingang van PartijRol
*/
public void setDatumIngang(final Integer datumIngang) {
this.datumIngang = datumIngang;
}
/**
* Geef de waarde van datum einde van PartijRol.
*
* @return de waarde van datum einde van PartijRol
*/
public Integer getDatumEinde() {
return datumEinde;
}
/**
* Geef de waarde van isActueelEnGeldig.
*
* @return isActueelEnGeldig
*/
public boolean isActueelEnGeldig() {
return isActueelEnGeldig;
}
/**
* Zet de waarde van isActueelEnGeldig.
*
* @param actueelEnGeldig isActueelEnGeldig
*/
public void setActueelEnGeldig(final boolean actueelEnGeldig) {
isActueelEnGeldig = actueelEnGeldig;
}
/**
* Zet de waarden voor datum einde van PartijRol.
*
* @param datumEinde de nieuwe waarde voor datum einde van PartijRol
*/
public void setDatumEinde(final Integer datumEinde) {
this.datumEinde = datumEinde;
}
/**
* Geef de waarde van partij bijhouding historie set van PartijRol.
*
* @return de waarde van partij bijhouding historie set van PartijRol
*/
public Set<PartijRolHistorie> getPartijBijhoudingHistorieSet() {
return partijRolHistorieSet;
}
/**
* Toevoegen van een partijRolHistorie.
*
* @param partijRolHistorie partijRolHistorie
*/
public void addPartijBijhoudingHistorie(final PartijRolHistorie partijRolHistorie) {
partijRolHistorie.setPartijRol(this);
partijRolHistorieSet.add(partijRolHistorie);
}
/**
* Zet de waarden voor partijrol historie set van PartijRol.
*
* @param partijRolHistorieSet de nieuwe waarde voor partijrol historie set van PartijRol
*/
public void setPartijRolHistorieSet(final Set<PartijRolHistorie> partijRolHistorieSet) {
this.partijRolHistorieSet = partijRolHistorieSet;
}
}
| DDDNL/OperatieBRP | Broncode/operatiebrp-code-145.3/algemeen/alg-dal-entiteiten/src/main/java/nl/bzk/algemeenbrp/dal/domein/brp/entity/PartijRol.java | 2,055 | /**
* Geef de waarde van rol van PartijRol.
*
* @return de waarde van rol van PartijRol
*/ | 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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import java.util.LinkedHashSet;
import java.util.Set;
import javax.persistence.Access;
import javax.persistence.AccessType;
import javax.persistence.Cacheable;
import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.OneToMany;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import javax.persistence.UniqueConstraint;
import nl.bzk.algemeenbrp.dal.domein.brp.annotation.IndicatieActueelEnGeldig;
import nl.bzk.algemeenbrp.dal.domein.brp.enums.Rol;
import nl.bzk.algemeenbrp.dal.domein.brp.util.Geldigheid;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.Fetch;
import org.hibernate.annotations.FetchMode;
/**
* The persistent class for the partijrol database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "partijrol", schema = "kern", uniqueConstraints = @UniqueConstraint(columnNames = {"partij", "rol"}))
@Cacheable
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
@Access(AccessType.FIELD)
public class PartijRol extends AbstractEntiteit implements Afleidbaar, Serializable, DynamischeStamtabel, Geldigheid {
private static final long serialVersionUID = 1L;
private static final String PARTIJ_MAG_NIET_NULL_ZIJN = "partij mag niet null zijn";
@Id
@SequenceGenerator(name = "partijrol_id_generator", sequenceName = "kern.seq_partijrol", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "partijrol_id_generator")
@Column(nullable = false, updatable = false)
@Access(AccessType.PROPERTY)
private Integer id;
@ManyToOne(fetch = FetchType.LAZY)
@JoinColumn(name = "partij", nullable = false)
private Partij partij;
@Column(name = "rol", nullable = false)
private int rolId;
@Column(name = "datingang")
private Integer datumIngang;
@Column(name = "dateinde")
private Integer datumEinde;
@Column(name = "indag", nullable = false)
private boolean isActueelEnGeldig;
@IndicatieActueelEnGeldig(naam = "isActueelEnGeldig")
@OneToMany(fetch = FetchType.LAZY, mappedBy = "partijRol", cascade = CascadeType.ALL)
@Fetch(value = FetchMode.SELECT)
private Set<PartijRolHistorie> partijRolHistorieSet = new LinkedHashSet<>(0);
/**
* JPA default constructor.
*/
protected PartijRol() {}
/**
* Maak een nieuwe partij rol.
*
* @param partij partij
* @param rol rol
*/
public PartijRol(final Partij partij, final Rol rol) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
setRol(rol);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Integer getId() {
return id;
}
/**
* Zet de waarden voor id van PartijRol.
*
* @param id de nieuwe waarde voor id van PartijRol
*/
public void setId(final Integer id) {
this.id = id;
}
/**
* Geef de waarde van partij van PartijRol.
*
* @return de waarde van partij van PartijRol
*/
public Partij getPartij() {
return partij;
}
/**
* Zet de waarden voor partij van PartijRol.
*
* @param partij de nieuwe waarde voor partij van PartijRol
*/
public void setPartij(final Partij partij) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
}
/**
* Geef de waarde<SUF>*/
public Rol getRol() {
return Rol.parseId(rolId);
}
/**
* Zet de waarden voor rol van PartijRol.
*
* @param rol de nieuwe waarde voor rol van PartijRol
*/
public void setRol(final Rol rol) {
ValidationUtils.controleerOpNullWaarden("rol mag niet null zijn", rol);
rolId = rol.getId();
}
/**
* Geef de waarde van datum ingang van PartijRol.
*
* @return de waarde van datum ingang van PartijRol
*/
public Integer getDatumIngang() {
return datumIngang;
}
/**
* Zet de waarden voor datum ingang van PartijRol.
*
* @param datumIngang de nieuwe waarde voor datum ingang van PartijRol
*/
public void setDatumIngang(final Integer datumIngang) {
this.datumIngang = datumIngang;
}
/**
* Geef de waarde van datum einde van PartijRol.
*
* @return de waarde van datum einde van PartijRol
*/
public Integer getDatumEinde() {
return datumEinde;
}
/**
* Geef de waarde van isActueelEnGeldig.
*
* @return isActueelEnGeldig
*/
public boolean isActueelEnGeldig() {
return isActueelEnGeldig;
}
/**
* Zet de waarde van isActueelEnGeldig.
*
* @param actueelEnGeldig isActueelEnGeldig
*/
public void setActueelEnGeldig(final boolean actueelEnGeldig) {
isActueelEnGeldig = actueelEnGeldig;
}
/**
* Zet de waarden voor datum einde van PartijRol.
*
* @param datumEinde de nieuwe waarde voor datum einde van PartijRol
*/
public void setDatumEinde(final Integer datumEinde) {
this.datumEinde = datumEinde;
}
/**
* Geef de waarde van partij bijhouding historie set van PartijRol.
*
* @return de waarde van partij bijhouding historie set van PartijRol
*/
public Set<PartijRolHistorie> getPartijBijhoudingHistorieSet() {
return partijRolHistorieSet;
}
/**
* Toevoegen van een partijRolHistorie.
*
* @param partijRolHistorie partijRolHistorie
*/
public void addPartijBijhoudingHistorie(final PartijRolHistorie partijRolHistorie) {
partijRolHistorie.setPartijRol(this);
partijRolHistorieSet.add(partijRolHistorie);
}
/**
* Zet de waarden voor partijrol historie set van PartijRol.
*
* @param partijRolHistorieSet de nieuwe waarde voor partijrol historie set van PartijRol
*/
public void setPartijRolHistorieSet(final Set<PartijRolHistorie> partijRolHistorieSet) {
this.partijRolHistorieSet = partijRolHistorieSet;
}
}
|
202160_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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import java.util.LinkedHashSet;
import java.util.Set;
import javax.persistence.Access;
import javax.persistence.AccessType;
import javax.persistence.Cacheable;
import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.OneToMany;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import javax.persistence.UniqueConstraint;
import nl.bzk.algemeenbrp.dal.domein.brp.annotation.IndicatieActueelEnGeldig;
import nl.bzk.algemeenbrp.dal.domein.brp.enums.Rol;
import nl.bzk.algemeenbrp.dal.domein.brp.util.Geldigheid;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.Fetch;
import org.hibernate.annotations.FetchMode;
/**
* The persistent class for the partijrol database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "partijrol", schema = "kern", uniqueConstraints = @UniqueConstraint(columnNames = {"partij", "rol"}))
@Cacheable
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
@Access(AccessType.FIELD)
public class PartijRol extends AbstractEntiteit implements Afleidbaar, Serializable, DynamischeStamtabel, Geldigheid {
private static final long serialVersionUID = 1L;
private static final String PARTIJ_MAG_NIET_NULL_ZIJN = "partij mag niet null zijn";
@Id
@SequenceGenerator(name = "partijrol_id_generator", sequenceName = "kern.seq_partijrol", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "partijrol_id_generator")
@Column(nullable = false, updatable = false)
@Access(AccessType.PROPERTY)
private Integer id;
@ManyToOne(fetch = FetchType.LAZY)
@JoinColumn(name = "partij", nullable = false)
private Partij partij;
@Column(name = "rol", nullable = false)
private int rolId;
@Column(name = "datingang")
private Integer datumIngang;
@Column(name = "dateinde")
private Integer datumEinde;
@Column(name = "indag", nullable = false)
private boolean isActueelEnGeldig;
@IndicatieActueelEnGeldig(naam = "isActueelEnGeldig")
@OneToMany(fetch = FetchType.LAZY, mappedBy = "partijRol", cascade = CascadeType.ALL)
@Fetch(value = FetchMode.SELECT)
private Set<PartijRolHistorie> partijRolHistorieSet = new LinkedHashSet<>(0);
/**
* JPA default constructor.
*/
protected PartijRol() {}
/**
* Maak een nieuwe partij rol.
*
* @param partij partij
* @param rol rol
*/
public PartijRol(final Partij partij, final Rol rol) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
setRol(rol);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Integer getId() {
return id;
}
/**
* Zet de waarden voor id van PartijRol.
*
* @param id de nieuwe waarde voor id van PartijRol
*/
public void setId(final Integer id) {
this.id = id;
}
/**
* Geef de waarde van partij van PartijRol.
*
* @return de waarde van partij van PartijRol
*/
public Partij getPartij() {
return partij;
}
/**
* Zet de waarden voor partij van PartijRol.
*
* @param partij de nieuwe waarde voor partij van PartijRol
*/
public void setPartij(final Partij partij) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
}
/**
* Geef de waarde van rol van PartijRol.
*
* @return de waarde van rol van PartijRol
*/
public Rol getRol() {
return Rol.parseId(rolId);
}
/**
* Zet de waarden voor rol van PartijRol.
*
* @param rol de nieuwe waarde voor rol van PartijRol
*/
public void setRol(final Rol rol) {
ValidationUtils.controleerOpNullWaarden("rol mag niet null zijn", rol);
rolId = rol.getId();
}
/**
* Geef de waarde van datum ingang van PartijRol.
*
* @return de waarde van datum ingang van PartijRol
*/
public Integer getDatumIngang() {
return datumIngang;
}
/**
* Zet de waarden voor datum ingang van PartijRol.
*
* @param datumIngang de nieuwe waarde voor datum ingang van PartijRol
*/
public void setDatumIngang(final Integer datumIngang) {
this.datumIngang = datumIngang;
}
/**
* Geef de waarde van datum einde van PartijRol.
*
* @return de waarde van datum einde van PartijRol
*/
public Integer getDatumEinde() {
return datumEinde;
}
/**
* Geef de waarde van isActueelEnGeldig.
*
* @return isActueelEnGeldig
*/
public boolean isActueelEnGeldig() {
return isActueelEnGeldig;
}
/**
* Zet de waarde van isActueelEnGeldig.
*
* @param actueelEnGeldig isActueelEnGeldig
*/
public void setActueelEnGeldig(final boolean actueelEnGeldig) {
isActueelEnGeldig = actueelEnGeldig;
}
/**
* Zet de waarden voor datum einde van PartijRol.
*
* @param datumEinde de nieuwe waarde voor datum einde van PartijRol
*/
public void setDatumEinde(final Integer datumEinde) {
this.datumEinde = datumEinde;
}
/**
* Geef de waarde van partij bijhouding historie set van PartijRol.
*
* @return de waarde van partij bijhouding historie set van PartijRol
*/
public Set<PartijRolHistorie> getPartijBijhoudingHistorieSet() {
return partijRolHistorieSet;
}
/**
* Toevoegen van een partijRolHistorie.
*
* @param partijRolHistorie partijRolHistorie
*/
public void addPartijBijhoudingHistorie(final PartijRolHistorie partijRolHistorie) {
partijRolHistorie.setPartijRol(this);
partijRolHistorieSet.add(partijRolHistorie);
}
/**
* Zet de waarden voor partijrol historie set van PartijRol.
*
* @param partijRolHistorieSet de nieuwe waarde voor partijrol historie set van PartijRol
*/
public void setPartijRolHistorieSet(final Set<PartijRolHistorie> partijRolHistorieSet) {
this.partijRolHistorieSet = partijRolHistorieSet;
}
}
| DDDNL/OperatieBRP | Broncode/operatiebrp-code-145.3/algemeen/alg-dal-entiteiten/src/main/java/nl/bzk/algemeenbrp/dal/domein/brp/entity/PartijRol.java | 2,055 | /**
* Zet de waarden voor rol van PartijRol.
*
* @param rol de nieuwe waarde voor rol van PartijRol
*/ | 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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import java.util.LinkedHashSet;
import java.util.Set;
import javax.persistence.Access;
import javax.persistence.AccessType;
import javax.persistence.Cacheable;
import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.OneToMany;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import javax.persistence.UniqueConstraint;
import nl.bzk.algemeenbrp.dal.domein.brp.annotation.IndicatieActueelEnGeldig;
import nl.bzk.algemeenbrp.dal.domein.brp.enums.Rol;
import nl.bzk.algemeenbrp.dal.domein.brp.util.Geldigheid;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.Fetch;
import org.hibernate.annotations.FetchMode;
/**
* The persistent class for the partijrol database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "partijrol", schema = "kern", uniqueConstraints = @UniqueConstraint(columnNames = {"partij", "rol"}))
@Cacheable
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
@Access(AccessType.FIELD)
public class PartijRol extends AbstractEntiteit implements Afleidbaar, Serializable, DynamischeStamtabel, Geldigheid {
private static final long serialVersionUID = 1L;
private static final String PARTIJ_MAG_NIET_NULL_ZIJN = "partij mag niet null zijn";
@Id
@SequenceGenerator(name = "partijrol_id_generator", sequenceName = "kern.seq_partijrol", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "partijrol_id_generator")
@Column(nullable = false, updatable = false)
@Access(AccessType.PROPERTY)
private Integer id;
@ManyToOne(fetch = FetchType.LAZY)
@JoinColumn(name = "partij", nullable = false)
private Partij partij;
@Column(name = "rol", nullable = false)
private int rolId;
@Column(name = "datingang")
private Integer datumIngang;
@Column(name = "dateinde")
private Integer datumEinde;
@Column(name = "indag", nullable = false)
private boolean isActueelEnGeldig;
@IndicatieActueelEnGeldig(naam = "isActueelEnGeldig")
@OneToMany(fetch = FetchType.LAZY, mappedBy = "partijRol", cascade = CascadeType.ALL)
@Fetch(value = FetchMode.SELECT)
private Set<PartijRolHistorie> partijRolHistorieSet = new LinkedHashSet<>(0);
/**
* JPA default constructor.
*/
protected PartijRol() {}
/**
* Maak een nieuwe partij rol.
*
* @param partij partij
* @param rol rol
*/
public PartijRol(final Partij partij, final Rol rol) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
setRol(rol);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Integer getId() {
return id;
}
/**
* Zet de waarden voor id van PartijRol.
*
* @param id de nieuwe waarde voor id van PartijRol
*/
public void setId(final Integer id) {
this.id = id;
}
/**
* Geef de waarde van partij van PartijRol.
*
* @return de waarde van partij van PartijRol
*/
public Partij getPartij() {
return partij;
}
/**
* Zet de waarden voor partij van PartijRol.
*
* @param partij de nieuwe waarde voor partij van PartijRol
*/
public void setPartij(final Partij partij) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
}
/**
* Geef de waarde van rol van PartijRol.
*
* @return de waarde van rol van PartijRol
*/
public Rol getRol() {
return Rol.parseId(rolId);
}
/**
* Zet de waarden<SUF>*/
public void setRol(final Rol rol) {
ValidationUtils.controleerOpNullWaarden("rol mag niet null zijn", rol);
rolId = rol.getId();
}
/**
* Geef de waarde van datum ingang van PartijRol.
*
* @return de waarde van datum ingang van PartijRol
*/
public Integer getDatumIngang() {
return datumIngang;
}
/**
* Zet de waarden voor datum ingang van PartijRol.
*
* @param datumIngang de nieuwe waarde voor datum ingang van PartijRol
*/
public void setDatumIngang(final Integer datumIngang) {
this.datumIngang = datumIngang;
}
/**
* Geef de waarde van datum einde van PartijRol.
*
* @return de waarde van datum einde van PartijRol
*/
public Integer getDatumEinde() {
return datumEinde;
}
/**
* Geef de waarde van isActueelEnGeldig.
*
* @return isActueelEnGeldig
*/
public boolean isActueelEnGeldig() {
return isActueelEnGeldig;
}
/**
* Zet de waarde van isActueelEnGeldig.
*
* @param actueelEnGeldig isActueelEnGeldig
*/
public void setActueelEnGeldig(final boolean actueelEnGeldig) {
isActueelEnGeldig = actueelEnGeldig;
}
/**
* Zet de waarden voor datum einde van PartijRol.
*
* @param datumEinde de nieuwe waarde voor datum einde van PartijRol
*/
public void setDatumEinde(final Integer datumEinde) {
this.datumEinde = datumEinde;
}
/**
* Geef de waarde van partij bijhouding historie set van PartijRol.
*
* @return de waarde van partij bijhouding historie set van PartijRol
*/
public Set<PartijRolHistorie> getPartijBijhoudingHistorieSet() {
return partijRolHistorieSet;
}
/**
* Toevoegen van een partijRolHistorie.
*
* @param partijRolHistorie partijRolHistorie
*/
public void addPartijBijhoudingHistorie(final PartijRolHistorie partijRolHistorie) {
partijRolHistorie.setPartijRol(this);
partijRolHistorieSet.add(partijRolHistorie);
}
/**
* Zet de waarden voor partijrol historie set van PartijRol.
*
* @param partijRolHistorieSet de nieuwe waarde voor partijrol historie set van PartijRol
*/
public void setPartijRolHistorieSet(final Set<PartijRolHistorie> partijRolHistorieSet) {
this.partijRolHistorieSet = partijRolHistorieSet;
}
}
|
202160_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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import java.util.LinkedHashSet;
import java.util.Set;
import javax.persistence.Access;
import javax.persistence.AccessType;
import javax.persistence.Cacheable;
import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.OneToMany;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import javax.persistence.UniqueConstraint;
import nl.bzk.algemeenbrp.dal.domein.brp.annotation.IndicatieActueelEnGeldig;
import nl.bzk.algemeenbrp.dal.domein.brp.enums.Rol;
import nl.bzk.algemeenbrp.dal.domein.brp.util.Geldigheid;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.Fetch;
import org.hibernate.annotations.FetchMode;
/**
* The persistent class for the partijrol database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "partijrol", schema = "kern", uniqueConstraints = @UniqueConstraint(columnNames = {"partij", "rol"}))
@Cacheable
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
@Access(AccessType.FIELD)
public class PartijRol extends AbstractEntiteit implements Afleidbaar, Serializable, DynamischeStamtabel, Geldigheid {
private static final long serialVersionUID = 1L;
private static final String PARTIJ_MAG_NIET_NULL_ZIJN = "partij mag niet null zijn";
@Id
@SequenceGenerator(name = "partijrol_id_generator", sequenceName = "kern.seq_partijrol", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "partijrol_id_generator")
@Column(nullable = false, updatable = false)
@Access(AccessType.PROPERTY)
private Integer id;
@ManyToOne(fetch = FetchType.LAZY)
@JoinColumn(name = "partij", nullable = false)
private Partij partij;
@Column(name = "rol", nullable = false)
private int rolId;
@Column(name = "datingang")
private Integer datumIngang;
@Column(name = "dateinde")
private Integer datumEinde;
@Column(name = "indag", nullable = false)
private boolean isActueelEnGeldig;
@IndicatieActueelEnGeldig(naam = "isActueelEnGeldig")
@OneToMany(fetch = FetchType.LAZY, mappedBy = "partijRol", cascade = CascadeType.ALL)
@Fetch(value = FetchMode.SELECT)
private Set<PartijRolHistorie> partijRolHistorieSet = new LinkedHashSet<>(0);
/**
* JPA default constructor.
*/
protected PartijRol() {}
/**
* Maak een nieuwe partij rol.
*
* @param partij partij
* @param rol rol
*/
public PartijRol(final Partij partij, final Rol rol) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
setRol(rol);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Integer getId() {
return id;
}
/**
* Zet de waarden voor id van PartijRol.
*
* @param id de nieuwe waarde voor id van PartijRol
*/
public void setId(final Integer id) {
this.id = id;
}
/**
* Geef de waarde van partij van PartijRol.
*
* @return de waarde van partij van PartijRol
*/
public Partij getPartij() {
return partij;
}
/**
* Zet de waarden voor partij van PartijRol.
*
* @param partij de nieuwe waarde voor partij van PartijRol
*/
public void setPartij(final Partij partij) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
}
/**
* Geef de waarde van rol van PartijRol.
*
* @return de waarde van rol van PartijRol
*/
public Rol getRol() {
return Rol.parseId(rolId);
}
/**
* Zet de waarden voor rol van PartijRol.
*
* @param rol de nieuwe waarde voor rol van PartijRol
*/
public void setRol(final Rol rol) {
ValidationUtils.controleerOpNullWaarden("rol mag niet null zijn", rol);
rolId = rol.getId();
}
/**
* Geef de waarde van datum ingang van PartijRol.
*
* @return de waarde van datum ingang van PartijRol
*/
public Integer getDatumIngang() {
return datumIngang;
}
/**
* Zet de waarden voor datum ingang van PartijRol.
*
* @param datumIngang de nieuwe waarde voor datum ingang van PartijRol
*/
public void setDatumIngang(final Integer datumIngang) {
this.datumIngang = datumIngang;
}
/**
* Geef de waarde van datum einde van PartijRol.
*
* @return de waarde van datum einde van PartijRol
*/
public Integer getDatumEinde() {
return datumEinde;
}
/**
* Geef de waarde van isActueelEnGeldig.
*
* @return isActueelEnGeldig
*/
public boolean isActueelEnGeldig() {
return isActueelEnGeldig;
}
/**
* Zet de waarde van isActueelEnGeldig.
*
* @param actueelEnGeldig isActueelEnGeldig
*/
public void setActueelEnGeldig(final boolean actueelEnGeldig) {
isActueelEnGeldig = actueelEnGeldig;
}
/**
* Zet de waarden voor datum einde van PartijRol.
*
* @param datumEinde de nieuwe waarde voor datum einde van PartijRol
*/
public void setDatumEinde(final Integer datumEinde) {
this.datumEinde = datumEinde;
}
/**
* Geef de waarde van partij bijhouding historie set van PartijRol.
*
* @return de waarde van partij bijhouding historie set van PartijRol
*/
public Set<PartijRolHistorie> getPartijBijhoudingHistorieSet() {
return partijRolHistorieSet;
}
/**
* Toevoegen van een partijRolHistorie.
*
* @param partijRolHistorie partijRolHistorie
*/
public void addPartijBijhoudingHistorie(final PartijRolHistorie partijRolHistorie) {
partijRolHistorie.setPartijRol(this);
partijRolHistorieSet.add(partijRolHistorie);
}
/**
* Zet de waarden voor partijrol historie set van PartijRol.
*
* @param partijRolHistorieSet de nieuwe waarde voor partijrol historie set van PartijRol
*/
public void setPartijRolHistorieSet(final Set<PartijRolHistorie> partijRolHistorieSet) {
this.partijRolHistorieSet = partijRolHistorieSet;
}
}
| DDDNL/OperatieBRP | Broncode/operatiebrp-code-145.3/algemeen/alg-dal-entiteiten/src/main/java/nl/bzk/algemeenbrp/dal/domein/brp/entity/PartijRol.java | 2,055 | /**
* Geef de waarde van datum ingang van PartijRol.
*
* @return de waarde van datum ingang van PartijRol
*/ | 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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import java.util.LinkedHashSet;
import java.util.Set;
import javax.persistence.Access;
import javax.persistence.AccessType;
import javax.persistence.Cacheable;
import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.OneToMany;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import javax.persistence.UniqueConstraint;
import nl.bzk.algemeenbrp.dal.domein.brp.annotation.IndicatieActueelEnGeldig;
import nl.bzk.algemeenbrp.dal.domein.brp.enums.Rol;
import nl.bzk.algemeenbrp.dal.domein.brp.util.Geldigheid;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.Fetch;
import org.hibernate.annotations.FetchMode;
/**
* The persistent class for the partijrol database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "partijrol", schema = "kern", uniqueConstraints = @UniqueConstraint(columnNames = {"partij", "rol"}))
@Cacheable
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
@Access(AccessType.FIELD)
public class PartijRol extends AbstractEntiteit implements Afleidbaar, Serializable, DynamischeStamtabel, Geldigheid {
private static final long serialVersionUID = 1L;
private static final String PARTIJ_MAG_NIET_NULL_ZIJN = "partij mag niet null zijn";
@Id
@SequenceGenerator(name = "partijrol_id_generator", sequenceName = "kern.seq_partijrol", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "partijrol_id_generator")
@Column(nullable = false, updatable = false)
@Access(AccessType.PROPERTY)
private Integer id;
@ManyToOne(fetch = FetchType.LAZY)
@JoinColumn(name = "partij", nullable = false)
private Partij partij;
@Column(name = "rol", nullable = false)
private int rolId;
@Column(name = "datingang")
private Integer datumIngang;
@Column(name = "dateinde")
private Integer datumEinde;
@Column(name = "indag", nullable = false)
private boolean isActueelEnGeldig;
@IndicatieActueelEnGeldig(naam = "isActueelEnGeldig")
@OneToMany(fetch = FetchType.LAZY, mappedBy = "partijRol", cascade = CascadeType.ALL)
@Fetch(value = FetchMode.SELECT)
private Set<PartijRolHistorie> partijRolHistorieSet = new LinkedHashSet<>(0);
/**
* JPA default constructor.
*/
protected PartijRol() {}
/**
* Maak een nieuwe partij rol.
*
* @param partij partij
* @param rol rol
*/
public PartijRol(final Partij partij, final Rol rol) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
setRol(rol);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Integer getId() {
return id;
}
/**
* Zet de waarden voor id van PartijRol.
*
* @param id de nieuwe waarde voor id van PartijRol
*/
public void setId(final Integer id) {
this.id = id;
}
/**
* Geef de waarde van partij van PartijRol.
*
* @return de waarde van partij van PartijRol
*/
public Partij getPartij() {
return partij;
}
/**
* Zet de waarden voor partij van PartijRol.
*
* @param partij de nieuwe waarde voor partij van PartijRol
*/
public void setPartij(final Partij partij) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
}
/**
* Geef de waarde van rol van PartijRol.
*
* @return de waarde van rol van PartijRol
*/
public Rol getRol() {
return Rol.parseId(rolId);
}
/**
* Zet de waarden voor rol van PartijRol.
*
* @param rol de nieuwe waarde voor rol van PartijRol
*/
public void setRol(final Rol rol) {
ValidationUtils.controleerOpNullWaarden("rol mag niet null zijn", rol);
rolId = rol.getId();
}
/**
* Geef de waarde<SUF>*/
public Integer getDatumIngang() {
return datumIngang;
}
/**
* Zet de waarden voor datum ingang van PartijRol.
*
* @param datumIngang de nieuwe waarde voor datum ingang van PartijRol
*/
public void setDatumIngang(final Integer datumIngang) {
this.datumIngang = datumIngang;
}
/**
* Geef de waarde van datum einde van PartijRol.
*
* @return de waarde van datum einde van PartijRol
*/
public Integer getDatumEinde() {
return datumEinde;
}
/**
* Geef de waarde van isActueelEnGeldig.
*
* @return isActueelEnGeldig
*/
public boolean isActueelEnGeldig() {
return isActueelEnGeldig;
}
/**
* Zet de waarde van isActueelEnGeldig.
*
* @param actueelEnGeldig isActueelEnGeldig
*/
public void setActueelEnGeldig(final boolean actueelEnGeldig) {
isActueelEnGeldig = actueelEnGeldig;
}
/**
* Zet de waarden voor datum einde van PartijRol.
*
* @param datumEinde de nieuwe waarde voor datum einde van PartijRol
*/
public void setDatumEinde(final Integer datumEinde) {
this.datumEinde = datumEinde;
}
/**
* Geef de waarde van partij bijhouding historie set van PartijRol.
*
* @return de waarde van partij bijhouding historie set van PartijRol
*/
public Set<PartijRolHistorie> getPartijBijhoudingHistorieSet() {
return partijRolHistorieSet;
}
/**
* Toevoegen van een partijRolHistorie.
*
* @param partijRolHistorie partijRolHistorie
*/
public void addPartijBijhoudingHistorie(final PartijRolHistorie partijRolHistorie) {
partijRolHistorie.setPartijRol(this);
partijRolHistorieSet.add(partijRolHistorie);
}
/**
* Zet de waarden voor partijrol historie set van PartijRol.
*
* @param partijRolHistorieSet de nieuwe waarde voor partijrol historie set van PartijRol
*/
public void setPartijRolHistorieSet(final Set<PartijRolHistorie> partijRolHistorieSet) {
this.partijRolHistorieSet = partijRolHistorieSet;
}
}
|
202160_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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import java.util.LinkedHashSet;
import java.util.Set;
import javax.persistence.Access;
import javax.persistence.AccessType;
import javax.persistence.Cacheable;
import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.OneToMany;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import javax.persistence.UniqueConstraint;
import nl.bzk.algemeenbrp.dal.domein.brp.annotation.IndicatieActueelEnGeldig;
import nl.bzk.algemeenbrp.dal.domein.brp.enums.Rol;
import nl.bzk.algemeenbrp.dal.domein.brp.util.Geldigheid;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.Fetch;
import org.hibernate.annotations.FetchMode;
/**
* The persistent class for the partijrol database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "partijrol", schema = "kern", uniqueConstraints = @UniqueConstraint(columnNames = {"partij", "rol"}))
@Cacheable
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
@Access(AccessType.FIELD)
public class PartijRol extends AbstractEntiteit implements Afleidbaar, Serializable, DynamischeStamtabel, Geldigheid {
private static final long serialVersionUID = 1L;
private static final String PARTIJ_MAG_NIET_NULL_ZIJN = "partij mag niet null zijn";
@Id
@SequenceGenerator(name = "partijrol_id_generator", sequenceName = "kern.seq_partijrol", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "partijrol_id_generator")
@Column(nullable = false, updatable = false)
@Access(AccessType.PROPERTY)
private Integer id;
@ManyToOne(fetch = FetchType.LAZY)
@JoinColumn(name = "partij", nullable = false)
private Partij partij;
@Column(name = "rol", nullable = false)
private int rolId;
@Column(name = "datingang")
private Integer datumIngang;
@Column(name = "dateinde")
private Integer datumEinde;
@Column(name = "indag", nullable = false)
private boolean isActueelEnGeldig;
@IndicatieActueelEnGeldig(naam = "isActueelEnGeldig")
@OneToMany(fetch = FetchType.LAZY, mappedBy = "partijRol", cascade = CascadeType.ALL)
@Fetch(value = FetchMode.SELECT)
private Set<PartijRolHistorie> partijRolHistorieSet = new LinkedHashSet<>(0);
/**
* JPA default constructor.
*/
protected PartijRol() {}
/**
* Maak een nieuwe partij rol.
*
* @param partij partij
* @param rol rol
*/
public PartijRol(final Partij partij, final Rol rol) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
setRol(rol);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Integer getId() {
return id;
}
/**
* Zet de waarden voor id van PartijRol.
*
* @param id de nieuwe waarde voor id van PartijRol
*/
public void setId(final Integer id) {
this.id = id;
}
/**
* Geef de waarde van partij van PartijRol.
*
* @return de waarde van partij van PartijRol
*/
public Partij getPartij() {
return partij;
}
/**
* Zet de waarden voor partij van PartijRol.
*
* @param partij de nieuwe waarde voor partij van PartijRol
*/
public void setPartij(final Partij partij) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
}
/**
* Geef de waarde van rol van PartijRol.
*
* @return de waarde van rol van PartijRol
*/
public Rol getRol() {
return Rol.parseId(rolId);
}
/**
* Zet de waarden voor rol van PartijRol.
*
* @param rol de nieuwe waarde voor rol van PartijRol
*/
public void setRol(final Rol rol) {
ValidationUtils.controleerOpNullWaarden("rol mag niet null zijn", rol);
rolId = rol.getId();
}
/**
* Geef de waarde van datum ingang van PartijRol.
*
* @return de waarde van datum ingang van PartijRol
*/
public Integer getDatumIngang() {
return datumIngang;
}
/**
* Zet de waarden voor datum ingang van PartijRol.
*
* @param datumIngang de nieuwe waarde voor datum ingang van PartijRol
*/
public void setDatumIngang(final Integer datumIngang) {
this.datumIngang = datumIngang;
}
/**
* Geef de waarde van datum einde van PartijRol.
*
* @return de waarde van datum einde van PartijRol
*/
public Integer getDatumEinde() {
return datumEinde;
}
/**
* Geef de waarde van isActueelEnGeldig.
*
* @return isActueelEnGeldig
*/
public boolean isActueelEnGeldig() {
return isActueelEnGeldig;
}
/**
* Zet de waarde van isActueelEnGeldig.
*
* @param actueelEnGeldig isActueelEnGeldig
*/
public void setActueelEnGeldig(final boolean actueelEnGeldig) {
isActueelEnGeldig = actueelEnGeldig;
}
/**
* Zet de waarden voor datum einde van PartijRol.
*
* @param datumEinde de nieuwe waarde voor datum einde van PartijRol
*/
public void setDatumEinde(final Integer datumEinde) {
this.datumEinde = datumEinde;
}
/**
* Geef de waarde van partij bijhouding historie set van PartijRol.
*
* @return de waarde van partij bijhouding historie set van PartijRol
*/
public Set<PartijRolHistorie> getPartijBijhoudingHistorieSet() {
return partijRolHistorieSet;
}
/**
* Toevoegen van een partijRolHistorie.
*
* @param partijRolHistorie partijRolHistorie
*/
public void addPartijBijhoudingHistorie(final PartijRolHistorie partijRolHistorie) {
partijRolHistorie.setPartijRol(this);
partijRolHistorieSet.add(partijRolHistorie);
}
/**
* Zet de waarden voor partijrol historie set van PartijRol.
*
* @param partijRolHistorieSet de nieuwe waarde voor partijrol historie set van PartijRol
*/
public void setPartijRolHistorieSet(final Set<PartijRolHistorie> partijRolHistorieSet) {
this.partijRolHistorieSet = partijRolHistorieSet;
}
}
| DDDNL/OperatieBRP | Broncode/operatiebrp-code-145.3/algemeen/alg-dal-entiteiten/src/main/java/nl/bzk/algemeenbrp/dal/domein/brp/entity/PartijRol.java | 2,055 | /**
* Zet de waarden voor datum ingang van PartijRol.
*
* @param datumIngang de nieuwe waarde voor datum ingang van PartijRol
*/ | 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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import java.util.LinkedHashSet;
import java.util.Set;
import javax.persistence.Access;
import javax.persistence.AccessType;
import javax.persistence.Cacheable;
import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.OneToMany;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import javax.persistence.UniqueConstraint;
import nl.bzk.algemeenbrp.dal.domein.brp.annotation.IndicatieActueelEnGeldig;
import nl.bzk.algemeenbrp.dal.domein.brp.enums.Rol;
import nl.bzk.algemeenbrp.dal.domein.brp.util.Geldigheid;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.Fetch;
import org.hibernate.annotations.FetchMode;
/**
* The persistent class for the partijrol database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "partijrol", schema = "kern", uniqueConstraints = @UniqueConstraint(columnNames = {"partij", "rol"}))
@Cacheable
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
@Access(AccessType.FIELD)
public class PartijRol extends AbstractEntiteit implements Afleidbaar, Serializable, DynamischeStamtabel, Geldigheid {
private static final long serialVersionUID = 1L;
private static final String PARTIJ_MAG_NIET_NULL_ZIJN = "partij mag niet null zijn";
@Id
@SequenceGenerator(name = "partijrol_id_generator", sequenceName = "kern.seq_partijrol", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "partijrol_id_generator")
@Column(nullable = false, updatable = false)
@Access(AccessType.PROPERTY)
private Integer id;
@ManyToOne(fetch = FetchType.LAZY)
@JoinColumn(name = "partij", nullable = false)
private Partij partij;
@Column(name = "rol", nullable = false)
private int rolId;
@Column(name = "datingang")
private Integer datumIngang;
@Column(name = "dateinde")
private Integer datumEinde;
@Column(name = "indag", nullable = false)
private boolean isActueelEnGeldig;
@IndicatieActueelEnGeldig(naam = "isActueelEnGeldig")
@OneToMany(fetch = FetchType.LAZY, mappedBy = "partijRol", cascade = CascadeType.ALL)
@Fetch(value = FetchMode.SELECT)
private Set<PartijRolHistorie> partijRolHistorieSet = new LinkedHashSet<>(0);
/**
* JPA default constructor.
*/
protected PartijRol() {}
/**
* Maak een nieuwe partij rol.
*
* @param partij partij
* @param rol rol
*/
public PartijRol(final Partij partij, final Rol rol) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
setRol(rol);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Integer getId() {
return id;
}
/**
* Zet de waarden voor id van PartijRol.
*
* @param id de nieuwe waarde voor id van PartijRol
*/
public void setId(final Integer id) {
this.id = id;
}
/**
* Geef de waarde van partij van PartijRol.
*
* @return de waarde van partij van PartijRol
*/
public Partij getPartij() {
return partij;
}
/**
* Zet de waarden voor partij van PartijRol.
*
* @param partij de nieuwe waarde voor partij van PartijRol
*/
public void setPartij(final Partij partij) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
}
/**
* Geef de waarde van rol van PartijRol.
*
* @return de waarde van rol van PartijRol
*/
public Rol getRol() {
return Rol.parseId(rolId);
}
/**
* Zet de waarden voor rol van PartijRol.
*
* @param rol de nieuwe waarde voor rol van PartijRol
*/
public void setRol(final Rol rol) {
ValidationUtils.controleerOpNullWaarden("rol mag niet null zijn", rol);
rolId = rol.getId();
}
/**
* Geef de waarde van datum ingang van PartijRol.
*
* @return de waarde van datum ingang van PartijRol
*/
public Integer getDatumIngang() {
return datumIngang;
}
/**
* Zet de waarden<SUF>*/
public void setDatumIngang(final Integer datumIngang) {
this.datumIngang = datumIngang;
}
/**
* Geef de waarde van datum einde van PartijRol.
*
* @return de waarde van datum einde van PartijRol
*/
public Integer getDatumEinde() {
return datumEinde;
}
/**
* Geef de waarde van isActueelEnGeldig.
*
* @return isActueelEnGeldig
*/
public boolean isActueelEnGeldig() {
return isActueelEnGeldig;
}
/**
* Zet de waarde van isActueelEnGeldig.
*
* @param actueelEnGeldig isActueelEnGeldig
*/
public void setActueelEnGeldig(final boolean actueelEnGeldig) {
isActueelEnGeldig = actueelEnGeldig;
}
/**
* Zet de waarden voor datum einde van PartijRol.
*
* @param datumEinde de nieuwe waarde voor datum einde van PartijRol
*/
public void setDatumEinde(final Integer datumEinde) {
this.datumEinde = datumEinde;
}
/**
* Geef de waarde van partij bijhouding historie set van PartijRol.
*
* @return de waarde van partij bijhouding historie set van PartijRol
*/
public Set<PartijRolHistorie> getPartijBijhoudingHistorieSet() {
return partijRolHistorieSet;
}
/**
* Toevoegen van een partijRolHistorie.
*
* @param partijRolHistorie partijRolHistorie
*/
public void addPartijBijhoudingHistorie(final PartijRolHistorie partijRolHistorie) {
partijRolHistorie.setPartijRol(this);
partijRolHistorieSet.add(partijRolHistorie);
}
/**
* Zet de waarden voor partijrol historie set van PartijRol.
*
* @param partijRolHistorieSet de nieuwe waarde voor partijrol historie set van PartijRol
*/
public void setPartijRolHistorieSet(final Set<PartijRolHistorie> partijRolHistorieSet) {
this.partijRolHistorieSet = partijRolHistorieSet;
}
}
|
202160_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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import java.util.LinkedHashSet;
import java.util.Set;
import javax.persistence.Access;
import javax.persistence.AccessType;
import javax.persistence.Cacheable;
import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.OneToMany;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import javax.persistence.UniqueConstraint;
import nl.bzk.algemeenbrp.dal.domein.brp.annotation.IndicatieActueelEnGeldig;
import nl.bzk.algemeenbrp.dal.domein.brp.enums.Rol;
import nl.bzk.algemeenbrp.dal.domein.brp.util.Geldigheid;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.Fetch;
import org.hibernate.annotations.FetchMode;
/**
* The persistent class for the partijrol database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "partijrol", schema = "kern", uniqueConstraints = @UniqueConstraint(columnNames = {"partij", "rol"}))
@Cacheable
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
@Access(AccessType.FIELD)
public class PartijRol extends AbstractEntiteit implements Afleidbaar, Serializable, DynamischeStamtabel, Geldigheid {
private static final long serialVersionUID = 1L;
private static final String PARTIJ_MAG_NIET_NULL_ZIJN = "partij mag niet null zijn";
@Id
@SequenceGenerator(name = "partijrol_id_generator", sequenceName = "kern.seq_partijrol", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "partijrol_id_generator")
@Column(nullable = false, updatable = false)
@Access(AccessType.PROPERTY)
private Integer id;
@ManyToOne(fetch = FetchType.LAZY)
@JoinColumn(name = "partij", nullable = false)
private Partij partij;
@Column(name = "rol", nullable = false)
private int rolId;
@Column(name = "datingang")
private Integer datumIngang;
@Column(name = "dateinde")
private Integer datumEinde;
@Column(name = "indag", nullable = false)
private boolean isActueelEnGeldig;
@IndicatieActueelEnGeldig(naam = "isActueelEnGeldig")
@OneToMany(fetch = FetchType.LAZY, mappedBy = "partijRol", cascade = CascadeType.ALL)
@Fetch(value = FetchMode.SELECT)
private Set<PartijRolHistorie> partijRolHistorieSet = new LinkedHashSet<>(0);
/**
* JPA default constructor.
*/
protected PartijRol() {}
/**
* Maak een nieuwe partij rol.
*
* @param partij partij
* @param rol rol
*/
public PartijRol(final Partij partij, final Rol rol) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
setRol(rol);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Integer getId() {
return id;
}
/**
* Zet de waarden voor id van PartijRol.
*
* @param id de nieuwe waarde voor id van PartijRol
*/
public void setId(final Integer id) {
this.id = id;
}
/**
* Geef de waarde van partij van PartijRol.
*
* @return de waarde van partij van PartijRol
*/
public Partij getPartij() {
return partij;
}
/**
* Zet de waarden voor partij van PartijRol.
*
* @param partij de nieuwe waarde voor partij van PartijRol
*/
public void setPartij(final Partij partij) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
}
/**
* Geef de waarde van rol van PartijRol.
*
* @return de waarde van rol van PartijRol
*/
public Rol getRol() {
return Rol.parseId(rolId);
}
/**
* Zet de waarden voor rol van PartijRol.
*
* @param rol de nieuwe waarde voor rol van PartijRol
*/
public void setRol(final Rol rol) {
ValidationUtils.controleerOpNullWaarden("rol mag niet null zijn", rol);
rolId = rol.getId();
}
/**
* Geef de waarde van datum ingang van PartijRol.
*
* @return de waarde van datum ingang van PartijRol
*/
public Integer getDatumIngang() {
return datumIngang;
}
/**
* Zet de waarden voor datum ingang van PartijRol.
*
* @param datumIngang de nieuwe waarde voor datum ingang van PartijRol
*/
public void setDatumIngang(final Integer datumIngang) {
this.datumIngang = datumIngang;
}
/**
* Geef de waarde van datum einde van PartijRol.
*
* @return de waarde van datum einde van PartijRol
*/
public Integer getDatumEinde() {
return datumEinde;
}
/**
* Geef de waarde van isActueelEnGeldig.
*
* @return isActueelEnGeldig
*/
public boolean isActueelEnGeldig() {
return isActueelEnGeldig;
}
/**
* Zet de waarde van isActueelEnGeldig.
*
* @param actueelEnGeldig isActueelEnGeldig
*/
public void setActueelEnGeldig(final boolean actueelEnGeldig) {
isActueelEnGeldig = actueelEnGeldig;
}
/**
* Zet de waarden voor datum einde van PartijRol.
*
* @param datumEinde de nieuwe waarde voor datum einde van PartijRol
*/
public void setDatumEinde(final Integer datumEinde) {
this.datumEinde = datumEinde;
}
/**
* Geef de waarde van partij bijhouding historie set van PartijRol.
*
* @return de waarde van partij bijhouding historie set van PartijRol
*/
public Set<PartijRolHistorie> getPartijBijhoudingHistorieSet() {
return partijRolHistorieSet;
}
/**
* Toevoegen van een partijRolHistorie.
*
* @param partijRolHistorie partijRolHistorie
*/
public void addPartijBijhoudingHistorie(final PartijRolHistorie partijRolHistorie) {
partijRolHistorie.setPartijRol(this);
partijRolHistorieSet.add(partijRolHistorie);
}
/**
* Zet de waarden voor partijrol historie set van PartijRol.
*
* @param partijRolHistorieSet de nieuwe waarde voor partijrol historie set van PartijRol
*/
public void setPartijRolHistorieSet(final Set<PartijRolHistorie> partijRolHistorieSet) {
this.partijRolHistorieSet = partijRolHistorieSet;
}
}
| DDDNL/OperatieBRP | Broncode/operatiebrp-code-145.3/algemeen/alg-dal-entiteiten/src/main/java/nl/bzk/algemeenbrp/dal/domein/brp/entity/PartijRol.java | 2,055 | /**
* Geef de waarde van datum einde van PartijRol.
*
* @return de waarde van datum einde van PartijRol
*/ | 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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import java.util.LinkedHashSet;
import java.util.Set;
import javax.persistence.Access;
import javax.persistence.AccessType;
import javax.persistence.Cacheable;
import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.OneToMany;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import javax.persistence.UniqueConstraint;
import nl.bzk.algemeenbrp.dal.domein.brp.annotation.IndicatieActueelEnGeldig;
import nl.bzk.algemeenbrp.dal.domein.brp.enums.Rol;
import nl.bzk.algemeenbrp.dal.domein.brp.util.Geldigheid;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.Fetch;
import org.hibernate.annotations.FetchMode;
/**
* The persistent class for the partijrol database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "partijrol", schema = "kern", uniqueConstraints = @UniqueConstraint(columnNames = {"partij", "rol"}))
@Cacheable
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
@Access(AccessType.FIELD)
public class PartijRol extends AbstractEntiteit implements Afleidbaar, Serializable, DynamischeStamtabel, Geldigheid {
private static final long serialVersionUID = 1L;
private static final String PARTIJ_MAG_NIET_NULL_ZIJN = "partij mag niet null zijn";
@Id
@SequenceGenerator(name = "partijrol_id_generator", sequenceName = "kern.seq_partijrol", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "partijrol_id_generator")
@Column(nullable = false, updatable = false)
@Access(AccessType.PROPERTY)
private Integer id;
@ManyToOne(fetch = FetchType.LAZY)
@JoinColumn(name = "partij", nullable = false)
private Partij partij;
@Column(name = "rol", nullable = false)
private int rolId;
@Column(name = "datingang")
private Integer datumIngang;
@Column(name = "dateinde")
private Integer datumEinde;
@Column(name = "indag", nullable = false)
private boolean isActueelEnGeldig;
@IndicatieActueelEnGeldig(naam = "isActueelEnGeldig")
@OneToMany(fetch = FetchType.LAZY, mappedBy = "partijRol", cascade = CascadeType.ALL)
@Fetch(value = FetchMode.SELECT)
private Set<PartijRolHistorie> partijRolHistorieSet = new LinkedHashSet<>(0);
/**
* JPA default constructor.
*/
protected PartijRol() {}
/**
* Maak een nieuwe partij rol.
*
* @param partij partij
* @param rol rol
*/
public PartijRol(final Partij partij, final Rol rol) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
setRol(rol);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Integer getId() {
return id;
}
/**
* Zet de waarden voor id van PartijRol.
*
* @param id de nieuwe waarde voor id van PartijRol
*/
public void setId(final Integer id) {
this.id = id;
}
/**
* Geef de waarde van partij van PartijRol.
*
* @return de waarde van partij van PartijRol
*/
public Partij getPartij() {
return partij;
}
/**
* Zet de waarden voor partij van PartijRol.
*
* @param partij de nieuwe waarde voor partij van PartijRol
*/
public void setPartij(final Partij partij) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
}
/**
* Geef de waarde van rol van PartijRol.
*
* @return de waarde van rol van PartijRol
*/
public Rol getRol() {
return Rol.parseId(rolId);
}
/**
* Zet de waarden voor rol van PartijRol.
*
* @param rol de nieuwe waarde voor rol van PartijRol
*/
public void setRol(final Rol rol) {
ValidationUtils.controleerOpNullWaarden("rol mag niet null zijn", rol);
rolId = rol.getId();
}
/**
* Geef de waarde van datum ingang van PartijRol.
*
* @return de waarde van datum ingang van PartijRol
*/
public Integer getDatumIngang() {
return datumIngang;
}
/**
* Zet de waarden voor datum ingang van PartijRol.
*
* @param datumIngang de nieuwe waarde voor datum ingang van PartijRol
*/
public void setDatumIngang(final Integer datumIngang) {
this.datumIngang = datumIngang;
}
/**
* Geef de waarde<SUF>*/
public Integer getDatumEinde() {
return datumEinde;
}
/**
* Geef de waarde van isActueelEnGeldig.
*
* @return isActueelEnGeldig
*/
public boolean isActueelEnGeldig() {
return isActueelEnGeldig;
}
/**
* Zet de waarde van isActueelEnGeldig.
*
* @param actueelEnGeldig isActueelEnGeldig
*/
public void setActueelEnGeldig(final boolean actueelEnGeldig) {
isActueelEnGeldig = actueelEnGeldig;
}
/**
* Zet de waarden voor datum einde van PartijRol.
*
* @param datumEinde de nieuwe waarde voor datum einde van PartijRol
*/
public void setDatumEinde(final Integer datumEinde) {
this.datumEinde = datumEinde;
}
/**
* Geef de waarde van partij bijhouding historie set van PartijRol.
*
* @return de waarde van partij bijhouding historie set van PartijRol
*/
public Set<PartijRolHistorie> getPartijBijhoudingHistorieSet() {
return partijRolHistorieSet;
}
/**
* Toevoegen van een partijRolHistorie.
*
* @param partijRolHistorie partijRolHistorie
*/
public void addPartijBijhoudingHistorie(final PartijRolHistorie partijRolHistorie) {
partijRolHistorie.setPartijRol(this);
partijRolHistorieSet.add(partijRolHistorie);
}
/**
* Zet de waarden voor partijrol historie set van PartijRol.
*
* @param partijRolHistorieSet de nieuwe waarde voor partijrol historie set van PartijRol
*/
public void setPartijRolHistorieSet(final Set<PartijRolHistorie> partijRolHistorieSet) {
this.partijRolHistorieSet = partijRolHistorieSet;
}
}
|
202160_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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import java.util.LinkedHashSet;
import java.util.Set;
import javax.persistence.Access;
import javax.persistence.AccessType;
import javax.persistence.Cacheable;
import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.OneToMany;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import javax.persistence.UniqueConstraint;
import nl.bzk.algemeenbrp.dal.domein.brp.annotation.IndicatieActueelEnGeldig;
import nl.bzk.algemeenbrp.dal.domein.brp.enums.Rol;
import nl.bzk.algemeenbrp.dal.domein.brp.util.Geldigheid;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.Fetch;
import org.hibernate.annotations.FetchMode;
/**
* The persistent class for the partijrol database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "partijrol", schema = "kern", uniqueConstraints = @UniqueConstraint(columnNames = {"partij", "rol"}))
@Cacheable
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
@Access(AccessType.FIELD)
public class PartijRol extends AbstractEntiteit implements Afleidbaar, Serializable, DynamischeStamtabel, Geldigheid {
private static final long serialVersionUID = 1L;
private static final String PARTIJ_MAG_NIET_NULL_ZIJN = "partij mag niet null zijn";
@Id
@SequenceGenerator(name = "partijrol_id_generator", sequenceName = "kern.seq_partijrol", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "partijrol_id_generator")
@Column(nullable = false, updatable = false)
@Access(AccessType.PROPERTY)
private Integer id;
@ManyToOne(fetch = FetchType.LAZY)
@JoinColumn(name = "partij", nullable = false)
private Partij partij;
@Column(name = "rol", nullable = false)
private int rolId;
@Column(name = "datingang")
private Integer datumIngang;
@Column(name = "dateinde")
private Integer datumEinde;
@Column(name = "indag", nullable = false)
private boolean isActueelEnGeldig;
@IndicatieActueelEnGeldig(naam = "isActueelEnGeldig")
@OneToMany(fetch = FetchType.LAZY, mappedBy = "partijRol", cascade = CascadeType.ALL)
@Fetch(value = FetchMode.SELECT)
private Set<PartijRolHistorie> partijRolHistorieSet = new LinkedHashSet<>(0);
/**
* JPA default constructor.
*/
protected PartijRol() {}
/**
* Maak een nieuwe partij rol.
*
* @param partij partij
* @param rol rol
*/
public PartijRol(final Partij partij, final Rol rol) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
setRol(rol);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Integer getId() {
return id;
}
/**
* Zet de waarden voor id van PartijRol.
*
* @param id de nieuwe waarde voor id van PartijRol
*/
public void setId(final Integer id) {
this.id = id;
}
/**
* Geef de waarde van partij van PartijRol.
*
* @return de waarde van partij van PartijRol
*/
public Partij getPartij() {
return partij;
}
/**
* Zet de waarden voor partij van PartijRol.
*
* @param partij de nieuwe waarde voor partij van PartijRol
*/
public void setPartij(final Partij partij) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
}
/**
* Geef de waarde van rol van PartijRol.
*
* @return de waarde van rol van PartijRol
*/
public Rol getRol() {
return Rol.parseId(rolId);
}
/**
* Zet de waarden voor rol van PartijRol.
*
* @param rol de nieuwe waarde voor rol van PartijRol
*/
public void setRol(final Rol rol) {
ValidationUtils.controleerOpNullWaarden("rol mag niet null zijn", rol);
rolId = rol.getId();
}
/**
* Geef de waarde van datum ingang van PartijRol.
*
* @return de waarde van datum ingang van PartijRol
*/
public Integer getDatumIngang() {
return datumIngang;
}
/**
* Zet de waarden voor datum ingang van PartijRol.
*
* @param datumIngang de nieuwe waarde voor datum ingang van PartijRol
*/
public void setDatumIngang(final Integer datumIngang) {
this.datumIngang = datumIngang;
}
/**
* Geef de waarde van datum einde van PartijRol.
*
* @return de waarde van datum einde van PartijRol
*/
public Integer getDatumEinde() {
return datumEinde;
}
/**
* Geef de waarde van isActueelEnGeldig.
*
* @return isActueelEnGeldig
*/
public boolean isActueelEnGeldig() {
return isActueelEnGeldig;
}
/**
* Zet de waarde van isActueelEnGeldig.
*
* @param actueelEnGeldig isActueelEnGeldig
*/
public void setActueelEnGeldig(final boolean actueelEnGeldig) {
isActueelEnGeldig = actueelEnGeldig;
}
/**
* Zet de waarden voor datum einde van PartijRol.
*
* @param datumEinde de nieuwe waarde voor datum einde van PartijRol
*/
public void setDatumEinde(final Integer datumEinde) {
this.datumEinde = datumEinde;
}
/**
* Geef de waarde van partij bijhouding historie set van PartijRol.
*
* @return de waarde van partij bijhouding historie set van PartijRol
*/
public Set<PartijRolHistorie> getPartijBijhoudingHistorieSet() {
return partijRolHistorieSet;
}
/**
* Toevoegen van een partijRolHistorie.
*
* @param partijRolHistorie partijRolHistorie
*/
public void addPartijBijhoudingHistorie(final PartijRolHistorie partijRolHistorie) {
partijRolHistorie.setPartijRol(this);
partijRolHistorieSet.add(partijRolHistorie);
}
/**
* Zet de waarden voor partijrol historie set van PartijRol.
*
* @param partijRolHistorieSet de nieuwe waarde voor partijrol historie set van PartijRol
*/
public void setPartijRolHistorieSet(final Set<PartijRolHistorie> partijRolHistorieSet) {
this.partijRolHistorieSet = partijRolHistorieSet;
}
}
| DDDNL/OperatieBRP | Broncode/operatiebrp-code-145.3/algemeen/alg-dal-entiteiten/src/main/java/nl/bzk/algemeenbrp/dal/domein/brp/entity/PartijRol.java | 2,055 | /**
* Geef de waarde van isActueelEnGeldig.
*
* @return isActueelEnGeldig
*/ | 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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import java.util.LinkedHashSet;
import java.util.Set;
import javax.persistence.Access;
import javax.persistence.AccessType;
import javax.persistence.Cacheable;
import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.OneToMany;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import javax.persistence.UniqueConstraint;
import nl.bzk.algemeenbrp.dal.domein.brp.annotation.IndicatieActueelEnGeldig;
import nl.bzk.algemeenbrp.dal.domein.brp.enums.Rol;
import nl.bzk.algemeenbrp.dal.domein.brp.util.Geldigheid;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.Fetch;
import org.hibernate.annotations.FetchMode;
/**
* The persistent class for the partijrol database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "partijrol", schema = "kern", uniqueConstraints = @UniqueConstraint(columnNames = {"partij", "rol"}))
@Cacheable
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
@Access(AccessType.FIELD)
public class PartijRol extends AbstractEntiteit implements Afleidbaar, Serializable, DynamischeStamtabel, Geldigheid {
private static final long serialVersionUID = 1L;
private static final String PARTIJ_MAG_NIET_NULL_ZIJN = "partij mag niet null zijn";
@Id
@SequenceGenerator(name = "partijrol_id_generator", sequenceName = "kern.seq_partijrol", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "partijrol_id_generator")
@Column(nullable = false, updatable = false)
@Access(AccessType.PROPERTY)
private Integer id;
@ManyToOne(fetch = FetchType.LAZY)
@JoinColumn(name = "partij", nullable = false)
private Partij partij;
@Column(name = "rol", nullable = false)
private int rolId;
@Column(name = "datingang")
private Integer datumIngang;
@Column(name = "dateinde")
private Integer datumEinde;
@Column(name = "indag", nullable = false)
private boolean isActueelEnGeldig;
@IndicatieActueelEnGeldig(naam = "isActueelEnGeldig")
@OneToMany(fetch = FetchType.LAZY, mappedBy = "partijRol", cascade = CascadeType.ALL)
@Fetch(value = FetchMode.SELECT)
private Set<PartijRolHistorie> partijRolHistorieSet = new LinkedHashSet<>(0);
/**
* JPA default constructor.
*/
protected PartijRol() {}
/**
* Maak een nieuwe partij rol.
*
* @param partij partij
* @param rol rol
*/
public PartijRol(final Partij partij, final Rol rol) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
setRol(rol);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Integer getId() {
return id;
}
/**
* Zet de waarden voor id van PartijRol.
*
* @param id de nieuwe waarde voor id van PartijRol
*/
public void setId(final Integer id) {
this.id = id;
}
/**
* Geef de waarde van partij van PartijRol.
*
* @return de waarde van partij van PartijRol
*/
public Partij getPartij() {
return partij;
}
/**
* Zet de waarden voor partij van PartijRol.
*
* @param partij de nieuwe waarde voor partij van PartijRol
*/
public void setPartij(final Partij partij) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
}
/**
* Geef de waarde van rol van PartijRol.
*
* @return de waarde van rol van PartijRol
*/
public Rol getRol() {
return Rol.parseId(rolId);
}
/**
* Zet de waarden voor rol van PartijRol.
*
* @param rol de nieuwe waarde voor rol van PartijRol
*/
public void setRol(final Rol rol) {
ValidationUtils.controleerOpNullWaarden("rol mag niet null zijn", rol);
rolId = rol.getId();
}
/**
* Geef de waarde van datum ingang van PartijRol.
*
* @return de waarde van datum ingang van PartijRol
*/
public Integer getDatumIngang() {
return datumIngang;
}
/**
* Zet de waarden voor datum ingang van PartijRol.
*
* @param datumIngang de nieuwe waarde voor datum ingang van PartijRol
*/
public void setDatumIngang(final Integer datumIngang) {
this.datumIngang = datumIngang;
}
/**
* Geef de waarde van datum einde van PartijRol.
*
* @return de waarde van datum einde van PartijRol
*/
public Integer getDatumEinde() {
return datumEinde;
}
/**
* Geef de waarde<SUF>*/
public boolean isActueelEnGeldig() {
return isActueelEnGeldig;
}
/**
* Zet de waarde van isActueelEnGeldig.
*
* @param actueelEnGeldig isActueelEnGeldig
*/
public void setActueelEnGeldig(final boolean actueelEnGeldig) {
isActueelEnGeldig = actueelEnGeldig;
}
/**
* Zet de waarden voor datum einde van PartijRol.
*
* @param datumEinde de nieuwe waarde voor datum einde van PartijRol
*/
public void setDatumEinde(final Integer datumEinde) {
this.datumEinde = datumEinde;
}
/**
* Geef de waarde van partij bijhouding historie set van PartijRol.
*
* @return de waarde van partij bijhouding historie set van PartijRol
*/
public Set<PartijRolHistorie> getPartijBijhoudingHistorieSet() {
return partijRolHistorieSet;
}
/**
* Toevoegen van een partijRolHistorie.
*
* @param partijRolHistorie partijRolHistorie
*/
public void addPartijBijhoudingHistorie(final PartijRolHistorie partijRolHistorie) {
partijRolHistorie.setPartijRol(this);
partijRolHistorieSet.add(partijRolHistorie);
}
/**
* Zet de waarden voor partijrol historie set van PartijRol.
*
* @param partijRolHistorieSet de nieuwe waarde voor partijrol historie set van PartijRol
*/
public void setPartijRolHistorieSet(final Set<PartijRolHistorie> partijRolHistorieSet) {
this.partijRolHistorieSet = partijRolHistorieSet;
}
}
|
202160_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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import java.util.LinkedHashSet;
import java.util.Set;
import javax.persistence.Access;
import javax.persistence.AccessType;
import javax.persistence.Cacheable;
import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.OneToMany;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import javax.persistence.UniqueConstraint;
import nl.bzk.algemeenbrp.dal.domein.brp.annotation.IndicatieActueelEnGeldig;
import nl.bzk.algemeenbrp.dal.domein.brp.enums.Rol;
import nl.bzk.algemeenbrp.dal.domein.brp.util.Geldigheid;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.Fetch;
import org.hibernate.annotations.FetchMode;
/**
* The persistent class for the partijrol database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "partijrol", schema = "kern", uniqueConstraints = @UniqueConstraint(columnNames = {"partij", "rol"}))
@Cacheable
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
@Access(AccessType.FIELD)
public class PartijRol extends AbstractEntiteit implements Afleidbaar, Serializable, DynamischeStamtabel, Geldigheid {
private static final long serialVersionUID = 1L;
private static final String PARTIJ_MAG_NIET_NULL_ZIJN = "partij mag niet null zijn";
@Id
@SequenceGenerator(name = "partijrol_id_generator", sequenceName = "kern.seq_partijrol", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "partijrol_id_generator")
@Column(nullable = false, updatable = false)
@Access(AccessType.PROPERTY)
private Integer id;
@ManyToOne(fetch = FetchType.LAZY)
@JoinColumn(name = "partij", nullable = false)
private Partij partij;
@Column(name = "rol", nullable = false)
private int rolId;
@Column(name = "datingang")
private Integer datumIngang;
@Column(name = "dateinde")
private Integer datumEinde;
@Column(name = "indag", nullable = false)
private boolean isActueelEnGeldig;
@IndicatieActueelEnGeldig(naam = "isActueelEnGeldig")
@OneToMany(fetch = FetchType.LAZY, mappedBy = "partijRol", cascade = CascadeType.ALL)
@Fetch(value = FetchMode.SELECT)
private Set<PartijRolHistorie> partijRolHistorieSet = new LinkedHashSet<>(0);
/**
* JPA default constructor.
*/
protected PartijRol() {}
/**
* Maak een nieuwe partij rol.
*
* @param partij partij
* @param rol rol
*/
public PartijRol(final Partij partij, final Rol rol) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
setRol(rol);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Integer getId() {
return id;
}
/**
* Zet de waarden voor id van PartijRol.
*
* @param id de nieuwe waarde voor id van PartijRol
*/
public void setId(final Integer id) {
this.id = id;
}
/**
* Geef de waarde van partij van PartijRol.
*
* @return de waarde van partij van PartijRol
*/
public Partij getPartij() {
return partij;
}
/**
* Zet de waarden voor partij van PartijRol.
*
* @param partij de nieuwe waarde voor partij van PartijRol
*/
public void setPartij(final Partij partij) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
}
/**
* Geef de waarde van rol van PartijRol.
*
* @return de waarde van rol van PartijRol
*/
public Rol getRol() {
return Rol.parseId(rolId);
}
/**
* Zet de waarden voor rol van PartijRol.
*
* @param rol de nieuwe waarde voor rol van PartijRol
*/
public void setRol(final Rol rol) {
ValidationUtils.controleerOpNullWaarden("rol mag niet null zijn", rol);
rolId = rol.getId();
}
/**
* Geef de waarde van datum ingang van PartijRol.
*
* @return de waarde van datum ingang van PartijRol
*/
public Integer getDatumIngang() {
return datumIngang;
}
/**
* Zet de waarden voor datum ingang van PartijRol.
*
* @param datumIngang de nieuwe waarde voor datum ingang van PartijRol
*/
public void setDatumIngang(final Integer datumIngang) {
this.datumIngang = datumIngang;
}
/**
* Geef de waarde van datum einde van PartijRol.
*
* @return de waarde van datum einde van PartijRol
*/
public Integer getDatumEinde() {
return datumEinde;
}
/**
* Geef de waarde van isActueelEnGeldig.
*
* @return isActueelEnGeldig
*/
public boolean isActueelEnGeldig() {
return isActueelEnGeldig;
}
/**
* Zet de waarde van isActueelEnGeldig.
*
* @param actueelEnGeldig isActueelEnGeldig
*/
public void setActueelEnGeldig(final boolean actueelEnGeldig) {
isActueelEnGeldig = actueelEnGeldig;
}
/**
* Zet de waarden voor datum einde van PartijRol.
*
* @param datumEinde de nieuwe waarde voor datum einde van PartijRol
*/
public void setDatumEinde(final Integer datumEinde) {
this.datumEinde = datumEinde;
}
/**
* Geef de waarde van partij bijhouding historie set van PartijRol.
*
* @return de waarde van partij bijhouding historie set van PartijRol
*/
public Set<PartijRolHistorie> getPartijBijhoudingHistorieSet() {
return partijRolHistorieSet;
}
/**
* Toevoegen van een partijRolHistorie.
*
* @param partijRolHistorie partijRolHistorie
*/
public void addPartijBijhoudingHistorie(final PartijRolHistorie partijRolHistorie) {
partijRolHistorie.setPartijRol(this);
partijRolHistorieSet.add(partijRolHistorie);
}
/**
* Zet de waarden voor partijrol historie set van PartijRol.
*
* @param partijRolHistorieSet de nieuwe waarde voor partijrol historie set van PartijRol
*/
public void setPartijRolHistorieSet(final Set<PartijRolHistorie> partijRolHistorieSet) {
this.partijRolHistorieSet = partijRolHistorieSet;
}
}
| DDDNL/OperatieBRP | Broncode/operatiebrp-code-145.3/algemeen/alg-dal-entiteiten/src/main/java/nl/bzk/algemeenbrp/dal/domein/brp/entity/PartijRol.java | 2,055 | /**
* Zet de waarde van isActueelEnGeldig.
*
* @param actueelEnGeldig isActueelEnGeldig
*/ | 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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import java.util.LinkedHashSet;
import java.util.Set;
import javax.persistence.Access;
import javax.persistence.AccessType;
import javax.persistence.Cacheable;
import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.OneToMany;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import javax.persistence.UniqueConstraint;
import nl.bzk.algemeenbrp.dal.domein.brp.annotation.IndicatieActueelEnGeldig;
import nl.bzk.algemeenbrp.dal.domein.brp.enums.Rol;
import nl.bzk.algemeenbrp.dal.domein.brp.util.Geldigheid;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.Fetch;
import org.hibernate.annotations.FetchMode;
/**
* The persistent class for the partijrol database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "partijrol", schema = "kern", uniqueConstraints = @UniqueConstraint(columnNames = {"partij", "rol"}))
@Cacheable
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
@Access(AccessType.FIELD)
public class PartijRol extends AbstractEntiteit implements Afleidbaar, Serializable, DynamischeStamtabel, Geldigheid {
private static final long serialVersionUID = 1L;
private static final String PARTIJ_MAG_NIET_NULL_ZIJN = "partij mag niet null zijn";
@Id
@SequenceGenerator(name = "partijrol_id_generator", sequenceName = "kern.seq_partijrol", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "partijrol_id_generator")
@Column(nullable = false, updatable = false)
@Access(AccessType.PROPERTY)
private Integer id;
@ManyToOne(fetch = FetchType.LAZY)
@JoinColumn(name = "partij", nullable = false)
private Partij partij;
@Column(name = "rol", nullable = false)
private int rolId;
@Column(name = "datingang")
private Integer datumIngang;
@Column(name = "dateinde")
private Integer datumEinde;
@Column(name = "indag", nullable = false)
private boolean isActueelEnGeldig;
@IndicatieActueelEnGeldig(naam = "isActueelEnGeldig")
@OneToMany(fetch = FetchType.LAZY, mappedBy = "partijRol", cascade = CascadeType.ALL)
@Fetch(value = FetchMode.SELECT)
private Set<PartijRolHistorie> partijRolHistorieSet = new LinkedHashSet<>(0);
/**
* JPA default constructor.
*/
protected PartijRol() {}
/**
* Maak een nieuwe partij rol.
*
* @param partij partij
* @param rol rol
*/
public PartijRol(final Partij partij, final Rol rol) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
setRol(rol);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Integer getId() {
return id;
}
/**
* Zet de waarden voor id van PartijRol.
*
* @param id de nieuwe waarde voor id van PartijRol
*/
public void setId(final Integer id) {
this.id = id;
}
/**
* Geef de waarde van partij van PartijRol.
*
* @return de waarde van partij van PartijRol
*/
public Partij getPartij() {
return partij;
}
/**
* Zet de waarden voor partij van PartijRol.
*
* @param partij de nieuwe waarde voor partij van PartijRol
*/
public void setPartij(final Partij partij) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
}
/**
* Geef de waarde van rol van PartijRol.
*
* @return de waarde van rol van PartijRol
*/
public Rol getRol() {
return Rol.parseId(rolId);
}
/**
* Zet de waarden voor rol van PartijRol.
*
* @param rol de nieuwe waarde voor rol van PartijRol
*/
public void setRol(final Rol rol) {
ValidationUtils.controleerOpNullWaarden("rol mag niet null zijn", rol);
rolId = rol.getId();
}
/**
* Geef de waarde van datum ingang van PartijRol.
*
* @return de waarde van datum ingang van PartijRol
*/
public Integer getDatumIngang() {
return datumIngang;
}
/**
* Zet de waarden voor datum ingang van PartijRol.
*
* @param datumIngang de nieuwe waarde voor datum ingang van PartijRol
*/
public void setDatumIngang(final Integer datumIngang) {
this.datumIngang = datumIngang;
}
/**
* Geef de waarde van datum einde van PartijRol.
*
* @return de waarde van datum einde van PartijRol
*/
public Integer getDatumEinde() {
return datumEinde;
}
/**
* Geef de waarde van isActueelEnGeldig.
*
* @return isActueelEnGeldig
*/
public boolean isActueelEnGeldig() {
return isActueelEnGeldig;
}
/**
* Zet de waarde<SUF>*/
public void setActueelEnGeldig(final boolean actueelEnGeldig) {
isActueelEnGeldig = actueelEnGeldig;
}
/**
* Zet de waarden voor datum einde van PartijRol.
*
* @param datumEinde de nieuwe waarde voor datum einde van PartijRol
*/
public void setDatumEinde(final Integer datumEinde) {
this.datumEinde = datumEinde;
}
/**
* Geef de waarde van partij bijhouding historie set van PartijRol.
*
* @return de waarde van partij bijhouding historie set van PartijRol
*/
public Set<PartijRolHistorie> getPartijBijhoudingHistorieSet() {
return partijRolHistorieSet;
}
/**
* Toevoegen van een partijRolHistorie.
*
* @param partijRolHistorie partijRolHistorie
*/
public void addPartijBijhoudingHistorie(final PartijRolHistorie partijRolHistorie) {
partijRolHistorie.setPartijRol(this);
partijRolHistorieSet.add(partijRolHistorie);
}
/**
* Zet de waarden voor partijrol historie set van PartijRol.
*
* @param partijRolHistorieSet de nieuwe waarde voor partijrol historie set van PartijRol
*/
public void setPartijRolHistorieSet(final Set<PartijRolHistorie> partijRolHistorieSet) {
this.partijRolHistorieSet = partijRolHistorieSet;
}
}
|
202160_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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import java.util.LinkedHashSet;
import java.util.Set;
import javax.persistence.Access;
import javax.persistence.AccessType;
import javax.persistence.Cacheable;
import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.OneToMany;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import javax.persistence.UniqueConstraint;
import nl.bzk.algemeenbrp.dal.domein.brp.annotation.IndicatieActueelEnGeldig;
import nl.bzk.algemeenbrp.dal.domein.brp.enums.Rol;
import nl.bzk.algemeenbrp.dal.domein.brp.util.Geldigheid;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.Fetch;
import org.hibernate.annotations.FetchMode;
/**
* The persistent class for the partijrol database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "partijrol", schema = "kern", uniqueConstraints = @UniqueConstraint(columnNames = {"partij", "rol"}))
@Cacheable
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
@Access(AccessType.FIELD)
public class PartijRol extends AbstractEntiteit implements Afleidbaar, Serializable, DynamischeStamtabel, Geldigheid {
private static final long serialVersionUID = 1L;
private static final String PARTIJ_MAG_NIET_NULL_ZIJN = "partij mag niet null zijn";
@Id
@SequenceGenerator(name = "partijrol_id_generator", sequenceName = "kern.seq_partijrol", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "partijrol_id_generator")
@Column(nullable = false, updatable = false)
@Access(AccessType.PROPERTY)
private Integer id;
@ManyToOne(fetch = FetchType.LAZY)
@JoinColumn(name = "partij", nullable = false)
private Partij partij;
@Column(name = "rol", nullable = false)
private int rolId;
@Column(name = "datingang")
private Integer datumIngang;
@Column(name = "dateinde")
private Integer datumEinde;
@Column(name = "indag", nullable = false)
private boolean isActueelEnGeldig;
@IndicatieActueelEnGeldig(naam = "isActueelEnGeldig")
@OneToMany(fetch = FetchType.LAZY, mappedBy = "partijRol", cascade = CascadeType.ALL)
@Fetch(value = FetchMode.SELECT)
private Set<PartijRolHistorie> partijRolHistorieSet = new LinkedHashSet<>(0);
/**
* JPA default constructor.
*/
protected PartijRol() {}
/**
* Maak een nieuwe partij rol.
*
* @param partij partij
* @param rol rol
*/
public PartijRol(final Partij partij, final Rol rol) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
setRol(rol);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Integer getId() {
return id;
}
/**
* Zet de waarden voor id van PartijRol.
*
* @param id de nieuwe waarde voor id van PartijRol
*/
public void setId(final Integer id) {
this.id = id;
}
/**
* Geef de waarde van partij van PartijRol.
*
* @return de waarde van partij van PartijRol
*/
public Partij getPartij() {
return partij;
}
/**
* Zet de waarden voor partij van PartijRol.
*
* @param partij de nieuwe waarde voor partij van PartijRol
*/
public void setPartij(final Partij partij) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
}
/**
* Geef de waarde van rol van PartijRol.
*
* @return de waarde van rol van PartijRol
*/
public Rol getRol() {
return Rol.parseId(rolId);
}
/**
* Zet de waarden voor rol van PartijRol.
*
* @param rol de nieuwe waarde voor rol van PartijRol
*/
public void setRol(final Rol rol) {
ValidationUtils.controleerOpNullWaarden("rol mag niet null zijn", rol);
rolId = rol.getId();
}
/**
* Geef de waarde van datum ingang van PartijRol.
*
* @return de waarde van datum ingang van PartijRol
*/
public Integer getDatumIngang() {
return datumIngang;
}
/**
* Zet de waarden voor datum ingang van PartijRol.
*
* @param datumIngang de nieuwe waarde voor datum ingang van PartijRol
*/
public void setDatumIngang(final Integer datumIngang) {
this.datumIngang = datumIngang;
}
/**
* Geef de waarde van datum einde van PartijRol.
*
* @return de waarde van datum einde van PartijRol
*/
public Integer getDatumEinde() {
return datumEinde;
}
/**
* Geef de waarde van isActueelEnGeldig.
*
* @return isActueelEnGeldig
*/
public boolean isActueelEnGeldig() {
return isActueelEnGeldig;
}
/**
* Zet de waarde van isActueelEnGeldig.
*
* @param actueelEnGeldig isActueelEnGeldig
*/
public void setActueelEnGeldig(final boolean actueelEnGeldig) {
isActueelEnGeldig = actueelEnGeldig;
}
/**
* Zet de waarden voor datum einde van PartijRol.
*
* @param datumEinde de nieuwe waarde voor datum einde van PartijRol
*/
public void setDatumEinde(final Integer datumEinde) {
this.datumEinde = datumEinde;
}
/**
* Geef de waarde van partij bijhouding historie set van PartijRol.
*
* @return de waarde van partij bijhouding historie set van PartijRol
*/
public Set<PartijRolHistorie> getPartijBijhoudingHistorieSet() {
return partijRolHistorieSet;
}
/**
* Toevoegen van een partijRolHistorie.
*
* @param partijRolHistorie partijRolHistorie
*/
public void addPartijBijhoudingHistorie(final PartijRolHistorie partijRolHistorie) {
partijRolHistorie.setPartijRol(this);
partijRolHistorieSet.add(partijRolHistorie);
}
/**
* Zet de waarden voor partijrol historie set van PartijRol.
*
* @param partijRolHistorieSet de nieuwe waarde voor partijrol historie set van PartijRol
*/
public void setPartijRolHistorieSet(final Set<PartijRolHistorie> partijRolHistorieSet) {
this.partijRolHistorieSet = partijRolHistorieSet;
}
}
| DDDNL/OperatieBRP | Broncode/operatiebrp-code-145.3/algemeen/alg-dal-entiteiten/src/main/java/nl/bzk/algemeenbrp/dal/domein/brp/entity/PartijRol.java | 2,055 | /**
* Zet de waarden voor datum einde van PartijRol.
*
* @param datumEinde de nieuwe waarde voor datum einde van PartijRol
*/ | 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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import java.util.LinkedHashSet;
import java.util.Set;
import javax.persistence.Access;
import javax.persistence.AccessType;
import javax.persistence.Cacheable;
import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.OneToMany;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import javax.persistence.UniqueConstraint;
import nl.bzk.algemeenbrp.dal.domein.brp.annotation.IndicatieActueelEnGeldig;
import nl.bzk.algemeenbrp.dal.domein.brp.enums.Rol;
import nl.bzk.algemeenbrp.dal.domein.brp.util.Geldigheid;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.Fetch;
import org.hibernate.annotations.FetchMode;
/**
* The persistent class for the partijrol database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "partijrol", schema = "kern", uniqueConstraints = @UniqueConstraint(columnNames = {"partij", "rol"}))
@Cacheable
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
@Access(AccessType.FIELD)
public class PartijRol extends AbstractEntiteit implements Afleidbaar, Serializable, DynamischeStamtabel, Geldigheid {
private static final long serialVersionUID = 1L;
private static final String PARTIJ_MAG_NIET_NULL_ZIJN = "partij mag niet null zijn";
@Id
@SequenceGenerator(name = "partijrol_id_generator", sequenceName = "kern.seq_partijrol", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "partijrol_id_generator")
@Column(nullable = false, updatable = false)
@Access(AccessType.PROPERTY)
private Integer id;
@ManyToOne(fetch = FetchType.LAZY)
@JoinColumn(name = "partij", nullable = false)
private Partij partij;
@Column(name = "rol", nullable = false)
private int rolId;
@Column(name = "datingang")
private Integer datumIngang;
@Column(name = "dateinde")
private Integer datumEinde;
@Column(name = "indag", nullable = false)
private boolean isActueelEnGeldig;
@IndicatieActueelEnGeldig(naam = "isActueelEnGeldig")
@OneToMany(fetch = FetchType.LAZY, mappedBy = "partijRol", cascade = CascadeType.ALL)
@Fetch(value = FetchMode.SELECT)
private Set<PartijRolHistorie> partijRolHistorieSet = new LinkedHashSet<>(0);
/**
* JPA default constructor.
*/
protected PartijRol() {}
/**
* Maak een nieuwe partij rol.
*
* @param partij partij
* @param rol rol
*/
public PartijRol(final Partij partij, final Rol rol) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
setRol(rol);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Integer getId() {
return id;
}
/**
* Zet de waarden voor id van PartijRol.
*
* @param id de nieuwe waarde voor id van PartijRol
*/
public void setId(final Integer id) {
this.id = id;
}
/**
* Geef de waarde van partij van PartijRol.
*
* @return de waarde van partij van PartijRol
*/
public Partij getPartij() {
return partij;
}
/**
* Zet de waarden voor partij van PartijRol.
*
* @param partij de nieuwe waarde voor partij van PartijRol
*/
public void setPartij(final Partij partij) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
}
/**
* Geef de waarde van rol van PartijRol.
*
* @return de waarde van rol van PartijRol
*/
public Rol getRol() {
return Rol.parseId(rolId);
}
/**
* Zet de waarden voor rol van PartijRol.
*
* @param rol de nieuwe waarde voor rol van PartijRol
*/
public void setRol(final Rol rol) {
ValidationUtils.controleerOpNullWaarden("rol mag niet null zijn", rol);
rolId = rol.getId();
}
/**
* Geef de waarde van datum ingang van PartijRol.
*
* @return de waarde van datum ingang van PartijRol
*/
public Integer getDatumIngang() {
return datumIngang;
}
/**
* Zet de waarden voor datum ingang van PartijRol.
*
* @param datumIngang de nieuwe waarde voor datum ingang van PartijRol
*/
public void setDatumIngang(final Integer datumIngang) {
this.datumIngang = datumIngang;
}
/**
* Geef de waarde van datum einde van PartijRol.
*
* @return de waarde van datum einde van PartijRol
*/
public Integer getDatumEinde() {
return datumEinde;
}
/**
* Geef de waarde van isActueelEnGeldig.
*
* @return isActueelEnGeldig
*/
public boolean isActueelEnGeldig() {
return isActueelEnGeldig;
}
/**
* Zet de waarde van isActueelEnGeldig.
*
* @param actueelEnGeldig isActueelEnGeldig
*/
public void setActueelEnGeldig(final boolean actueelEnGeldig) {
isActueelEnGeldig = actueelEnGeldig;
}
/**
* Zet de waarden<SUF>*/
public void setDatumEinde(final Integer datumEinde) {
this.datumEinde = datumEinde;
}
/**
* Geef de waarde van partij bijhouding historie set van PartijRol.
*
* @return de waarde van partij bijhouding historie set van PartijRol
*/
public Set<PartijRolHistorie> getPartijBijhoudingHistorieSet() {
return partijRolHistorieSet;
}
/**
* Toevoegen van een partijRolHistorie.
*
* @param partijRolHistorie partijRolHistorie
*/
public void addPartijBijhoudingHistorie(final PartijRolHistorie partijRolHistorie) {
partijRolHistorie.setPartijRol(this);
partijRolHistorieSet.add(partijRolHistorie);
}
/**
* Zet de waarden voor partijrol historie set van PartijRol.
*
* @param partijRolHistorieSet de nieuwe waarde voor partijrol historie set van PartijRol
*/
public void setPartijRolHistorieSet(final Set<PartijRolHistorie> partijRolHistorieSet) {
this.partijRolHistorieSet = partijRolHistorieSet;
}
}
|
202160_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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import java.util.LinkedHashSet;
import java.util.Set;
import javax.persistence.Access;
import javax.persistence.AccessType;
import javax.persistence.Cacheable;
import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.OneToMany;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import javax.persistence.UniqueConstraint;
import nl.bzk.algemeenbrp.dal.domein.brp.annotation.IndicatieActueelEnGeldig;
import nl.bzk.algemeenbrp.dal.domein.brp.enums.Rol;
import nl.bzk.algemeenbrp.dal.domein.brp.util.Geldigheid;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.Fetch;
import org.hibernate.annotations.FetchMode;
/**
* The persistent class for the partijrol database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "partijrol", schema = "kern", uniqueConstraints = @UniqueConstraint(columnNames = {"partij", "rol"}))
@Cacheable
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
@Access(AccessType.FIELD)
public class PartijRol extends AbstractEntiteit implements Afleidbaar, Serializable, DynamischeStamtabel, Geldigheid {
private static final long serialVersionUID = 1L;
private static final String PARTIJ_MAG_NIET_NULL_ZIJN = "partij mag niet null zijn";
@Id
@SequenceGenerator(name = "partijrol_id_generator", sequenceName = "kern.seq_partijrol", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "partijrol_id_generator")
@Column(nullable = false, updatable = false)
@Access(AccessType.PROPERTY)
private Integer id;
@ManyToOne(fetch = FetchType.LAZY)
@JoinColumn(name = "partij", nullable = false)
private Partij partij;
@Column(name = "rol", nullable = false)
private int rolId;
@Column(name = "datingang")
private Integer datumIngang;
@Column(name = "dateinde")
private Integer datumEinde;
@Column(name = "indag", nullable = false)
private boolean isActueelEnGeldig;
@IndicatieActueelEnGeldig(naam = "isActueelEnGeldig")
@OneToMany(fetch = FetchType.LAZY, mappedBy = "partijRol", cascade = CascadeType.ALL)
@Fetch(value = FetchMode.SELECT)
private Set<PartijRolHistorie> partijRolHistorieSet = new LinkedHashSet<>(0);
/**
* JPA default constructor.
*/
protected PartijRol() {}
/**
* Maak een nieuwe partij rol.
*
* @param partij partij
* @param rol rol
*/
public PartijRol(final Partij partij, final Rol rol) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
setRol(rol);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Integer getId() {
return id;
}
/**
* Zet de waarden voor id van PartijRol.
*
* @param id de nieuwe waarde voor id van PartijRol
*/
public void setId(final Integer id) {
this.id = id;
}
/**
* Geef de waarde van partij van PartijRol.
*
* @return de waarde van partij van PartijRol
*/
public Partij getPartij() {
return partij;
}
/**
* Zet de waarden voor partij van PartijRol.
*
* @param partij de nieuwe waarde voor partij van PartijRol
*/
public void setPartij(final Partij partij) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
}
/**
* Geef de waarde van rol van PartijRol.
*
* @return de waarde van rol van PartijRol
*/
public Rol getRol() {
return Rol.parseId(rolId);
}
/**
* Zet de waarden voor rol van PartijRol.
*
* @param rol de nieuwe waarde voor rol van PartijRol
*/
public void setRol(final Rol rol) {
ValidationUtils.controleerOpNullWaarden("rol mag niet null zijn", rol);
rolId = rol.getId();
}
/**
* Geef de waarde van datum ingang van PartijRol.
*
* @return de waarde van datum ingang van PartijRol
*/
public Integer getDatumIngang() {
return datumIngang;
}
/**
* Zet de waarden voor datum ingang van PartijRol.
*
* @param datumIngang de nieuwe waarde voor datum ingang van PartijRol
*/
public void setDatumIngang(final Integer datumIngang) {
this.datumIngang = datumIngang;
}
/**
* Geef de waarde van datum einde van PartijRol.
*
* @return de waarde van datum einde van PartijRol
*/
public Integer getDatumEinde() {
return datumEinde;
}
/**
* Geef de waarde van isActueelEnGeldig.
*
* @return isActueelEnGeldig
*/
public boolean isActueelEnGeldig() {
return isActueelEnGeldig;
}
/**
* Zet de waarde van isActueelEnGeldig.
*
* @param actueelEnGeldig isActueelEnGeldig
*/
public void setActueelEnGeldig(final boolean actueelEnGeldig) {
isActueelEnGeldig = actueelEnGeldig;
}
/**
* Zet de waarden voor datum einde van PartijRol.
*
* @param datumEinde de nieuwe waarde voor datum einde van PartijRol
*/
public void setDatumEinde(final Integer datumEinde) {
this.datumEinde = datumEinde;
}
/**
* Geef de waarde van partij bijhouding historie set van PartijRol.
*
* @return de waarde van partij bijhouding historie set van PartijRol
*/
public Set<PartijRolHistorie> getPartijBijhoudingHistorieSet() {
return partijRolHistorieSet;
}
/**
* Toevoegen van een partijRolHistorie.
*
* @param partijRolHistorie partijRolHistorie
*/
public void addPartijBijhoudingHistorie(final PartijRolHistorie partijRolHistorie) {
partijRolHistorie.setPartijRol(this);
partijRolHistorieSet.add(partijRolHistorie);
}
/**
* Zet de waarden voor partijrol historie set van PartijRol.
*
* @param partijRolHistorieSet de nieuwe waarde voor partijrol historie set van PartijRol
*/
public void setPartijRolHistorieSet(final Set<PartijRolHistorie> partijRolHistorieSet) {
this.partijRolHistorieSet = partijRolHistorieSet;
}
}
| DDDNL/OperatieBRP | Broncode/operatiebrp-code-145.3/algemeen/alg-dal-entiteiten/src/main/java/nl/bzk/algemeenbrp/dal/domein/brp/entity/PartijRol.java | 2,055 | /**
* Geef de waarde van partij bijhouding historie set van PartijRol.
*
* @return de waarde van partij bijhouding historie set van PartijRol
*/ | 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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import java.util.LinkedHashSet;
import java.util.Set;
import javax.persistence.Access;
import javax.persistence.AccessType;
import javax.persistence.Cacheable;
import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.OneToMany;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import javax.persistence.UniqueConstraint;
import nl.bzk.algemeenbrp.dal.domein.brp.annotation.IndicatieActueelEnGeldig;
import nl.bzk.algemeenbrp.dal.domein.brp.enums.Rol;
import nl.bzk.algemeenbrp.dal.domein.brp.util.Geldigheid;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.Fetch;
import org.hibernate.annotations.FetchMode;
/**
* The persistent class for the partijrol database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "partijrol", schema = "kern", uniqueConstraints = @UniqueConstraint(columnNames = {"partij", "rol"}))
@Cacheable
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
@Access(AccessType.FIELD)
public class PartijRol extends AbstractEntiteit implements Afleidbaar, Serializable, DynamischeStamtabel, Geldigheid {
private static final long serialVersionUID = 1L;
private static final String PARTIJ_MAG_NIET_NULL_ZIJN = "partij mag niet null zijn";
@Id
@SequenceGenerator(name = "partijrol_id_generator", sequenceName = "kern.seq_partijrol", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "partijrol_id_generator")
@Column(nullable = false, updatable = false)
@Access(AccessType.PROPERTY)
private Integer id;
@ManyToOne(fetch = FetchType.LAZY)
@JoinColumn(name = "partij", nullable = false)
private Partij partij;
@Column(name = "rol", nullable = false)
private int rolId;
@Column(name = "datingang")
private Integer datumIngang;
@Column(name = "dateinde")
private Integer datumEinde;
@Column(name = "indag", nullable = false)
private boolean isActueelEnGeldig;
@IndicatieActueelEnGeldig(naam = "isActueelEnGeldig")
@OneToMany(fetch = FetchType.LAZY, mappedBy = "partijRol", cascade = CascadeType.ALL)
@Fetch(value = FetchMode.SELECT)
private Set<PartijRolHistorie> partijRolHistorieSet = new LinkedHashSet<>(0);
/**
* JPA default constructor.
*/
protected PartijRol() {}
/**
* Maak een nieuwe partij rol.
*
* @param partij partij
* @param rol rol
*/
public PartijRol(final Partij partij, final Rol rol) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
setRol(rol);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Integer getId() {
return id;
}
/**
* Zet de waarden voor id van PartijRol.
*
* @param id de nieuwe waarde voor id van PartijRol
*/
public void setId(final Integer id) {
this.id = id;
}
/**
* Geef de waarde van partij van PartijRol.
*
* @return de waarde van partij van PartijRol
*/
public Partij getPartij() {
return partij;
}
/**
* Zet de waarden voor partij van PartijRol.
*
* @param partij de nieuwe waarde voor partij van PartijRol
*/
public void setPartij(final Partij partij) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
}
/**
* Geef de waarde van rol van PartijRol.
*
* @return de waarde van rol van PartijRol
*/
public Rol getRol() {
return Rol.parseId(rolId);
}
/**
* Zet de waarden voor rol van PartijRol.
*
* @param rol de nieuwe waarde voor rol van PartijRol
*/
public void setRol(final Rol rol) {
ValidationUtils.controleerOpNullWaarden("rol mag niet null zijn", rol);
rolId = rol.getId();
}
/**
* Geef de waarde van datum ingang van PartijRol.
*
* @return de waarde van datum ingang van PartijRol
*/
public Integer getDatumIngang() {
return datumIngang;
}
/**
* Zet de waarden voor datum ingang van PartijRol.
*
* @param datumIngang de nieuwe waarde voor datum ingang van PartijRol
*/
public void setDatumIngang(final Integer datumIngang) {
this.datumIngang = datumIngang;
}
/**
* Geef de waarde van datum einde van PartijRol.
*
* @return de waarde van datum einde van PartijRol
*/
public Integer getDatumEinde() {
return datumEinde;
}
/**
* Geef de waarde van isActueelEnGeldig.
*
* @return isActueelEnGeldig
*/
public boolean isActueelEnGeldig() {
return isActueelEnGeldig;
}
/**
* Zet de waarde van isActueelEnGeldig.
*
* @param actueelEnGeldig isActueelEnGeldig
*/
public void setActueelEnGeldig(final boolean actueelEnGeldig) {
isActueelEnGeldig = actueelEnGeldig;
}
/**
* Zet de waarden voor datum einde van PartijRol.
*
* @param datumEinde de nieuwe waarde voor datum einde van PartijRol
*/
public void setDatumEinde(final Integer datumEinde) {
this.datumEinde = datumEinde;
}
/**
* Geef de waarde<SUF>*/
public Set<PartijRolHistorie> getPartijBijhoudingHistorieSet() {
return partijRolHistorieSet;
}
/**
* Toevoegen van een partijRolHistorie.
*
* @param partijRolHistorie partijRolHistorie
*/
public void addPartijBijhoudingHistorie(final PartijRolHistorie partijRolHistorie) {
partijRolHistorie.setPartijRol(this);
partijRolHistorieSet.add(partijRolHistorie);
}
/**
* Zet de waarden voor partijrol historie set van PartijRol.
*
* @param partijRolHistorieSet de nieuwe waarde voor partijrol historie set van PartijRol
*/
public void setPartijRolHistorieSet(final Set<PartijRolHistorie> partijRolHistorieSet) {
this.partijRolHistorieSet = partijRolHistorieSet;
}
}
|
202160_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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import java.util.LinkedHashSet;
import java.util.Set;
import javax.persistence.Access;
import javax.persistence.AccessType;
import javax.persistence.Cacheable;
import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.OneToMany;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import javax.persistence.UniqueConstraint;
import nl.bzk.algemeenbrp.dal.domein.brp.annotation.IndicatieActueelEnGeldig;
import nl.bzk.algemeenbrp.dal.domein.brp.enums.Rol;
import nl.bzk.algemeenbrp.dal.domein.brp.util.Geldigheid;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.Fetch;
import org.hibernate.annotations.FetchMode;
/**
* The persistent class for the partijrol database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "partijrol", schema = "kern", uniqueConstraints = @UniqueConstraint(columnNames = {"partij", "rol"}))
@Cacheable
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
@Access(AccessType.FIELD)
public class PartijRol extends AbstractEntiteit implements Afleidbaar, Serializable, DynamischeStamtabel, Geldigheid {
private static final long serialVersionUID = 1L;
private static final String PARTIJ_MAG_NIET_NULL_ZIJN = "partij mag niet null zijn";
@Id
@SequenceGenerator(name = "partijrol_id_generator", sequenceName = "kern.seq_partijrol", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "partijrol_id_generator")
@Column(nullable = false, updatable = false)
@Access(AccessType.PROPERTY)
private Integer id;
@ManyToOne(fetch = FetchType.LAZY)
@JoinColumn(name = "partij", nullable = false)
private Partij partij;
@Column(name = "rol", nullable = false)
private int rolId;
@Column(name = "datingang")
private Integer datumIngang;
@Column(name = "dateinde")
private Integer datumEinde;
@Column(name = "indag", nullable = false)
private boolean isActueelEnGeldig;
@IndicatieActueelEnGeldig(naam = "isActueelEnGeldig")
@OneToMany(fetch = FetchType.LAZY, mappedBy = "partijRol", cascade = CascadeType.ALL)
@Fetch(value = FetchMode.SELECT)
private Set<PartijRolHistorie> partijRolHistorieSet = new LinkedHashSet<>(0);
/**
* JPA default constructor.
*/
protected PartijRol() {}
/**
* Maak een nieuwe partij rol.
*
* @param partij partij
* @param rol rol
*/
public PartijRol(final Partij partij, final Rol rol) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
setRol(rol);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Integer getId() {
return id;
}
/**
* Zet de waarden voor id van PartijRol.
*
* @param id de nieuwe waarde voor id van PartijRol
*/
public void setId(final Integer id) {
this.id = id;
}
/**
* Geef de waarde van partij van PartijRol.
*
* @return de waarde van partij van PartijRol
*/
public Partij getPartij() {
return partij;
}
/**
* Zet de waarden voor partij van PartijRol.
*
* @param partij de nieuwe waarde voor partij van PartijRol
*/
public void setPartij(final Partij partij) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
}
/**
* Geef de waarde van rol van PartijRol.
*
* @return de waarde van rol van PartijRol
*/
public Rol getRol() {
return Rol.parseId(rolId);
}
/**
* Zet de waarden voor rol van PartijRol.
*
* @param rol de nieuwe waarde voor rol van PartijRol
*/
public void setRol(final Rol rol) {
ValidationUtils.controleerOpNullWaarden("rol mag niet null zijn", rol);
rolId = rol.getId();
}
/**
* Geef de waarde van datum ingang van PartijRol.
*
* @return de waarde van datum ingang van PartijRol
*/
public Integer getDatumIngang() {
return datumIngang;
}
/**
* Zet de waarden voor datum ingang van PartijRol.
*
* @param datumIngang de nieuwe waarde voor datum ingang van PartijRol
*/
public void setDatumIngang(final Integer datumIngang) {
this.datumIngang = datumIngang;
}
/**
* Geef de waarde van datum einde van PartijRol.
*
* @return de waarde van datum einde van PartijRol
*/
public Integer getDatumEinde() {
return datumEinde;
}
/**
* Geef de waarde van isActueelEnGeldig.
*
* @return isActueelEnGeldig
*/
public boolean isActueelEnGeldig() {
return isActueelEnGeldig;
}
/**
* Zet de waarde van isActueelEnGeldig.
*
* @param actueelEnGeldig isActueelEnGeldig
*/
public void setActueelEnGeldig(final boolean actueelEnGeldig) {
isActueelEnGeldig = actueelEnGeldig;
}
/**
* Zet de waarden voor datum einde van PartijRol.
*
* @param datumEinde de nieuwe waarde voor datum einde van PartijRol
*/
public void setDatumEinde(final Integer datumEinde) {
this.datumEinde = datumEinde;
}
/**
* Geef de waarde van partij bijhouding historie set van PartijRol.
*
* @return de waarde van partij bijhouding historie set van PartijRol
*/
public Set<PartijRolHistorie> getPartijBijhoudingHistorieSet() {
return partijRolHistorieSet;
}
/**
* Toevoegen van een partijRolHistorie.
*
* @param partijRolHistorie partijRolHistorie
*/
public void addPartijBijhoudingHistorie(final PartijRolHistorie partijRolHistorie) {
partijRolHistorie.setPartijRol(this);
partijRolHistorieSet.add(partijRolHistorie);
}
/**
* Zet de waarden voor partijrol historie set van PartijRol.
*
* @param partijRolHistorieSet de nieuwe waarde voor partijrol historie set van PartijRol
*/
public void setPartijRolHistorieSet(final Set<PartijRolHistorie> partijRolHistorieSet) {
this.partijRolHistorieSet = partijRolHistorieSet;
}
}
| DDDNL/OperatieBRP | Broncode/operatiebrp-code-145.3/algemeen/alg-dal-entiteiten/src/main/java/nl/bzk/algemeenbrp/dal/domein/brp/entity/PartijRol.java | 2,055 | /**
* Toevoegen van een partijRolHistorie.
*
* @param partijRolHistorie partijRolHistorie
*/ | 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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import java.util.LinkedHashSet;
import java.util.Set;
import javax.persistence.Access;
import javax.persistence.AccessType;
import javax.persistence.Cacheable;
import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.OneToMany;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import javax.persistence.UniqueConstraint;
import nl.bzk.algemeenbrp.dal.domein.brp.annotation.IndicatieActueelEnGeldig;
import nl.bzk.algemeenbrp.dal.domein.brp.enums.Rol;
import nl.bzk.algemeenbrp.dal.domein.brp.util.Geldigheid;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.Fetch;
import org.hibernate.annotations.FetchMode;
/**
* The persistent class for the partijrol database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "partijrol", schema = "kern", uniqueConstraints = @UniqueConstraint(columnNames = {"partij", "rol"}))
@Cacheable
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
@Access(AccessType.FIELD)
public class PartijRol extends AbstractEntiteit implements Afleidbaar, Serializable, DynamischeStamtabel, Geldigheid {
private static final long serialVersionUID = 1L;
private static final String PARTIJ_MAG_NIET_NULL_ZIJN = "partij mag niet null zijn";
@Id
@SequenceGenerator(name = "partijrol_id_generator", sequenceName = "kern.seq_partijrol", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "partijrol_id_generator")
@Column(nullable = false, updatable = false)
@Access(AccessType.PROPERTY)
private Integer id;
@ManyToOne(fetch = FetchType.LAZY)
@JoinColumn(name = "partij", nullable = false)
private Partij partij;
@Column(name = "rol", nullable = false)
private int rolId;
@Column(name = "datingang")
private Integer datumIngang;
@Column(name = "dateinde")
private Integer datumEinde;
@Column(name = "indag", nullable = false)
private boolean isActueelEnGeldig;
@IndicatieActueelEnGeldig(naam = "isActueelEnGeldig")
@OneToMany(fetch = FetchType.LAZY, mappedBy = "partijRol", cascade = CascadeType.ALL)
@Fetch(value = FetchMode.SELECT)
private Set<PartijRolHistorie> partijRolHistorieSet = new LinkedHashSet<>(0);
/**
* JPA default constructor.
*/
protected PartijRol() {}
/**
* Maak een nieuwe partij rol.
*
* @param partij partij
* @param rol rol
*/
public PartijRol(final Partij partij, final Rol rol) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
setRol(rol);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Integer getId() {
return id;
}
/**
* Zet de waarden voor id van PartijRol.
*
* @param id de nieuwe waarde voor id van PartijRol
*/
public void setId(final Integer id) {
this.id = id;
}
/**
* Geef de waarde van partij van PartijRol.
*
* @return de waarde van partij van PartijRol
*/
public Partij getPartij() {
return partij;
}
/**
* Zet de waarden voor partij van PartijRol.
*
* @param partij de nieuwe waarde voor partij van PartijRol
*/
public void setPartij(final Partij partij) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
}
/**
* Geef de waarde van rol van PartijRol.
*
* @return de waarde van rol van PartijRol
*/
public Rol getRol() {
return Rol.parseId(rolId);
}
/**
* Zet de waarden voor rol van PartijRol.
*
* @param rol de nieuwe waarde voor rol van PartijRol
*/
public void setRol(final Rol rol) {
ValidationUtils.controleerOpNullWaarden("rol mag niet null zijn", rol);
rolId = rol.getId();
}
/**
* Geef de waarde van datum ingang van PartijRol.
*
* @return de waarde van datum ingang van PartijRol
*/
public Integer getDatumIngang() {
return datumIngang;
}
/**
* Zet de waarden voor datum ingang van PartijRol.
*
* @param datumIngang de nieuwe waarde voor datum ingang van PartijRol
*/
public void setDatumIngang(final Integer datumIngang) {
this.datumIngang = datumIngang;
}
/**
* Geef de waarde van datum einde van PartijRol.
*
* @return de waarde van datum einde van PartijRol
*/
public Integer getDatumEinde() {
return datumEinde;
}
/**
* Geef de waarde van isActueelEnGeldig.
*
* @return isActueelEnGeldig
*/
public boolean isActueelEnGeldig() {
return isActueelEnGeldig;
}
/**
* Zet de waarde van isActueelEnGeldig.
*
* @param actueelEnGeldig isActueelEnGeldig
*/
public void setActueelEnGeldig(final boolean actueelEnGeldig) {
isActueelEnGeldig = actueelEnGeldig;
}
/**
* Zet de waarden voor datum einde van PartijRol.
*
* @param datumEinde de nieuwe waarde voor datum einde van PartijRol
*/
public void setDatumEinde(final Integer datumEinde) {
this.datumEinde = datumEinde;
}
/**
* Geef de waarde van partij bijhouding historie set van PartijRol.
*
* @return de waarde van partij bijhouding historie set van PartijRol
*/
public Set<PartijRolHistorie> getPartijBijhoudingHistorieSet() {
return partijRolHistorieSet;
}
/**
* Toevoegen van een<SUF>*/
public void addPartijBijhoudingHistorie(final PartijRolHistorie partijRolHistorie) {
partijRolHistorie.setPartijRol(this);
partijRolHistorieSet.add(partijRolHistorie);
}
/**
* Zet de waarden voor partijrol historie set van PartijRol.
*
* @param partijRolHistorieSet de nieuwe waarde voor partijrol historie set van PartijRol
*/
public void setPartijRolHistorieSet(final Set<PartijRolHistorie> partijRolHistorieSet) {
this.partijRolHistorieSet = partijRolHistorieSet;
}
}
|
202160_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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import java.util.LinkedHashSet;
import java.util.Set;
import javax.persistence.Access;
import javax.persistence.AccessType;
import javax.persistence.Cacheable;
import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.OneToMany;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import javax.persistence.UniqueConstraint;
import nl.bzk.algemeenbrp.dal.domein.brp.annotation.IndicatieActueelEnGeldig;
import nl.bzk.algemeenbrp.dal.domein.brp.enums.Rol;
import nl.bzk.algemeenbrp.dal.domein.brp.util.Geldigheid;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.Fetch;
import org.hibernate.annotations.FetchMode;
/**
* The persistent class for the partijrol database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "partijrol", schema = "kern", uniqueConstraints = @UniqueConstraint(columnNames = {"partij", "rol"}))
@Cacheable
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
@Access(AccessType.FIELD)
public class PartijRol extends AbstractEntiteit implements Afleidbaar, Serializable, DynamischeStamtabel, Geldigheid {
private static final long serialVersionUID = 1L;
private static final String PARTIJ_MAG_NIET_NULL_ZIJN = "partij mag niet null zijn";
@Id
@SequenceGenerator(name = "partijrol_id_generator", sequenceName = "kern.seq_partijrol", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "partijrol_id_generator")
@Column(nullable = false, updatable = false)
@Access(AccessType.PROPERTY)
private Integer id;
@ManyToOne(fetch = FetchType.LAZY)
@JoinColumn(name = "partij", nullable = false)
private Partij partij;
@Column(name = "rol", nullable = false)
private int rolId;
@Column(name = "datingang")
private Integer datumIngang;
@Column(name = "dateinde")
private Integer datumEinde;
@Column(name = "indag", nullable = false)
private boolean isActueelEnGeldig;
@IndicatieActueelEnGeldig(naam = "isActueelEnGeldig")
@OneToMany(fetch = FetchType.LAZY, mappedBy = "partijRol", cascade = CascadeType.ALL)
@Fetch(value = FetchMode.SELECT)
private Set<PartijRolHistorie> partijRolHistorieSet = new LinkedHashSet<>(0);
/**
* JPA default constructor.
*/
protected PartijRol() {}
/**
* Maak een nieuwe partij rol.
*
* @param partij partij
* @param rol rol
*/
public PartijRol(final Partij partij, final Rol rol) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
setRol(rol);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Integer getId() {
return id;
}
/**
* Zet de waarden voor id van PartijRol.
*
* @param id de nieuwe waarde voor id van PartijRol
*/
public void setId(final Integer id) {
this.id = id;
}
/**
* Geef de waarde van partij van PartijRol.
*
* @return de waarde van partij van PartijRol
*/
public Partij getPartij() {
return partij;
}
/**
* Zet de waarden voor partij van PartijRol.
*
* @param partij de nieuwe waarde voor partij van PartijRol
*/
public void setPartij(final Partij partij) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
}
/**
* Geef de waarde van rol van PartijRol.
*
* @return de waarde van rol van PartijRol
*/
public Rol getRol() {
return Rol.parseId(rolId);
}
/**
* Zet de waarden voor rol van PartijRol.
*
* @param rol de nieuwe waarde voor rol van PartijRol
*/
public void setRol(final Rol rol) {
ValidationUtils.controleerOpNullWaarden("rol mag niet null zijn", rol);
rolId = rol.getId();
}
/**
* Geef de waarde van datum ingang van PartijRol.
*
* @return de waarde van datum ingang van PartijRol
*/
public Integer getDatumIngang() {
return datumIngang;
}
/**
* Zet de waarden voor datum ingang van PartijRol.
*
* @param datumIngang de nieuwe waarde voor datum ingang van PartijRol
*/
public void setDatumIngang(final Integer datumIngang) {
this.datumIngang = datumIngang;
}
/**
* Geef de waarde van datum einde van PartijRol.
*
* @return de waarde van datum einde van PartijRol
*/
public Integer getDatumEinde() {
return datumEinde;
}
/**
* Geef de waarde van isActueelEnGeldig.
*
* @return isActueelEnGeldig
*/
public boolean isActueelEnGeldig() {
return isActueelEnGeldig;
}
/**
* Zet de waarde van isActueelEnGeldig.
*
* @param actueelEnGeldig isActueelEnGeldig
*/
public void setActueelEnGeldig(final boolean actueelEnGeldig) {
isActueelEnGeldig = actueelEnGeldig;
}
/**
* Zet de waarden voor datum einde van PartijRol.
*
* @param datumEinde de nieuwe waarde voor datum einde van PartijRol
*/
public void setDatumEinde(final Integer datumEinde) {
this.datumEinde = datumEinde;
}
/**
* Geef de waarde van partij bijhouding historie set van PartijRol.
*
* @return de waarde van partij bijhouding historie set van PartijRol
*/
public Set<PartijRolHistorie> getPartijBijhoudingHistorieSet() {
return partijRolHistorieSet;
}
/**
* Toevoegen van een partijRolHistorie.
*
* @param partijRolHistorie partijRolHistorie
*/
public void addPartijBijhoudingHistorie(final PartijRolHistorie partijRolHistorie) {
partijRolHistorie.setPartijRol(this);
partijRolHistorieSet.add(partijRolHistorie);
}
/**
* Zet de waarden voor partijrol historie set van PartijRol.
*
* @param partijRolHistorieSet de nieuwe waarde voor partijrol historie set van PartijRol
*/
public void setPartijRolHistorieSet(final Set<PartijRolHistorie> partijRolHistorieSet) {
this.partijRolHistorieSet = partijRolHistorieSet;
}
}
| DDDNL/OperatieBRP | Broncode/operatiebrp-code-145.3/algemeen/alg-dal-entiteiten/src/main/java/nl/bzk/algemeenbrp/dal/domein/brp/entity/PartijRol.java | 2,055 | /**
* Zet de waarden voor partijrol historie set van PartijRol.
*
* @param partijRolHistorieSet de nieuwe waarde voor partijrol historie set van PartijRol
*/ | 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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import java.util.LinkedHashSet;
import java.util.Set;
import javax.persistence.Access;
import javax.persistence.AccessType;
import javax.persistence.Cacheable;
import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.OneToMany;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import javax.persistence.UniqueConstraint;
import nl.bzk.algemeenbrp.dal.domein.brp.annotation.IndicatieActueelEnGeldig;
import nl.bzk.algemeenbrp.dal.domein.brp.enums.Rol;
import nl.bzk.algemeenbrp.dal.domein.brp.util.Geldigheid;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.Fetch;
import org.hibernate.annotations.FetchMode;
/**
* The persistent class for the partijrol database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "partijrol", schema = "kern", uniqueConstraints = @UniqueConstraint(columnNames = {"partij", "rol"}))
@Cacheable
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
@Access(AccessType.FIELD)
public class PartijRol extends AbstractEntiteit implements Afleidbaar, Serializable, DynamischeStamtabel, Geldigheid {
private static final long serialVersionUID = 1L;
private static final String PARTIJ_MAG_NIET_NULL_ZIJN = "partij mag niet null zijn";
@Id
@SequenceGenerator(name = "partijrol_id_generator", sequenceName = "kern.seq_partijrol", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "partijrol_id_generator")
@Column(nullable = false, updatable = false)
@Access(AccessType.PROPERTY)
private Integer id;
@ManyToOne(fetch = FetchType.LAZY)
@JoinColumn(name = "partij", nullable = false)
private Partij partij;
@Column(name = "rol", nullable = false)
private int rolId;
@Column(name = "datingang")
private Integer datumIngang;
@Column(name = "dateinde")
private Integer datumEinde;
@Column(name = "indag", nullable = false)
private boolean isActueelEnGeldig;
@IndicatieActueelEnGeldig(naam = "isActueelEnGeldig")
@OneToMany(fetch = FetchType.LAZY, mappedBy = "partijRol", cascade = CascadeType.ALL)
@Fetch(value = FetchMode.SELECT)
private Set<PartijRolHistorie> partijRolHistorieSet = new LinkedHashSet<>(0);
/**
* JPA default constructor.
*/
protected PartijRol() {}
/**
* Maak een nieuwe partij rol.
*
* @param partij partij
* @param rol rol
*/
public PartijRol(final Partij partij, final Rol rol) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
setRol(rol);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Integer getId() {
return id;
}
/**
* Zet de waarden voor id van PartijRol.
*
* @param id de nieuwe waarde voor id van PartijRol
*/
public void setId(final Integer id) {
this.id = id;
}
/**
* Geef de waarde van partij van PartijRol.
*
* @return de waarde van partij van PartijRol
*/
public Partij getPartij() {
return partij;
}
/**
* Zet de waarden voor partij van PartijRol.
*
* @param partij de nieuwe waarde voor partij van PartijRol
*/
public void setPartij(final Partij partij) {
ValidationUtils.controleerOpNullWaarden(PARTIJ_MAG_NIET_NULL_ZIJN, partij);
this.partij = partij;
}
/**
* Geef de waarde van rol van PartijRol.
*
* @return de waarde van rol van PartijRol
*/
public Rol getRol() {
return Rol.parseId(rolId);
}
/**
* Zet de waarden voor rol van PartijRol.
*
* @param rol de nieuwe waarde voor rol van PartijRol
*/
public void setRol(final Rol rol) {
ValidationUtils.controleerOpNullWaarden("rol mag niet null zijn", rol);
rolId = rol.getId();
}
/**
* Geef de waarde van datum ingang van PartijRol.
*
* @return de waarde van datum ingang van PartijRol
*/
public Integer getDatumIngang() {
return datumIngang;
}
/**
* Zet de waarden voor datum ingang van PartijRol.
*
* @param datumIngang de nieuwe waarde voor datum ingang van PartijRol
*/
public void setDatumIngang(final Integer datumIngang) {
this.datumIngang = datumIngang;
}
/**
* Geef de waarde van datum einde van PartijRol.
*
* @return de waarde van datum einde van PartijRol
*/
public Integer getDatumEinde() {
return datumEinde;
}
/**
* Geef de waarde van isActueelEnGeldig.
*
* @return isActueelEnGeldig
*/
public boolean isActueelEnGeldig() {
return isActueelEnGeldig;
}
/**
* Zet de waarde van isActueelEnGeldig.
*
* @param actueelEnGeldig isActueelEnGeldig
*/
public void setActueelEnGeldig(final boolean actueelEnGeldig) {
isActueelEnGeldig = actueelEnGeldig;
}
/**
* Zet de waarden voor datum einde van PartijRol.
*
* @param datumEinde de nieuwe waarde voor datum einde van PartijRol
*/
public void setDatumEinde(final Integer datumEinde) {
this.datumEinde = datumEinde;
}
/**
* Geef de waarde van partij bijhouding historie set van PartijRol.
*
* @return de waarde van partij bijhouding historie set van PartijRol
*/
public Set<PartijRolHistorie> getPartijBijhoudingHistorieSet() {
return partijRolHistorieSet;
}
/**
* Toevoegen van een partijRolHistorie.
*
* @param partijRolHistorie partijRolHistorie
*/
public void addPartijBijhoudingHistorie(final PartijRolHistorie partijRolHistorie) {
partijRolHistorie.setPartijRol(this);
partijRolHistorieSet.add(partijRolHistorie);
}
/**
* Zet de waarden<SUF>*/
public void setPartijRolHistorieSet(final Set<PartijRolHistorie> partijRolHistorieSet) {
this.partijRolHistorieSet = partijRolHistorieSet;
}
}
|
202161_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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import java.sql.Timestamp;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import javax.persistence.UniqueConstraint;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
/**
* The persistent class for the his_partijrol database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "his_partijrol", schema = "kern", uniqueConstraints = {@UniqueConstraint(columnNames = {"partijrol", "tsreg"})})
public class PartijRolHistorie extends AbstractFormeleHistorieZonderVerantwoording implements Serializable {
private static final long serialVersionUID = 1L;
@Id
@SequenceGenerator(name = "his_partijrol_id_generator", sequenceName = "kern.seq_his_partijrol", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "his_partijrol_id_generator")
@Column(nullable = false)
/**
* Het veld zou Integer moeten zijn maar is Long i.v.m. de link naar GegevenInOnderzoek.
*/
private Long id;
@Column(name = "datingang", nullable = false)
private int datumIngang;
@Column(name = "dateinde")
private Integer datumEinde;
// bi-directional many-to-one association to Partij
@ManyToOne(fetch = FetchType.LAZY)
@JoinColumn(name = "partijrol", nullable = false)
private PartijRol partijRol;
/**
* JPA default constructor.
*/
protected PartijRolHistorie() {}
/**
* Maak een nieuwe partij historie.
*
* @param partijRol partij rol
* @param datumTijdRegistratie datumTijdRegistratie
* @param datumIngang datum ingang
*/
public PartijRolHistorie(final PartijRol partijRol, final Timestamp datumTijdRegistratie, final int datumIngang) {
setPartijRol(partijRol);
setDatumTijdRegistratie(datumTijdRegistratie);
setDatumIngang(datumIngang);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Integer getId() {
return convertLongNaarInteger(id);
}
/**
* Zet de waarden voor id van PartijRolHistorie.
*
* @param id de nieuwe waarde voor id van PartijRolHistorie
*/
public void setId(final Integer id) {
this.id = convertIntegerNaarLong(id);
}
/**
* Geef de waarde van datum ingang van PartijRolHistorie.
*
* @return de waarde van datum ingang van PartijRolHistorie
*/
public int getDatumIngang() {
return datumIngang;
}
/**
* Zet de waarden voor datum ingang van PartijRolHistorie.
*
* @param datumIngang de nieuwe waarde voor datum ingang van PartijRolHistorie
*/
public void setDatumIngang(final int datumIngang) {
this.datumIngang = datumIngang;
}
/**
* Geef de waarde van datum einde van PartijRolHistorie.
*
* @return de waarde van datum einde van PartijRolHistorie
*/
public Integer getDatumEinde() {
return datumEinde;
}
/**
* Zet de waarden voor datum einde van PartijRolHistorie.
*
* @param datumEinde de nieuwe waarde voor datum einde van PartijRolHistorie
*/
public void setDatumEinde(final Integer datumEinde) {
this.datumEinde = datumEinde;
}
/**
* Geef de waarde van partij rol van PartijRolHistorie.
*
* @return de waarde van partij rol van PartijRolHistorie
*/
public PartijRol getPartijRol() {
return partijRol;
}
/**
* Zet de waarden voor partij rol van PartijRolHistorie.
*
* @param partijRol de nieuwe waarde voor partij rol van PartijRolHistorie
*/
public void setPartijRol(final PartijRol partijRol) {
ValidationUtils.controleerOpNullWaarden("partijrol mag niet null zijn", partijRol);
this.partijRol = partijRol;
}
}
| DDDNL/OperatieBRP | Broncode/operatiebrp-code-145.3/algemeen/alg-dal-entiteiten/src/main/java/nl/bzk/algemeenbrp/dal/domein/brp/entity/PartijRolHistorie.java | 1,288 | /**
* Het veld zou Integer moeten zijn maar is Long i.v.m. de link naar GegevenInOnderzoek.
*/ | 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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import java.sql.Timestamp;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import javax.persistence.UniqueConstraint;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
/**
* The persistent class for the his_partijrol database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "his_partijrol", schema = "kern", uniqueConstraints = {@UniqueConstraint(columnNames = {"partijrol", "tsreg"})})
public class PartijRolHistorie extends AbstractFormeleHistorieZonderVerantwoording implements Serializable {
private static final long serialVersionUID = 1L;
@Id
@SequenceGenerator(name = "his_partijrol_id_generator", sequenceName = "kern.seq_his_partijrol", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "his_partijrol_id_generator")
@Column(nullable = false)
/**
* Het veld zou<SUF>*/
private Long id;
@Column(name = "datingang", nullable = false)
private int datumIngang;
@Column(name = "dateinde")
private Integer datumEinde;
// bi-directional many-to-one association to Partij
@ManyToOne(fetch = FetchType.LAZY)
@JoinColumn(name = "partijrol", nullable = false)
private PartijRol partijRol;
/**
* JPA default constructor.
*/
protected PartijRolHistorie() {}
/**
* Maak een nieuwe partij historie.
*
* @param partijRol partij rol
* @param datumTijdRegistratie datumTijdRegistratie
* @param datumIngang datum ingang
*/
public PartijRolHistorie(final PartijRol partijRol, final Timestamp datumTijdRegistratie, final int datumIngang) {
setPartijRol(partijRol);
setDatumTijdRegistratie(datumTijdRegistratie);
setDatumIngang(datumIngang);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Integer getId() {
return convertLongNaarInteger(id);
}
/**
* Zet de waarden voor id van PartijRolHistorie.
*
* @param id de nieuwe waarde voor id van PartijRolHistorie
*/
public void setId(final Integer id) {
this.id = convertIntegerNaarLong(id);
}
/**
* Geef de waarde van datum ingang van PartijRolHistorie.
*
* @return de waarde van datum ingang van PartijRolHistorie
*/
public int getDatumIngang() {
return datumIngang;
}
/**
* Zet de waarden voor datum ingang van PartijRolHistorie.
*
* @param datumIngang de nieuwe waarde voor datum ingang van PartijRolHistorie
*/
public void setDatumIngang(final int datumIngang) {
this.datumIngang = datumIngang;
}
/**
* Geef de waarde van datum einde van PartijRolHistorie.
*
* @return de waarde van datum einde van PartijRolHistorie
*/
public Integer getDatumEinde() {
return datumEinde;
}
/**
* Zet de waarden voor datum einde van PartijRolHistorie.
*
* @param datumEinde de nieuwe waarde voor datum einde van PartijRolHistorie
*/
public void setDatumEinde(final Integer datumEinde) {
this.datumEinde = datumEinde;
}
/**
* Geef de waarde van partij rol van PartijRolHistorie.
*
* @return de waarde van partij rol van PartijRolHistorie
*/
public PartijRol getPartijRol() {
return partijRol;
}
/**
* Zet de waarden voor partij rol van PartijRolHistorie.
*
* @param partijRol de nieuwe waarde voor partij rol van PartijRolHistorie
*/
public void setPartijRol(final PartijRol partijRol) {
ValidationUtils.controleerOpNullWaarden("partijrol mag niet null zijn", partijRol);
this.partijRol = partijRol;
}
}
|
202161_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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import java.sql.Timestamp;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import javax.persistence.UniqueConstraint;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
/**
* The persistent class for the his_partijrol database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "his_partijrol", schema = "kern", uniqueConstraints = {@UniqueConstraint(columnNames = {"partijrol", "tsreg"})})
public class PartijRolHistorie extends AbstractFormeleHistorieZonderVerantwoording implements Serializable {
private static final long serialVersionUID = 1L;
@Id
@SequenceGenerator(name = "his_partijrol_id_generator", sequenceName = "kern.seq_his_partijrol", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "his_partijrol_id_generator")
@Column(nullable = false)
/**
* Het veld zou Integer moeten zijn maar is Long i.v.m. de link naar GegevenInOnderzoek.
*/
private Long id;
@Column(name = "datingang", nullable = false)
private int datumIngang;
@Column(name = "dateinde")
private Integer datumEinde;
// bi-directional many-to-one association to Partij
@ManyToOne(fetch = FetchType.LAZY)
@JoinColumn(name = "partijrol", nullable = false)
private PartijRol partijRol;
/**
* JPA default constructor.
*/
protected PartijRolHistorie() {}
/**
* Maak een nieuwe partij historie.
*
* @param partijRol partij rol
* @param datumTijdRegistratie datumTijdRegistratie
* @param datumIngang datum ingang
*/
public PartijRolHistorie(final PartijRol partijRol, final Timestamp datumTijdRegistratie, final int datumIngang) {
setPartijRol(partijRol);
setDatumTijdRegistratie(datumTijdRegistratie);
setDatumIngang(datumIngang);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Integer getId() {
return convertLongNaarInteger(id);
}
/**
* Zet de waarden voor id van PartijRolHistorie.
*
* @param id de nieuwe waarde voor id van PartijRolHistorie
*/
public void setId(final Integer id) {
this.id = convertIntegerNaarLong(id);
}
/**
* Geef de waarde van datum ingang van PartijRolHistorie.
*
* @return de waarde van datum ingang van PartijRolHistorie
*/
public int getDatumIngang() {
return datumIngang;
}
/**
* Zet de waarden voor datum ingang van PartijRolHistorie.
*
* @param datumIngang de nieuwe waarde voor datum ingang van PartijRolHistorie
*/
public void setDatumIngang(final int datumIngang) {
this.datumIngang = datumIngang;
}
/**
* Geef de waarde van datum einde van PartijRolHistorie.
*
* @return de waarde van datum einde van PartijRolHistorie
*/
public Integer getDatumEinde() {
return datumEinde;
}
/**
* Zet de waarden voor datum einde van PartijRolHistorie.
*
* @param datumEinde de nieuwe waarde voor datum einde van PartijRolHistorie
*/
public void setDatumEinde(final Integer datumEinde) {
this.datumEinde = datumEinde;
}
/**
* Geef de waarde van partij rol van PartijRolHistorie.
*
* @return de waarde van partij rol van PartijRolHistorie
*/
public PartijRol getPartijRol() {
return partijRol;
}
/**
* Zet de waarden voor partij rol van PartijRolHistorie.
*
* @param partijRol de nieuwe waarde voor partij rol van PartijRolHistorie
*/
public void setPartijRol(final PartijRol partijRol) {
ValidationUtils.controleerOpNullWaarden("partijrol mag niet null zijn", partijRol);
this.partijRol = partijRol;
}
}
| DDDNL/OperatieBRP | Broncode/operatiebrp-code-145.3/algemeen/alg-dal-entiteiten/src/main/java/nl/bzk/algemeenbrp/dal/domein/brp/entity/PartijRolHistorie.java | 1,288 | /**
* Maak een nieuwe partij historie.
*
* @param partijRol partij rol
* @param datumTijdRegistratie datumTijdRegistratie
* @param datumIngang datum ingang
*/ | 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 www.github.com/MinBZK/operatieBRP.
*/
package nl.bzk.algemeenbrp.dal.domein.brp.entity;
import java.io.Serializable;
import java.sql.Timestamp;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;
import javax.persistence.UniqueConstraint;
import nl.bzk.algemeenbrp.dal.domein.brp.util.ValidationUtils;
/**
* The persistent class for the his_partijrol database table.
*
*/
@Entity
@EntityListeners(GegevenInOnderzoekListener.class)
@Table(name = "his_partijrol", schema = "kern", uniqueConstraints = {@UniqueConstraint(columnNames = {"partijrol", "tsreg"})})
public class PartijRolHistorie extends AbstractFormeleHistorieZonderVerantwoording implements Serializable {
private static final long serialVersionUID = 1L;
@Id
@SequenceGenerator(name = "his_partijrol_id_generator", sequenceName = "kern.seq_his_partijrol", allocationSize = 1)
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "his_partijrol_id_generator")
@Column(nullable = false)
/**
* Het veld zou Integer moeten zijn maar is Long i.v.m. de link naar GegevenInOnderzoek.
*/
private Long id;
@Column(name = "datingang", nullable = false)
private int datumIngang;
@Column(name = "dateinde")
private Integer datumEinde;
// bi-directional many-to-one association to Partij
@ManyToOne(fetch = FetchType.LAZY)
@JoinColumn(name = "partijrol", nullable = false)
private PartijRol partijRol;
/**
* JPA default constructor.
*/
protected PartijRolHistorie() {}
/**
* Maak een nieuwe<SUF>*/
public PartijRolHistorie(final PartijRol partijRol, final Timestamp datumTijdRegistratie, final int datumIngang) {
setPartijRol(partijRol);
setDatumTijdRegistratie(datumTijdRegistratie);
setDatumIngang(datumIngang);
}
/*
* (non-Javadoc)
*
* @see nl.bzk.algemeen.dal.domein.brp.kern.entity.DeltaEntiteit#getId()
*/
@Override
public Integer getId() {
return convertLongNaarInteger(id);
}
/**
* Zet de waarden voor id van PartijRolHistorie.
*
* @param id de nieuwe waarde voor id van PartijRolHistorie
*/
public void setId(final Integer id) {
this.id = convertIntegerNaarLong(id);
}
/**
* Geef de waarde van datum ingang van PartijRolHistorie.
*
* @return de waarde van datum ingang van PartijRolHistorie
*/
public int getDatumIngang() {
return datumIngang;
}
/**
* Zet de waarden voor datum ingang van PartijRolHistorie.
*
* @param datumIngang de nieuwe waarde voor datum ingang van PartijRolHistorie
*/
public void setDatumIngang(final int datumIngang) {
this.datumIngang = datumIngang;
}
/**
* Geef de waarde van datum einde van PartijRolHistorie.
*
* @return de waarde van datum einde van PartijRolHistorie
*/
public Integer getDatumEinde() {
return datumEinde;
}
/**
* Zet de waarden voor datum einde van PartijRolHistorie.
*
* @param datumEinde de nieuwe waarde voor datum einde van PartijRolHistorie
*/
public void setDatumEinde(final Integer datumEinde) {
this.datumEinde = datumEinde;
}
/**
* Geef de waarde van partij rol van PartijRolHistorie.
*
* @return de waarde van partij rol van PartijRolHistorie
*/
public PartijRol getPartijRol() {
return partijRol;
}
/**
* Zet de waarden voor partij rol van PartijRolHistorie.
*
* @param partijRol de nieuwe waarde voor partij rol van PartijRolHistorie
*/
public void setPartijRol(final PartijRol partijRol) {
ValidationUtils.controleerOpNullWaarden("partijrol mag niet null zijn", partijRol);
this.partijRol = partijRol;
}
}
|