io.apiman.manager.api.rest.contract

Interface IUserResource

@Path(value="users")
public interface IUserResource

The User API.

Author:

eric.wittmann@redhat.com

Method Summary

Methods

Modifier and Type	Method and Description
io.apiman.manager.api.beans.idm.UserBean	get(String userId)
io.apiman.manager.api.beans.search.SearchResultsBean<io.apiman.manager.api.beans.audit.AuditEntryBean>	getActivity(String userId, int page, int pageSize)
List<io.apiman.manager.api.beans.summary.ApplicationSummaryBean>	getApplications(String userId)
List<io.apiman.manager.api.beans.summary.OrganizationSummaryBean>	getOrganizations(String userId)
List<io.apiman.manager.api.beans.summary.ServiceSummaryBean>	getServices(String userId)
io.apiman.manager.api.beans.search.SearchResultsBean<io.apiman.manager.api.beans.idm.UserBean>	search(io.apiman.manager.api.beans.search.SearchCriteriaBean criteria)
void	update(String userId, io.apiman.manager.api.beans.idm.UserBean user)

Method Detail

get

@GET
@Path(value="{userId}")
@Produces(value="application/json")
io.apiman.manager.api.beans.idm.UserBean get(@PathParam(value="userId")
                                                             String userId)
                                             throws UserNotFoundException

Throws:

UserNotFoundException

update

@PUT
@Path(value="{userId}")
@Consumes(value="application/json")
void update(@PathParam(value="userId")
                            String userId,
                            io.apiman.manager.api.beans.idm.UserBean user)
            throws UserNotFoundException,
                   NotAuthorizedException

Throws:

UserNotFoundException

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.UserBean> search(io.apiman.manager.api.beans.search.SearchCriteriaBean criteria)
                                                                                                      throws InvalidSearchCriteriaException

Throws:

InvalidSearchCriteriaException

getOrganizations

@GET
@Path(value="{userId}/organizations")
@Produces(value="application/json")
List<io.apiman.manager.api.beans.summary.OrganizationSummaryBean> getOrganizations(@PathParam(value="userId")
                                                                                                   String userId)

getApplications

@GET
@Path(value="{userId}/applications")
@Produces(value="application/json")
List<io.apiman.manager.api.beans.summary.ApplicationSummaryBean> getApplications(@PathParam(value="userId")
                                                                                                 String userId)

getServices

@GET
@Path(value="{userId}/services")
@Produces(value="application/json")
List<io.apiman.manager.api.beans.summary.ServiceSummaryBean> getServices(@PathParam(value="userId")
                                                                                         String userId)

getActivity

@GET
@Path(value="{userId}/activity")
@Produces(value="application/json")
io.apiman.manager.api.beans.search.SearchResultsBean<io.apiman.manager.api.beans.audit.AuditEntryBean> getActivity(@PathParam(value="userId")
                                                                                                                                   String userId,
                                                                                                                                   @QueryParam(value="page")
                                                                                                                                   int page,
                                                                                                                                   @QueryParam(value="count")
                                                                                                                                   int pageSize)