You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by kw...@apache.org on 2017/02/21 10:37:21 UTC
svn commit: r1783863 - in /sling/trunk/bundles/extensions/validation/core:
./ src/main/java/org/apache/sling/validation/impl/
src/main/java/org/apache/sling/validation/impl/resourcemodel/
src/main/java/org/apache/sling/validation/impl/validators/ src/t...
Author: kwin
Date: Tue Feb 21 10:37:20 2017
New Revision: 1783863
URL: http://svn.apache.org/viewvc?rev=1783863&view=rev
Log:
SLING-6534 optionally cache ValidationResult
migrate to OSGi DS annotations
Added:
sling/trunk/bundles/extensions/validation/core/src/main/java/org/apache/sling/validation/impl/ResourceToValidationResultAdapterFactory.java (with props)
sling/trunk/bundles/extensions/validation/core/src/main/java/org/apache/sling/validation/impl/ValidationServiceConfiguration.java (with props)
Modified:
sling/trunk/bundles/extensions/validation/core/pom.xml
sling/trunk/bundles/extensions/validation/core/src/main/java/org/apache/sling/validation/impl/ValidationModelCacheImpl.java
sling/trunk/bundles/extensions/validation/core/src/main/java/org/apache/sling/validation/impl/ValidationModelRetrieverImpl.java
sling/trunk/bundles/extensions/validation/core/src/main/java/org/apache/sling/validation/impl/ValidationServiceImpl.java
sling/trunk/bundles/extensions/validation/core/src/main/java/org/apache/sling/validation/impl/resourcemodel/ResourceValidationModelProviderImpl.java
sling/trunk/bundles/extensions/validation/core/src/main/java/org/apache/sling/validation/impl/validators/RegexValidator.java
sling/trunk/bundles/extensions/validation/core/src/test/java/org/apache/sling/validation/impl/ValidationServiceImplTest.java
Modified: sling/trunk/bundles/extensions/validation/core/pom.xml
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/extensions/validation/core/pom.xml?rev=1783863&r1=1783862&r2=1783863&view=diff
==============================================================================
--- sling/trunk/bundles/extensions/validation/core/pom.xml (original)
+++ sling/trunk/bundles/extensions/validation/core/pom.xml Tue Feb 21 10:37:20 2017
@@ -47,10 +47,6 @@
<plugins>
<plugin>
<groupId>org.apache.felix</groupId>
- <artifactId>maven-scr-plugin</artifactId>
- </plugin>
- <plugin>
- <groupId>org.apache.felix</groupId>
<artifactId>maven-bundle-plugin</artifactId>
<extensions>true</extensions>
<configuration>
@@ -58,7 +54,6 @@
<!-- embed the commons.osgi bundle as described in http://njbartlett.name/2014/05/26/static-linking.html,
to make this bundle compatible with older versions of Sling -->
<Conditional-Package>org.apache.sling.commons.osgi</Conditional-Package>
- <Bundle-Category>sling</Bundle-Category>
<Sling-Initial-Content>SLING-INF;overwrite=true</Sling-Initial-Content>
</instructions>
</configuration>
Added: sling/trunk/bundles/extensions/validation/core/src/main/java/org/apache/sling/validation/impl/ResourceToValidationResultAdapterFactory.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/extensions/validation/core/src/main/java/org/apache/sling/validation/impl/ResourceToValidationResultAdapterFactory.java?rev=1783863&view=auto
==============================================================================
--- sling/trunk/bundles/extensions/validation/core/src/main/java/org/apache/sling/validation/impl/ResourceToValidationResultAdapterFactory.java (added)
+++ sling/trunk/bundles/extensions/validation/core/src/main/java/org/apache/sling/validation/impl/ResourceToValidationResultAdapterFactory.java Tue Feb 21 10:37:20 2017
@@ -0,0 +1,59 @@
+/*
+ * 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.apache.sling.validation.impl;
+
+import org.apache.sling.api.adapter.AdapterFactory;
+import org.apache.sling.api.resource.Resource;
+import org.apache.sling.validation.ValidationFailure;
+import org.apache.sling.validation.ValidationResult;
+import org.osgi.service.component.annotations.Component;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+@Component(property={AdapterFactory.ADAPTABLE_CLASSES+"=org.apache.sling.api.Resource", AdapterFactory.ADAPTER_CLASSES+"=org.apache.sling.validation.ValidationResult"})
+public class ResourceToValidationResultAdapterFactory implements AdapterFactory {
+
+ private static final Logger LOG = LoggerFactory.getLogger(ResourceToValidationResultAdapterFactory.class);
+
+ private static final String KEY_RESOURCE_METADATA = "sling.validationResult";
+
+ @SuppressWarnings("unchecked")
+ public <AdapterType> AdapterType getAdapter(Object adaptable, Class<AdapterType> type) {
+ AdapterType adapter = null;
+ if (adaptable instanceof Resource) {
+ final Resource resource = (Resource) adaptable;
+ if (type == ValidationFailure.class) {
+ return (AdapterType)getValidationResultFromCache(resource);
+ } else {
+ LOG.warn("Cannot handle adapter {}", type.getName());
+ }
+ } else {
+ LOG.warn("Cannot handle adaptable {}", adaptable.getClass().getName());
+ }
+ return adapter;
+ }
+
+ public static void putValidationResultToCache(ValidationResult validationResult, Resource resource) {
+ resource.getResourceMetadata().put(KEY_RESOURCE_METADATA, validationResult);
+ }
+
+ private ValidationFailure getValidationResultFromCache(Resource resource) {
+ return (ValidationFailure) resource.getResourceMetadata().get(KEY_RESOURCE_METADATA);
+ }
+}
Propchange: sling/trunk/bundles/extensions/validation/core/src/main/java/org/apache/sling/validation/impl/ResourceToValidationResultAdapterFactory.java
------------------------------------------------------------------------------
svn:mime-type = text/plain
Modified: sling/trunk/bundles/extensions/validation/core/src/main/java/org/apache/sling/validation/impl/ValidationModelCacheImpl.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/extensions/validation/core/src/main/java/org/apache/sling/validation/impl/ValidationModelCacheImpl.java?rev=1783863&r1=1783862&r2=1783863&view=diff
==============================================================================
--- sling/trunk/bundles/extensions/validation/core/src/main/java/org/apache/sling/validation/impl/ValidationModelCacheImpl.java (original)
+++ sling/trunk/bundles/extensions/validation/core/src/main/java/org/apache/sling/validation/impl/ValidationModelCacheImpl.java Tue Feb 21 10:37:20 2017
@@ -20,17 +20,15 @@ package org.apache.sling.validation.impl
import java.util.Dictionary;
-import org.apache.felix.scr.annotations.Component;
-import org.apache.felix.scr.annotations.Reference;
-import org.apache.felix.scr.annotations.Service;
import org.apache.sling.validation.model.spi.ValidationModelCache;
+import org.osgi.service.component.annotations.Component;
+import org.osgi.service.component.annotations.Reference;
import org.osgi.service.event.Event;
import org.osgi.service.event.EventAdmin;
/**
* Invalidates the cache of the {@link ValidationModelRetrieverImpl} by sending an event through the {@link EventAdmin}
*/
-@Service
@Component
public class ValidationModelCacheImpl implements ValidationModelCache {
Modified: sling/trunk/bundles/extensions/validation/core/src/main/java/org/apache/sling/validation/impl/ValidationModelRetrieverImpl.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/extensions/validation/core/src/main/java/org/apache/sling/validation/impl/ValidationModelRetrieverImpl.java?rev=1783863&r1=1783862&r2=1783863&view=diff
==============================================================================
--- sling/trunk/bundles/extensions/validation/core/src/main/java/org/apache/sling/validation/impl/ValidationModelRetrieverImpl.java (original)
+++ sling/trunk/bundles/extensions/validation/core/src/main/java/org/apache/sling/validation/impl/ValidationModelRetrieverImpl.java Tue Feb 21 10:37:20 2017
@@ -26,12 +26,6 @@ import java.util.concurrent.ConcurrentHa
import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;
-import org.apache.felix.scr.annotations.Component;
-import org.apache.felix.scr.annotations.Property;
-import org.apache.felix.scr.annotations.Reference;
-import org.apache.felix.scr.annotations.ReferenceCardinality;
-import org.apache.felix.scr.annotations.ReferencePolicy;
-import org.apache.felix.scr.annotations.Service;
import org.apache.sling.api.resource.LoginException;
import org.apache.sling.api.resource.ResourceResolver;
import org.apache.sling.api.resource.ResourceResolverFactory;
@@ -41,6 +35,10 @@ import org.apache.sling.validation.impl.
import org.apache.sling.validation.model.ValidationModel;
import org.apache.sling.validation.model.spi.ValidationModelProvider;
import org.apache.sling.validation.spi.Validator;
+import org.osgi.service.component.annotations.Component;
+import org.osgi.service.component.annotations.Reference;
+import org.osgi.service.component.annotations.ReferenceCardinality;
+import org.osgi.service.component.annotations.ReferencePolicy;
import org.osgi.service.event.Event;
import org.osgi.service.event.EventConstants;
import org.osgi.service.event.EventHandler;
@@ -52,11 +50,9 @@ import org.slf4j.LoggerFactory;
* {@link ValidationModelProvider}s. Also implements a cache of all previously retrieved models.
*
*/
-@Service
-@Component
+@Component(property={EventConstants.EVENT_TOPIC+"="+ValidationModelRetrieverImpl.CACHE_INVALIDATION_EVENT_TOPIC})
public class ValidationModelRetrieverImpl implements ValidationModelRetriever, EventHandler {
- @Property(name = EventConstants.EVENT_TOPIC)
public static final String CACHE_INVALIDATION_EVENT_TOPIC = "org/apache/sling/validation/cache/INVALIDATE";
/**
@@ -66,13 +62,13 @@ public class ValidationModelRetrieverImp
protected Map<String, Trie<ValidationModel>> validationModelsCache = new ConcurrentHashMap<String, Trie<ValidationModel>>();
/** Map of validation providers (key=service properties) */
- @Reference(name = "modelProvider", referenceInterface = ValidationModelProvider.class, policy = ReferencePolicy.DYNAMIC, cardinality = ReferenceCardinality.OPTIONAL_MULTIPLE)
+ @Reference(name = "modelProvider", service = ValidationModelProvider.class, bind="bindModelProvider", policy = ReferencePolicy.DYNAMIC, cardinality = ReferenceCardinality.MULTIPLE)
private RankedServices<ValidationModelProvider> modelProviders = new RankedServices<ValidationModelProvider>();
/**
* List of all known validators (key=classname of validator)
*/
- @Reference(name = "validator", referenceInterface = Validator.class, policy = ReferencePolicy.DYNAMIC, cardinality = ReferenceCardinality.OPTIONAL_MULTIPLE)
+ @Reference(name = "validator", service = Validator.class, bind="bindValidator",policy = ReferencePolicy.DYNAMIC, cardinality = ReferenceCardinality.MULTIPLE)
@Nonnull Map<String, Validator<?>> validators = new ConcurrentHashMap<String, Validator<?>>();
@Reference
Added: sling/trunk/bundles/extensions/validation/core/src/main/java/org/apache/sling/validation/impl/ValidationServiceConfiguration.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/extensions/validation/core/src/main/java/org/apache/sling/validation/impl/ValidationServiceConfiguration.java?rev=1783863&view=auto
==============================================================================
--- sling/trunk/bundles/extensions/validation/core/src/main/java/org/apache/sling/validation/impl/ValidationServiceConfiguration.java (added)
+++ sling/trunk/bundles/extensions/validation/core/src/main/java/org/apache/sling/validation/impl/ValidationServiceConfiguration.java Tue Feb 21 10:37:20 2017
@@ -0,0 +1,28 @@
+/*
+ * 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.apache.sling.validation.impl;
+
+import org.osgi.service.metatype.annotations.AttributeDefinition;
+import org.osgi.service.metatype.annotations.ObjectClassDefinition;
+
+@ObjectClassDefinition(name = "Apache Sling Validation Configuration", description = "Allows to influence the validation behaviour")
+public @interface ValidationServiceConfiguration {
+ @AttributeDefinition(name = "Cache Validation Results on Resources", description = "If enabled will cache the validation result from calls to ValidationService.validate(Resource,ValidationModel) and expose it via Resource.adaptTo('ValidationResult.class').")
+ boolean cacheValidationResultsOnResources() default false;
+}
Propchange: sling/trunk/bundles/extensions/validation/core/src/main/java/org/apache/sling/validation/impl/ValidationServiceConfiguration.java
------------------------------------------------------------------------------
svn:mime-type = text/plain
Modified: sling/trunk/bundles/extensions/validation/core/src/main/java/org/apache/sling/validation/impl/ValidationServiceImpl.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/extensions/validation/core/src/main/java/org/apache/sling/validation/impl/ValidationServiceImpl.java?rev=1783863&r1=1783862&r2=1783863&view=diff
==============================================================================
--- sling/trunk/bundles/extensions/validation/core/src/main/java/org/apache/sling/validation/impl/ValidationServiceImpl.java (original)
+++ sling/trunk/bundles/extensions/validation/core/src/main/java/org/apache/sling/validation/impl/ValidationServiceImpl.java Tue Feb 21 10:37:20 2017
@@ -30,15 +30,10 @@ import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;
import org.apache.commons.lang3.StringUtils;
-import org.apache.felix.scr.annotations.Activate;
-import org.apache.felix.scr.annotations.Component;
-import org.apache.felix.scr.annotations.Reference;
-import org.apache.felix.scr.annotations.Service;
import org.apache.sling.api.resource.LoginException;
import org.apache.sling.api.resource.Resource;
import org.apache.sling.api.resource.ResourceResolver;
import org.apache.sling.api.resource.ResourceResolverFactory;
-import org.apache.sling.api.resource.ResourceUtil;
import org.apache.sling.api.resource.ValueMap;
import org.apache.sling.api.wrappers.ValueMapDecorator;
import org.apache.sling.validation.SlingValidationException;
@@ -50,11 +45,13 @@ import org.apache.sling.validation.model
import org.apache.sling.validation.model.ValidationModel;
import org.apache.sling.validation.spi.ValidationContext;
import org.apache.sling.validation.spi.Validator;
+import org.osgi.service.component.annotations.Activate;
+import org.osgi.service.component.annotations.Component;
+import org.osgi.service.component.annotations.Reference;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-@Component()
-@Service()
+@Component
public class ValidationServiceImpl implements ValidationService{
/** Keys whose values are defined in the JCR resource bundle contained in the content-repository section of this bundle */
@@ -73,12 +70,15 @@ public class ValidationServiceImpl imple
Collection<String> searchPaths;
+ ValidationServiceConfiguration configuration;
+
@Reference
private ResourceResolverFactory rrf = null;
@Activate
- public void activate() {
+ public void activate(ValidationServiceConfiguration configuration) {
+ this.configuration = configuration;
ResourceResolver rr = null;
try {
rr = rrf.getAdministrativeResourceResolver(null);
@@ -159,6 +159,11 @@ public class ValidationServiceImpl imple
// validate child resources, if any
validateChildren(resource, relativePath, model.getChildren(), result);
+
+ // optionally put result to cache
+ if (configuration.cacheValidationResultsOnResources()) {
+ ResourceToValidationResultAdapterFactory.putValidationResultToCache(result, resource);
+ }
return result;
}
Modified: sling/trunk/bundles/extensions/validation/core/src/main/java/org/apache/sling/validation/impl/resourcemodel/ResourceValidationModelProviderImpl.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/extensions/validation/core/src/main/java/org/apache/sling/validation/impl/resourcemodel/ResourceValidationModelProviderImpl.java?rev=1783863&r1=1783862&r2=1783863&view=diff
==============================================================================
--- sling/trunk/bundles/extensions/validation/core/src/main/java/org/apache/sling/validation/impl/resourcemodel/ResourceValidationModelProviderImpl.java (original)
+++ sling/trunk/bundles/extensions/validation/core/src/main/java/org/apache/sling/validation/impl/resourcemodel/ResourceValidationModelProviderImpl.java Tue Feb 21 10:37:20 2017
@@ -29,11 +29,6 @@ import java.util.Map;
import javax.annotation.Nonnull;
-import org.apache.felix.scr.annotations.Activate;
-import org.apache.felix.scr.annotations.Component;
-import org.apache.felix.scr.annotations.Deactivate;
-import org.apache.felix.scr.annotations.Reference;
-import org.apache.felix.scr.annotations.Service;
import org.apache.sling.api.SlingConstants;
import org.apache.sling.api.resource.LoginException;
import org.apache.sling.api.resource.Resource;
@@ -57,6 +52,10 @@ import org.apache.sling.validation.model
import org.apache.sling.validation.spi.Validator;
import org.osgi.framework.ServiceRegistration;
import org.osgi.service.component.ComponentContext;
+import org.osgi.service.component.annotations.Activate;
+import org.osgi.service.component.annotations.Component;
+import org.osgi.service.component.annotations.Deactivate;
+import org.osgi.service.component.annotations.Reference;
import org.osgi.service.event.Event;
import org.osgi.service.event.EventConstants;
import org.osgi.service.event.EventHandler;
@@ -64,8 +63,7 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
//the event handler is dynamic and registered in the activate method
-@Service(value = ValidationModelProvider.class)
-@Component
+@Component(service = ValidationModelProvider.class)
public class ResourceValidationModelProviderImpl implements ValidationModelProvider, EventHandler {
static final String MODEL_XPATH_QUERY = "/jcr:root%s/*[@sling:resourceType=\""+ResourceValidationModelProviderImpl.VALIDATION_MODEL_RESOURCE_TYPE+"\" and @"+ResourceValidationModelProviderImpl.VALIDATED_RESOURCE_TYPE+"=\"%s\"]";
Modified: sling/trunk/bundles/extensions/validation/core/src/main/java/org/apache/sling/validation/impl/validators/RegexValidator.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/extensions/validation/core/src/main/java/org/apache/sling/validation/impl/validators/RegexValidator.java?rev=1783863&r1=1783862&r2=1783863&view=diff
==============================================================================
--- sling/trunk/bundles/extensions/validation/core/src/main/java/org/apache/sling/validation/impl/validators/RegexValidator.java (original)
+++ sling/trunk/bundles/extensions/validation/core/src/main/java/org/apache/sling/validation/impl/validators/RegexValidator.java Tue Feb 21 10:37:20 2017
@@ -24,21 +24,19 @@ import java.util.regex.PatternSyntaxExce
import javax.annotation.Nonnull;
import org.apache.commons.lang3.StringUtils;
-import org.apache.felix.scr.annotations.Component;
-import org.apache.felix.scr.annotations.Service;
import org.apache.sling.api.resource.ValueMap;
-import org.apache.sling.validation.ValidationResult;
import org.apache.sling.validation.SlingValidationException;
+import org.apache.sling.validation.ValidationResult;
import org.apache.sling.validation.spi.DefaultValidationResult;
import org.apache.sling.validation.spi.ValidationContext;
import org.apache.sling.validation.spi.Validator;
+import org.osgi.service.component.annotations.Component;
/**
* Performs regular expressions validation on the supplied data with the help of the {@link Pattern} class. This {@code Validator} expects a
* mandatory parameter in the arguments map: {@link RegexValidator#REGEX_PARAM}.
*/
-@Component()
-@Service(Validator.class)
+@Component
public class RegexValidator implements Validator<String> {
public static final String I18N_KEY_PATTERN_DOES_NOT_MATCH = "sling.validator.regex.pattern-does-not-match";
Modified: sling/trunk/bundles/extensions/validation/core/src/test/java/org/apache/sling/validation/impl/ValidationServiceImplTest.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/extensions/validation/core/src/test/java/org/apache/sling/validation/impl/ValidationServiceImplTest.java?rev=1783863&r1=1783862&r2=1783863&view=diff
==============================================================================
--- sling/trunk/bundles/extensions/validation/core/src/test/java/org/apache/sling/validation/impl/ValidationServiceImplTest.java (original)
+++ sling/trunk/bundles/extensions/validation/core/src/test/java/org/apache/sling/validation/impl/ValidationServiceImplTest.java Tue Feb 21 10:37:20 2017
@@ -62,7 +62,11 @@ import org.junit.Assert;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.Mock;
+import org.mockito.runners.MockitoJUnitRunner;
+@RunWith(MockitoJUnitRunner.class)
public class ValidationServiceImplTest {
/**
@@ -73,6 +77,9 @@ public class ValidationServiceImplTest {
private ValidationModelBuilder modelBuilder;
private ResourcePropertyBuilder propertyBuilder;
+
+ @Mock
+ ValidationServiceConfiguration configuration;
@Rule
public SlingContext context = new SlingContext();
@@ -81,6 +88,7 @@ public class ValidationServiceImplTest {
public void setUp() throws LoginException, PersistenceException, RepositoryException {
validationService = new ValidationServiceImpl();
validationService.searchPaths = Arrays.asList(context.resourceResolver().getSearchPath());
+ validationService.configuration = configuration;
modelBuilder = new ValidationModelBuilder();
propertyBuilder = new ResourcePropertyBuilder();
}