Package org.wso2.am.admin.clients.user

Class RemoteUserStoreManagerServiceClient

java.lang.Object

org.wso2.am.admin.clients.user.RemoteUserStoreManagerServiceClient

public class RemoteUserStoreManagerServiceClient
extends Object

this client is used for update user claims, and related operations

Constructor Summary

Constructors

Constructor	Description
RemoteUserStoreManagerServiceClient(String backEndUrl, String sessionCookie)	Create Remote user store admin client
RemoteUserStoreManagerServiceClient(String backEndUrl, String userName, String password)	Create Remote user store admin client using username and password

Method Summary

Modifier and Type	Method	Description
void	addRole(String roleName, String[] userList, org.wso2.carbon.um.ws.api.stub.PermissionDTO[] permissions)
void	addUser(String userName, String credential, String[] roleList, org.wso2.carbon.um.ws.api.stub.ClaimValue[] claimValues, String profileName, boolean requirePasswordChange)	add user to user store
void	deleteRole(String roleName)
void	deleteUser(String userName)
String[]	getProfileNames(String userName)	get available profiles
String[]	getRoleListOfUser(String userName)
org.wso2.carbon.um.ws.api.stub.ClaimValue[]	getUserClaimValuesForClaims(String userName, String[] claims, String profileName)	get user claim values for given claim URL's
void	removeUser(String user)	Used to delete user.
void	setUserClaimValue(String username, String claim, String value, String profile)	set user claim value
void	updateRoleListOfUser(String userName, String[] deletedRoles, String[] newRoles)
void	updateUser(String user, String password)

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteUserStoreManagerServiceClient

public RemoteUserStoreManagerServiceClient(String backEndUrl,
                                           String sessionCookie)
                                    throws org.apache.axis2.AxisFault

Create Remote user store admin client

Parameters:

backEndUrl - - url to log

sessionCookie - - session cookie

Throws:

org.apache.axis2.AxisFault

RemoteUserStoreManagerServiceClient

public RemoteUserStoreManagerServiceClient(String backEndUrl,
                                           String userName,
                                           String password)
                                    throws org.apache.axis2.AxisFault

Create Remote user store admin client using username and password

Parameters:

backEndUrl -

userName -

password -

Throws:

org.apache.axis2.AxisFault

Method Detail

addUser

public void addUser(String userName,
                    String credential,
                    String[] roleList,
                    org.wso2.carbon.um.ws.api.stub.ClaimValue[] claimValues,
                    String profileName,
                    boolean requirePasswordChange)
             throws org.wso2.carbon.user.core.UserStoreException,
                    RemoteException,
                    org.wso2.carbon.um.ws.api.stub.RemoteUserStoreManagerServiceUserStoreExceptionException

add user to user store

Parameters:

userName -

credential - - password

roleList - - permission roles

claimValues - - claim values

profileName - - user profile

requirePasswordChange -

Throws:

org.wso2.carbon.user.core.UserStoreException

RemoteException

org.wso2.carbon.um.ws.api.stub.RemoteUserStoreManagerServiceUserStoreExceptionException

getProfileNames

public String[] getProfileNames(String userName)
                         throws RemoteException,
                                org.wso2.carbon.um.ws.api.stub.RemoteUserStoreManagerServiceUserStoreExceptionException

get available profiles

Parameters:

userName -

Returns:

Throws:

RemoteException

org.wso2.carbon.um.ws.api.stub.RemoteUserStoreManagerServiceUserStoreExceptionException

getUserClaimValuesForClaims

public org.wso2.carbon.um.ws.api.stub.ClaimValue[] getUserClaimValuesForClaims(String userName,
                                                                               String[] claims,
                                                                               String profileName)
                                                                        throws RemoteException,
                                                                               org.wso2.carbon.um.ws.api.stub.RemoteUserStoreManagerServiceUserStoreExceptionException

get user claim values for given claim URL's

Parameters:

userName -

claims -

profileName -

Returns:

Throws:

RemoteException

org.wso2.carbon.um.ws.api.stub.RemoteUserStoreManagerServiceUserStoreExceptionException

setUserClaimValue

public void setUserClaimValue(String username,
                              String claim,
                              String value,
                              String profile)
                       throws org.wso2.carbon.um.ws.api.stub.RemoteUserStoreManagerServiceUserStoreExceptionException,
                              RemoteException

set user claim value

Parameters:

username -

claim - - claim URI

value - - value of the claim

profile - - user profile

Throws:

org.wso2.carbon.um.ws.api.stub.RemoteUserStoreManagerServiceUserStoreExceptionException

RemoteException

removeUser

public void removeUser(String user)
                throws org.wso2.carbon.um.ws.api.stub.RemoteUserStoreManagerServiceUserStoreExceptionException,
                       RemoteException

Used to delete user.

Parameters:

user -

Throws:

org.wso2.carbon.um.ws.api.stub.RemoteUserStoreManagerServiceUserStoreExceptionException

RemoteException

updateUser

public void updateUser(String user,
                       String password)
                throws org.wso2.carbon.um.ws.api.stub.RemoteUserStoreManagerServiceUserStoreExceptionException,
                       RemoteException

Parameters:

user -

password -

Throws:

org.wso2.carbon.um.ws.api.stub.RemoteUserStoreManagerServiceUserStoreExceptionException

RemoteException

updateRoleListOfUser

public void updateRoleListOfUser(String userName,
                                 String[] deletedRoles,
                                 String[] newRoles)
                          throws org.wso2.carbon.um.ws.api.stub.RemoteUserStoreManagerServiceUserStoreExceptionException,
                                 RemoteException

Throws:

org.wso2.carbon.um.ws.api.stub.RemoteUserStoreManagerServiceUserStoreExceptionException

RemoteException

getRoleListOfUser

public String[] getRoleListOfUser(String userName)
                           throws org.wso2.carbon.um.ws.api.stub.RemoteUserStoreManagerServiceUserStoreExceptionException,
                                  RemoteException

Throws:

org.wso2.carbon.um.ws.api.stub.RemoteUserStoreManagerServiceUserStoreExceptionException

RemoteException

addRole

public void addRole(String roleName,
                    String[] userList,
                    org.wso2.carbon.um.ws.api.stub.PermissionDTO[] permissions)
             throws org.wso2.carbon.um.ws.api.stub.RemoteUserStoreManagerServiceUserStoreExceptionException,
                    RemoteException

Throws:

org.wso2.carbon.um.ws.api.stub.RemoteUserStoreManagerServiceUserStoreExceptionException

RemoteException

deleteRole

public void deleteRole(String roleName)
                throws org.wso2.carbon.um.ws.api.stub.RemoteUserStoreManagerServiceUserStoreExceptionException,
                       RemoteException

Throws:

org.wso2.carbon.um.ws.api.stub.RemoteUserStoreManagerServiceUserStoreExceptionException

RemoteException

deleteUser

public void deleteUser(String userName)
                throws org.wso2.carbon.um.ws.api.stub.RemoteUserStoreManagerServiceUserStoreExceptionException,
                       RemoteException

Throws:

org.wso2.carbon.um.ws.api.stub.RemoteUserStoreManagerServiceUserStoreExceptionException

RemoteException