Package com.sun.identity.idm.plugins.database

Interface DaoInterface

All Known Implementing Classes:

JdbcSimpleUserDao

public interface DaoInterface

Classes that implement this interface are expected to conatin code that accesses a datastore, such as JBDC code to access a database, and create, read, update, delete, and search users and user related attributes. No matter what technology is used to access the datastore or what format or type the data may be, it should be converted to Strings before being returned to the opensso layer and calling code, as indicated in the method interfaces. An IdRepo.java implementatiuon class like JDBCSimpleUserDao.java is an example of the expected client that would be calling these methods.

Method Summary

Modifier and Type	Method	Description
void	addMembersToGroup(Set<String> members, String groupName, String membershipIdAttributeName)
void	createGroup(String groupName, String membershipIdAttributeName)
String	createUser(String userIDAttributeName, Map<String,Set<String>> attrMap)
void	deleteGroup(String groupName, String membershipIdAttributeName)
void	deleteMembersFromGroup(Set<String> members, String groupName, String membershipIdAttributeName)
void	deleteUser(String userID, String userIDAttributeName)
Map<String,Set<String>>	getAttributes(String userID, String userIDAttributeName, Set<String> attributesToFetch)
String	getDataSourceURL()	get the url of the current database.
Map<String,Set<String>>	getGroupAttributes(String groupName, String membershipIdAttributeName, Set<String> attributesToFetch)
Set<String>	getMembers(String groupName, String membershipIdAttributeName)
Set<String>	getMemberships(String userName, String membershipIdAttributeName)
void	initialize(String jndiName, String userDataBaseTableName, String membershipDataBaseTableName, Debug idRepoDebugLog)
void	initialize(String jdbcDriver, String jdbcDriverUrl, String jdbcDbUser, String jdbcDbPassword, String userDataBaseTableName, String membershipDataBaseTableName, Debug idRepoDebugLog)
Map<String,Map<String,Set<String>>>	search(String userIDAttributeName, int limit, String idPattern, Set<String> attributesToFetch, String filterOperand, Map<String,Set<String>> avPairs)
Map<String,Map<String,Set<String>>>	search(String userIDAttributeName, int limit, org.forgerock.util.query.QueryFilter<org.forgerock.json.JsonPointer> queryFilter, Set<String> attributesToFetch, String filterOperand, Map<String,Set<String>> avPairs)
Map<String,Map<String,Set<String>>>	searchForGroups(String membershipIdAttributeName, int limit, String idPattern, Set<String> attributesToFetch, String filterOperand, Map<String,Set<String>> avPairs)
Map<String,Map<String,Set<String>>>	searchForGroups(String membershipIdAttributeName, int limit, org.forgerock.util.query.QueryFilter<org.forgerock.json.JsonPointer> queryFilter, Set<String> attributesToFetch, String filterOperand, Map<String,Set<String>> avPairs)
void	updateUser(String userID, String userIDAttributeName, Map<String,Set<String>> attrMap)

Method Detail

initialize

void initialize(String jndiName,
                String userDataBaseTableName,
                String membershipDataBaseTableName,
                Debug idRepoDebugLog)
         throws InstantiationException

Throws:

InstantiationException

initialize

void initialize(String jdbcDriver,
                String jdbcDriverUrl,
                String jdbcDbUser,
                String jdbcDbPassword,
                String userDataBaseTableName,
                String membershipDataBaseTableName,
                Debug idRepoDebugLog)
         throws InstantiationException

Throws:

InstantiationException

updateUser

void updateUser(String userID,
                String userIDAttributeName,
                Map<String,Set<String>> attrMap)

deleteUser

void deleteUser(String userID,
                String userIDAttributeName)

createUser

String createUser(String userIDAttributeName,
                  Map<String,Set<String>> attrMap)

getAttributes

Map<String,Set<String>> getAttributes(String userID,
                                            String userIDAttributeName,
                                            Set<String> attributesToFetch)

search

Map<String,Map<String,Set<String>>> search(String userIDAttributeName,
                                                       int limit,
                                                       String idPattern,
                                                       Set<String> attributesToFetch,
                                                       String filterOperand,
                                                       Map<String,Set<String>> avPairs)

search

Map<String,Map<String,Set<String>>> search(String userIDAttributeName,
                                                       int limit,
                                                       org.forgerock.util.query.QueryFilter<org.forgerock.json.JsonPointer> queryFilter,
                                                       Set<String> attributesToFetch,
                                                       String filterOperand,
                                                       Map<String,Set<String>> avPairs)
                                                throws IdRepoUnsupportedOpException

Throws:

IdRepoUnsupportedOpException

getDataSourceURL

String getDataSourceURL()

get the url of the current database.

Returns:

a url of the current db connection, should be of the form jdbc:mysql://localhost:3306/seantestdb1 It is used by the IdRepo implementation to provide a fully qualified domain name for users, and this value serves as sort of the prefix.

getMembers

Set<String> getMembers(String groupName,
                       String membershipIdAttributeName)

getMemberships

Set<String> getMemberships(String userName,
                           String membershipIdAttributeName)

deleteGroup

void deleteGroup(String groupName,
                 String membershipIdAttributeName)

createGroup

void createGroup(String groupName,
                 String membershipIdAttributeName)

deleteMembersFromGroup

void deleteMembersFromGroup(Set<String> members,
                            String groupName,
                            String membershipIdAttributeName)

addMembersToGroup

void addMembersToGroup(Set<String> members,
                       String groupName,
                       String membershipIdAttributeName)

searchForGroups

Map<String,Map<String,Set<String>>> searchForGroups(String membershipIdAttributeName,
                                                                int limit,
                                                                String idPattern,
                                                                Set<String> attributesToFetch,
                                                                String filterOperand,
                                                                Map<String,Set<String>> avPairs)

searchForGroups

Map<String,Map<String,Set<String>>> searchForGroups(String membershipIdAttributeName,
                                                                int limit,
                                                                org.forgerock.util.query.QueryFilter<org.forgerock.json.JsonPointer> queryFilter,
                                                                Set<String> attributesToFetch,
                                                                String filterOperand,
                                                                Map<String,Set<String>> avPairs)

getGroupAttributes

Map<String,Set<String>> getGroupAttributes(String groupName,
                                                 String membershipIdAttributeName,
                                                 Set<String> attributesToFetch)