org.apache.marmotta.platform.user.webservices

Class UserManagementWebService

java.lang.Object

org.apache.marmotta.platform.user.webservices.UserManagementWebService

@Path(value="/users")
public class UserManagementWebService
extends Object

Constructor Summary

Constructors

Constructor and Description
UserManagementWebService()

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createUser(String login) Create a new user account (incl.
javax.ws.rs.core.Response	deleteUser(String login, boolean delFoaf) Delete the account with the given login.
javax.ws.rs.core.Response	getUser(String login) Return the Account data of the requested login
void	initialize()
javax.ws.rs.core.Response	listUsers(String role) List users (that have the given role).
javax.ws.rs.core.Response	setUserPassword(String login, String passwd) Set the password for the given account
javax.ws.rs.core.Response	setUserProfile(String login, javax.ws.rs.core.MultivaluedMap<String,String> formParams) Update/Save the user profile (foaf) for the given account
javax.ws.rs.core.Response	setUserRoles(String login, String[] roles, String[] roles2) Set the roles for the given account

Methods inherited from class java.lang.Object

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

Constructor Detail

UserManagementWebService

public UserManagementWebService()

Method Detail

initialize

@PostConstruct
public void initialize()

listUsers

@GET
@Produces(value="application/json")
public javax.ws.rs.core.Response listUsers(@QueryParam(value="role")
                                               String role)

List users (that have the given role).

Parameters:

role - the required role (optional)

Returns:

an array of UserWebService.AccountPoJos containing users (that have the required role, if role was given) (in JSON).

createUser

@POST
@Path(value="/{login}")
public javax.ws.rs.core.Response createUser(@PathParam(value="login")
                                             String login)

Create a new user account (incl. user resource)

Parameters:

login - the account name / login name of the new user.

Returns:

the UserWebService.AccountPoJo of the newly created user.

HTTP Status Codes

409 if an account with the given login already exists, 400 if the login is a reserved keyword: [me, login, anonymous], 500 on other errors.

getUser

@GET
@Path(value="/{login}")
@Produces(value="application/json")
public javax.ws.rs.core.Response getUser(@PathParam(value="login")
                                                  String login)

Return the Account data of the requested login

Parameters:

login - the account requested

Returns:

an UserWebService.AccountPoJo of the requested account

HTTP Status Codes

404 if no such user exists.

deleteUser

@DELETE
@Path(value="/{login}")
public javax.ws.rs.core.Response deleteUser(@PathParam(value="login")
                                               String login,
                                               @QueryParam(value="deleteFoaf")@DefaultValue(value="false")
                                               boolean delFoaf)

Delete the account with the given login.

Parameters:

login - the account to delete

delFoaf - if true, also delete the user profile (foaf)

Returns:

200 ok on success

HTTP Status Codes

404 if no such user exists

setUserRoles

@POST
@Path(value="/{login}/roles")
public javax.ws.rs.core.Response setUserRoles(@PathParam(value="login")
                                               String login,
                                               @QueryParam(value="role")
                                               String[] roles,
                                               @QueryParam(value="role[]")
                                               String[] roles2)

Set the roles for the given account

Parameters:

login - the account

roles - role params of the roles to set

roles2 - role[] params of the roles to set

Returns:

the UserWebService.AccountPoJo of the account after update

HTTP Status Codes

404 if no such account exists.

setUserPassword

@POST
@Path(value="/{login}/password")
public javax.ws.rs.core.Response setUserPassword(@PathParam(value="login")
                                                  String login,
                                                  @FormParam(value="password")
                                                  String passwd)

Set the password for the given account

Parameters:

login - the account to set the password for

passwd - the new password

Returns:

200 OK on success

HTTP Status Codes

404 if no such account exists

setUserProfile

@POST
@Path(value="/{login}/profile")
public javax.ws.rs.core.Response setUserProfile(@PathParam(value="login")
                                                 String login,
                                                 javax.ws.rs.core.MultivaluedMap<String,String> formParams)

Update/Save the user profile (foaf) for the given account

Parameters:

login - the user to modify

formParams - the user profile (foaf, without prefix) in

Returns:

UserWebService.AccountPoJo after the update in JSON

See Also:

UserWebService.post(MultivaluedMap)

HTTP Status Codes

404 if no such user exists.