public interface IDirQueryProvider
Modifier and Type | Method and Description |
---|---|
IDirPrincipalList |
getMemberShipShortCut(String DN)
If your directory service has a short cut or optization to get
users group membership.
|
IDirPrincipalList |
listPrincipals(int type,
int start,
int end)
List the registered principals, either users or roles
|
IDirPrincipalList |
listPrincipals(int type,
IPagingCookie pagingCookie) |
IDirPrincipal |
lookup(IURI principalURI)
Lookup a principal based on its uri
|
IDirPrincipal |
lookupByDN(int type,
String dn)
Lookup a principal based on its dn
|
IDirPrincipal |
lookupByID(int type,
String uid)
Lookup a principal based on its uid
|
default IDirPrincipal |
lookupByID(String uid)
Lookup a principal based on its uid.
|
default IDirPrincipal |
lookupByUUID(int type,
String uuid)
Lookup a principal based on its uuid
|
IDirPrincipalList |
search(int type,
ISearchQuery searchQuery)
Query for principals using the criteria contained in a ISearchQuery instance
|
IDirPrincipalList |
search(int type,
ISearchQuery searchQuery,
IPagingCookie pagingCoookie)
Query for principals using the criteria contained in a ISearchQuery instance (with paging)
|
IDirPrincipalList |
search(int type,
String queryString)
This isn't an LDAP query, but merely a wildcard query, such as 'bob'
|
IDirPrincipalList |
search(int type,
String queryString,
IPagingCookie pagingCookie)
This isn't an LDAP query, but merely a wildcard query, such as 'bob'
|
IDirPrincipalList |
searchRaw(int type,
String queryString)
Most of the time, the query provider will wrap your query appropriately...
|
IDirPrincipalList getMemberShipShortCut(String DN) throws PortalException
dn
- of the user to get groups forIDirPrincipalList
PortalException
IDirPrincipalList listPrincipals(int type, int start, int end) throws PortalException
type
- either IDirConstants.TYPE_USER
or IDirConstants.TYPE_GROUP
start
- 0 is the first possible entryend
- must be greater then start or -1 for allIDirPrincipalList
PortalException
IDirPrincipalList listPrincipals(int type, IPagingCookie pagingCookie) throws PortalException
type
- either IDirConstants.TYPE_USER
or IDirConstants.TYPE_GROUP
pagingCookie
- IPagingCookie
IDirPrincipalList
PortalException
listPrincipals(int, int, int)
IDirPrincipalList search(int type, String queryString) throws PortalException
type
- either IDirConstants.TYPE_USER
or IDirConstants.TYPE_GROUP
queryString
- IDirPrincipalList
PortalException
IDirPrincipalList search(int type, String queryString, IPagingCookie pagingCookie) throws PortalException
type
- either IDirConstants.TYPE_USER
or IDirConstants.TYPE_GROUP
queryString
- pagingCookie
- IDirPrincipalList
PortalException
IDirPrincipalList search(int type, ISearchQuery searchQuery) throws PortalException
type
- either IDirConstants.TYPE_USER
or IDirConstants.TYPE_GROUP
searchQuery
- IDirPrincipalList
PortalException
IDirPrincipalList search(int type, ISearchQuery searchQuery, IPagingCookie pagingCoookie) throws PortalException
type
- either IDirConstants.TYPE_USER
or IDirConstants.TYPE_GROUP
queryString
- pagingCookie
- IDirPrincipalList
PortalException
IDirPrincipalList searchRaw(int type, String queryString) throws PortalException
type
- queryString
- IDirPrincipalList
PortalException
IDirPrincipal lookup(IURI principalURI) throws PortalException
principalURI
- PortalException
IDirPrincipal lookupByID(int type, String uid) throws PortalException
type
- either IDirConstants.TYPE_USER
or IDirConstants.TYPE_GROUP
uid
- PortalException
default IDirPrincipal lookupByID(String uid) throws PortalException
uid
- PortalException
default IDirPrincipal lookupByUUID(int type, String uuid) throws PortalException
type
- either IDirConstants.TYPE_USER
or IDirConstants.TYPE_GROUP
uuid
- PortalException
IDirPrincipal lookupByDN(int type, String dn) throws PortalException
type
- either IDirConstants.TYPE_USER
or IDirConstants.TYPE_GROUP
dn
- PortalException