net.caspervg.lex4j.route

Class UserRoute

java.lang.Object

net.caspervg.lex4j.route.UserRoute

public class UserRoute
extends java.lang.Object

Attention: methods can throw ResourceExceptions.

See Also:

Restlet Status API Javadoc, LEX API Overview on Github Created with IntelliJ IDEA. User: Casper Date: 21/11/13 Time: 12:10

Field Summary

Fields

Modifier and Type	Field and Description
private Auth	auth

Constructor Summary

Constructors

Constructor and Description
UserRoute() Create a new LotRoute, without Authorisation token.
UserRoute(Auth auth) Create a new LotRoute, with Authorisation token.

Method Summary

Modifier and Type	Method and Description
void	getActivation(java.lang.String key) Activates a user on the SC4D LEX
java.util.List<DownloadHistoryItem>	getDownloadHistory() Retrieves the download history for the User authenticated in the constructor
java.util.List<DownloadListItem>	getDownloadList() Retrieves the download list for the User authenticated in the constructor
User	getUser() Retrieve the user that has been authenticated in the constructor
User	getUser(int id) Retrieve the user with requested ID
java.util.List<User>	getUserList(boolean concise, int start, int amount) Retrieves a list of all Users
void	postRegistration(java.lang.String username, java.lang.String password, java.lang.String email, java.lang.String fullname) Registers a new user for the SC4D LEX

Methods inherited from class java.lang.Object

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

Field Detail

auth

private Auth auth

Constructor Detail

UserRoute

public UserRoute()

Create a new LotRoute, without Authorisation token. Some functions may not work.

UserRoute

public UserRoute(Auth auth)

Create a new LotRoute, with Authorisation token.

Parameters:

auth - Authentication token

Method Detail

getUser

public User getUser()

Retrieve the user that has been authenticated in the constructor

Returns:

User's profile

Requires:

Authentication

getUser

public User getUser(int id)

Retrieve the user with requested ID

Parameters:

id - ID of the User

Returns:

Requested User's profile

Requires:

Authentication and Administrator

getUserList

public java.util.List<User> getUserList(boolean concise,
                                        int start,
                                        int amount)

Retrieves a list of all Users

Parameters:

concise - true: only ID and Username (the rest will be null) - false: all data

start - start number of results

amount - number of results to return

Returns:

List of Users

Requires:

Authentication and Administrator

getDownloadList

public java.util.List<DownloadListItem> getDownloadList()

Retrieves the download list for the User authenticated in the constructor

Returns:

List of DownloadListItems

Requires:

Authentication

getDownloadHistory

public java.util.List<DownloadHistoryItem> getDownloadHistory()

Retrieves the download history for the User authenticated in the constructor

Returns:

List of DownloadHistoryItems

Requires:

Authentication

postRegistration

public void postRegistration(java.lang.String username,
                             java.lang.String password,
                             java.lang.String email,
                             java.lang.String fullname)

Registers a new user for the SC4D LEX

Parameters:

username - the username

password - the password

email - the e-mail

fullname - the fullname (can be blank)

getActivation

public void getActivation(java.lang.String key)

Activates a user on the SC4D LEX

Parameters:

key - the activation key