com.shephertz.app42.paas.sdk.android.user
Class UserService

java.lang.Object
  com.shephertz.app42.paas.sdk.android.user.UserService

public class UserService
extends java.lang.Object

Creates User for the App. App42 Cloud API's provides a complete User Management for any Mobile or Web App. It supports User registration, retrieval, state management e.g. lock, delete and Authentication. Along with User Management the platform provides API's for persistent SessionManagement

See Also:

SessionService, User, App42Response

Constructor Summary

UserService(java.lang.String apiKey, java.lang.String secretKey, java.lang.String baseURL)
This is a constructor that takes

Method Summary

User	assignRoles(java.lang.String uName, java.util.ArrayList<java.lang.String> roleList) Add Role for the App
App42Response	authenticate(java.lang.String uName, java.lang.String pwd) Authenticate user based on userName and password
App42Response	changeUserPassword(java.lang.String uName, java.lang.String oldPwd, java.lang.String newPwd) Change the password for user based on the userName.
User	createOrUpdateProfile(User user) Creates or Updates User Profile.
User	createUser(java.lang.String uName, java.lang.String pwd, java.lang.String emailAddress) Create User for the App
User	createUser(java.lang.String uName, java.lang.String pwd, java.lang.String emailAddress, java.util.ArrayList<java.lang.String> roleList) Create User for the App
App42Response	deleteUser(java.lang.String userName) Deletes a particular user based on userName.
java.lang.String	fillParamsWithProfileData(User.Profile profileData)
java.util.ArrayList<User>	getAllUsers() Gets All users details
java.util.ArrayList<User>	getAllUsers(int max, int offset) Gets All users By Paging
App42Response	getAllUsersCount() Gets the count of all the users
java.util.ArrayList<User>	getLockedUsers() Gets All the locked users details
java.util.ArrayList<User>	getLockedUsers(int max, int offset) Gets All the locked users details By paging.
App42Response	getLockedUsersCount() Gets the count of all the locked users
User	getRolesByUser(java.lang.String userName) Get Roles based on userName
User	getUser(java.lang.String userName) Gets user details based on userName
User	getUserByEmailId(java.lang.String emailId) Gets user details based on emailId
java.util.ArrayList<User>	getUsersByProfileData(User.Profile profileData) Get Users based on Profile Data
java.util.ArrayList<User>	getUsersByRole(java.lang.String role) Get Users based on Role
User	lockUser(java.lang.String uName) Locks the user based on the userName.
App42Response	resetUserPassword(java.lang.String uName, java.lang.String pwd) Updates the User based on userName.
App42Response	revokeAllRoles(java.lang.String userName) Revokes the specified role from the user.
App42Response	revokeRole(java.lang.String userName, java.lang.String role) Revokes the specified role from the user.
User	unlockUser(java.lang.String uName) Unlock the user based on the userName.
User	updateEmail(java.lang.String uName, java.lang.String emailAddress) Updates the User based on userName.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserService

public UserService(java.lang.String apiKey,
                   java.lang.String secretKey,
                   java.lang.String baseURL)

This is a constructor that takes

Parameters:

apiKey -

secretKey -

baseURL -

Method Detail

assignRoles

public User assignRoles(java.lang.String uName,
                        java.util.ArrayList<java.lang.String> roleList)
                 throws App42Exception

Add Role for the App

Parameters:

uName - UserName which should be unique for the App

roleList - list of roles to be added to User

Returns:

The created User Object.

Throws:

App42Exception

authenticate

public App42Response authenticate(java.lang.String uName,
                                  java.lang.String pwd)
                           throws App42Exception

Authenticate user based on userName and password

Parameters:

uName - UserName which should be unique for the App

pwd - Password for the User

Throws:

App42Exception - if authentication fails or username/password is blank or null

changeUserPassword

public App42Response changeUserPassword(java.lang.String uName,
                                        java.lang.String oldPwd,
                                        java.lang.String newPwd)
                                 throws App42Exception

Change the password for user based on the userName.

Parameters:

uName - UserName which should be unique for the App

oldPwd - Old Password for the user for authentication

newPwd - New Password for the user to change

Throws:

App42Exception

createOrUpdateProfile

public User createOrUpdateProfile(User user)
                           throws App42Exception

Creates or Updates User Profile. First time the Profile for the user is created and in future calls user profile will be updated. This will always update the profile with new value passed in profile object. Call to this method should have all the values you want to retain in user profile object, otherwise old values of profile will get updated with null. Method only updates the profile of user, passing email/password in user object does not have any significance for this method call.

Parameters:

user - - User for which profile has to be updated, this should contain the userName and profile object in it.

Throws:

App42Exception

See Also:

User.Profile

createUser

public User createUser(java.lang.String uName,
                       java.lang.String pwd,
                       java.lang.String emailAddress)
                throws App42Exception

Create User for the App

Parameters:

uName - UserName which should be unique for the App

pwd - Password for the User

emailAddress - Email address of the user

Returns:

The created User Object.

Throws:

App42Exception

createUser

public User createUser(java.lang.String uName,
                       java.lang.String pwd,
                       java.lang.String emailAddress,
                       java.util.ArrayList<java.lang.String> roleList)
                throws App42Exception

Create User for the App

Parameters:

uName - UserName which should be unique for the App

pwd - Password for the User

emailAddress - Email address of the user

roleList - list of roles to be assigned to User

Returns:

The created User Object.

Throws:

App42Exception

deleteUser

public App42Response deleteUser(java.lang.String userName)
                         throws App42Exception

Deletes a particular user based on userName.

Parameters:

userName - UserName which should be unique for the App

Throws:

App42Exception

fillParamsWithProfileData

public java.lang.String fillParamsWithProfileData(User.Profile profileData)

getAllUsers

public java.util.ArrayList<User> getAllUsers()
                                      throws App42Exception

Gets All users details

Returns:

Returns the list that contains all User Object

Throws:

App42Exception

getAllUsers

public java.util.ArrayList<User> getAllUsers(int max,
                                             int offset)
                                      throws App42Exception

Gets All users By Paging

Parameters:

max - Maximum number of records to be fetched

offset - From where the records are to be fetched

Returns:

Returns the list that contains all User Object

Throws:

App42Exception

getAllUsersCount

public App42Response getAllUsersCount()
                               throws App42Exception

Gets the count of all the users

Returns:

Returns the count of all User exists

Throws:

App42Exception

getLockedUsers

public java.util.ArrayList<User> getLockedUsers()
                                         throws App42Exception

Gets All the locked users details

Returns:

Returns the list that contains locked User Objects

Throws:

App42Exception

getLockedUsers

public java.util.ArrayList<User> getLockedUsers(int max,
                                                int offset)
                                         throws App42Exception

Gets All the locked users details By paging.

Parameters:

max - Maximum number of records to be fetched

offset - From where the records are to be fetched

Returns:

Returns the list that contains locked User Objects

Throws:

App42Exception

getLockedUsersCount

public App42Response getLockedUsersCount()
                                  throws App42Exception

Gets the count of all the locked users

Returns:

Returns the count of locked User exists

Throws:

App42Exception

getRolesByUser

public User getRolesByUser(java.lang.String userName)
                    throws App42Exception

Get Roles based on userName

Parameters:

userName - UserName which should be unique for the App

Returns:

Returns User Object

Throws:

App42Exception

getUser

public User getUser(java.lang.String userName)
             throws App42Exception

Gets user details based on userName

Parameters:

userName - UserName which should be unique for the App

Returns:

Returns User Object

Throws:

App42Exception

getUserByEmailId

public User getUserByEmailId(java.lang.String emailId)
                      throws App42Exception

Gets user details based on emailId

Parameters:

emailId - EmailId of the user to be retrieved

Returns:

Returns User Object

Throws:

App42Exception

getUsersByProfileData

public java.util.ArrayList<User> getUsersByProfileData(User.Profile profileData)
                                                throws App42Exception

Get Users based on Profile Data

Parameters:

profileData - Profile Data key/value for which Users need to be retrieved

Returns:

ArrayList of User Object for that particular role

Throws:

App42Exception

getUsersByRole

public java.util.ArrayList<User> getUsersByRole(java.lang.String role)
                                         throws App42Exception

Get Users based on Role

Parameters:

role - Role for which User needs to be retrieved

Returns:

Returns Arraylist of User Object for that particular role

Throws:

App42Exception

lockUser

public User lockUser(java.lang.String uName)
              throws App42Exception

Locks the user based on the userName. Apps can use these feature to lock a user because of reasons specific to their usercase e.g. If payment not received and the App wants the user to be inactive

Parameters:

uName - UserName which should be unique for the App

Throws:

App42Exception

resetUserPassword

public App42Response resetUserPassword(java.lang.String uName,
                                       java.lang.String pwd)
                                throws App42Exception

Updates the User based on userName. Note: Only email can be updated. Username cannot be updated.

Parameters:

uName - UserName which should be unique for the App

emailAddress - Email address of the user

Throws:

App42Exception

revokeAllRoles

public App42Response revokeAllRoles(java.lang.String userName)
                             throws App42Exception

Revokes the specified role from the user.

Parameters:

userName - UserName which should be unique for the App

Throws:

App42Exception

revokeRole

public App42Response revokeRole(java.lang.String userName,
                                java.lang.String role)
                         throws App42Exception

Revokes the specified role from the user.

Parameters:

userName - UserName which should be unique for the App

Throws:

App42Exception

unlockUser

public User unlockUser(java.lang.String uName)
                throws App42Exception

Unlock the user based on the userName. Apps can use these feature to unlock a user because of reasons specific to their usercase e.g. If payment received and the App wants to the user to be active.

Parameters:

uName - UserName which should be unique for the App

Throws:

App42Exception

updateEmail

public User updateEmail(java.lang.String uName,
                        java.lang.String emailAddress)
                 throws App42Exception

Updates the User based on userName. Note: Only email can be updated. Username cannot be updated.

Parameters:

uName - UserName which should be unique for the App

emailAddress - Email address of the user

Throws:

App42Exception