Package org.apache.unomi.rest.endpoints

Class UserListServiceEndPoint

java.lang.Object

org.apache.unomi.rest.endpoints.UserListServiceEndPoint

@Produces("application/json")
@Consumes("application/json")
@Path("/userList")
public class UserListServiceEndPoint
extends Object

A JAX-RS endpoint to manage UserLists.

Constructor Summary

Constructors

Constructor	Description
UserListServiceEndPoint()

Method Summary

Modifier and Type	Method	Description
List<Metadata>	getUserListsMetadatas(int offset, int size, String sortBy)	Retrieves the 50 first UserList metadatas.
void	setUserListService(UserListService userListService)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserListServiceEndPoint

public UserListServiceEndPoint()

Method Detail

setUserListService

public void setUserListService(UserListService userListService)

getUserListsMetadatas

@GET
@Path("/")
public List<Metadata> getUserListsMetadatas(@QueryParam("offset") @DefaultValue("0")
                                            int offset,
                                            @QueryParam("size") @DefaultValue("50")
                                            int size,
                                            @QueryParam("sort")
                                            String sortBy)

Retrieves the 50 first UserList metadatas.

Parameters:

offset - zero or a positive integer specifying the position of the first element in the total ordered collection of matching elements

size - a positive integer specifying how many matching elements should be retrieved or -1 if all of them should be retrieved

sortBy - an optional (null if no sorting is required) String of comma (,) separated property names on which ordering should be performed, ordering elements according to the property order in the String, considering each in turn and moving on to the next one in case of equality of all preceding ones. Each property name is optionally followed by a column (:) and an order specifier: asc or desc.

Returns:

a List of the 50 first UserList metadata