Author: cziegeler
Date: Mon May 18 05:59:29 2015
New Revision: 1679940
URL: http://svn.apache.org/r1679940
Log:
Add missing flag
Modified:
sling/whiteboard/cziegeler/api-v3/src/main/java/org/apache/sling/api/resource/provider/ResourceProvider.java
Modified:
sling/whiteboard/cziegeler/api-v3/src/main/java/org/apache/sling/api/resource/provider/ResourceProvider.java
URL:
http://svn.apache.org/viewvc/sling/whiteboard/cziegeler/api-v3/src/main/java/org/apache/sling/api/resource/provider/ResourceProvider.java?rev=1679940&r1=1679939&r2=1679940&view=diff
==============================================================================
---
sling/whiteboard/cziegeler/api-v3/src/main/java/org/apache/sling/api/resource/provider/ResourceProvider.java
(original)
+++
sling/whiteboard/cziegeler/api-v3/src/main/java/org/apache/sling/api/resource/provider/ResourceProvider.java
Mon May 18 05:59:29 2015
@@ -90,13 +90,25 @@ public abstract class ResourceProvider<T
public static final String PROPERTY_REQUIRED = "provider.required";
/**
+ * If a resource provider needs the user to be authenticated this flag
must be set
+ * to {@code true}. In this case {@link #authenticate(Map)} is called
first and only
+ * if authentication is successful, this provider instance is used for the
current
+ * resource resolver.
+ * Boolean service property, default value is <code>false</true>.
+ * (value is "provider.authenticate")
+ */
+ public static final String PROPERTY_AUTHENTICATE = "provider.authenticate";
+
+ /**
* A modifiable resource provider is capable of creating, changing and
deleting resources.
* This means the methods {@link #create(ResolveContext, String, Map)},
* {@link #delete(ResolveContext, Resource)} and adapting a resource to a
modifiable
* value map is supported.
- * If this flag is set to {@code false}, the resource resolver treats does
not take this
+ * If this flag is set to {@code false}, the resource resolver does not
take this
* provider into account for modifications and modification operations to
this provider
* always result in an exception.
+ * If this is set to {@code true}, the property {@link
ResourceProvider#PROPERTY_AUTHENTICATE}
+ * is automatically set to {@code true} as well.
* Boolean service property, default value is <code>false</true>.
* (value is "provider.modifiable")
*/
