service.tut.pori.users

Class UserService

java.lang.Object

service.tut.pori.users.UserService

@HTTPService(name="user")
public class UserService
extends java.lang.Object

User Service method declarations. This chapter defines the APIs for registering a new account with the system, removing an existing account and retrieving the basic user details known by the system as well as retrieving a listing of the external accounts connected to a user account

Constructor Summary

Constructors

Constructor and Description
UserService()

Method Summary

Modifier and Type	Method and Description
void	deleteExternalAccountConnection(AuthenticationParameter authenticatedUser, StringParameter serviceTypes) This method can be used to remove external account connection for the authenticated user.
Response	getExternalAccountConnections(AuthenticationParameter authenticatedUser, StringParameter serviceTypes) This method can be used to retrieve all external account connections known by the system for the authenticated user.
Response	getUserDetails(AuthenticationParameter authenticatedUser, LongParameter userIdFilter) This method can be used to retrieve details for users.
Response	register(InputStreamParameter xml) The request is to be sent in the body of POST method.
void	unregister(AuthenticationParameter authenticatedUser) This method will immediately revoke user login permissions for the authenticated user and schedule the removal of all content owned by the user.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserService

public UserService()

Method Detail

register

@HTTPServiceMethod(name="register",
                   acceptedMethods="POST")
public Response register(@HTTPMethodParameter(name="body",bodyParameter=true)
                                                                                                          InputStreamParameter xml)

The request is to be sent in the body of POST method. The Content-Type header MUST be set to "text/xml". The character set MUST be UTF-8. For example, "Content-Type: text/xml; charset=UTF-8".

Parameters:

xml - Details of the new user. See UserCore.Registration

Returns:

response

unregister

@HTTPServiceMethod(name="unregister",
                   acceptedMethods="POST")
public void unregister(@HTTPAuthenticationParameter
                                                                                                          AuthenticationParameter authenticatedUser)

This method will immediately revoke user login permissions for the authenticated user and schedule the removal of all content owned by the user. The content is removed in phases (service-by-service), and may not happen immediately.

Parameters:

authenticatedUser -

getExternalAccountConnections

@HTTPServiceMethod(name="getExternalAccountConnections",
                   acceptedMethods="GET")
public Response getExternalAccountConnections(@HTTPAuthenticationParameter
                                                                                                                                                   AuthenticationParameter authenticatedUser,
                                                                                                                                                   @HTTPMethodParameter(name="service_type",required=false)
                                                                                                                                                   StringParameter serviceTypes)

This method can be used to retrieve all external account connections known by the system for the authenticated user.

Parameters:

authenticatedUser -

serviceTypes - optional service type filter ExternalAccountConnection.UserServiceType

Returns:

See ExternalAccountConnectionList

deleteExternalAccountConnection

@HTTPServiceMethod(name="deleteExternalAccountConnection",
                   acceptedMethods="DELETE")
public void deleteExternalAccountConnection(@HTTPAuthenticationParameter
                                                                                                                                                      AuthenticationParameter authenticatedUser,
                                                                                                                                                      @HTTPMethodParameter(name="service_type")
                                                                                                                                                      StringParameter serviceTypes)

This method can be used to remove external account connection for the authenticated user.

Parameters:

authenticatedUser -

serviceTypes - the service to remove ExternalAccountConnection.UserServiceType

getUserDetails

@HTTPServiceMethod(name="getUserDetails",
                   acceptedMethods="GET")
public Response getUserDetails(@HTTPAuthenticationParameter
                                                                                                                     AuthenticationParameter authenticatedUser,
                                                                                                                     @HTTPMethodParameter(name="user_id",required=false)
                                                                                                                     LongParameter userIdFilter)

This method can be used to retrieve details for users.

Parameters:

authenticatedUser -

userIdFilter - If parameter is missing, details for the authenticated user will be returned. Normal users only have permissions to their own accounts, an attempt to access details for other users will result in error.

Returns:

See UserIdentityList