You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by cz...@apache.org on 2016/02/05 16:33:21 UTC
svn commit: r1728690 - in
/sling/trunk/bundles/api/src/main/java/org/apache/sling: api/resource/
api/resource/observation/ api/resource/path/ api/resource/runtime/
api/resource/runtime/dto/ spi/resource/provider/
Author: cziegeler
Date: Fri Feb 5 15:33:21 2016
New Revision: 1728690
URL: http://svn.apache.org/viewvc?rev=1728690&view=rev
Log:
SLING-5486 : Consolidate path utilities under org.apache.sling.api.resource.path
Modified:
sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceResolver.java
sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/observation/ExternalResourceChangeListener.java
sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/observation/ResourceChange.java
sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/observation/ResourceChangeListener.java
sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/path/Path.java
sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/path/PathBuilder.java
sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/path/PathSet.java
sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/runtime/RuntimeService.java
sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/runtime/dto/AuthType.java
sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/runtime/dto/FailureReason.java
sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/runtime/dto/ResourceProviderDTO.java
sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/runtime/dto/ResourceProviderFailureDTO.java
sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/runtime/dto/RuntimeDTO.java
sling/trunk/bundles/api/src/main/java/org/apache/sling/spi/resource/provider/ObservationReporter.java
sling/trunk/bundles/api/src/main/java/org/apache/sling/spi/resource/provider/ObserverConfiguration.java
sling/trunk/bundles/api/src/main/java/org/apache/sling/spi/resource/provider/ProviderContext.java
sling/trunk/bundles/api/src/main/java/org/apache/sling/spi/resource/provider/QueryLanguageProvider.java
sling/trunk/bundles/api/src/main/java/org/apache/sling/spi/resource/provider/ResolveContext.java
sling/trunk/bundles/api/src/main/java/org/apache/sling/spi/resource/provider/ResourceContext.java
sling/trunk/bundles/api/src/main/java/org/apache/sling/spi/resource/provider/ResourceProvider.java
Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceResolver.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceResolver.java?rev=1728690&r1=1728689&r2=1728690&view=diff
==============================================================================
--- sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceResolver.java (original)
+++ sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceResolver.java Fri Feb 5 15:33:21 2016
@@ -399,7 +399,7 @@ public interface ResourceResolver extend
* the parent resource.
* @throws IllegalStateException if this resource resolver has already been
* {@link #close() closed}.
- * @since 2.9 (Sling API Bundle 2.10.0)
+ * @since 2.9 (Sling API Bundle 2.11.0)
*/
@CheckForNull Resource getParent(@Nonnull Resource child);
@@ -739,7 +739,7 @@ public interface ResourceResolver extend
* not allow to create a resource at that location.
* @throws IllegalStateException if this resource resolver has already been
* {@link #close() closed}.
- * @since 2.9 (Sling API Bundle 2.10.0)
+ * @since 2.9 (Sling API Bundle 2.11.0)
*/
Resource copy(final String srcAbsPath,
final String destAbsPath) throws PersistenceException;
@@ -767,7 +767,7 @@ public interface ResourceResolver extend
* not allow to create a resource at that location.
* @throws IllegalStateException if this resource resolver has already been
* {@link #close() closed}.
- * @since 2.9 (Sling API Bundle 2.10.0)
+ * @since 2.9 (Sling API Bundle 2.11.0)
*/
Resource move(final String srcAbsPath,
final String destAbsPath) throws PersistenceException;
Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/observation/ExternalResourceChangeListener.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/observation/ExternalResourceChangeListener.java?rev=1728690&r1=1728689&r2=1728690&view=diff
==============================================================================
--- sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/observation/ExternalResourceChangeListener.java (original)
+++ sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/observation/ExternalResourceChangeListener.java Fri Feb 5 15:33:21 2016
@@ -22,6 +22,8 @@ import aQute.bnd.annotation.ConsumerType
/**
* This is a marker interface to receive external events.
+ *
+ * @since 1.0.0 (Sling API Bundle 2.11.0)
*/
@ConsumerType
public interface ExternalResourceChangeListener {
Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/observation/ResourceChange.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/observation/ResourceChange.java?rev=1728690&r1=1728689&r2=1728690&view=diff
==============================================================================
--- sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/observation/ResourceChange.java (original)
+++ sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/observation/ResourceChange.java Fri Feb 5 15:33:21 2016
@@ -43,6 +43,8 @@ import aQute.bnd.annotation.ConsumerType
* Local events for resources provide the names of the properties that
* have been added, removed or changed. This information might be missing
* for external events.
+ *
+ * @since 1.0.0 (Sling API Bundle 2.11.0)
*/
@ConsumerType
public class ResourceChange {
Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/observation/ResourceChangeListener.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/observation/ResourceChangeListener.java?rev=1728690&r1=1728689&r2=1728690&view=diff
==============================================================================
--- sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/observation/ResourceChangeListener.java (original)
+++ sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/observation/ResourceChangeListener.java Fri Feb 5 15:33:21 2016
@@ -46,6 +46,8 @@ import aQute.bnd.annotation.ConsumerType
* If the resource listener is interested in external events, the implementation
* should implement the {@link ExternalResourceChangeListener} interface, but still register
* the service as a {@code ResourceChangeListener} service.
+ *
+ * @since 1.0.0 (Sling API Bundle 2.11.0)
*/
@ConsumerType
public interface ResourceChangeListener {
Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/path/Path.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/path/Path.java?rev=1728690&r1=1728689&r2=1728690&view=diff
==============================================================================
--- sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/path/Path.java (original)
+++ sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/path/Path.java Fri Feb 5 15:33:21 2016
@@ -21,7 +21,7 @@ package org.apache.sling.api.resource.pa
/**
* Simple helper class for path matching.
*
- * @since 1.0.0 (Sling API Bundle 2.10.0)
+ * @since 1.0.0 (Sling API Bundle 2.11.0)
*/
public class Path implements Comparable<Path> {
Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/path/PathBuilder.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/path/PathBuilder.java?rev=1728690&r1=1728689&r2=1728690&view=diff
==============================================================================
--- sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/path/PathBuilder.java (original)
+++ sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/path/PathBuilder.java Fri Feb 5 15:33:21 2016
@@ -21,40 +21,41 @@ package org.apache.sling.api.resource.pa
/**
* The <tt>PathBuilder</tt> offers a convenient way of creating a valid path from multiple fragments
*
+ * @since 1.0.0 (Sling API Bundle 2.11.0)
*/
public final class PathBuilder {
-
- private StringBuilder sb = new StringBuilder();
-
+
+ private final StringBuilder sb = new StringBuilder();
+
/**
* Creates a new <tt>PathBuilder</tt> instance
- *
+ *
* @param path the initial path
*/
- public PathBuilder(String path) {
-
+ public PathBuilder(final String path) {
+
if ( path == null || path.isEmpty() || path.charAt(0) != '/') {
throw new IllegalArgumentException("Path '" + path + "' is not absolute");
}
-
+
sb.append(path);
}
-
+
/**
* Appends a new path fragment
- *
+ *
* @param path the path fragment to append
* @return this instance
*/
- public PathBuilder append(String path) {
-
+ public PathBuilder append(final String path) {
+
if ( path == null || path.isEmpty() ) {
throw new IllegalArgumentException("Path '" + path + "' is null or empty");
}
-
+
boolean trailingSlash = sb.charAt(sb.length() - 1) == '/';
boolean leadingSlash = path.charAt(0) == '/';
-
+
if ( trailingSlash && leadingSlash) {
sb.append(path.substring(1));
} else if ( !trailingSlash && !leadingSlash ) {
@@ -62,15 +63,16 @@ public final class PathBuilder {
} else {
sb.append(path);
}
-
+
return this;
}
-
+
/**
* Returns the path
- *
+ *
* @return the path
*/
+ @Override
public String toString() {
return sb.toString();
}
Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/path/PathSet.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/path/PathSet.java?rev=1728690&r1=1728689&r2=1728690&view=diff
==============================================================================
--- sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/path/PathSet.java (original)
+++ sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/path/PathSet.java Fri Feb 5 15:33:21 2016
@@ -27,7 +27,7 @@ import java.util.Set;
/**
* Simple helper class for path matching against a set of paths.
*
- * @since 1.0.0 (Sling API Bundle 2.10.0)
+ * @since 1.0.0 (Sling API Bundle 2.11.0)
*/
public class PathSet implements Iterable<Path> {
Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/runtime/RuntimeService.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/runtime/RuntimeService.java?rev=1728690&r1=1728689&r2=1728690&view=diff
==============================================================================
--- sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/runtime/RuntimeService.java (original)
+++ sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/runtime/RuntimeService.java Fri Feb 5 15:33:21 2016
@@ -22,6 +22,12 @@ import org.apache.sling.api.resource.run
import aQute.bnd.annotation.ProviderType;
+/**
+ * Runtime service providing introspection of the state of the resource resolver
+ * and the resource providers.
+ *
+ * @since 1.0.0 (Sling API Bundle 2.11.0)
+ */
@ProviderType
public interface RuntimeService {
Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/runtime/dto/AuthType.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/runtime/dto/AuthType.java?rev=1728690&r1=1728689&r2=1728690&view=diff
==============================================================================
--- sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/runtime/dto/AuthType.java (original)
+++ sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/runtime/dto/AuthType.java Fri Feb 5 15:33:21 2016
@@ -20,6 +20,8 @@ package org.apache.sling.api.resource.ru
/**
* Enumeration for the auth type of a resource provider.
+ *
+ * @since 1.0.0 (Sling API Bundle 2.11.0)
*/
public enum AuthType {
Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/runtime/dto/FailureReason.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/runtime/dto/FailureReason.java?rev=1728690&r1=1728689&r2=1728690&view=diff
==============================================================================
--- sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/runtime/dto/FailureReason.java (original)
+++ sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/runtime/dto/FailureReason.java Fri Feb 5 15:33:21 2016
@@ -20,6 +20,8 @@ package org.apache.sling.api.resource.ru
/**
* Failure reason for a failed resource provider.
+ *
+ * @since 1.0.0 (Sling API Bundle 2.11.0)
*/
public enum FailureReason {
Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/runtime/dto/ResourceProviderDTO.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/runtime/dto/ResourceProviderDTO.java?rev=1728690&r1=1728689&r2=1728690&view=diff
==============================================================================
--- sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/runtime/dto/ResourceProviderDTO.java (original)
+++ sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/runtime/dto/ResourceProviderDTO.java Fri Feb 5 15:33:21 2016
@@ -20,6 +20,8 @@ package org.apache.sling.api.resource.ru
/**
* Represents a {@code org.apache.sling.spi.resource.provider.ResourceProvider}.
+ *
+ * @since 1.0.0 (Sling API Bundle 2.11.0)
*/
public class ResourceProviderDTO {
Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/runtime/dto/ResourceProviderFailureDTO.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/runtime/dto/ResourceProviderFailureDTO.java?rev=1728690&r1=1728689&r2=1728690&view=diff
==============================================================================
--- sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/runtime/dto/ResourceProviderFailureDTO.java (original)
+++ sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/runtime/dto/ResourceProviderFailureDTO.java Fri Feb 5 15:33:21 2016
@@ -23,6 +23,8 @@ package org.apache.sling.api.resource.ru
* If the provider is failed, some of the properties of the {@link ResourceProviderDTO}
* might be missing or invalid, e.g. {@link ResourceProviderDTO#path} might contain
* the empty path.
+ *
+ * @since 1.0.0 (Sling API Bundle 2.11.0)
*/
public class ResourceProviderFailureDTO extends ResourceProviderDTO {
Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/runtime/dto/RuntimeDTO.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/runtime/dto/RuntimeDTO.java?rev=1728690&r1=1728689&r2=1728690&view=diff
==============================================================================
--- sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/runtime/dto/RuntimeDTO.java (original)
+++ sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/runtime/dto/RuntimeDTO.java Fri Feb 5 15:33:21 2016
@@ -20,6 +20,8 @@ package org.apache.sling.api.resource.ru
/**
* Represents the resource resolver runtime
+ *
+ * @since 1.0.0 (Sling API Bundle 2.11.0)
*/
public class RuntimeDTO {
Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/spi/resource/provider/ObservationReporter.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/spi/resource/provider/ObservationReporter.java?rev=1728690&r1=1728689&r2=1728690&view=diff
==============================================================================
--- sling/trunk/bundles/api/src/main/java/org/apache/sling/spi/resource/provider/ObservationReporter.java (original)
+++ sling/trunk/bundles/api/src/main/java/org/apache/sling/spi/resource/provider/ObservationReporter.java Fri Feb 5 15:33:21 2016
@@ -30,6 +30,8 @@ import aQute.bnd.annotation.ProviderType
* A {@code ResourceProvider} must use an observation reporter
* to report changes to resources. The resource provider gets
* an instance of this reporter through the {@link ProviderContext}.
+ *
+ * @since 1.0.0 (Sling API Bundle 2.11.0)
*/
@ProviderType
public interface ObservationReporter {
Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/spi/resource/provider/ObserverConfiguration.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/spi/resource/provider/ObserverConfiguration.java?rev=1728690&r1=1728689&r2=1728690&view=diff
==============================================================================
--- sling/trunk/bundles/api/src/main/java/org/apache/sling/spi/resource/provider/ObserverConfiguration.java (original)
+++ sling/trunk/bundles/api/src/main/java/org/apache/sling/spi/resource/provider/ObserverConfiguration.java Fri Feb 5 15:33:21 2016
@@ -29,6 +29,8 @@ import aQute.bnd.annotation.ProviderType
/**
* A observer configuration describes active configurations from registered listeners.
+ *
+ * @since 1.0.0 (Sling API Bundle 2.11.0)
*/
@ProviderType
public interface ObserverConfiguration {
Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/spi/resource/provider/ProviderContext.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/spi/resource/provider/ProviderContext.java?rev=1728690&r1=1728689&r2=1728690&view=diff
==============================================================================
--- sling/trunk/bundles/api/src/main/java/org/apache/sling/spi/resource/provider/ProviderContext.java (original)
+++ sling/trunk/bundles/api/src/main/java/org/apache/sling/spi/resource/provider/ProviderContext.java Fri Feb 5 15:33:21 2016
@@ -26,6 +26,8 @@ import aQute.bnd.annotation.ProviderType
/**
* The provider context...
+ *
+ * @since 1.0.0 (Sling API Bundle 2.11.0)
*/
@ProviderType
public interface ProviderContext {
Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/spi/resource/provider/QueryLanguageProvider.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/spi/resource/provider/QueryLanguageProvider.java?rev=1728690&r1=1728689&r2=1728690&view=diff
==============================================================================
--- sling/trunk/bundles/api/src/main/java/org/apache/sling/spi/resource/provider/QueryLanguageProvider.java (original)
+++ sling/trunk/bundles/api/src/main/java/org/apache/sling/spi/resource/provider/QueryLanguageProvider.java Fri Feb 5 15:33:21 2016
@@ -35,6 +35,8 @@ import aQute.bnd.annotation.ConsumerType
* Calls from {@link ResourceResolver#findResources(String, String)} and
* {@link ResourceResolver#queryResources(String, String)} are passed on
* to this object.
+ *
+ * @since 1.0.0 (Sling API Bundle 2.11.0)
*/
@ConsumerType
public interface QueryLanguageProvider<T> {
Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/spi/resource/provider/ResolveContext.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/spi/resource/provider/ResolveContext.java?rev=1728690&r1=1728689&r2=1728690&view=diff
==============================================================================
--- sling/trunk/bundles/api/src/main/java/org/apache/sling/spi/resource/provider/ResolveContext.java (original)
+++ sling/trunk/bundles/api/src/main/java/org/apache/sling/spi/resource/provider/ResolveContext.java Fri Feb 5 15:33:21 2016
@@ -33,6 +33,8 @@ import aQute.bnd.annotation.ProviderType
*
* If the provider requires authentication, the object returned by {@link ResourceProvider#authenticate(Map)}
* is returned in {@link #getProviderState()}.
+ *
+ * @since 1.0.0 (Sling API Bundle 2.11.0)
*/
@ProviderType
public interface ResolveContext<T> {
Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/spi/resource/provider/ResourceContext.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/spi/resource/provider/ResourceContext.java?rev=1728690&r1=1728689&r2=1728690&view=diff
==============================================================================
--- sling/trunk/bundles/api/src/main/java/org/apache/sling/spi/resource/provider/ResourceContext.java (original)
+++ sling/trunk/bundles/api/src/main/java/org/apache/sling/spi/resource/provider/ResourceContext.java Fri Feb 5 15:33:21 2016
@@ -26,6 +26,8 @@ import aQute.bnd.annotation.ProviderType
/**
* The resource context provides additional information for resource resolving.
+ *
+ * @since 1.0.0 (Sling API Bundle 2.11.0)
*/
@ProviderType
public interface ResourceContext {
Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/spi/resource/provider/ResourceProvider.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/spi/resource/provider/ResourceProvider.java?rev=1728690&r1=1728689&r2=1728690&view=diff
==============================================================================
--- sling/trunk/bundles/api/src/main/java/org/apache/sling/spi/resource/provider/ResourceProvider.java (original)
+++ sling/trunk/bundles/api/src/main/java/org/apache/sling/spi/resource/provider/ResourceProvider.java Fri Feb 5 15:33:21 2016
@@ -82,6 +82,8 @@ import aQute.bnd.annotation.ConsumerType
* <p>
* Each method gets the {@link ResourceContext} which gives access to
* further functionality.
+ *
+ * @since 1.0.0 (Sling API Bundle 2.11.0)
*/
@ConsumerType
public abstract class ResourceProvider<T> {