com.webmethods.portal.service.dir

Interface IDirQueryProvider

public interface IDirQueryProvider

Provider which can search and list users and groups

Method Summary

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...

Method Detail

getMemberShipShortCut

IDirPrincipalList getMemberShipShortCut(String DN)
                                 throws PortalException

If your directory service has a short cut or optization to get users group membership.

Parameters:

dn - of the user to get groups for

Returns:

the IDirPrincipalList

Throws:

PortalException

listPrincipals

IDirPrincipalList listPrincipals(int type,
                                 int start,
                                 int end)
                          throws PortalException

List the registered principals, either users or roles

Parameters:

type - either IDirConstants.TYPE_USER or IDirConstants.TYPE_GROUP

start - 0 is the first possible entry

end - must be greater then start or -1 for all

Returns:

the IDirPrincipalList

Throws:

PortalException

listPrincipals

IDirPrincipalList listPrincipals(int type,
                                 IPagingCookie pagingCookie)
                          throws PortalException

Parameters:

type - either IDirConstants.TYPE_USER or IDirConstants.TYPE_GROUP

pagingCookie - IPagingCookie

Returns:

the IDirPrincipalList

Throws:

PortalException

See Also:

listPrincipals(int, int, int)

search

IDirPrincipalList search(int type,
                         String queryString)
                  throws PortalException

This isn't an LDAP query, but merely a wildcard query, such as 'bob'

Parameters:

type - either IDirConstants.TYPE_USER or IDirConstants.TYPE_GROUP

queryString -

Returns:

the IDirPrincipalList

Throws:

PortalException

search

IDirPrincipalList search(int type,
                         String queryString,
                         IPagingCookie pagingCookie)
                  throws PortalException

This isn't an LDAP query, but merely a wildcard query, such as 'bob'

Parameters:

type - either IDirConstants.TYPE_USER or IDirConstants.TYPE_GROUP

queryString -

pagingCookie -

Returns:

the IDirPrincipalList

Throws:

PortalException

search

IDirPrincipalList search(int type,
                         ISearchQuery searchQuery)
                  throws PortalException

Query for principals using the criteria contained in a ISearchQuery instance

Parameters:

type - either IDirConstants.TYPE_USER or IDirConstants.TYPE_GROUP

searchQuery -

Returns:

the IDirPrincipalList

Throws:

PortalException

search

IDirPrincipalList search(int type,
                         ISearchQuery searchQuery,
                         IPagingCookie pagingCoookie)
                  throws PortalException

Query for principals using the criteria contained in a ISearchQuery instance (with paging)

Parameters:

type - either IDirConstants.TYPE_USER or IDirConstants.TYPE_GROUP

queryString -

pagingCookie -

Returns:

the IDirPrincipalList

Throws:

PortalException

searchRaw

IDirPrincipalList searchRaw(int type,
                            String queryString)
                     throws PortalException

Most of the time, the query provider will wrap your query appropriately... This will not be wrapped

Parameters:

type -

queryString -

Returns:

the IDirPrincipalList

Throws:

PortalException

lookup

IDirPrincipal lookup(IURI principalURI)
              throws PortalException

Lookup a principal based on its uri

Parameters:

principalURI -

Throws:

PortalException

lookupByID

IDirPrincipal lookupByID(int type,
                         String uid)
                  throws PortalException

Lookup a principal based on its uid

Parameters:

type - either IDirConstants.TYPE_USER or IDirConstants.TYPE_GROUP

uid -

Throws:

PortalException

lookupByID

default IDirPrincipal lookupByID(String uid)
                          throws PortalException

Lookup a principal based on its uid. First a lookup for group is done, then for a user.

Parameters:

uid -

Throws:

PortalException

lookupByUUID

default IDirPrincipal lookupByUUID(int type,
                                   String uuid)
                            throws PortalException

Lookup a principal based on its uuid

Parameters:

type - either IDirConstants.TYPE_USER or IDirConstants.TYPE_GROUP

uuid -

Throws:

PortalException

lookupByDN

IDirPrincipal lookupByDN(int type,
                         String dn)
                  throws PortalException

Lookup a principal based on its dn

Parameters:

type - either IDirConstants.TYPE_USER or IDirConstants.TYPE_GROUP

dn -

Throws:

PortalException