edu.illinois.ncsa.datawolf.service

Class PersonsResource

java.lang.Object

edu.illinois.ncsa.datawolf.service.PersonsResource

@Path(value="/persons")
public class PersonsResource
extends Object

Constructor Summary

Constructors

Constructor and Description
PersonsResource()

Method Summary

Methods

Modifier and Type	Method and Description
String	createPerson(String firstName, String lastName, String email)
void	deletePerson(String personId) Delete the person given the specific id.
Person	getPerson(String personId) Get a dataset by Id
List<Person>	getPersons(int size, int page, String email, boolean showdeleted) Get all users

Methods inherited from class java.lang.Object

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

Constructor Detail

PersonsResource

public PersonsResource()

Method Detail

getPersons

@GET
@Produces(value="application/json")
public List<Person> getPersons(@QueryParam(value="size")@DefaultValue(value="100")
                                   int size,
                                   @QueryParam(value="page")@DefaultValue(value="0")
                                   int page,
                                   @QueryParam(value="email")@DefaultValue(value="")
                                   String email,
                                   @QueryParam(value="showdeleted")@DefaultValue(value="false")
                                   boolean showdeleted)

Get all users

Parameters:

size - number of users per page

page - page number starting 0

showdeleted - should we return deleted person.

Returns:

createPerson

@POST
@Produces(value="text/plain")
public String createPerson(@QueryParam(value="firstname")@DefaultValue(value="")
                                String firstName,
                                @QueryParam(value="lastname")@DefaultValue(value="")
                                String lastName,
                                @QueryParam(value="email")@DefaultValue(value="")
                                String email)

Parameters:

firstName - given name of user to create

lastName - surname of user to create

email - email address of user to create

Returns:

id of generated user

getPerson

@GET
@Path(value="{person-id}")
@Produces(value="application/json")
public Person getPerson(@PathParam(value="person-id")
                                 String personId)

Get a dataset by Id

Parameters:

personId - dataset Id

Returns:

a dataset in JSON

deletePerson

@DELETE
@Path(value="{person-id}")
public void deletePerson(@PathParam(value="person-id")
                            String personId)
                  throws Exception

Delete the person given the specific id.

Parameters:

personId - the person to be deleted

Throws:

Exception