You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by fm...@apache.org on 2014/11/19 10:30:39 UTC
svn commit: r1640508 - in /sling/trunk/contrib/scripting/sightly/engine: ./
src/main/java/org/apache/sling/scripting/sightly/api/
Author: fmeschbe
Date: Wed Nov 19 09:30:38 2014
New Revision: 1640508
URL: http://svn.apache.org/r1640508
Log:
SLING-4180 - Sightly Engine should properly reimport its own API export
* added ProviderType annotation for services implemented by the engine bundle
* added ConsumerType annotation for services that can be implemented by other bundles
This closes #43
(Applying patch by Radu Cotescu with the exception of the Exceptions which I don't annotate for now; Thanks for providing the patch)
Added:
sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/package-info.java (with props)
Modified:
sling/trunk/contrib/scripting/sightly/engine/pom.xml
sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/BaseRenderUnit.java
sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/ExtensionInstance.java
sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/ObjectModel.java
sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/ProviderOutcome.java
sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/Record.java
sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/RenderContext.java
sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/RenderUnit.java
sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/ResourceResolution.java
sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/RuntimeExtension.java
sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/RuntimeExtensionComponent.java
sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/SightlyRuntime.java
sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/StackedWriter.java
sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/UnitLocator.java
sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/Use.java
sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/UseProvider.java
sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/UseProviderComponent.java
Modified: sling/trunk/contrib/scripting/sightly/engine/pom.xml
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/scripting/sightly/engine/pom.xml?rev=1640508&r1=1640507&r2=1640508&view=diff
==============================================================================
--- sling/trunk/contrib/scripting/sightly/engine/pom.xml (original)
+++ sling/trunk/contrib/scripting/sightly/engine/pom.xml Wed Nov 19 09:30:38 2014
@@ -79,7 +79,7 @@
<instructions>
<Embed-Dependency>antlr4-runtime,org.abego.treelayout.core</Embed-Dependency>
<Export-Package>
- org.apache.sling.scripting.sightly.api;version=1.0.0
+ org.apache.sling.scripting.sightly.api
</Export-Package>
<ScriptEngine-Name>${project.name}</ScriptEngine-Name>
<ScriptEngine-Version>${project.version}</ScriptEngine-Version>
Modified: sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/BaseRenderUnit.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/BaseRenderUnit.java?rev=1640508&r1=1640507&r2=1640508&view=diff
==============================================================================
--- sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/BaseRenderUnit.java (original)
+++ sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/BaseRenderUnit.java Wed Nov 19 09:30:38 2014
@@ -26,9 +26,12 @@ import java.util.Set;
import javax.script.Bindings;
import javax.script.SimpleBindings;
+import aQute.bnd.annotation.ProviderType;
+
/**
* Compiled version of render units
*/
+@ProviderType
public abstract class BaseRenderUnit implements RenderUnit {
private final Map<String, RenderUnit> subTemplates = new HashMap<String, RenderUnit>();
Modified: sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/ExtensionInstance.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/ExtensionInstance.java?rev=1640508&r1=1640507&r2=1640508&view=diff
==============================================================================
--- sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/ExtensionInstance.java (original)
+++ sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/ExtensionInstance.java Wed Nov 19 09:30:38 2014
@@ -18,9 +18,12 @@
******************************************************************************/
package org.apache.sling.scripting.sightly.api;
+import aQute.bnd.annotation.ProviderType;
+
/**
* An instance of an {@link RuntimeExtension}
*/
+@ProviderType
public interface ExtensionInstance {
/**
Modified: sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/ObjectModel.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/ObjectModel.java?rev=1640508&r1=1640507&r2=1640508&view=diff
==============================================================================
--- sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/ObjectModel.java (original)
+++ sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/ObjectModel.java Wed Nov 19 09:30:38 2014
@@ -22,10 +22,13 @@ package org.apache.sling.scripting.sight
import java.util.Collection;
import java.util.Map;
+import aQute.bnd.annotation.ProviderType;
+
/**
* Defines the dynamic queries that values must support
* in Sightly
*/
+@ProviderType
public interface ObjectModel {
String PROPERTY_ACCESS = "resolveProperty";
Modified: sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/ProviderOutcome.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/ProviderOutcome.java?rev=1640508&r1=1640507&r2=1640508&view=diff
==============================================================================
--- sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/ProviderOutcome.java (original)
+++ sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/ProviderOutcome.java Wed Nov 19 09:30:38 2014
@@ -19,9 +19,12 @@
package org.apache.sling.scripting.sightly.api;
+import aQute.bnd.annotation.ProviderType;
+
/**
* Result returned by a use provider
*/
+@ProviderType
public final class ProviderOutcome {
private boolean success;
Modified: sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/Record.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/Record.java?rev=1640508&r1=1640507&r2=1640508&view=diff
==============================================================================
--- sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/Record.java (original)
+++ sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/Record.java Wed Nov 19 09:30:38 2014
@@ -21,10 +21,13 @@ package org.apache.sling.scripting.sight
import java.util.Set;
+import aQute.bnd.annotation.ProviderType;
+
/**
* A key-value immutable object understood by the Sightly runtime
* @param <T> the type of values for this record
*/
+@ProviderType
public interface Record<T> {
/**
Modified: sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/RenderContext.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/RenderContext.java?rev=1640508&r1=1640507&r2=1640508&view=diff
==============================================================================
--- sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/RenderContext.java (original)
+++ sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/RenderContext.java Wed Nov 19 09:30:38 2014
@@ -24,10 +24,13 @@ import java.util.Map;
import javax.script.Bindings;
import javax.script.SimpleBindings;
+import aQute.bnd.annotation.ProviderType;
+
/**
* Rendering context for Sightly rendering units.
* @see RenderUnit
*/
+@ProviderType
public class RenderContext {
private final StackedWriter writer;
Modified: sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/RenderUnit.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/RenderUnit.java?rev=1640508&r1=1640507&r2=1640508&view=diff
==============================================================================
--- sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/RenderUnit.java (original)
+++ sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/RenderUnit.java Wed Nov 19 09:30:38 2014
@@ -20,10 +20,13 @@ package org.apache.sling.scripting.sight
import javax.script.Bindings;
+import aQute.bnd.annotation.ProviderType;
+
/**
* Basic unit of rendering. This also extends the record interface.
* The properties for a unit are the sub-units
*/
+@ProviderType
public interface RenderUnit extends Record<RenderUnit> {
/**
Modified: sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/ResourceResolution.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/ResourceResolution.java?rev=1640508&r1=1640507&r2=1640508&view=diff
==============================================================================
--- sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/ResourceResolution.java (original)
+++ sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/ResourceResolution.java Wed Nov 19 09:30:38 2014
@@ -25,11 +25,14 @@ import org.apache.sling.api.resource.Res
import org.apache.sling.api.resource.ResourceResolver;
import org.apache.sling.api.resource.ResourceUtil;
+import aQute.bnd.annotation.ProviderType;
+
/**
* Utility class which used by the Sightly engine & extensions
* to resolve resources
*/
-public class ResourceResolution {
+@ProviderType
+public final class ResourceResolution {
/**
* Maximum number of iterations that can be performed when searching for a resource in
Modified: sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/RuntimeExtension.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/RuntimeExtension.java?rev=1640508&r1=1640507&r2=1640508&view=diff
==============================================================================
--- sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/RuntimeExtension.java (original)
+++ sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/RuntimeExtension.java Wed Nov 19 09:30:38 2014
@@ -18,9 +18,12 @@
******************************************************************************/
package org.apache.sling.scripting.sightly.api;
+import aQute.bnd.annotation.ConsumerType;
+
/**
* Extensions provided to the Sightly runtime
*/
+@ConsumerType
public interface RuntimeExtension {
/**
Modified: sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/RuntimeExtensionComponent.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/RuntimeExtensionComponent.java?rev=1640508&r1=1640507&r2=1640508&view=diff
==============================================================================
--- sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/RuntimeExtensionComponent.java (original)
+++ sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/RuntimeExtensionComponent.java Wed Nov 19 09:30:38 2014
@@ -22,9 +22,12 @@ import java.util.Dictionary;
import org.osgi.service.component.ComponentContext;
+import aQute.bnd.annotation.ProviderType;
+
/**
* Component-based implementation for extensions
*/
+@ProviderType
public abstract class RuntimeExtensionComponent implements RuntimeExtension {
public static final String SCR_PROP_NAME = "org.apache.sling.scripting.sightly.rtextension.name";
Modified: sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/SightlyRuntime.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/SightlyRuntime.java?rev=1640508&r1=1640507&r2=1640508&view=diff
==============================================================================
--- sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/SightlyRuntime.java (original)
+++ sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/SightlyRuntime.java Wed Nov 19 09:30:38 2014
@@ -19,9 +19,12 @@
package org.apache.sling.scripting.sightly.api;
+import aQute.bnd.annotation.ProviderType;
+
/**
* Runtime interface provided to Sightly scripts
*/
+@ProviderType
public interface SightlyRuntime {
/**
Modified: sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/StackedWriter.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/StackedWriter.java?rev=1640508&r1=1640507&r2=1640508&view=diff
==============================================================================
--- sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/StackedWriter.java (original)
+++ sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/StackedWriter.java Wed Nov 19 09:30:38 2014
@@ -27,7 +27,7 @@ import java.util.Stack;
/**
* Text writing utility which allows stacking of temporary buffers
*/
-public class StackedWriter extends Writer {
+public final class StackedWriter extends Writer {
private final PrintWriter baseWriter;
private final Stack<StringWriter> writerStack = new Stack<StringWriter>();
Modified: sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/UnitLocator.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/UnitLocator.java?rev=1640508&r1=1640507&r2=1640508&view=diff
==============================================================================
--- sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/UnitLocator.java (original)
+++ sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/UnitLocator.java Wed Nov 19 09:30:38 2014
@@ -18,9 +18,12 @@
******************************************************************************/
package org.apache.sling.scripting.sightly.api;
+import aQute.bnd.annotation.ProviderType;
+
/**
* Locates rendering units
*/
+@ProviderType
public interface UnitLocator {
/**
Modified: sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/Use.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/Use.java?rev=1640508&r1=1640507&r2=1640508&view=diff
==============================================================================
--- sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/Use.java (original)
+++ sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/Use.java Wed Nov 19 09:30:38 2014
@@ -20,6 +20,9 @@ package org.apache.sling.scripting.sight
import javax.script.Bindings;
+import aQute.bnd.annotation.ConsumerType;
+
+@ConsumerType
public interface Use {
public void init(Bindings bindings);
Modified: sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/UseProvider.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/UseProvider.java?rev=1640508&r1=1640507&r2=1640508&view=diff
==============================================================================
--- sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/UseProvider.java (original)
+++ sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/UseProvider.java Wed Nov 19 09:30:38 2014
@@ -21,10 +21,13 @@ package org.apache.sling.scripting.sight
import javax.script.Bindings;
+import aQute.bnd.annotation.ConsumerType;
+
/**
* Provides instances for the use API. Providers are tried in the order
* of their priority until one is found which can provide a non-null instance
*/
+@ConsumerType
public interface UseProvider extends Comparable<UseProvider> {
int DEFAULT_PRIORITY = 0;
Modified: sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/UseProviderComponent.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/UseProviderComponent.java?rev=1640508&r1=1640507&r2=1640508&view=diff
==============================================================================
--- sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/UseProviderComponent.java (original)
+++ sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/UseProviderComponent.java Wed Nov 19 09:30:38 2014
@@ -26,9 +26,12 @@ import org.apache.felix.scr.annotations.
import org.apache.sling.commons.osgi.PropertiesUtil;
import org.osgi.service.component.ComponentContext;
+import aQute.bnd.annotation.ConsumerType;
+
/**
* Component-based use provider
*/
+@ConsumerType
public abstract class UseProviderComponent implements UseProvider {
public static final String PRIORITY = "org.apache.sling.scripting.sightly.api.use.priority";
Added: sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/package-info.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/package-info.java?rev=1640508&view=auto
==============================================================================
--- sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/package-info.java (added)
+++ sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/package-info.java Wed Nov 19 09:30:38 2014
@@ -0,0 +1,22 @@
+/*******************************************************************************
+ * 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.
+ ******************************************************************************/
+@Version("1.0.0")
+package org.apache.sling.scripting.sightly.api;
+
+import aQute.bnd.annotation.Version;
Propchange: sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/api/package-info.java
------------------------------------------------------------------------------
svn:mime-type = text/plain