@Path(value="users") public interface UserService extends JAXRSService
DEFAULT_PARAM_PAGE, DEFAULT_PARAM_PAGE_VALUE, DEFAULT_PARAM_SIZE, DEFAULT_PARAM_SIZE_VALUE, PARAM_DETAILS, PARAM_FIQL, PARAM_ORDERBY, PARAM_PAGE, PARAM_SIZE| Modifier and Type | Method and Description |
|---|---|
BulkActionResult |
bulk(BulkAction bulkAction)
Executes the provided bulk action.
|
javax.ws.rs.core.Response |
bulkAssociation(Long userId,
ResourceAssociationActionType type,
ResourceAssociationMod associationMod)
Executes resource-related operations on given user.
|
javax.ws.rs.core.Response |
bulkDeassociation(Long userId,
ResourceDeassociationActionType type,
List<ResourceName> resourceNames)
Executes resource-related operations on given user.
|
javax.ws.rs.core.Response |
create(UserTO userTO,
boolean storePassword)
Creates a new user.
|
javax.ws.rs.core.Response |
delete(Long userId)
Deletes user matching provided userId.
|
javax.ws.rs.core.Response |
getUserId(String username)
Gives the user id for the provided username.
|
javax.ws.rs.core.Response |
getUsername(Long userId)
Gives the username for the provided user id.
|
PagedResult<UserTO> |
list()
Returns a paged list of existing users.
|
PagedResult<UserTO> |
list(Integer page,
Integer size)
Returns a paged list of existing users matching page/size conditions.
|
PagedResult<UserTO> |
list(Integer page,
Integer size,
String orderBy,
boolean details)
Returns a paged list of existing users matching page/size conditions.
|
PagedResult<UserTO> |
list(String orderBy)
Returns a paged list of existing users.
|
UserTO |
read(Long userId)
Reads the user matching the provided userId.
|
PagedResult<UserTO> |
search(String fiql)
Returns a paged list of users matching the provided FIQL search condition.
|
PagedResult<UserTO> |
search(String fiql,
Integer page,
Integer size)
Returns a paged list of users matching the provided FIQL search condition.
|
PagedResult<UserTO> |
search(String fiql,
Integer page,
Integer size,
String orderBy,
boolean details)
Returns a paged list of users matching the provided FIQL search condition.
|
PagedResult<UserTO> |
search(String fiql,
String orderBy)
Returns a paged list of users matching the provided FIQL search condition.
|
javax.ws.rs.core.Response |
status(Long userId,
StatusMod statusMod)
Performs a status update on user matching provided userId.
|
javax.ws.rs.core.Response |
update(Long userId,
UserMod userMod)
Updates user matching the provided userId.
|
@OPTIONS
@Path(value="{userId}/username")
javax.ws.rs.core.Response getUsername(@NotNull@PathParam(value="userId")
Long userId)
userId - user id@OPTIONS
@Path(value="{username}/userId")
javax.ws.rs.core.Response getUserId(@NotNull@PathParam(value="username")
String username)
username - username@GET
@Path(value="{userId}")
@Produces(value={"application/xml","application/json"})
UserTO read(@NotNull@PathParam(value="userId")
Long userId)
userId - id of user to be read@GET
@Produces(value={"application/xml","application/json"})
PagedResult<UserTO> list()
@GET
@Produces(value={"application/xml","application/json"})
PagedResult<UserTO> list(@QueryParam(value="orderby")
String orderBy)
orderBy - list of ordering clauses, separated by comma@GET
@Produces(value={"application/xml","application/json"})
PagedResult<UserTO> list(@NotNull@Min(value=1L)@QueryParam(value="page")@DefaultValue(value="1")
Integer page,
@NotNull@Min(value=1L)@QueryParam(value="size")@DefaultValue(value="25")
Integer size)
page - result page numbersize - number of entries per page@GET
@Produces(value={"application/xml","application/json"})
PagedResult<UserTO> list(@NotNull@Min(value=1L)@QueryParam(value="page")@DefaultValue(value="1")
Integer page,
@NotNull@Min(value=1L)@QueryParam(value="size")@DefaultValue(value="25")
Integer size,
@QueryParam(value="orderby")
String orderBy,
@QueryParam(value="details")@DefaultValue(value="true")
boolean details)
page - result page numbersize - number of entries per pageorderBy - list of ordering clauses, separated by commadetails - whether include all details or not, defaults to true@GET
@Path(value="search")
@Produces(value={"application/xml","application/json"})
PagedResult<UserTO> search(@NotNull@QueryParam(value="fiql")
String fiql)
fiql - FIQL search expression@GET
@Path(value="search")
@Produces(value={"application/xml","application/json"})
PagedResult<UserTO> search(@NotNull@QueryParam(value="fiql")
String fiql,
@QueryParam(value="orderby")
String orderBy)
fiql - FIQL search expressionorderBy - list of ordering clauses, separated by comma@GET
@Path(value="search")
@Produces(value={"application/xml","application/json"})
PagedResult<UserTO> search(@QueryParam(value="fiql")
String fiql,
@NotNull@Min(value=1L)@QueryParam(value="page")@DefaultValue(value="1")
Integer page,
@NotNull@Min(value=1L)@QueryParam(value="size")@DefaultValue(value="25")
Integer size)
fiql - FIQL search expressionpage - result page numbersize - number of entries per page@GET
@Path(value="search")
@Produces(value={"application/xml","application/json"})
PagedResult<UserTO> search(@QueryParam(value="fiql")
String fiql,
@NotNull@Min(value=1L)@QueryParam(value="page")@DefaultValue(value="1")
Integer page,
@NotNull@Min(value=1L)@QueryParam(value="size")@DefaultValue(value="25")
Integer size,
@QueryParam(value="orderby")
String orderBy,
@QueryParam(value="details")@DefaultValue(value="true")
boolean details)
fiql - FIQL search expressionpage - result page numbersize - number of entries per pageorderBy - list of ordering clauses, separated by commadetails - whether include all details or not, defaults to true@POST
@Produces(value={"application/xml","application/json"})
@Consumes(value={"application/xml","application/json"})
javax.ws.rs.core.Response create(@NotNull
UserTO userTO,
@DefaultValue(value="true")@QueryParam(value="storePassword")
boolean storePassword)
userTO - user to be createdstorePassword - whether password shall be stored internallyUserTO as Entity@POST
@Path(value="{userId}")
@Produces(value={"application/xml","application/json"})
@Consumes(value={"application/xml","application/json"})
javax.ws.rs.core.Response update(@NotNull@PathParam(value="userId")
Long userId,
@NotNull
UserMod userMod)
userId - id of user to be updateduserMod - modification to be applied to user matching the provided userIdUserTO as Entity@POST
@Path(value="{userId}/status")
@Produces(value={"application/xml","application/json"})
@Consumes(value={"application/xml","application/json"})
javax.ws.rs.core.Response status(@NotNull@PathParam(value="userId")
Long userId,
@NotNull
StatusMod statusMod)
userId - id of user to be subjected to status updatestatusMod - status update detailsUserTO as Entity@DELETE
@Path(value="{userId}")
@Produces(value={"application/xml","application/json"})
javax.ws.rs.core.Response delete(@NotNull@PathParam(value="userId")
Long userId)
userId - id of user to be deletedUserTO as Entity@POST
@Path(value="{userId}/bulkDeassociation/{type}")
@Produces(value={"application/xml","application/json"})
@Consumes(value={"application/xml","application/json"})
javax.ws.rs.core.Response bulkDeassociation(@NotNull@PathParam(value="userId")
Long userId,
@NotNull@PathParam(value="type")
ResourceDeassociationActionType type,
@NotNull
List<ResourceName> resourceNames)
userId - user idtype - resource de-association action typeresourceNames - external resources to be used for propagation-related operationsBulkActionResult as Entity@POST
@Path(value="{userId}/bulkAssociation/{type}")
@Produces(value={"application/xml","application/json"})
@Consumes(value={"application/xml","application/json"})
javax.ws.rs.core.Response bulkAssociation(@NotNull@PathParam(value="userId")
Long userId,
@NotNull@PathParam(value="type")
ResourceAssociationActionType type,
@NotNull
ResourceAssociationMod associationMod)
userId - user id.type - resource association action typeassociationMod - external resources to be used for propagation-related operationsBulkActionResult as Entity@POST
@Path(value="bulk")
@Produces(value={"application/xml","application/json"})
@Consumes(value={"application/xml","application/json"})
BulkActionResult bulk(@NotNull
BulkAction bulkAction)
bulkAction - list of user ids against which the bulk action will be performed.Copyright © 2010–2018 The Apache Software Foundation. All rights reserved.