Package com.sun.identity.sm

Interface ServiceManagementDAO

All Known Implementing Classes:

ServiceManagementDAOWrapper

public interface ServiceManagementDAO

DAO definition for service management.

Author:

apforrest

Method Summary

Modifier and Type	Method	Description
boolean	checkIfEntryExists(String dn, SSOToken token)	Checks if the provided DN exists.
String	getRootSuffix()
Iterator<SMSDataEntry>	search(SSOToken token, String dn, String filter, int numOfEntries, int timeLimit, boolean sortResults, boolean ascendingOrder, Set<String> exclude)	Returns the DNs and its attribute values that match the filter.

Method Detail

search

Iterator<SMSDataEntry> search(SSOToken token,
                              String dn,
                              String filter,
                              int numOfEntries,
                              int timeLimit,
                              boolean sortResults,
                              boolean ascendingOrder,
                              Set<String> exclude)
                       throws SMSException

Returns the DNs and its attribute values that match the filter. The search is performed from the root suffix ie., DN. It searches for SMS objects only.

Parameters:

token - Single-Sign On token.

dn - Base DN

filter - Search Filter.

numOfEntries - number of max entries, 0 means unlimited

timeLimit - maximum number of seconds for the search to spend, 0 means unlimited

sortResults - true to have result sorted.

ascendingOrder - true to have result sorted in ascending order.

exclude - List of DN to exclude.

Returns:

DNs and its attribute values that match the filter.

Throws:

SMSException - When an underlying error occurs.

checkIfEntryExists

boolean checkIfEntryExists(String dn,
                           SSOToken token)

Checks if the provided DN exists. Used by PolicyManager.

Parameters:

dn - The DN in question.

token - Single-Sign On token.

Returns:

Whether the DN exists.

getRootSuffix

String getRootSuffix()

Returns:

The root suffix (dn).