org.apache.marmotta.platform.user.webservices

Class UserWebService

java.lang.Object

org.apache.marmotta.platform.user.webservices.UserWebService

@Path(value="/user")
public class UserWebService
extends Object

User-Account related webservices, accessable by every user (each for his/her own data)

Author:

Jakob Frank

Constructor Summary

Constructors

Constructor and Description
UserWebService()

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	get() Provide Account information about the currently logged in user (account)
javax.ws.rs.core.Response	getUser(String login, String types) Resolve/Redirect access to /user/* uris.
void	initialize()
javax.ws.rs.core.Response	login(String ref, boolean logout, String login) Throws a AccessDeniedException if currently no user is logged in (aka: current user is anonymous).
javax.ws.rs.core.Response	passwd(String oldPwd, String newPwd) Update/change the password for the current user.
javax.ws.rs.core.Response	post() Dummy to avoid exceptions if post body is empty.
javax.ws.rs.core.Response	post(javax.ws.rs.core.MultivaluedMap<String,String> formParams) Update/Set the profile information (foaf) for the current user.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserWebService

public UserWebService()

Method Detail

initialize

@PostConstruct
public void initialize()

get

@GET
@Path(value="/me")
@Produces(value="application/json")
public javax.ws.rs.core.Response get()

Provide Account information about the currently logged in user (account)

Returns:

AccountPoJo of the current user in JSON

See Also:

AccountPoJo

post

@POST
@Path(value="/me")
@Consumes(value="application/x-www-form-urlencoded")
public javax.ws.rs.core.Response post(javax.ws.rs.core.MultivaluedMap<String,String> formParams)

Update/Set the profile information (foaf) for the current user. Post-Body should contain the property=value mapping (propterty without foaf-prefix) for the profile.

Parameters:

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

Returns:

AccountPoJo after the update in JSON

HTTP Status Codes

403 When the current user is anonymous., 500 If a RepositoryException occurs (which should not happen as no namespaces are used here)

post

@POST
@Path(value="/me")
public javax.ws.rs.core.Response post()

Dummy to avoid exceptions if post body is empty.

Returns:

AccountPoJo of the current user in JSON

See Also:

post(MultivaluedMap)

passwd

@POST
@Path(value="/me/passwd")
public javax.ws.rs.core.Response passwd(@FormParam(value="oldPasswd")
                                         String oldPwd,
                                         @FormParam(value="newPasswd")
                                         String newPwd)

Update/change the password for the current user.

Parameters:

oldPwd - the old (current) password.

newPwd - the new password

Returns:

200 OK on success

HTTP Status Codes

404 if the current account could not be loaded, 403 if the old pasword did not match

getUser

@GET
@Path(value="/{login:[^#?]+}")
public javax.ws.rs.core.Response getUser(@PathParam(value="login")
                                         String login,
                                         @HeaderParam(value="Accept")
                                         String types)

Resolve/Redirect access to /user/* uris.

Parameters:

login - the login of the user to redirect to

types - header param of accepted mime-types

Returns:

a redirect to the user-resource in the resource service.

HTTP Status Codes

404 if no such user exists., 303 on success, 400 if no valid resource uri could be built with the login, 500 on other exceptions

login

@GET
@Path(value="/login")
public javax.ws.rs.core.Response login(@HeaderParam(value="Referer")
                                       String ref,
                                       @QueryParam(value="logout")@DefaultValue(value="false")
                                       boolean logout,
                                       @QueryParam(value="user")
                                       String login)

Throws a AccessDeniedException if currently no user is logged in (aka: current user is anonymous).

Parameters:

ref - the referer to redirect to

logout - set to true to log out (does currently nothing)

Returns:

a redirect to the referer url

Throws:

org.apache.marmotta.platform.core.exception.security.AccessDeniedException - if currently no user is logged in.

HTTP Status Codes

303 if the user is already logged in (or logout == true)