Nemcio/SCM-Manager
1
0
Fork 0
mirror of https://github.com/scm-manager/scm-manager.git synced 2025-11-10 15:35:49 +01:00
Code Issues Packages Projects Releases Activity

document user and group permission resource

Browse Source
This commit is contained in:
Sebastian Sdorra
2013-05-31 17:51:04 +02:00
parent b255d69366
commit d665367b39
3 changed files with 103 additions and 86 deletions
Download Patch File Download Diff File Expand all files Collapse all files

107
scm-webapp/src/main/java/sonia/scm/api/rest/resources/AbstractPermissionResource.java
View File

@@ -30,6 +30,7 @@
*/ */
package sonia.scm.api.rest.resources; package sonia.scm.api.rest.resources;
//~--- non-JDK imports -------------------------------------------------------- //~--- non-JDK imports --------------------------------------------------------
@@ -65,6 +66,7 @@ import javax.ws.rs.core.Response.Status;
import javax.ws.rs.core.UriInfo; import javax.ws.rs.core.UriInfo;
/** /**
* Abstract base class for global permission resources.
* *
* @author Sebastian Sdorra * @author Sebastian Sdorra
* @since 1.31 * @since 1.31
@@ -73,11 +75,11 @@ public abstract class AbstractPermissionResource
{ {
/** /**
* Constructs ... * Constructs a new {@link AbstractPermissionResource}.
* *
* *
* @param securitySystem * @param securitySystem security system
* @param name * @param name name of the user or group
*/ */
protected AbstractPermissionResource(SecuritySystem securitySystem, protected AbstractPermissionResource(SecuritySystem securitySystem,
String name) String name)
@@ -89,12 +91,12 @@ public abstract class AbstractPermissionResource
//~--- methods -------------------------------------------------------------- //~--- 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( protected abstract AssignedPermission transformPermission(
Permission permission); Permission permission);
@@ -102,23 +104,28 @@ public abstract class AbstractPermissionResource
//~--- get methods ---------------------------------------------------------- //~--- get methods ----------------------------------------------------------
/** /**
* Method description * Returns a {@link Predicate} to filter permissions.
* *
* *
* @return * @return {@link Predicate} to filter permissions
*/ */
protected abstract Predicate<AssignedPermission> getPredicate(); protected abstract Predicate<AssignedPermission> getPredicate();
//~--- methods -------------------------------------------------------------- //~--- methods --------------------------------------------------------------
/** /**
* Method description * Adds a new permission to the user or group managed by the resource.<br />
* <br />
* Status codes:
* <ul>
* <li>201 add successful</li>
* <li>500 internal server error</li>
* </ul>
* *
* @param uriInfo uri informations
* @param permission permission to add
* *
* @param uriInfo * @return web response
* @param permission
*
* @return
*/ */
@POST @POST
@Consumes({ MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON }) @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.<br />
* <br />
* Status codes:
* <ul>
* <li>200 delete successful</li>
* <li>400 bad request, permission id does not belong to the user or group</li>
* <li>404 not found, no permission with the specified id available</li>
* <li>500 internal server error</li>
* </ul>
* *
* @param id id of the permission
* *
* @param id * @return web response
*
* @return
*/ */
@DELETE @DELETE
@Path("{id}") @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.<br />
* <br />
* Status codes:
* <ul>
* <li>204 update successful</li>
* <li>400 bad request, permission id does not belong to the user or group</li>
* <li>404 not found, no permission with the specified id available</li>
* <li>500 internal server error</li>
* </ul>
* *
* @param id id of the permission
* @param permission updated permission
* *
* @param id * @return web response
* @param permission
*
* @return
*/ */
@PUT @PUT
@Path("{id}") @Path("{id}")
@@ -175,12 +197,20 @@ public abstract class AbstractPermissionResource
//~--- get methods ---------------------------------------------------------- //~--- get methods ----------------------------------------------------------
/** /**
* Method description * Returns the {@link Permission} with the specified id.<br />
* <br />
* Status codes:
* <ul>
* <li>200 get successful</li>
* <li>400 bad request, permission id does not belong to the user or group</li>
* <li>404 not found, no permission with the specified id available</li>
* <li>500 internal server error</li>
* </ul>
* *
* *
* @param id * @param id id of the {@link Permission}
* *
* @return * @return {@link Permission} with the specified id
*/ */
@GET @GET
@Path("{id}") @Path("{id}")
@@ -193,10 +223,15 @@ public abstract class AbstractPermissionResource
} }
/** /**
* Method description * Returns all permissions of the user or group managed by the resource.<br />
* <br />
* Status codes:
* <ul>
* <li>200 get successful</li>
* <li>500 internal server error</li>
* </ul>
* *
* * @return all permissions of the user or group
* @return
*/ */
@GET @GET
@Produces({ MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON }) @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) 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<Permission> getPermissions( private List<Permission> getPermissions(
Predicate<AssignedPermission> predicate) Predicate<AssignedPermission> predicate)
@@ -258,9 +293,9 @@ public abstract class AbstractPermissionResource
//~--- fields --------------------------------------------------------------- //~--- fields ---------------------------------------------------------------
/** Field description */ /** name of the user or the group */
protected String name; protected String name;
/** Field description */ /** security system */
private SecuritySystem securitySystem; private SecuritySystem securitySystem;
} }

41
scm-webapp/src/main/java/sonia/scm/api/rest/resources/GroupPermissionResource.java
View File

@@ -41,18 +41,20 @@ import sonia.scm.security.AssignedPermission;
import sonia.scm.security.SecuritySystem; import sonia.scm.security.SecuritySystem;
/** /**
* Resource to manage global group permission for a specified group.
* *
* @author Sebastian Sdorra * @author Sebastian Sdorra
* @since 1.31
*/ */
public class GroupPermissionResource extends AbstractPermissionResource public class GroupPermissionResource extends AbstractPermissionResource
{ {
/** /**
* Constructs ... * Constructs a new group permissions resource
* *
* *
* @param securitySystem * @param securitySystem security system
* @param name * @param name name of the group
*/ */
public GroupPermissionResource(SecuritySystem securitySystem, String name) public GroupPermissionResource(SecuritySystem securitySystem, String name)
{ {
@@ -62,12 +64,7 @@ public class GroupPermissionResource extends AbstractPermissionResource
//~--- methods -------------------------------------------------------------- //~--- methods --------------------------------------------------------------
/** /**
* Method description * {@inheritDoc}
*
*
* @param permission
*
* @return
*/ */
@Override @Override
protected AssignedPermission transformPermission(Permission permission) protected AssignedPermission transformPermission(Permission permission)
@@ -78,10 +75,7 @@ public class GroupPermissionResource extends AbstractPermissionResource
//~--- get methods ---------------------------------------------------------- //~--- get methods ----------------------------------------------------------
/** /**
* Method description * {@inheritDoc}
*
*
* @return
*/ */
@Override @Override
protected Predicate<AssignedPermission> getPredicate() protected Predicate<AssignedPermission> getPredicate()
@@ -92,20 +86,16 @@ public class GroupPermissionResource extends AbstractPermissionResource
//~--- inner classes -------------------------------------------------------- //~--- inner classes --------------------------------------------------------
/** /**
* Class description * Group predicate to filter permissions.
*
*
* @version Enter version here..., 13/05/01
* @author Enter your name here...
*/ */
private static class GroupPredicate implements Predicate<AssignedPermission> private static class GroupPredicate implements Predicate<AssignedPermission>
{ {
/** /**
* Constructs ... * Constructs a new group predicate
* *
* *
* @param name * @param name name of the group
*/ */
public GroupPredicate(String name) public GroupPredicate(String name)
{ {
@@ -115,12 +105,13 @@ public class GroupPermissionResource extends AbstractPermissionResource
//~--- methods ------------------------------------------------------------ //~--- methods ------------------------------------------------------------
/** /**
* Method description * Returns true if the permission is a group permission and the name is
* equals.
* *
* @param input permission
* *
* @param input * @return true if the permission is a group permission and the name is
* * equals
* @return
*/ */
@Override @Override
public boolean apply(AssignedPermission input) public boolean apply(AssignedPermission input)
@@ -130,7 +121,7 @@ public class GroupPermissionResource extends AbstractPermissionResource
//~--- fields ------------------------------------------------------------- //~--- fields -------------------------------------------------------------
/** Field description */ /** name of the group */
private String name; private String name;
} }
} }

41
scm-webapp/src/main/java/sonia/scm/api/rest/resources/UserPermissionResource.java
View File

@@ -41,18 +41,20 @@ import sonia.scm.security.AssignedPermission;
import sonia.scm.security.SecuritySystem; import sonia.scm.security.SecuritySystem;
/** /**
* Resource to manage global user permission for a specified user.
* *
* @author Sebastian Sdorra * @author Sebastian Sdorra
* @since 1.31
*/ */
public class UserPermissionResource extends AbstractPermissionResource public class UserPermissionResource extends AbstractPermissionResource
{ {
/** /**
* Constructs ... * Constructs a new user permission resource.
* *
* *
* @param securitySystem * @param securitySystem security system
* @param name * @param name name of the user
*/ */
public UserPermissionResource(SecuritySystem securitySystem, String name) public UserPermissionResource(SecuritySystem securitySystem, String name)
{ {
@@ -62,12 +64,7 @@ public class UserPermissionResource extends AbstractPermissionResource
//~--- methods -------------------------------------------------------------- //~--- methods --------------------------------------------------------------
/** /**
* Method description * {@inheritDoc}
*
*
* @param permission
*
* @return
*/ */
@Override @Override
protected AssignedPermission transformPermission(Permission permission) protected AssignedPermission transformPermission(Permission permission)
@@ -78,10 +75,7 @@ public class UserPermissionResource extends AbstractPermissionResource
//~--- get methods ---------------------------------------------------------- //~--- get methods ----------------------------------------------------------
/** /**
* Method description * {@inheritDoc}
*
*
* @return
*/ */
@Override @Override
protected Predicate<AssignedPermission> getPredicate() protected Predicate<AssignedPermission> getPredicate()
@@ -92,20 +86,16 @@ public class UserPermissionResource extends AbstractPermissionResource
//~--- inner classes -------------------------------------------------------- //~--- inner classes --------------------------------------------------------
/** /**
* Class description * User predicate to filter permissions.
*
*
* @version Enter version here..., 13/05/01
* @author Enter your name here...
*/ */
private static class UserPredicate implements Predicate<AssignedPermission> private static class UserPredicate implements Predicate<AssignedPermission>
{ {
/** /**
* Constructs ... * Constructs a new user predicate.
* *
* *
* @param name * @param name name of the user
*/ */
public UserPredicate(String name) public UserPredicate(String name)
{ {
@@ -115,12 +105,13 @@ public class UserPermissionResource extends AbstractPermissionResource
//~--- methods ------------------------------------------------------------ //~--- methods ------------------------------------------------------------
/** /**
* Method description * Returns true if the permission is a user permission and the name is
* equals.
* *
* @param input permission
* *
* @param input * @return true if the permission is a user permission and the name is
* * equals
* @return
*/ */
@Override @Override
public boolean apply(AssignedPermission input) public boolean apply(AssignedPermission input)
@@ -130,7 +121,7 @@ public class UserPermissionResource extends AbstractPermissionResource
//~--- fields ------------------------------------------------------------- //~--- fields -------------------------------------------------------------
/** Field description */ /** name of the user */
private String name; private String name;
} }
} }