org.wso2.carbon.device.mgt.jaxrs.api.impl

Class UserImpl

java.lang.Object

org.wso2.carbon.device.mgt.jaxrs.api.impl.UserImpl

All Implemented Interfaces:

User

public class UserImpl
extends Object
implements User

This class represents the JAX-RS services of User related functionality.

Constructor Summary

Constructors

Constructor and Description
UserImpl()

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addUser(UserWrapper userWrapper) Method to add user to emm-user-store.
javax.ws.rs.core.Response	getAllDeviceOfUser(String username, int startIdx, int length) Get a list of devices based on the username.
javax.ws.rs.core.Response	getAllUserNamesByUsername(String userName) Get the list of user names in the system.
javax.ws.rs.core.Response	getAllUsers() Get the list of all users with all user-related info.
javax.ws.rs.core.Response	getAllUsersByUsername(String userName) Get the list of user names in the system.
javax.ws.rs.core.Response	getMatchingUsers(String filter) Get the list of all users with all user-related info.
javax.ws.rs.core.Response	getRolesOfUser(String username) Get user's roles by username
javax.ws.rs.core.Response	getUser(String username) Method to get user information from emm-user-store.
javax.ws.rs.core.Response	getUserCount() This method is used to retrieve the user count of the system.
javax.ws.rs.core.Response	inviteExistingUsersToEnrollDevice(List<String> usernames) Method used to send an invitation email to a existing user to enroll a device.
javax.ws.rs.core.Response	removeUser(String username) Method to remove user from emm-user-store.
javax.ws.rs.core.Response	resetPassword(UserCredentialWrapper credentials) Method to change the user password.
javax.ws.rs.core.Response	resetPasswordByAdmin(UserCredentialWrapper credentials) Method to change the user password.
javax.ws.rs.core.Response	updateRoles(String username, List<String> userList) API is used to update roles of a user
javax.ws.rs.core.Response	updateUser(UserWrapper userWrapper, String username) Update user in user store

Methods inherited from class java.lang.Object

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

Constructor Detail

UserImpl

public UserImpl()

Method Detail

addUser

public javax.ws.rs.core.Response addUser(UserWrapper userWrapper)

Method to add user to emm-user-store.

Specified by:

addUser in interface User

Parameters:

userWrapper - Wrapper object representing input json payload

Returns:

{Response} Status of the request wrapped inside Response object

getUser

public javax.ws.rs.core.Response getUser(String username)

Method to get user information from emm-user-store.

Specified by:

getUser in interface User

Parameters:

username - User-name of the user

Returns:

{Response} Status of the request wrapped inside Response object.

updateUser

public javax.ws.rs.core.Response updateUser(UserWrapper userWrapper,
                                   String username)

Update user in user store

Specified by:

updateUser in interface User

Parameters:

userWrapper - Wrapper object representing input json payload

Returns:

{Response} Status of the request wrapped inside Response object.

removeUser

public javax.ws.rs.core.Response removeUser(String username)

Method to remove user from emm-user-store.

Specified by:

removeUser in interface User

Parameters:

username - Username of the user

Returns:

{Response} Status of the request wrapped inside Response object.

getRolesOfUser

public javax.ws.rs.core.Response getRolesOfUser(String username)

Get user's roles by username

Specified by:

getRolesOfUser in interface User

Parameters:

username - Username of the user

Returns:

{Response} Status of the request wrapped inside Response object.

getAllUsers

public javax.ws.rs.core.Response getAllUsers()

Get the list of all users with all user-related info.

Specified by:

getAllUsers in interface User

Returns:

A list of users

getMatchingUsers

public javax.ws.rs.core.Response getMatchingUsers(String filter)

Get the list of all users with all user-related info.

Specified by:

getMatchingUsers in interface User

Returns:

A list of users

getAllUsersByUsername

public javax.ws.rs.core.Response getAllUsersByUsername(String userName)

Get the list of user names in the system.

Specified by:

getAllUsersByUsername in interface User

Returns:

A list of user names.

getAllUserNamesByUsername

public javax.ws.rs.core.Response getAllUserNamesByUsername(String userName)

Get the list of user names in the system.

Specified by:

getAllUserNamesByUsername in interface User

Returns:

A list of user names.

inviteExistingUsersToEnrollDevice

public javax.ws.rs.core.Response inviteExistingUsersToEnrollDevice(List<String> usernames)

Method used to send an invitation email to a existing user to enroll a device.

Specified by:

inviteExistingUsersToEnrollDevice in interface User

Parameters:

usernames - Username list of the users to be invited

getAllDeviceOfUser

public javax.ws.rs.core.Response getAllDeviceOfUser(String username,
                                           int startIdx,
                                           int length)

Get a list of devices based on the username.

Specified by:

getAllDeviceOfUser in interface User

Parameters:

username - Username of the device owner

Returns:

A list of devices

getUserCount

public javax.ws.rs.core.Response getUserCount()

This method is used to retrieve the user count of the system.

Specified by:

getUserCount in interface User

Returns:

returns the count.

updateRoles

public javax.ws.rs.core.Response updateRoles(String username,
                                    List<String> userList)

API is used to update roles of a user

Specified by:

updateRoles in interface User

Parameters:

username -

userList -

Returns:

resetPassword

public javax.ws.rs.core.Response resetPassword(UserCredentialWrapper credentials)

Method to change the user password.

Specified by:

resetPassword in interface User

Parameters:

credentials - Wrapper object representing user credentials.

Returns:

{Response} Status of the request wrapped inside Response object.

resetPasswordByAdmin

public javax.ws.rs.core.Response resetPasswordByAdmin(UserCredentialWrapper credentials)

Method to change the user password.

Specified by:

resetPasswordByAdmin in interface User

Parameters:

credentials - Wrapper object representing user credentials.

Returns:

{Response} Status of the request wrapped inside Response object.