Package org.apache.archiva.redback.rest.api.services

Interface RoleManagementService

All Known Implementing Classes:

DefaultRoleManagementService

@Deprecated
@Path("/roleManagementService/")
public interface RoleManagementService

Deprecated.

Use the new v2 service RoleService

Author:

Olivier Lamy

Method Summary

Modifier and Type	Method	Description
ActionStatus	assignRole(String roleId, String principal)	Deprecated. Assigns the role indicated by the roleId to the given principal
ActionStatus	assignRoleByName(String roleName, String principal)	Deprecated. Assigns the role indicated by the roleName to the given principal
ActionStatus	assignTemplatedRole(String templateId, String resource, String principal)	Deprecated. Assigns the templated role indicated by the templateId fails if the templated role has not been created
ActionStatus	createTemplatedRole(String templateId, String resource)	Deprecated.
List<Role>	getAllRoles()	Deprecated.
List<ApplicationRoles>	getApplicationRoles(String username)	Deprecated.
List<Application>	getApplications(String username)	Deprecated.
List<Role>	getDetailedAllRoles()	Deprecated.
List<Role>	getEffectivelyAssignedRoles(String username)	Deprecated.
Role	getRole(String roleName)	Deprecated.
ActionStatus	removeTemplatedRole(String templateId, String resource)	Deprecated. removes a role corresponding to the role Id that was manufactured with the given resource it also removes any user assignments for that role
Boolean	roleExists(String roleId)	Deprecated. true of a role exists with the given roleId
Boolean	templatedRoleExists(String templateId, String resource)	Deprecated. true of a role exists with the given roleId
ActionStatus	unassignRole(String roleId, String principal)	Deprecated. Unassigns the role indicated by the role id from the given principal
ActionStatus	unassignRoleByName(String roleName, String principal)	Deprecated. Unassigns the role indicated by the role name from the given principal
ActionStatus	updateRole(String templateId, String oldResource, String newResource)	Deprecated. allows for a role coming from a template to be renamed effectively swapping out the bits of it that were labeled with the oldResource with the newResource it also manages any user assignments for that role
ActionStatus	updateRoleDescription(String roleName, String description)	Deprecated.
ActionStatus	updateRoleUsers(Role role)	Deprecated. update users assigned to a role
ActionStatus	updateUserRoles(User user)	Deprecated. update roles assigned to a user
VerificationStatus	verifyTemplatedRole(String templateId, String resource)	Deprecated. Check a role template is complete in the RBAC store.

Method Detail

createTemplatedRole

@Path("createTemplatedRole")
@GET
@Produces({"application/json","application/xml","text/plain"})
ActionStatus createTemplatedRole(@QueryParam("templateId")
                                 String templateId,
                                 @QueryParam("resource")
                                 String resource)
                          throws RedbackServiceException

Deprecated.

Throws:

RedbackServiceException

removeTemplatedRole

@Path("removeTemplatedRole")
@GET
@Produces({"application/json","application/xml","text/plain"})
ActionStatus removeTemplatedRole(@QueryParam("templateId")
                                 String templateId,
                                 @QueryParam("resource")
                                 String resource)
                          throws RedbackServiceException

Deprecated.

removes a role corresponding to the role Id that was manufactured with the given resource it also removes any user assignments for that role

Parameters:

templateId -

resource -

Throws:

RedbackServiceException

updateRole

@Path("updateRole")
@GET
@Produces({"application/json","application/xml","text/plain"})
ActionStatus updateRole(@QueryParam("templateId")
                        String templateId,
                        @QueryParam("oldResource")
                        String oldResource,
                        @QueryParam("newResource")
                        String newResource)
                 throws RedbackServiceException

Deprecated.

allows for a role coming from a template to be renamed effectively swapping out the bits of it that were labeled with the oldResource with the newResource it also manages any user assignments for that role

Parameters:

templateId -

oldResource -

newResource -

Throws:

RedbackServiceException

assignRole

@Path("assignRole")
@GET
@Produces({"application/json","application/xml","text/plain"})
ActionStatus assignRole(@QueryParam("roleId")
                        String roleId,
                        @QueryParam("principal")
                        String principal)
                 throws RedbackServiceException

Deprecated.

Assigns the role indicated by the roleId to the given principal

Parameters:

roleId -

principal -

Throws:

RedbackServiceException

assignRoleByName

@Path("assignRoleByName")
@GET
@Produces({"application/json","application/xml","text/plain"})
ActionStatus assignRoleByName(@QueryParam("roleName")
                              String roleName,
                              @QueryParam("principal")
                              String principal)
                       throws RedbackServiceException

Deprecated.

Assigns the role indicated by the roleName to the given principal

Parameters:

roleName -

principal -

Throws:

RedbackServiceException

assignTemplatedRole

@Path("assignTemplatedRole")
@GET
@Produces({"application/json","application/xml","text/plain"})
ActionStatus assignTemplatedRole(@QueryParam("templateId")
                                 String templateId,
                                 @QueryParam("resource")
                                 String resource,
                                 @QueryParam("principal")
                                 String principal)
                          throws RedbackServiceException

Deprecated.

Assigns the templated role indicated by the templateId fails if the templated role has not been created

Parameters:

templateId -

resource -

principal -

Throws:

RedbackServiceException

unassignRole

@Path("unassignRole")
@GET
@Produces({"application/json","application/xml","text/plain"})
ActionStatus unassignRole(@QueryParam("roleId")
                          String roleId,
                          @QueryParam("principal")
                          String principal)
                   throws RedbackServiceException

Deprecated.

Unassigns the role indicated by the role id from the given principal

Parameters:

roleId -

principal -

Throws:

RedbackServiceException

unassignRoleByName

@Path("unassignRoleByName")
@GET
@Produces({"application/json","application/xml","text/plain"})
ActionStatus unassignRoleByName(@QueryParam("roleName")
                                String roleName,
                                @QueryParam("principal")
                                String principal)
                         throws RedbackServiceException

Deprecated.

Unassigns the role indicated by the role name from the given principal

Parameters:

roleName -

principal -

Throws:

RedbackServiceException

roleExists

@Path("roleExists")
@GET
@Produces({"application/json","application/xml","text/plain"})
Boolean roleExists(@QueryParam("roleId")
                   String roleId)
            throws RedbackServiceException

Deprecated.

true of a role exists with the given roleId

Parameters:

roleId -

Returns:

Throws:

RedbackServiceException

templatedRoleExists

@Path("templatedRoleExists")
@GET
@Produces({"application/json","application/xml","text/plain"})
Boolean templatedRoleExists(@QueryParam("templateId")
                            String templateId,
                            @QueryParam("resource")
                            String resource)
                     throws RedbackServiceException

Deprecated.

true of a role exists with the given roleId

Parameters:

templateId -

resource -

Returns:

Throws:

RedbackServiceException

verifyTemplatedRole

@Path("verifyTemplatedRole")
@GET
@Produces({"application/json","application/xml","text/plain"})
VerificationStatus verifyTemplatedRole(@QueryParam("templateId")
                                       String templateId,
                                       @QueryParam("resource")
                                       String resource)
                                throws RedbackServiceException

Deprecated.

Check a role template is complete in the RBAC store.

Parameters:

templateId - the templated role

resource - the resource to verify

Throws:

RedbackServiceException

getEffectivelyAssignedRoles

@Path("getEffectivelyAssignedRoles/{username}")
@GET
@Produces({"application/json","application/xml","text/plain"})
List<Role> getEffectivelyAssignedRoles(@PathParam("username")
                                       String username)
                                throws RedbackServiceException

Deprecated.

Throws:

RedbackServiceException

Since:

1.4

getAllRoles

@Path("allRoles")
@GET
@Produces({"application/json","application/xml","text/plain"})
List<Role> getAllRoles()
                throws RedbackServiceException

Deprecated.

Throws:

RedbackServiceException

Since:

2.0

getDetailedAllRoles

@Path("detailledAllRoles")
@GET
@Produces({"application/json","application/xml","text/plain"})
List<Role> getDetailedAllRoles()
                        throws RedbackServiceException

Deprecated.

Throws:

RedbackServiceException

Since:

2.0

getApplications

@Path("getApplications/{username}")
@GET
@Produces({"application/json","application/xml","text/plain"})
List<Application> getApplications(@PathParam("username")
                                  String username)
                           throws RedbackServiceException

Deprecated.

Throws:

RedbackServiceException

Since:

2.0

getRole

@Path("getRole/{roleName}")
@GET
@Produces({"application/json","application/xml","text/plain"})
Role getRole(@PathParam("roleName")
             String roleName)
      throws RedbackServiceException

Deprecated.

Throws:

RedbackServiceException

Since:

2.0

updateRoleDescription

@Path("updateRoleDescription")
@GET
@Produces({"application/json","application/xml","text/plain"})
ActionStatus updateRoleDescription(@QueryParam("roleName")
                                   String roleName,
                                   @QueryParam("roleDescription")
                                   String description)
                            throws RedbackServiceException

Deprecated.

Throws:

RedbackServiceException

Since:

2.0

updateRoleUsers

@Path("updateRoleUsers")
@POST
@Produces({"application/json","application/xml"})
@Consumes({"application/json","application/xml"})
ActionStatus updateRoleUsers(Role role)
                      throws RedbackServiceException

Deprecated.

update users assigned to a role

Throws:

RedbackServiceException

Since:

2.0

getApplicationRoles

@Path("getApplicationRoles/{username}")
@GET
@Produces({"application/json","application/xml"})
List<ApplicationRoles> getApplicationRoles(@PathParam("username")
                                           String username)
                                    throws RedbackServiceException

Deprecated.

Throws:

RedbackServiceException

Since:

2.0

updateUserRoles

@Path("updateUserRoles")
@POST
@Produces({"application/json","application/xml"})
@Consumes({"application/json","application/xml"})
ActionStatus updateUserRoles(User user)
                      throws RedbackServiceException

Deprecated.

update roles assigned to a user

Throws:

RedbackServiceException

Since:

2.0