initial public commit

This commit is contained in:
2021-09-06 17:46:59 +03:00
commit b744b08829
824 changed files with 91593 additions and 0 deletions

View File

@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed 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.

View File

@ -0,0 +1,14 @@
# SCHEMA Component
Компонент для валидации xml с помощью xsd, ранее загруженных в бд через soap(/schema-management)
Сделан на основе camel validator, с заменой загрузчика xsd и ResourceResolver'a(для подгрузки зависимых xsd)
https://camel.apache.org/components/latest/validator-component.html
Компонент работает в двух режимах:
- статический, когда небходимую схему указывают в самом маршруте через namespace, uud или name(версию можно указывать через параметры)
validatorWithDBStorage:namespace:http://www.entaxy.ru/registry-scheme-service/
validatorWithDBStorage:uuid:a7ff793b-d996-42a5-a62b-fb44a2143e98?version=3.0
validatorWithDBStorage:name:lama.xsd?version=3.0
- динамический, если не было указано ничего из выше перечисленного, то будет выбран этот режим.
когда сообщение парсится при поступлении и с помощью namespace загружается его xsd, если xsd была
не найдена или namespace не был указан будет ошибка

View File

@ -0,0 +1,53 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent>
<artifactId>schema</artifactId>
<groupId>ru.entaxy.esb.system.registry.schema</groupId>
<version>1.8.0</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>schema-component</artifactId>
<packaging>bundle</packaging>
<name>SYSTEM :: ENTAXY :: REGISTRY :: SCHEMA :: COMPONENT</name>
<description>SYSTEM :: ENTAXY :: REGISTRY :: SCHEMA :: COMPONENT</description>
<properties>
<bundle.osgi.export.service>org.apache.camel.spi.ComponentResolver;component=schema</bundle.osgi.export.service>
<bundle.osgi.import.pkg>
ru.entaxy.esb.system.common.osgi,
ru.entaxy.esb.system.common.osgi.impl,
javax.persistence;version="[2,3)",
*
</bundle.osgi.import.pkg>
</properties>
<dependencies>
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-core</artifactId>
<version>${camel.version}</version>
</dependency>
<dependency>
<groupId>org.osgi</groupId>
<artifactId>org.osgi.core</artifactId>
<version>${osgi.version}</version>
</dependency>
<dependency>
<groupId>ru.entaxy.esb.system.registry.schema</groupId>
<artifactId>schema-api</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>ru.entaxy.esb.system.commons</groupId>
<artifactId>system-commons</artifactId>
<version>${project.version}</version>
<scope>provided</scope>
</dependency>
</dependencies>
</project>

View File

@ -0,0 +1,450 @@
/*-
* ~~~~~~licensing~~~~~~
* schema-component
* ==========
* Copyright (C) 2020 - 2021 EmDev LLC
* ==========
* Licensed 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.
* ~~~~~~/licensing~~~~~~
*/
package ru.entaxy.esb.system.registry.schema.component;
import org.apache.camel.*;
import org.apache.camel.converter.jaxp.XmlConverter;
import org.apache.camel.support.AsyncProcessorHelper;
import org.apache.camel.support.processor.validation.DefaultValidationErrorHandler;
import org.apache.camel.support.processor.validation.SchemaValidationException;
import org.apache.camel.support.processor.validation.ValidatorErrorHandler;
import org.apache.camel.util.IOHelper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.w3c.dom.ls.LSResourceResolver;
import org.xml.sax.SAXException;
import org.xml.sax.SAXParseException;
import ru.entaxy.esb.system.registry.schema.component.exception.SchemaNotFoundException;
import ru.entaxy.esb.system.registry.schema.component.util.SchemaReaderFromDB;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.transform.Result;
import javax.xml.transform.Source;
import javax.xml.transform.dom.DOMResult;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.sax.SAXResult;
import javax.xml.transform.sax.SAXSource;
import javax.xml.transform.stax.StAXSource;
import javax.xml.transform.stream.StreamSource;
import javax.xml.validation.Schema;
import javax.xml.validation.SchemaFactory;
import javax.xml.validation.Validator;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.CompletableFuture;
/**
* A processor which validates the XML version of the inbound message body
* against some schema either in XSD or RelaxNG
*/
public class ValidatingProcessor implements AsyncProcessor {
private static final Logger LOG = LoggerFactory.getLogger(ValidatingProcessor.class);
private final SchemaReaderFromDB schemaReaderFromDB;
private ValidatorErrorHandler errorHandler = new DefaultValidationErrorHandler();
private final XmlConverter converter = new XmlConverter();
private boolean useDom;
private boolean useSharedSchema = true;
private boolean failOnNullBody = true;
private boolean failOnNullHeader = true;
private String headerName;
private String uri;
private final Map<String, Schema> schemaMap = new HashMap<>();
public ValidatingProcessor() {
schemaReaderFromDB = new SchemaReaderFromDB();
}
public ValidatingProcessor(SchemaReaderFromDB schemaReaderFromDB, String uri) {
// schema reader can be a singelton per schema, therefore make reuse, see ValidatorEndpoint and ValidatorProducer
this.schemaReaderFromDB = schemaReaderFromDB;
this.uri = uri;
}
public void process(Exchange exchange) throws Exception {
AsyncProcessorHelper.process(this, exchange);
}
public boolean process(Exchange exchange, AsyncCallback callback) {
try {
doProcess(exchange);
} catch (Exception e) {
exchange.setException(e);
}
callback.done(true);
return true;
}
@Override
public CompletableFuture<Exchange> processAsync(Exchange exchange) {
return null;
}
protected void doProcess(Exchange exchange) throws Exception {
Schema schema = null;
Validator validator = null;
if (uri != null && !uri.isEmpty()) {
schema = getOrCreateSchema(schemaReaderFromDB.getSchemaResourceUri());
validator = getValidator(schema);
}
// the underlying input stream, which we need to close to avoid locking files or other resources
Source source = null;
InputStream is = null;
try {
Result result = null;
// only convert to input stream if really needed
if (isInputStreamNeeded(exchange)) {
is = getContentToValidate(exchange, InputStream.class);
if (is != null) {
source = getSource(exchange, is);
}
} else {
Object content = getContentToValidate(exchange);
if (content != null) {
source = getSource(exchange, content);
}
}
//CAMEL-7036 We don't need to set the result if the source is an instance of StreamSource
if (source instanceof DOMSource) {
result = new DOMResult();
} else if (source instanceof SAXSource) {
result = new SAXResult();
} else if (source instanceof StAXSource || source instanceof StreamSource) {
result = null;
}
if (source != null) {
if (validator == null) {
String namespace = "namespace:" + getNamespace(source);
schemaReaderFromDB.setSchemaResourceUri(namespace);
schema = getOrCreateSchema(namespace);
validator = getValidator(schema);
}
if (validator == null)
throw new SchemaNotFoundException("Schema not found for {" + schemaReaderFromDB.getSchemaResourceUri() + "}");
// create a new errorHandler and set it on the validator
// must be a local instance to avoid problems with concurrency (to be
// thread safe)
ValidatorErrorHandler handler = errorHandler.getClass().newInstance();
validator.setErrorHandler(handler);
try {
LOG.trace("Validating {}", source);
validator.validate(source, result);
handler.handleErrors(exchange, schema, result);
} catch (SAXParseException e) {
// can be thrown for non well formed XML
throw new SchemaValidationException(exchange, schema, Collections.singletonList(e),
Collections.emptyList(),
Collections.emptyList());
}
}
} finally {
IOHelper.close(is);
}
}
private String getNamespace(Source source) throws ParserConfigurationException, IOException, SAXException {
StreamSource domSource = (StreamSource) source;
domSource.getInputStream();
DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
factory.setNamespaceAware(true);
DocumentBuilder builder = factory.newDocumentBuilder();
Document document = builder.parse(domSource.getInputStream());
return document.getDocumentElement().getNamespaceURI();
}
private Schema getOrCreateSchema(String resourceUri) throws IOException, SAXException {
if (!schemaMap.containsKey(resourceUri) && resourceUri != null && !resourceUri.isEmpty()) {
schemaMap.put(resourceUri, createSchema());
}
return resourceUri == null ? null : schemaMap.get(resourceUri);
}
private Validator getValidator(Schema schema) {
return schema != null ? schema.newValidator() : null;
}
private Object getContentToValidate(Exchange exchange) {
if (shouldUseHeader()) {
return exchange.getIn().getHeader(headerName);
} else {
return exchange.getIn().getBody();
}
}
private <T> T getContentToValidate(Exchange exchange, Class<T> clazz) {
if (shouldUseHeader()) {
return exchange.getIn().getHeader(headerName, clazz);
} else {
return exchange.getIn().getBody(clazz);
}
}
private boolean shouldUseHeader() {
return headerName != null;
}
public void loadSchema() throws Exception {
schemaReaderFromDB.loadSchema();
}
// Properties
// -----------------------------------------------------------------------
public Schema getSchema() throws IOException, SAXException {
return schemaReaderFromDB.getSchema();
}
public void setSchema(Schema schema) {
schemaReaderFromDB.setSchema(schema);
}
public String getSchemaLanguage() {
return schemaReaderFromDB.getSchemaLanguage();
}
public void setSchemaLanguage(String schemaLanguage) {
schemaReaderFromDB.setSchemaLanguage(schemaLanguage);
}
public Source getSchemaSource() throws IOException {
return schemaReaderFromDB.getSchemaSource();
}
public void setSchemaSource(Source schemaSource) {
schemaReaderFromDB.setSchemaSource(schemaSource);
}
public URL getSchemaUrl() {
return schemaReaderFromDB.getSchemaUrl();
}
public void setSchemaUrl(URL schemaUrl) {
schemaReaderFromDB.setSchemaUrl(schemaUrl);
}
public File getSchemaFile() {
return schemaReaderFromDB.getSchemaFile();
}
public void setSchemaFile(File schemaFile) {
schemaReaderFromDB.setSchemaFile(schemaFile);
}
public byte[] getSchemaAsByteArray() {
return schemaReaderFromDB.getSchemaAsByteArray();
}
public void setSchemaAsByteArray(byte[] schemaAsByteArray) {
schemaReaderFromDB.setSchemaAsByteArray(schemaAsByteArray);
}
public SchemaFactory getSchemaFactory() {
return schemaReaderFromDB.getSchemaFactory();
}
public void setSchemaFactory(SchemaFactory schemaFactory) {
schemaReaderFromDB.setSchemaFactory(schemaFactory);
}
public ValidatorErrorHandler getErrorHandler() {
return errorHandler;
}
public void setErrorHandler(ValidatorErrorHandler errorHandler) {
this.errorHandler = errorHandler;
}
@Deprecated
public boolean isUseDom() {
return useDom;
}
/**
* Sets whether DOMSource and DOMResult should be used.
*
* @param useDom true to use DOM otherwise
*/
@Deprecated
public void setUseDom(boolean useDom) {
this.useDom = useDom;
}
public boolean isUseSharedSchema() {
return useSharedSchema;
}
public void setUseSharedSchema(boolean useSharedSchema) {
this.useSharedSchema = useSharedSchema;
}
public LSResourceResolver getResourceResolver() {
return schemaReaderFromDB.getResourceResolver();
}
public void setResourceResolver(LSResourceResolver resourceResolver) {
schemaReaderFromDB.setResourceResolver(resourceResolver);
}
public boolean isFailOnNullBody() {
return failOnNullBody;
}
public void setFailOnNullBody(boolean failOnNullBody) {
this.failOnNullBody = failOnNullBody;
}
public boolean isFailOnNullHeader() {
return failOnNullHeader;
}
public void setFailOnNullHeader(boolean failOnNullHeader) {
this.failOnNullHeader = failOnNullHeader;
}
public String getHeaderName() {
return headerName;
}
public void setHeaderName(String headerName) {
this.headerName = headerName;
}
// Implementation methods
// -----------------------------------------------------------------------
protected SchemaFactory createSchemaFactory() {
return schemaReaderFromDB.createSchemaFactory();
}
protected Source createSchemaSource() throws IOException {
return schemaReaderFromDB.createSchemaSource();
}
protected Schema createSchema() throws SAXException, IOException {
return schemaReaderFromDB.createSchema();
}
/**
* Checks whether we need an {@link InputStream} to access the message body or header.
* <p/>
* Depending on the content in the message body or header, we may not need to convert
* to {@link InputStream}.
*
* @param exchange the current exchange
* @return <tt>true</tt> to convert to {@link InputStream} beforehand converting to {@link Source} afterwards.
*/
protected boolean isInputStreamNeeded(Exchange exchange) {
Object content = getContentToValidate(exchange);
if (content == null) {
return false;
}
if (content instanceof InputStream) {
return true;
} else if (content instanceof Source) {
return false;
} else if (content instanceof String) {
return false;
} else if (content instanceof byte[]) {
return false;
} else //there is a direct and hopefully optimized converter to Source
if (content instanceof Node) {
return false;
} else return exchange.getContext().getTypeConverterRegistry().lookup(Source.class, content.getClass()) == null;
// yes an input stream is needed
}
/**
* Converts the inbound body or header to a {@link Source}, if it is <b>not</b> already a {@link Source}.
* <p/>
* This implementation will prefer to source in the following order:
* <ul>
* <li>DOM - DOM if explicit configured to use DOM</li>
* <li>SAX - SAX as 2nd choice</li>
* <li>Stream - Stream as 3rd choice</li>
* <li>DOM - DOM as 4th choice</li>
* </ul>
*/
protected Source getSource(Exchange exchange, Object content) {
if (isUseDom()) {
// force DOM
return exchange.getContext().getTypeConverter().tryConvertTo(DOMSource.class, exchange, content);
}
// body or header may already be a source
if (content instanceof Source) {
return (Source) content;
}
Source source = null;
if (content instanceof InputStream) {
return new StreamSource((InputStream) content);
}
if (content != null) {
TypeConverter tc = exchange.getContext().getTypeConverterRegistry().lookup(Source.class, content.getClass());
if (tc != null) {
source = tc.convertTo(Source.class, exchange, content);
}
}
if (source == null) {
// then try SAX
source = exchange.getContext().getTypeConverter().tryConvertTo(SAXSource.class, exchange, content);
}
if (source == null) {
// then try stream
source = exchange.getContext().getTypeConverter().tryConvertTo(StreamSource.class, exchange, content);
}
if (source == null) {
// and fallback to DOM
source = exchange.getContext().getTypeConverter().tryConvertTo(DOMSource.class, exchange, content);
}
if (source == null) {
if (isFailOnNullBody()) {
throw new ExpectedBodyTypeException(exchange, Source.class);
} else {
try {
source = converter.toDOMSource(converter.createDocument());
} catch (ParserConfigurationException e) {
throw new RuntimeTransformException(e);
}
}
}
return source;
}
}

View File

@ -0,0 +1,38 @@
/*-
* ~~~~~~licensing~~~~~~
* schema-component
* ==========
* Copyright (C) 2020 - 2021 EmDev LLC
* ==========
* Licensed 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.
* ~~~~~~/licensing~~~~~~
*/
package ru.entaxy.esb.system.registry.schema.component;
import org.apache.camel.Endpoint;
import org.apache.camel.support.DefaultComponent;
import java.util.Map;
public class ValidatorWithDBStorageComponent extends DefaultComponent {
@Override
protected Endpoint createEndpoint(String uri, String xsdScheme, Map<String, Object> parameters) throws Exception {
ValidatorWithDBStorageEndpoint endpoint = new ValidatorWithDBStorageEndpoint(uri, this);
endpoint.setUri(uri);
setProperties(endpoint, parameters);
return endpoint;
}
}

View File

@ -0,0 +1,131 @@
/*-
* ~~~~~~licensing~~~~~~
* schema-component
* ==========
* Copyright (C) 2020 - 2021 EmDev LLC
* ==========
* Licensed 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.
* ~~~~~~/licensing~~~~~~
*/
package ru.entaxy.esb.system.registry.schema.component;
import org.apache.camel.Component;
import org.apache.camel.Consumer;
import org.apache.camel.Processor;
import org.apache.camel.Producer;
import org.apache.camel.spi.Metadata;
import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
import org.apache.camel.spi.UriPath;
import org.apache.camel.support.DefaultEndpoint;
import org.osgi.framework.FrameworkUtil;
import org.w3c.dom.ls.LSResourceResolver;
import ru.entaxy.esb.system.common.osgi.OSGIUtils;
import ru.entaxy.esb.system.registry.schema.api.ResourceService;
import ru.entaxy.esb.system.registry.schema.component.util.SchemaReaderFromDB;
@UriEndpoint(
scheme = "validatorWithDBStorage",
title = "ValidatorWithDBStorage",
syntax = "validatorWithDBStorage:namespace",
label = "Custom validator component with loader resources from db",
producerOnly = true)
public class ValidatorWithDBStorageEndpoint extends DefaultEndpoint {
@UriPath(description = "URL to a local resource on the classpath, or a reference to lookup a bean in the Registry,"
+ " or a full URL to a remote resource or resource on the file system which contains the XSD to validate against.")
@Metadata(required = true)
private String uri;
@UriParam(description = "Version")
@Metadata(required = true)
private String version;
/**
* We need a one-to-one relation between endpoint and schema reader in order
* to be able to clear the cached schema in the schema reader. See method
*/
private final SchemaReaderFromDB schemaReaderFromDB;
private volatile boolean schemaReaderConfigured;
private ResourceService resourceService;
private LSResourceResolver resourceResolver;
public ValidatorWithDBStorageEndpoint(String uri, Component component) {
super(uri, component);
this.uri = uri.replace("validatorWithDBStorage://", "").replace("validatorWithDBStorage:", "").replace("validatorWithDBStorage", "");
schemaReaderFromDB = this.uri.isEmpty() ? new SchemaReaderFromDB() :
new SchemaReaderFromDB(getCamelContext(), this.uri, version);
}
public Producer createProducer() throws Exception {
if (!schemaReaderConfigured) {
if (resourceResolver != null) {
schemaReaderFromDB.setResourceResolver(getResourceResolver());
}
schemaReaderFromDB.setResourceService(getResourceService());
// force loading of schema at create time otherwise concurrent
// processing could cause thread safe issues for the
// javax.xml.validation.SchemaFactory
schemaReaderFromDB.loadSchema();
// configure only once
schemaReaderConfigured = true;
}
ValidatingProcessor validator = new ValidatingProcessor(schemaReaderFromDB, uri);
return new ValidatorWithDBStorageProducer(this, validator);
}
public Consumer createConsumer(Processor processor) throws Exception {
return null;
}
public boolean isSingleton() {
return true;
}
public String getUri() {
return uri;
}
public void setUri(String uri) {
this.uri = uri;
}
public ResourceService getResourceService() {
if (resourceService == null) {
resourceService = (ResourceService) OSGIUtils.getServiceReference(
FrameworkUtil.getBundle(ValidatorWithDBStorageEndpoint.class).getBundleContext(),
ResourceService.class.getName());
}
return resourceService;
}
private LSResourceResolver getResourceResolver() {
if (resourceResolver == null) {
resourceResolver = (LSResourceResolver) OSGIUtils.getServiceReference(
FrameworkUtil.getBundle(ValidatorWithDBStorageEndpoint.class).getBundleContext(),
LSResourceResolver.class.getName());
}
return resourceResolver;
}
public void setVersion(String version) {
this.version = version;
}
public String getVersion() {
return version;
}
}

View File

@ -0,0 +1,63 @@
/*-
* ~~~~~~licensing~~~~~~
* schema-component
* ==========
* Copyright (C) 2020 - 2021 EmDev LLC
* ==========
* Licensed 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.
* ~~~~~~/licensing~~~~~~
*/
package ru.entaxy.esb.system.registry.schema.component;
import org.apache.camel.AsyncCallback;
import org.apache.camel.Endpoint;
import org.apache.camel.Exchange;
import org.apache.camel.support.DefaultAsyncProducer;
import org.apache.camel.support.service.ServiceHelper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class ValidatorWithDBStorageProducer extends DefaultAsyncProducer {
private static final Logger LOG = LoggerFactory.getLogger(ValidatorWithDBStorageProducer.class);
private final ValidatingProcessor validatingProcessor;
public ValidatorWithDBStorageProducer(Endpoint endpoint, ValidatingProcessor validatingProcessor) {
super(endpoint);
this.validatingProcessor = validatingProcessor;
}
@Override
public boolean process(Exchange exchange, AsyncCallback callback) {
return validatingProcessor.process(exchange, callback);
}
@Override
protected void doStart() throws Exception {
super.doStart();
ServiceHelper.startService(validatingProcessor);
}
@Override
protected void doStop() throws Exception {
super.doStop();
ServiceHelper.stopService(validatingProcessor);
}
@Override
protected void doShutdown() throws Exception {
super.doStop();
ServiceHelper.stopAndShutdownService(validatingProcessor);
}
}

View File

@ -0,0 +1,47 @@
/*-
* ~~~~~~licensing~~~~~~
* schema-component
* ==========
* Copyright (C) 2020 - 2021 EmDev LLC
* ==========
* Licensed 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.
* ~~~~~~/licensing~~~~~~
*/
package ru.entaxy.esb.system.registry.schema.component.exception;
public class SchemaNotFoundException extends Exception {
private static final long serialVersionUID = 948229285513408917L;
public SchemaNotFoundException() {
super();
}
public SchemaNotFoundException(String message, Throwable cause, boolean enableSuppression,
boolean writableStackTrace) {
super(message, cause, enableSuppression, writableStackTrace);
}
public SchemaNotFoundException(String message, Throwable cause) {
super(message, cause);
}
public SchemaNotFoundException(String message) {
super(message);
}
public SchemaNotFoundException(Throwable cause) {
super(cause);
}
}

View File

@ -0,0 +1,221 @@
/*-
* ~~~~~~licensing~~~~~~
* schema-component
* ==========
* Copyright (C) 2020 - 2021 EmDev LLC
* ==========
* Licensed 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.
* ~~~~~~/licensing~~~~~~
*/
package ru.entaxy.esb.system.registry.schema.component.util;
import org.apache.camel.CamelContext;
import org.apache.camel.util.ObjectHelper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.w3c.dom.ls.LSResourceResolver;
import org.xml.sax.SAXException;
import ru.entaxy.esb.system.registry.schema.api.ResourceService;
import ru.entaxy.esb.system.registry.schema.api.entity.Resource;
import javax.xml.XMLConstants;
import javax.xml.transform.Source;
import javax.xml.transform.stream.StreamSource;
import javax.xml.validation.Schema;
import javax.xml.validation.SchemaFactory;
import java.io.ByteArrayInputStream;
import java.io.File;
import java.io.IOException;
import java.net.URL;
import java.util.Optional;
public class SchemaReaderFromDB {
/**
* Key of the global option to switch either off or on the access to external DTDs in the XML Validator for StreamSources.
* Only effective, if not a custom schema factory is used.
*/
public static final String ACCESS_EXTERNAL_DTD = "CamelXmlValidatorAccessExternalDTD";
private static final Logger LOG = LoggerFactory.getLogger(SchemaReaderFromDB.class);
private String schemaLanguage = XMLConstants.W3C_XML_SCHEMA_NS_URI;
// must be volatile because is accessed from different threads see ValidatorEndpoint.clearCachedSchema
private volatile Schema schema;
private Source schemaSource;
// must be volatile because is accessed from different threads see ValidatorEndpoint.clearCachedSchema
private volatile SchemaFactory schemaFactory;
private URL schemaUrl;
private File schemaFile;
private byte[] schemaAsByteArray;
private String schemaResourceUri;
private String version;
private LSResourceResolver resourceResolver;
private ResourceService resourceService;
private final CamelContext camelContext;
public SchemaReaderFromDB() {
this.camelContext = null;
this.schemaResourceUri = null;
}
/**
* Specify a camel context and a schema resource URI in order to read the schema via the class resolver specified in the Camel context.
*/
public SchemaReaderFromDB(CamelContext camelContext, String schemaResourceUri, String version) {
ObjectHelper.notNull(camelContext, "camelContext");
ObjectHelper.notNull(schemaResourceUri, "schemaResourceUri");
this.camelContext = camelContext;
this.schemaResourceUri = schemaResourceUri;
this.version = version;
}
public void loadSchema() throws Exception {
// force loading of schema
schema = createSchema();
}
// Properties
// -----------------------------------------------------------------------
public Schema getSchema() throws IOException, SAXException {
if (schema == null) {
synchronized (this) {
if (schema == null) {
schema = createSchema();
}
}
}
return schema;
}
public void setSchema(Schema schema) {
this.schema = schema;
}
public String getSchemaLanguage() {
return schemaLanguage;
}
public void setSchemaLanguage(String schemaLanguage) {
this.schemaLanguage = schemaLanguage;
}
public Source getSchemaSource() throws IOException {
if (schemaSource == null) {
schemaSource = createSchemaSource();
}
return schemaSource;
}
public void setSchemaSource(Source schemaSource) {
this.schemaSource = schemaSource;
}
public URL getSchemaUrl() {
return schemaUrl;
}
public void setSchemaUrl(URL schemaUrl) {
this.schemaUrl = schemaUrl;
}
public File getSchemaFile() {
return schemaFile;
}
public void setSchemaFile(File schemaFile) {
this.schemaFile = schemaFile;
}
public byte[] getSchemaAsByteArray() {
return schemaAsByteArray;
}
public void setSchemaAsByteArray(byte[] schemaAsByteArray) {
this.schemaAsByteArray = schemaAsByteArray;
}
public SchemaFactory getSchemaFactory() {
if (schemaFactory == null) {
synchronized (this) {
if (schemaFactory == null) {
schemaFactory = createSchemaFactory();
}
}
}
return schemaFactory;
}
public void setSchemaFactory(SchemaFactory schemaFactory) {
this.schemaFactory = schemaFactory;
}
public void setResourceService(ResourceService resourceService) {
this.resourceService = resourceService;
}
public LSResourceResolver getResourceResolver() {
return resourceResolver;
}
public void setResourceResolver(LSResourceResolver resourceResolver) {
this.resourceResolver = resourceResolver;
}
public void setSchemaResourceUri(String schemaResourceUri) {
this.schemaResourceUri = schemaResourceUri;
}
public String getSchemaResourceUri() {
return schemaResourceUri;
}
public SchemaFactory createSchemaFactory() {
SchemaFactory factory = SchemaFactory.newInstance(schemaLanguage);
if (getResourceResolver() != null) {
factory.setResourceResolver(getResourceResolver());
}
if (camelContext == null || !Boolean.parseBoolean(camelContext.getGlobalOptions().get(ACCESS_EXTERNAL_DTD))) {
try {
LOG.debug("Configuring SchemaFactory to not allow access to external DTD/Schema");
factory.setProperty(XMLConstants.ACCESS_EXTERNAL_DTD, "");
} catch (SAXException e) {
LOG.warn(e.getMessage(), e);
}
}
return factory;
}
public Source createSchemaSource() throws IOException {
throw new IllegalArgumentException("You must specify either a schema, schemaFile, schemaSource, schemaUrl, or schemaUri property");
}
public Schema createSchema() throws SAXException, IOException {
SchemaFactory factory = getSchemaFactory();
Optional<Resource> resource = Optional.empty();
if (schemaResourceUri != null && schemaResourceUri.contains("namespace:")) {
resource = resourceService.getResourceByNamespace(schemaResourceUri.replace("namespace:", ""));
}
if (schemaResourceUri != null && schemaResourceUri.contains("uuid:")) {
resource = resourceService.getResourceByNamespace(schemaResourceUri.replace("uuid:", ""));
}
if (resource.isPresent())
return factory.newSchema(new StreamSource(new ByteArrayInputStream(resource.get().getResourceValue())));
return null;
}
}

View File

@ -0,0 +1,30 @@
###
# ~~~~~~licensing~~~~~~
# schema-component
# ==========
# Copyright (C) 2020 - 2021 EmDev LLC
# ==========
# Licensed 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.
# ~~~~~~/licensing~~~~~~
###
appender.file.type=File
appender.file.name=file
appender.file.fileName=target/camel-test.log
appender.file.layout.type=PatternLayout
appender.file.layout.pattern=%d %-5p %c{1} - %m %n
appender.out.type=Console
appender.out.name=out
appender.out.layout.type=PatternLayout
appender.out.layout.pattern=[%30.30t] %-30.30c{1} %-5p %m%n
rootLogger.level=INFO
rootLogger.appenderRef.out.ref=out