io.apiman.manager.api.rest.contract

Interface IRoleResource

@Path(value="roles")
public interface IRoleResource

The Role API. Used to manage roles. Note: not used to manage users or user membership in roles. This API simply provides a way to create and manage role definitions. Typically this API is only available to system admins.

Author:

eric.wittmann@redhat.com

Method Summary

Methods

Modifier and Type	Method and Description
io.apiman.manager.api.beans.idm.RoleBean	create(io.apiman.manager.api.beans.idm.RoleBean bean)
void	delete(String roleId)
io.apiman.manager.api.beans.idm.RoleBean	get(String roleId)
List<io.apiman.manager.api.beans.idm.RoleBean>	list()
io.apiman.manager.api.beans.search.SearchResultsBean<io.apiman.manager.api.beans.idm.RoleBean>	search(io.apiman.manager.api.beans.search.SearchCriteriaBean criteria)
void	update(String roleId, io.apiman.manager.api.beans.idm.RoleBean bean)

Method Detail

create

@POST
@Consumes(value="application/json")
@Produces(value="application/json")
io.apiman.manager.api.beans.idm.RoleBean create(io.apiman.manager.api.beans.idm.RoleBean bean)
                                                throws RoleAlreadyExistsException,
                                                       NotAuthorizedException

Throws:

RoleAlreadyExistsException

NotAuthorizedException

list

@GET
@Produces(value="application/json")
List<io.apiman.manager.api.beans.idm.RoleBean> list()
                                                    throws NotAuthorizedException

Throws:

NotAuthorizedException

get

@GET
@Path(value="{roleId}")
@Produces(value="application/json")
io.apiman.manager.api.beans.idm.RoleBean get(@PathParam(value="roleId")
                                                             String roleId)
                                             throws RoleNotFoundException,
                                                    NotAuthorizedException

Throws:

RoleNotFoundException

NotAuthorizedException

update

@PUT
@Path(value="{roleId}")
@Consumes(value="application/json")
void update(@PathParam(value="roleId")
                            String roleId,
                            io.apiman.manager.api.beans.idm.RoleBean bean)
            throws RoleNotFoundException,
                   NotAuthorizedException

Throws:

RoleNotFoundException

NotAuthorizedException

delete

@DELETE
@Path(value="{roleId}")
void delete(@PathParam(value="roleId")
                      String roleId)
            throws RoleNotFoundException,
                   NotAuthorizedException

Throws:

RoleNotFoundException

NotAuthorizedException

search

@POST
@Path(value="search")
@Consumes(value="application/json")
@Produces(value="application/json")
io.apiman.manager.api.beans.search.SearchResultsBean<io.apiman.manager.api.beans.idm.RoleBean> search(io.apiman.manager.api.beans.search.SearchCriteriaBean criteria)
                                                                                                      throws InvalidSearchCriteriaException,
                                                                                                             NotAuthorizedException

Throws:

InvalidSearchCriteriaException

NotAuthorizedException