You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by ro...@apache.org on 2017/11/07 09:48:18 UTC
[sling-org-apache-sling-jcr-jackrabbit-usermanager] 18/28:
SLING-940 Applied patch from myself. Adds Javadoc to accessmanager and
usermanager servlets.
This is an automated email from the ASF dual-hosted git repository.
rombert pushed a commit to annotated tag org.apache.sling.jcr.jackrabbit.usermanager-2.0.4
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-jcr-jackrabbit-usermanager.git
commit be2ee7c7a9f6bd4fff27e8fc6ab7acdb75669ffd
Author: Ian Boston <ie...@apache.org>
AuthorDate: Thu Jul 16 16:54:39 2009 +0000
SLING-940
Applied patch from myself.
Adds Javadoc to accessmanager and usermanager servlets.
git-svn-id: https://svn.apache.org/repos/asf/sling/trunk/bundles/jcr/jackrabbit-usermanager@794751 13f79535-47bb-0310-9956-ffa450edef68
---
.../impl/post/ChangeUserPasswordServlet.java | 40 +++++++++++++++++--
.../usermanager/impl/post/CreateGroupServlet.java | 38 +++++++++++++++++-
.../usermanager/impl/post/CreateUserServlet.java | 46 +++++++++++++++++++---
.../impl/post/DeleteAuthorizableServlet.java | 37 +++++++++++++++--
.../usermanager/impl/post/UpdateGroupServlet.java | 39 +++++++++++++++++-
.../usermanager/impl/post/UpdateUserServlet.java | 40 ++++++++++++++++++-
6 files changed, 223 insertions(+), 17 deletions(-)
diff --git a/src/main/java/org/apache/sling/jackrabbit/usermanager/impl/post/ChangeUserPasswordServlet.java b/src/main/java/org/apache/sling/jackrabbit/usermanager/impl/post/ChangeUserPasswordServlet.java
index a4c6d22..1cd0c79 100644
--- a/src/main/java/org/apache/sling/jackrabbit/usermanager/impl/post/ChangeUserPasswordServlet.java
+++ b/src/main/java/org/apache/sling/jackrabbit/usermanager/impl/post/ChangeUserPasswordServlet.java
@@ -31,9 +31,43 @@ import org.apache.sling.api.servlets.HtmlResponse;
import org.apache.sling.servlets.post.Modification;
/**
- * Sling Post Operation implementation for updating the password of a user in
- * the jackrabbit UserManager.
- *
+ * <p>
+ * Changes the password associated with a user. a new group. Maps on to nodes of resourceType <code>sling/groups</code> like
+ * <code>/rep:system/rep:userManager/rep:users/ae/fd/3e/ieb</code> mapped to a resource url
+ * <code>/system/userManager/user/ieb</code>. This servlet responds at
+ * <code>/system/userManager/user/ieb.changePassword.create.html</code>
+ * </p>
+ * <h4>Methods</h4>
+ * <ul>
+ * <li>POST</li>
+ * </ul>
+ * <h4>Post Parameters</h4>
+ * <dl>
+ * <dt>oldPwd</dt>
+ * <dd>The current password for the user (required)</dd>
+ * <dt>newPwd</dt>
+ * <dd>The new password for the user (required)</dd>
+ * <dt>newPwdConfirm</dt>
+ * <dd>The confirm new password for the user (required)</dd>
+ * </dl>
+ * <h4>Response</h4>
+ * <dl>
+ * <dt>200</dt>
+ * <dd>Sucess sent with no body</dd>
+ * <dt>404</dt>
+ * <dd>If the user was not found.</dd>
+ * <dt>500</dt>
+ * <dd>Failure, including group already exists. HTML explains the failure.</dd>
+ * </dl>
+ * <h4>Example</h4>
+ *
+ * <code>
+ * curl -FoldPwd=oldpassword -FnewPwd=newpassword =FnewPwdConfirm=newpassword http://localhost:8080/system/userManager/user/ieb.changePassword.html
+ * </code>
+ *
+ * <h4>Notes</h4>
+ *
+ *
* @scr.component metatype="no" immediate="true"
* @scr.service interface="javax.servlet.Servlet"
* @scr.property name="sling.servlet.resourceTypes" value="sling/user"
diff --git a/src/main/java/org/apache/sling/jackrabbit/usermanager/impl/post/CreateGroupServlet.java b/src/main/java/org/apache/sling/jackrabbit/usermanager/impl/post/CreateGroupServlet.java
index 17d89e3..cc87d05 100644
--- a/src/main/java/org/apache/sling/jackrabbit/usermanager/impl/post/CreateGroupServlet.java
+++ b/src/main/java/org/apache/sling/jackrabbit/usermanager/impl/post/CreateGroupServlet.java
@@ -35,8 +35,42 @@ import org.apache.sling.servlets.post.Modification;
import org.apache.sling.servlets.post.SlingPostConstants;
/**
- * Sling Post Servlet implementation for creating a group in the jackrabbit
- * UserManager.
+ * <p>
+ * Sling Post Servlet implementation for creating a group in the jackrabbit UserManager.
+ * </p>
+ * <h2>Rest Service Description</h2>
+ * <p>
+ * Creates a new group. Maps on to nodes of resourceType <code>sling/groups</code> like
+ * <code>/rep:system/rep:userManager/rep:groups</code> mapped to a resource url
+ * <code>/system/userManager/group</code>. This servlet responds at
+ * <code>/system/userManager/group.create.html</code>
+ * </p>
+ * <h4>Methods</h4>
+ * <ul>
+ * <li>POST</li>
+ * </ul>
+ * <h4>Post Parameters</h4>
+ * <dl>
+ * <dt>:name</dt>
+ * <dd>The name of the new group (required)</dd>
+ * <dt>*</dt>
+ * <dd>Any additional parameters become properties of the group node (optional)</dd>
+ * </dl>
+ * <h4>Response</h4>
+ * <dl>
+ * <dt>200</dt>
+ * <dd>Success, a redirect is sent to the group resource locator. The redirect comes with
+ * HTML describing the status.</dd>
+ * <dt>500</dt>
+ * <dd>Failure, including group already exists. HTML explains the failure.</dd>
+ * </dl>
+ * <h4>Example</h4>
+ *
+ * <code>
+ * curl -F:name=newGroupA -Fproperty1=value1 http://localhost:8080/system/userManager/group.create.html
+ * </code>
+ *
+ * <h4>Notes</h4>
*
* @scr.component immediate="true"
* @scr.service interface="javax.servlet.Servlet"
diff --git a/src/main/java/org/apache/sling/jackrabbit/usermanager/impl/post/CreateUserServlet.java b/src/main/java/org/apache/sling/jackrabbit/usermanager/impl/post/CreateUserServlet.java
index 20135b1..ca62a85 100644
--- a/src/main/java/org/apache/sling/jackrabbit/usermanager/impl/post/CreateUserServlet.java
+++ b/src/main/java/org/apache/sling/jackrabbit/usermanager/impl/post/CreateUserServlet.java
@@ -39,9 +39,45 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * Sling Post Servlet implementation for creating a user in the jackrabbit
- * UserManager.
- *
+ * <p>
+ * Sling Post Servlet implementation for creating a user in the jackrabbit UserManager.
+ * </p>
+ * <h2>Rest Service Description</h2>
+ * <p>
+ * Creates a new user. Maps on to nodes of resourceType <code>sling/users</code> like
+ * <code>/rep:system/rep:userManager/rep:users</code> mapped to a resource url
+ * <code>/system/userManager/user</code>. This servlet responds at <code>/system/userManager/user.create.html</code>
+ * </p>
+ * <h4>Methods</h4>
+ * <ul>
+ * <li>POST</li>
+ * </ul>
+ * <h4>Post Parameters</h4>
+ * <dl>
+ * <dt>:name</dt>
+ * <dd>The name of the new user (required)</dd>
+ * <dt>:pwd</dt>
+ * <dd>The password of the new user (required)</dd>
+ * <dt>:pwdConfirm</dt>
+ * <dd>The password of the new user (required)</dd>
+ * <dt>*</dt>
+ * <dd>Any additional parameters become properties of the user node (optional)</dd>
+ * </dl>
+ * <h4>Response</h4>
+ * <dl>
+ * <dt>200</dt>
+ * <dd>Success, a redirect is sent to the users resource locator. The redirect comes with
+ * HTML describing the status.</dd>
+ * <dt>500</dt>
+ * <dd>Failure, including user already exists. HTML explains the failure.</dd>
+ * </dl>
+ * <h4>Example</h4>
+ *
+ * <code>
+ * curl -F:name=ieb -Fpwd=password -FpwdConfirm=password -Fproperty1=value1 http://localhost:8080/system/userManager/user.create.html
+ * </code>
+ *
+ *
* @scr.component immediate="true" label="%createUser.post.operation.name"
* description="%createUser.post.operation.description"
* @scr.service interface="javax.servlet.Servlet"
@@ -70,7 +106,7 @@ public class CreateUserServlet extends AbstractUserPostServlet {
/**
* The JCR Repository we access to resolve resources
- *
+ *
* @scr.reference
*/
private SlingRepository repository;
@@ -104,7 +140,7 @@ public class CreateUserServlet extends AbstractUserPostServlet {
/**
* Activates this component.
- *
+ *
* @param componentContext The OSGi <code>ComponentContext</code> of this
* component.
*/
diff --git a/src/main/java/org/apache/sling/jackrabbit/usermanager/impl/post/DeleteAuthorizableServlet.java b/src/main/java/org/apache/sling/jackrabbit/usermanager/impl/post/DeleteAuthorizableServlet.java
index c7fd71c..72b9921 100644
--- a/src/main/java/org/apache/sling/jackrabbit/usermanager/impl/post/DeleteAuthorizableServlet.java
+++ b/src/main/java/org/apache/sling/jackrabbit/usermanager/impl/post/DeleteAuthorizableServlet.java
@@ -33,9 +33,40 @@ import org.apache.sling.servlets.post.Modification;
import org.apache.sling.servlets.post.SlingPostConstants;
/**
- * Sling Post Operation implementation for deleting one or more users and/or
- * groups from the jackrabbit UserManager.
+
+ * <h2>Rest Service Description</h2>
+ * <p>
+ * Deletes an Authorizable, currently a user or a group. Maps on to nodes of resourceType <code>sling/users</code> or <code>sling/users</code> like
+ * <code>/rep:system/rep:userManager/rep:users</code> or <code>/rep:system/rep:userManager/rep:groups</code> mapped to a resource url
+ * <code>/system/userManager/user</code> or <code>/system/userManager/group</code>. This servlet responds at
+ * <code>/system/userManager/user.delete.html</code> or <code>/system/userManager/group.delete.html</code>.
+ * The servlet also responds to single delete requests eg <code>/system/userManager/group/newGroup.delete.html</code>
+ * </p>
+ * <h4>Methods</h4>
+ * <ul>
+ * <li>POST</li>
+ * </ul>
+ * <h4>Post Parameters</h4>
+ * <dl>
+ * <dt>:applyTo</dt>
+ * <dd>An array of relative resource references to Authorizables to be deleted, if this parameter is present, the url is ignored and all the Authorizables in the list are removed.</dd>
+ * </dl>
+ * <h4>Response</h4>
+ * <dl>
+ * <dt>200</dt>
+ * <dd>Success, no body.</dd>
+ * <dt>404</dt>
+ * <dd>The resource was not found</dd>
+ * <dt>500</dt>
+ * <dd>Failure</dd>
+ * </dl>
+ * <h4>Example</h4>
*
+ * <code>
+ * curl -Fgo=1 http://localhost:8080/system/userManager/user/ieb.delete.html
+ * </code>
+ *
+ *
* @scr.component metatype="no" immediate="true"
* @scr.service interface="javax.servlet.Servlet"
* @scr.property name="sling.servlet.resourceTypes" values.0="sling/user"
@@ -90,7 +121,7 @@ public class DeleteAuthorizableServlet extends AbstractAuthorizablePostServlet {
* set with valid resources an empty iterator is returned. Any resources
* addressed in the {@link SlingPostConstants#RP_APPLY_TO} parameter is
* ignored.
- *
+ *
* @param request The <code>SlingHttpServletRequest</code> object used to
* get the {@link SlingPostConstants#RP_APPLY_TO} parameter.
* @return The iterator of resources listed in the parameter or
diff --git a/src/main/java/org/apache/sling/jackrabbit/usermanager/impl/post/UpdateGroupServlet.java b/src/main/java/org/apache/sling/jackrabbit/usermanager/impl/post/UpdateGroupServlet.java
index 7354d23..42a7971 100644
--- a/src/main/java/org/apache/sling/jackrabbit/usermanager/impl/post/UpdateGroupServlet.java
+++ b/src/main/java/org/apache/sling/jackrabbit/usermanager/impl/post/UpdateGroupServlet.java
@@ -31,9 +31,44 @@ import org.apache.sling.jackrabbit.usermanager.impl.helper.RequestProperty;
import org.apache.sling.servlets.post.Modification;
/**
- * Sling Post Operation implementation for updating a group in the jackrabbit
- * UserManager.
+ * <p>
+ * Sling Post Operation implementation for updating a group in the
+ * jackrabbit UserManager.
+ * </p>
+ * <h2>Rest Service Description</h2>
+ * <p>
+ * Updates a group's properties. Maps on to nodes of resourceType <code>sling/groups</code> like
+ * <code>/rep:system/rep:userManager/rep:groups/ae/3f/ed/testGroup</code> mapped to a resource url
+ * <code>/system/userManager/group/testGroup</code>. This servlet responds at
+ * <code>/system/userManager/group/testGroup.update.html</code>
+ * </p>
+ * <h4>Methods</h4>
+ * <ul>
+ * <li>POST</li>
+ * </ul>
+ * <h4>Post Parameters</h4>
+ * <dl>
+ * <dt>*</dt>
+ * <dd>Any additional parameters become properties of the group node (optional)</dd>
+ * <dt>*@Delete</dt>
+ * <dd>The property is deleted, eg prop1@Delete</dd>
+ * </dl>
+ * <h4>Response</h4>
+ * <dl>
+ * <dt>200</dt>
+ * <dd>Success, a redirect is sent to the group's resource locator. The redirect comes with
+ * HTML describing the status.</dd>
+ * <dt>404</dt>
+ * <dd>The resource was not found</dd>
+ * <dt>500</dt>
+ * <dd>Failure</dd>
+ * </dl>
+ * <h4>Example</h4>
*
+ * <code>
+ * curl -Fprop1=value2 -Fproperty1=value1 http://localhost:8080/system/userManager/group/testGroup.update.html
+ * </code>
+ *
* @scr.component metatype="no" immediate="true"
* @scr.service interface="javax.servlet.Servlet"
* @scr.property name="sling.servlet.resourceTypes" values="sling/group"
diff --git a/src/main/java/org/apache/sling/jackrabbit/usermanager/impl/post/UpdateUserServlet.java b/src/main/java/org/apache/sling/jackrabbit/usermanager/impl/post/UpdateUserServlet.java
index b896eb1..3d60769 100644
--- a/src/main/java/org/apache/sling/jackrabbit/usermanager/impl/post/UpdateUserServlet.java
+++ b/src/main/java/org/apache/sling/jackrabbit/usermanager/impl/post/UpdateUserServlet.java
@@ -31,9 +31,45 @@ import org.apache.sling.jackrabbit.usermanager.impl.helper.RequestProperty;
import org.apache.sling.servlets.post.Modification;
/**
- * Sling Post Operation implementation for updating a user in the jackrabbit
- * UserManager.
+ * <p>
+ * Sling Post Operation implementation for updating a user in the jackrabbit UserManager.
+ * </p>
+ * <h2>Rest Service Description</h2>
+ * <p>
+ * Updates a users properties. Maps on to nodes of resourceType <code>sling/users</code> like
+ * <code>/rep:system/rep:userManager/rep:users</code> mapped to a resource url
+ * <code>/system/userManager/user/ieb</code>. This servlet responds at
+ * <code>/system/userManager/user/ieb.update.html</code>
+ * </p>
+ * <h4>Methods</h4>
+ * <ul>
+ * <li>POST</li>
+ * </ul>
+ * <h4>Post Parameters</h4>
+ * <dl>
+ * <dt>*</dt>
+ * <dd>Any additional parameters become properties of the user node (optional)</dd>
+ * <dt>*@Delete</dt>
+ * <dd>Delete the property eg prop3@Delete means prop3 will be deleted (optional)</dd>
+ * </dl>
+ * <h4>Response</h4>
+ * <dl>
+ * <dt>200</dt>
+ * <dd>Success, a redirect is sent to the users resource locator. The redirect comes with
+ * HTML describing the status.</dd>
+ * <dt>404</dt>
+ * <dd>The resource was not found</dd>
+ * <dt>500</dt>
+ * <dd>Failure</dd>
+ * </dl>
+ * <h4>Example</h4>
*
+ * <code>
+ * curl -Fprop1=value2 -Fproperty1=value1 http://localhost:8080/system/userManager/user/ieb.update.html
+ * </code>
+ *
+ *
+ *
* @scr.component metatype="no" immediate="true"
* @scr.service interface="javax.servlet.Servlet"
* @scr.property name="sling.servlet.resourceTypes" value="sling/user"
--
To stop receiving notification emails like this one, please contact
"commits@sling.apache.org" <co...@sling.apache.org>.