io.github.jhipster.sample.web.rest

Class AccountResource

java.lang.Object

io.github.jhipster.sample.web.rest.AccountResource

@RestController
 @RequestMapping(value="/api")
public class AccountResource
extends java.lang.Object

REST controller for managing the current user's account.

Constructor Summary

Constructors

Constructor and Description
AccountResource(UserRepository userRepository, UserService userService, MailService mailService)

Method Summary

Modifier and Type	Method and Description
void	activateAccount(java.lang.String key) GET /activate : activate the registered user.
void	changePassword(java.lang.String password) POST /account/change-password : changes the current user's password
void	finishPasswordReset(KeyAndPasswordVM keyAndPassword) POST /account/reset-password/finish : Finish to reset the password of the user
UserDTO	getAccount() GET /account : get the current user.
java.lang.String	isAuthenticated(javax.servlet.http.HttpServletRequest request) GET /authenticate : check if the user is authenticated, and return its login.
void	registerAccount(ManagedUserVM managedUserVM) POST /register : register the user.
void	requestPasswordReset(java.lang.String mail) POST /account/reset-password/init : Send an email to reset the password of the user
void	saveAccount(UserDTO userDTO) POST /account : update the current user information.

Methods inherited from class java.lang.Object

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

Constructor Detail

AccountResource

public AccountResource(UserRepository userRepository,
                       UserService userService,
                       MailService mailService)

Method Detail

registerAccount

@PostMapping(value="/register")
 @Timed
 @ResponseStatus(value=CREATED)
public void registerAccount(@RequestBody
                                                                                                    ManagedUserVM managedUserVM)

POST /register : register the user.

Parameters:

managedUserVM - the managed user View Model

Throws:

InvalidPasswordException - 400 (Bad Request) if the password is incorrect

EmailAlreadyUsedException - 400 (Bad Request) if the email is already used

LoginAlreadyUsedException - 400 (Bad Request) if the login is already used

activateAccount

@GetMapping(value="/activate")
 @Timed
public void activateAccount(@RequestParam(value="key")
                                                                   java.lang.String key)

GET /activate : activate the registered user.

Parameters:

key - the activation key

Throws:

java.lang.RuntimeException - 500 (Internal Server Error) if the user couldn't be activated

isAuthenticated

@GetMapping(value="/authenticate")
 @Timed
public java.lang.String isAuthenticated(javax.servlet.http.HttpServletRequest request)

GET /authenticate : check if the user is authenticated, and return its login.

Parameters:

request - the HTTP request

Returns:

the login if the user is authenticated

getAccount

@GetMapping(value="/account")
 @Timed
public UserDTO getAccount()

GET /account : get the current user.

Returns:

the current user

Throws:

java.lang.RuntimeException - 500 (Internal Server Error) if the user couldn't be returned

saveAccount

@PostMapping(value="/account")
 @Timed
public void saveAccount(@RequestBody
                                                               UserDTO userDTO)

POST /account : update the current user information.

Parameters:

userDTO - the current user information

Throws:

EmailAlreadyUsedException - 400 (Bad Request) if the email is already used

java.lang.RuntimeException - 500 (Internal Server Error) if the user login wasn't found

changePassword

@PostMapping(path="/account/change-password")
 @Timed
public void changePassword(@RequestBody
                                                                                 java.lang.String password)

POST /account/change-password : changes the current user's password

Parameters:

password - the new password

Throws:

InvalidPasswordException - 400 (Bad Request) if the new password is incorrect

requestPasswordReset

@PostMapping(path="/account/reset-password/init")
 @Timed
public void requestPasswordReset(@RequestBody
                                                                                           java.lang.String mail)

POST /account/reset-password/init : Send an email to reset the password of the user

Parameters:

mail - the mail of the user

Throws:

EmailNotFoundException - 400 (Bad Request) if the email address is not registered

finishPasswordReset

@PostMapping(path="/account/reset-password/finish")
 @Timed
public void finishPasswordReset(@RequestBody
                                                                                            KeyAndPasswordVM keyAndPassword)

POST /account/reset-password/finish : Finish to reset the password of the user

Parameters:

keyAndPassword - the generated key and the new password

Throws:

InvalidPasswordException - 400 (Bad Request) if the password is incorrect

java.lang.RuntimeException - 500 (Internal Server Error) if the password could not be reset