com.mambu.apisdk.services

Class UsersService

java.lang.Object

com.mambu.apisdk.services.UsersService

public class UsersService
extends java.lang.Object

Service class which handles API operations like getting and creating users. When getting users, for safety reasons the API call will have the response stripped of some fields: password - apiAppId - apiAppKey

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.HashMap<com.mambu.core.shared.data.DataViewType,com.mambu.api.server.handler.customviews.model.ApiViewType>	supportedDataViewTypes Map to convert custom view's DataViewType to the ApiViewType (required by Custom View API)

Constructor Summary

Constructors

Constructor and Description
UsersService(MambuAPIService mambuAPIService) Create a new users service

Method Summary

Modifier and Type	Method and Description
com.mambu.core.shared.model.User	createUser(com.mambu.core.shared.model.User user) Creates a new user i.e.
static com.mambu.api.server.handler.customviews.model.ApiViewType	getApiViewType(com.mambu.core.shared.data.DataViewType dataViewType) Helper to get ApiViewType for a DataViewType
java.util.List<com.mambu.core.shared.model.CustomView>	getCustomViews(java.lang.String userName) Convenience method to get all Custom Views for the user by user's userName.
java.util.List<com.mambu.core.shared.model.CustomView>	getCustomViews(java.lang.String username, com.mambu.api.server.handler.customviews.model.ApiViewType apiViewType) Get Custom Views for the user by user's userName and apiViewType.
com.mambu.core.shared.model.User	getUserById(java.lang.String userId) Get User by its userID
com.mambu.core.shared.model.User	getUserByUsername(java.lang.String userName) Get User by it's userName.
com.mambu.core.shared.model.Role	getUserRole(java.lang.String roleKey) Get user role by a role key
java.util.List<com.mambu.core.shared.model.Role>	getUserRoles() Get user roles
java.util.List<com.mambu.core.shared.model.User>	getUsers() Get users (first 50 per default)
java.util.List<com.mambu.core.shared.model.User>	getUsers(java.lang.String branchId, APIData.UserBranchAssignmentType userBranchAssignmentType, java.lang.String offset, java.lang.String limit) Get a paginated list of users.
java.util.List<com.mambu.core.shared.model.User>	getUsers(java.lang.String offset, java.lang.String limit) Get all the users with offset and limit
java.util.List<com.mambu.core.shared.model.User>	getUsers(java.lang.String branchId, java.lang.String offset, java.lang.String limit) Convenience method to Get a paginated list of users assigned to a branch, filtered by branch

Methods inherited from class java.lang.Object

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

Field Detail

supportedDataViewTypes

public static java.util.HashMap<com.mambu.core.shared.data.DataViewType,com.mambu.api.server.handler.customviews.model.ApiViewType> supportedDataViewTypes

Map to convert custom view's DataViewType to the ApiViewType (required by Custom View API)

Constructor Detail

UsersService

@Inject
public UsersService(MambuAPIService mambuAPIService)

Create a new users service

Parameters:

mambuAPIService - the service responsible with the connection to the server

Method Detail

getUsers

public java.util.List<com.mambu.core.shared.model.User> getUsers(java.lang.String offset,
                                                                 java.lang.String limit)
                                                          throws MambuApiException

Get all the users with offset and limit

Parameters:

offset - the offset of the response. If not set a value of 0 is used by default

limit - the maximum number of response entries. If not set a value of 50 is used by default

Returns:

List of all Users

Throws:

MambuApiException

getUsers

public java.util.List<com.mambu.core.shared.model.User> getUsers()
                                                          throws MambuApiException

Get users (first 50 per default)

Returns:

List of Users

Throws:

MambuApiException

getUsers

public java.util.List<com.mambu.core.shared.model.User> getUsers(java.lang.String branchId,
                                                                 APIData.UserBranchAssignmentType userBranchAssignmentType,
                                                                 java.lang.String offset,
                                                                 java.lang.String limit)
                                                          throws MambuApiException

Get a paginated list of users. API allows getting all users, or users who are assigned to a branch or users who are assigned or allowed to manage the branch

Parameters:

branchId - the id of the branch. If null, users for all branches are returned

userBranchAssignmentType - user's branch assignment type. This parameter is ignored if the branchId parameter is null. If userBranchAssignmentType is ASSIGNED then only users assigned to the specified branch are returned. If its value is MANAGE then all users who are either assigned or who can manage the branch are returned. If null, the default is ASSIGNED.

offset - the offset of the response. If not set a value of 0 is used by default

limit - the maximum number of response entries. If not set a value of 50 is used by default

Returns:

list of Users

Throws:

MambuApiException

getUsers

public java.util.List<com.mambu.core.shared.model.User> getUsers(java.lang.String branchId,
                                                                 java.lang.String offset,
                                                                 java.lang.String limit)
                                                          throws MambuApiException

Convenience method to Get a paginated list of users assigned to a branch, filtered by branch

Parameters:

branchId - the id of the branch to filter with. If null, all users are returned

offset - the offset of the response. If not set a value of 0 is used by default

limit - the maximum number of response entries. If not set a value of 50 is used by default

Returns:

list of assigned Users if branch id is not null. Otherwise, all users are returned

Throws:

MambuApiException

getUserById

public com.mambu.core.shared.model.User getUserById(java.lang.String userId)
                                             throws MambuApiException

Get User by its userID

Parameters:

userId - the id of the user to filter.

Returns:

User - with full details

Throws:

MambuApiException

getUserByUsername

public com.mambu.core.shared.model.User getUserByUsername(java.lang.String userName)
                                                   throws MambuApiException

Get User by it's userName. NOTE: This is just a convenience method, it uses the getById() API. One can use getById() directly too.

Parameters:

userName - the username of the user to filter

Returns:

User - with full details

Throws:

MambuApiException

getCustomViews

public java.util.List<com.mambu.core.shared.model.CustomView> getCustomViews(java.lang.String username,
                                                                             com.mambu.api.server.handler.customviews.model.ApiViewType apiViewType)
                                                                      throws MambuApiException

Get Custom Views for the user by user's userName and apiViewType. See more in @see MBU-4607 and in

Parameters:

username - the user name of the user. Mandatory field

apiViewType - view filter type. If null, all custom views are returned

Returns:

List of Custom Views for this user

Throws:

MambuApiException

See Also:

MBU-6306

getCustomViews

public java.util.List<com.mambu.core.shared.model.CustomView> getCustomViews(java.lang.String userName)
                                                                      throws MambuApiException

Convenience method to get all Custom Views for the user by user's userName.

Parameters:

userName - the username of the user

Returns:

List of Custom Views for this user

Throws:

MambuApiException

getApiViewType

public static com.mambu.api.server.handler.customviews.model.ApiViewType getApiViewType(com.mambu.core.shared.data.DataViewType dataViewType)

Helper to get ApiViewType for a DataViewType

Parameters:

dataViewType - data view type

Returns:

Api View Type

getUserRoles

public java.util.List<com.mambu.core.shared.model.Role> getUserRoles()
                                                              throws MambuApiException

Get user roles

Returns:

list of all User Roles

Throws:

MambuApiException

getUserRole

public com.mambu.core.shared.model.Role getUserRole(java.lang.String roleKey)
                                             throws MambuApiException

Get user role by a role key

Parameters:

roleKey - the encoded key of the user role

Returns:

user Role

Throws:

MambuApiException

createUser

public com.mambu.core.shared.model.User createUser(com.mambu.core.shared.model.User user)
                                            throws MambuApiException

Creates a new user i.e. API call POST api/users JSON payload: { "user": { "username": "tinker", "password": "pass1234566", "email": "ddd@mambu.com", "title": "Mrs", "firstName": "John"... } } NOTE: for more information on users API visit

Parameters:

user - The user to be created. Must be not be null. Also, take into account that the user must have a role assigned.

Returns:

newly created user

Throws:

MambuApiException

See Also:

Users API