org.wso2.registry.jdbc.realm
Class RegistryUserStoreAdmin

java.lang.Object
  org.wso2.registry.jdbc.realm.RegistryUserStoreAdmin

All Implemented Interfaces:

UserStoreAdmin, UserStoreReader

public class RegistryUserStoreAdmin
extends java.lang.Object
implements UserStoreAdmin

Constructor Summary

RegistryUserStoreAdmin(UserStoreAdmin userStoreAdmin)

Method Summary

void	addRole(java.lang.String roleName) Add role to user store
void	addUser(java.lang.String userName, java.lang.Object credential) Add user to the user store
void	addUserToRole(java.lang.String userName, java.lang.String roleName) Add user to role
void	deleteRole(java.lang.String roleName) Delete role from user store
void	deleteUser(java.lang.String userName) Delete user from user store
java.lang.String[]	getAllRoleNames() Retrieves all role names
java.lang.String[]	getAllUserNames() Retrieves all user names
java.util.Map	getRoleProperties(java.lang.String roleName) Retrieves role properties given the role name
java.lang.String[]	getUserNamesWithPropertyValue(java.lang.String propertyName, java.lang.String propetyValue) Retrieves user names with the given property values
java.util.Map	getUserProperties(java.lang.String userName) Retrieves user properties given the user name
java.lang.String[]	getUserPropertyNames() Retrieves user properties given the user name
java.lang.String[]	getUserRoles(java.lang.String userName) Gets all user roles
java.lang.String[]	getUsersInRole(java.lang.String roleName) Retrieves users in a role
boolean	isExistingRole(java.lang.String roleName) Checks whether a role exist in the user store
boolean	isExistingUser(java.lang.String userName) Checks whether an user exist in the user store
void	removeUserFromRole(java.lang.String userName, java.lang.String roleName) Delete user from role
void	setRoleProperties(java.lang.String roleName, java.util.Map properties) Set role properties in the user store
void	setUserProperties(java.lang.String userName, java.util.Map properties) Set user properties in the user store
void	updateUser(java.lang.String userName, java.lang.Object newCredential) Update method for admin
void	updateUser(java.lang.String userName, java.lang.Object newCredential, java.lang.Object oldCredential) Update user in the user store

Methods inherited from class java.lang.Object

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

Constructor Detail

RegistryUserStoreAdmin

public RegistryUserStoreAdmin(UserStoreAdmin userStoreAdmin)

Method Detail

addUser

public void addUser(java.lang.String userName,
                    java.lang.Object credential)
             throws UserStoreException

Description copied from interface: UserStoreAdmin

Add user to the user store

Specified by:

addUser in interface UserStoreAdmin

Throws:

UserStoreException

deleteUser

public void deleteUser(java.lang.String userName)
                throws UserStoreException

Description copied from interface: UserStoreAdmin

Delete user from user store

Specified by:

deleteUser in interface UserStoreAdmin

Throws:

UserStoreException

deleteRole

public void deleteRole(java.lang.String roleName)
                throws UserStoreException

Description copied from interface: UserStoreAdmin

Delete role from user store

Specified by:

deleteRole in interface UserStoreAdmin

Throws:

UserStoreException

removeUserFromRole

public void removeUserFromRole(java.lang.String userName,
                               java.lang.String roleName)
                        throws UserStoreException

Description copied from interface: UserStoreAdmin

Delete user from role

Specified by:

removeUserFromRole in interface UserStoreAdmin

Throws:

UserStoreException

updateUser

public void updateUser(java.lang.String userName,
                       java.lang.Object newCredential,
                       java.lang.Object oldCredential)
                throws UserStoreException

Description copied from interface: UserStoreAdmin

Update user in the user store

Specified by:

updateUser in interface UserStoreAdmin

Throws:

UserStoreException

updateUser

public void updateUser(java.lang.String userName,
                       java.lang.Object newCredential)
                throws UserStoreException

Description copied from interface: UserStoreAdmin

Update method for admin

Specified by:

updateUser in interface UserStoreAdmin

Throws:

UserStoreException

setUserProperties

public void setUserProperties(java.lang.String userName,
                              java.util.Map properties)
                       throws UserStoreException

Description copied from interface: UserStoreAdmin

Set user properties in the user store

Specified by:

setUserProperties in interface UserStoreAdmin

Throws:

UserStoreException

addRole

public void addRole(java.lang.String roleName)
             throws UserStoreException

Description copied from interface: UserStoreAdmin

Add role to user store

Specified by:

addRole in interface UserStoreAdmin

Throws:

UserStoreException

setRoleProperties

public void setRoleProperties(java.lang.String roleName,
                              java.util.Map properties)
                       throws UserStoreException

Description copied from interface: UserStoreAdmin

Set role properties in the user store

Specified by:

setRoleProperties in interface UserStoreAdmin

Throws:

UserStoreException

addUserToRole

public void addUserToRole(java.lang.String userName,
                          java.lang.String roleName)
                   throws UserStoreException

Description copied from interface: UserStoreAdmin

Add user to role

Specified by:

addUserToRole in interface UserStoreAdmin

Throws:

UserStoreException

getAllUserNames

public java.lang.String[] getAllUserNames()
                                   throws UserStoreException

Description copied from interface: UserStoreReader

Retrieves all user names

Specified by:

getAllUserNames in interface UserStoreReader

Throws:

UserStoreException

isExistingUser

public boolean isExistingUser(java.lang.String userName)
                       throws UserStoreException

Description copied from interface: UserStoreReader

Checks whether an user exist in the user store

Specified by:

isExistingUser in interface UserStoreReader

Parameters:

userName - TODO

Throws:

UserStoreException

isExistingRole

public boolean isExistingRole(java.lang.String roleName)
                       throws UserStoreException

Description copied from interface: UserStoreReader

Checks whether a role exist in the user store

Specified by:

isExistingRole in interface UserStoreReader

Parameters:

roleName - RoleName

Throws:

UserStoreException

getUserProperties

public java.util.Map getUserProperties(java.lang.String userName)
                                throws UserStoreException

Description copied from interface: UserStoreReader

Retrieves user properties given the user name

Specified by:

getUserProperties in interface UserStoreReader

Throws:

UserStoreException

getUserPropertyNames

public java.lang.String[] getUserPropertyNames()
                                        throws UserStoreException

Description copied from interface: UserStoreReader

Retrieves user properties given the user name

Specified by:

getUserPropertyNames in interface UserStoreReader

Throws:

UserStoreException

getUserNamesWithPropertyValue

public java.lang.String[] getUserNamesWithPropertyValue(java.lang.String propertyName,
                                                        java.lang.String propetyValue)
                                                 throws UserStoreException

Description copied from interface: UserStoreReader

Retrieves user names with the given property values

Specified by:

getUserNamesWithPropertyValue in interface UserStoreReader

Throws:

UserStoreException

getAllRoleNames

public java.lang.String[] getAllRoleNames()
                                   throws UserStoreException

Description copied from interface: UserStoreReader

Retrieves all role names

Specified by:

getAllRoleNames in interface UserStoreReader

Throws:

UserStoreException

getRoleProperties

public java.util.Map getRoleProperties(java.lang.String roleName)
                                throws UserStoreException

Description copied from interface: UserStoreReader

Retrieves role properties given the role name

Specified by:

getRoleProperties in interface UserStoreReader

Throws:

UserStoreException

getUserRoles

public java.lang.String[] getUserRoles(java.lang.String userName)
                                throws UserStoreException

Description copied from interface: UserStoreReader

Gets all user roles

Specified by:

getUserRoles in interface UserStoreReader

Throws:

UserStoreException

getUsersInRole

public java.lang.String[] getUsersInRole(java.lang.String roleName)
                                  throws UserStoreException

Description copied from interface: UserStoreReader

Retrieves users in a role

Specified by:

getUsersInRole in interface UserStoreReader

Throws:

UserStoreException