diff --git a/scm-webapp/src/main/java/sonia/scm/api/rest/resources/AbstractPermissionResource.java b/scm-webapp/src/main/java/sonia/scm/api/rest/resources/AbstractPermissionResource.java index 8e9c95afb2..29384ba020 100644 --- a/scm-webapp/src/main/java/sonia/scm/api/rest/resources/AbstractPermissionResource.java +++ b/scm-webapp/src/main/java/sonia/scm/api/rest/resources/AbstractPermissionResource.java @@ -30,6 +30,7 @@ */ + package sonia.scm.api.rest.resources; //~--- non-JDK imports -------------------------------------------------------- @@ -65,6 +66,7 @@ import javax.ws.rs.core.Response.Status; import javax.ws.rs.core.UriInfo; /** + * Abstract base class for global permission resources. * * @author Sebastian Sdorra * @since 1.31 @@ -73,11 +75,11 @@ public abstract class AbstractPermissionResource { /** - * Constructs ... + * Constructs a new {@link AbstractPermissionResource}. * * - * @param securitySystem - * @param name + * @param securitySystem security system + * @param name name of the user or group */ protected AbstractPermissionResource(SecuritySystem securitySystem, String name) @@ -89,12 +91,12 @@ public abstract class AbstractPermissionResource //~--- methods -------------------------------------------------------------- /** - * Method description + * Transforms a {@link Permission} to a {@link AssignedPermission}. * * - * @param permission + * @param permission permission object to transform * - * @return + * @return transformed {@link AssignedPermission} */ protected abstract AssignedPermission transformPermission( Permission permission); @@ -102,23 +104,28 @@ public abstract class AbstractPermissionResource //~--- get methods ---------------------------------------------------------- /** - * Method description + * Returns a {@link Predicate} to filter permissions. * * - * @return + * @return {@link Predicate} to filter permissions */ protected abstract Predicate getPredicate(); //~--- methods -------------------------------------------------------------- /** - * Method description + * Adds a new permission to the user or group managed by the resource.
+ *
+ * Status codes: + * * + * @param uriInfo uri informations + * @param permission permission to add * - * @param uriInfo - * @param permission - * - * @return + * @return web response */ @POST @Consumes({ MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON }) @@ -132,12 +139,19 @@ public abstract class AbstractPermissionResource } /** - * Method description + * Deletes a permission from the user or group managed by the resource.
+ *
+ * Status codes: + * * + * @param id id of the permission * - * @param id - * - * @return + * @return web response */ @DELETE @Path("{id}") @@ -151,13 +165,21 @@ public abstract class AbstractPermissionResource } /** - * Method description + * Updates the specified permission on the user or group managed by the + * resource.
+ *
+ * Status codes: + * * + * @param id id of the permission + * @param permission updated permission * - * @param id - * @param permission - * - * @return + * @return web response */ @PUT @Path("{id}") @@ -175,12 +197,20 @@ public abstract class AbstractPermissionResource //~--- get methods ---------------------------------------------------------- /** - * Method description + * Returns the {@link Permission} with the specified id.
+ *
+ * Status codes: + * * * - * @param id + * @param id id of the {@link Permission} * - * @return + * @return {@link Permission} with the specified id */ @GET @Path("{id}") @@ -193,10 +223,15 @@ public abstract class AbstractPermissionResource } /** - * Method description + * Returns all permissions of the user or group managed by the resource.
+ *
+ * Status codes: + * * - * - * @return + * @return all permissions of the user or group */ @GET @Produces({ MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON }) @@ -206,12 +241,12 @@ public abstract class AbstractPermissionResource } /** - * Method description + * Returns the {@link StoredAssignedPermission} with the given id. * * - * @param id + * @param id id of the stored permission * - * @return + * @return {@link StoredAssignedPermission} with the given id */ private StoredAssignedPermission getPermission(String id) { @@ -231,12 +266,12 @@ public abstract class AbstractPermissionResource } /** - * Method description + * Returns all permissions which matches the given {@link Predicate}. * * - * @param predicate + * @param predicate predicate for filtering * - * @return + * @return all permissions which matches the given {@link Predicate} */ private List getPermissions( Predicate predicate) @@ -258,9 +293,9 @@ public abstract class AbstractPermissionResource //~--- fields --------------------------------------------------------------- - /** Field description */ + /** name of the user or the group */ protected String name; - /** Field description */ + /** security system */ private SecuritySystem securitySystem; } diff --git a/scm-webapp/src/main/java/sonia/scm/api/rest/resources/GroupPermissionResource.java b/scm-webapp/src/main/java/sonia/scm/api/rest/resources/GroupPermissionResource.java index 793d7dad65..b591d6a2a3 100644 --- a/scm-webapp/src/main/java/sonia/scm/api/rest/resources/GroupPermissionResource.java +++ b/scm-webapp/src/main/java/sonia/scm/api/rest/resources/GroupPermissionResource.java @@ -41,18 +41,20 @@ import sonia.scm.security.AssignedPermission; import sonia.scm.security.SecuritySystem; /** + * Resource to manage global group permission for a specified group. * * @author Sebastian Sdorra + * @since 1.31 */ public class GroupPermissionResource extends AbstractPermissionResource { /** - * Constructs ... + * Constructs a new group permissions resource * * - * @param securitySystem - * @param name + * @param securitySystem security system + * @param name name of the group */ public GroupPermissionResource(SecuritySystem securitySystem, String name) { @@ -62,12 +64,7 @@ public class GroupPermissionResource extends AbstractPermissionResource //~--- methods -------------------------------------------------------------- /** - * Method description - * - * - * @param permission - * - * @return + * {@inheritDoc} */ @Override protected AssignedPermission transformPermission(Permission permission) @@ -78,10 +75,7 @@ public class GroupPermissionResource extends AbstractPermissionResource //~--- get methods ---------------------------------------------------------- /** - * Method description - * - * - * @return + * {@inheritDoc} */ @Override protected Predicate getPredicate() @@ -92,20 +86,16 @@ public class GroupPermissionResource extends AbstractPermissionResource //~--- inner classes -------------------------------------------------------- /** - * Class description - * - * - * @version Enter version here..., 13/05/01 - * @author Enter your name here... + * Group predicate to filter permissions. */ private static class GroupPredicate implements Predicate { /** - * Constructs ... + * Constructs a new group predicate * * - * @param name + * @param name name of the group */ public GroupPredicate(String name) { @@ -115,12 +105,13 @@ public class GroupPermissionResource extends AbstractPermissionResource //~--- methods ------------------------------------------------------------ /** - * Method description + * Returns true if the permission is a group permission and the name is + * equals. * + * @param input permission * - * @param input - * - * @return + * @return true if the permission is a group permission and the name is + * equals */ @Override public boolean apply(AssignedPermission input) @@ -130,7 +121,7 @@ public class GroupPermissionResource extends AbstractPermissionResource //~--- fields ------------------------------------------------------------- - /** Field description */ + /** name of the group */ private String name; } } diff --git a/scm-webapp/src/main/java/sonia/scm/api/rest/resources/UserPermissionResource.java b/scm-webapp/src/main/java/sonia/scm/api/rest/resources/UserPermissionResource.java index 346b9c6a50..5f82fb98eb 100644 --- a/scm-webapp/src/main/java/sonia/scm/api/rest/resources/UserPermissionResource.java +++ b/scm-webapp/src/main/java/sonia/scm/api/rest/resources/UserPermissionResource.java @@ -41,18 +41,20 @@ import sonia.scm.security.AssignedPermission; import sonia.scm.security.SecuritySystem; /** + * Resource to manage global user permission for a specified user. * * @author Sebastian Sdorra + * @since 1.31 */ public class UserPermissionResource extends AbstractPermissionResource { /** - * Constructs ... + * Constructs a new user permission resource. * * - * @param securitySystem - * @param name + * @param securitySystem security system + * @param name name of the user */ public UserPermissionResource(SecuritySystem securitySystem, String name) { @@ -62,12 +64,7 @@ public class UserPermissionResource extends AbstractPermissionResource //~--- methods -------------------------------------------------------------- /** - * Method description - * - * - * @param permission - * - * @return + * {@inheritDoc} */ @Override protected AssignedPermission transformPermission(Permission permission) @@ -78,10 +75,7 @@ public class UserPermissionResource extends AbstractPermissionResource //~--- get methods ---------------------------------------------------------- /** - * Method description - * - * - * @return + * {@inheritDoc} */ @Override protected Predicate getPredicate() @@ -92,20 +86,16 @@ public class UserPermissionResource extends AbstractPermissionResource //~--- inner classes -------------------------------------------------------- /** - * Class description - * - * - * @version Enter version here..., 13/05/01 - * @author Enter your name here... + * User predicate to filter permissions. */ private static class UserPredicate implements Predicate { /** - * Constructs ... + * Constructs a new user predicate. * * - * @param name + * @param name name of the user */ public UserPredicate(String name) { @@ -115,12 +105,13 @@ public class UserPermissionResource extends AbstractPermissionResource //~--- methods ------------------------------------------------------------ /** - * Method description + * Returns true if the permission is a user permission and the name is + * equals. * + * @param input permission * - * @param input - * - * @return + * @return true if the permission is a user permission and the name is + * equals */ @Override public boolean apply(AssignedPermission input) @@ -130,7 +121,7 @@ public class UserPermissionResource extends AbstractPermissionResource //~--- fields ------------------------------------------------------------- - /** Field description */ + /** name of the user */ private String name; } }