org.wso2.registry.users
Interface UserStoreReader

All Known Subinterfaces:
UserStoreAdmin
All Known Implementing Classes:
ACLUserStoreAdmin, ACLUserStoreReader, DefaultUserStoreAdmin, DefaultUserStoreReader, RegistryUserStoreAdmin

public interface UserStoreReader

Reads data from the user store


Method Summary
 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
 

Method Detail

getAllUserNames

java.lang.String[] getAllUserNames()
                                   throws UserStoreException
Retrieves all user names

Throws:
UserStoreException

isExistingUser

boolean isExistingUser(java.lang.String userName)
                       throws UserStoreException
Checks whether an user exist in the user store

Parameters:
userName - TODO
Throws:
UserStoreException

isExistingRole

boolean isExistingRole(java.lang.String roleName)
                       throws UserStoreException
Checks whether a role exist in the user store

Parameters:
roleName - RoleName
Throws:
UserStoreException

getUserProperties

java.util.Map getUserProperties(java.lang.String userName)
                                throws UserStoreException
Retrieves user properties given the user name

Throws:
UserStoreException

getUserPropertyNames

java.lang.String[] getUserPropertyNames()
                                        throws UserStoreException
Retrieves user properties given the user name

Throws:
UserStoreException

getUserNamesWithPropertyValue

java.lang.String[] getUserNamesWithPropertyValue(java.lang.String propertyName,
                                                 java.lang.String propetyValue)
                                                 throws UserStoreException
Retrieves user names with the given property values

Throws:
UserStoreException

getAllRoleNames

java.lang.String[] getAllRoleNames()
                                   throws UserStoreException
Retrieves all role names

Throws:
UserStoreException

getRoleProperties

java.util.Map getRoleProperties(java.lang.String roleName)
                                throws UserStoreException
Retrieves role properties given the role name

Throws:
UserStoreException

getUserRoles

java.lang.String[] getUserRoles(java.lang.String userName)
                                throws UserStoreException
Gets all user roles

Throws:
UserStoreException

getUsersInRole

java.lang.String[] getUsersInRole(java.lang.String roleName)
                                  throws UserStoreException
Retrieves users in a role

Throws:
UserStoreException


Copyright © 2007 Apache Web Services Project. All Rights Reserved.