|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectwt.services.StandardManager
wt.org.StandardOrganizationServicesManager
public class StandardOrganizationServicesManager
Standard implementation of the Organization Services Manager interface. Supports also a cache of WTPrincipal objects.
Use the newStandardOrganizationServicesManager static factory
method(s), not the StandardOrganizationServicesManager constructor,
to construct instances of this class. Instances must be constructed
using the static factory(s), in order to ensure proper initialization
of the instance.
Supported API: true
Extendable: false
| Method Summary | |
|---|---|
boolean |
addMember(WTGroup group,
WTPrincipal principal)
Adds a principal to a group. |
WTPrincipal[] |
addMembers(WTGroup group,
WTPrincipal[] principals)
Adds principals to a group. |
WTPrincipal |
createPrincipal(WTPrincipal principal)
This API persists the principal object in the database. |
WTGroup |
delete(WTGroup group)
The API is used to delete a group from the database and its corresponding entry in LDAP. |
WTUser |
delete(WTUser user)
The API is used to delete a user object from the database and its corresponding entry in LDAP. |
WTPrincipal |
disablePrincipal(WTPrincipal principal)
This API is used to disable a principal in the database. |
WTPrincipal |
enablePrincipal(WTPrincipal principal)
This API is used to enable a previously disabled principal. |
Enumeration |
findLikeActiveAndDisabledUsers(Class principalClass,
String criteria,
DirectoryContextProvider[] contexts)
This API returns a resultset containing all the active and disabled users. |
Enumeration |
findLikeDisabledUsers(String criteria)
Provides a result set of all disabled users that match the search criteria provided as a parameter. |
Enumeration |
findLikeGroups(String pattern,
DirectoryContextProvider context)
This method will search the given directory context for groups whose name matches the name pattern provided. |
Enumeration |
findLikeOrganizations(String attributeName,
String pattern,
DirectoryContextProvider context)
This API returns all the organizations matching the name provided as a pattern. |
Enumeration |
findLikeOrganizations(String attributeName,
String pattern,
DirectoryContextProvider context,
boolean querySubtree)
This API returns all the organizations matching the name provided as a pattern. |
Enumeration |
findLikeOrganizations(String attributeName,
String pattern,
DirectoryContextProvider context,
boolean querySubtree,
boolean applyAccessFilter)
This API returns all the organizations matching the name provided as a pattern. |
Enumeration |
findLikeUsers(String attributeName,
String pattern,
DirectoryContextProvider context)
This API returns all the users matching the name provided as a pattern. |
WTUser |
getAuthenticatedUser(String auth_name)
Supported API: true |
String[] |
getDirectoryServiceNames()
Supported API: true |
WTGroup |
getGroup(String name,
DirectoryContextProvider context)
This method will search for groups whose name attribute matches the given name in the given directory context. |
Enumeration |
getGroups(String name,
DirectoryContextProvider context)
Supported API: true |
WTOrganization |
getOrganization(String name,
DirectoryContextProvider context)
Supported API: true |
WTOrganization |
getOrganization(WTPrincipal principal)
Returns the organization with which a principal is associated. |
Enumeration |
getOrganizations(String name,
DirectoryContextProvider context)
Supported API: true |
WTPrincipal |
getPrincipal(ObjectIdentifier reference)
Gets the user or group for the specified principal reference. |
WTPrincipal |
getPrincipal(String name,
Class type,
DirectoryContextProvider context)
This method will search for a principal with the given name in the given organization. |
Enumeration |
getPrincipal(String name,
DirectoryContextProvider context)
This method will search for principals with the given name in the given organization. |
WTPrincipal |
getPrincipalByDN(String dn)
Returns the principal identified by a specific directory distinguished name, or null if no such principal exists. |
WTPrincipalReference |
getPrincipalReference(String name,
Class type,
DirectoryContextProvider context)
This method will search for a principal with the given name in the given organization, and return its reference. |
Enumeration |
getPrincipalReference(String name,
DirectoryContextProvider context)
This method will search for principals with the given name in the given organization, and references to them will be returned. |
WTUser |
getUser(String name,
DirectoryContextProvider context)
Supported API: true |
Enumeration |
getUsers(String name,
DirectoryContextProvider context)
Supported API: true |
boolean |
isMember(WTGroup group,
WTPrincipal principal)
Supported API: true |
boolean |
isMember(WTPrincipalReference group,
WTPrincipal principal)
Supported API: true |
Enumeration |
members(WTGroup group)
Supported API: true |
Enumeration |
members(WTGroup group,
boolean flatten)
Supported API: true |
WTPrincipal |
move(WTPrincipal principal,
DirectoryContextProvider newContext)
Supported API: true |
DirectoryContextProvider |
newDirectoryContextProvider(DirectoryContextProvider baseContext,
String[] searchScopes)
Supported API: true |
DirectoryContextProvider |
newDirectoryContextProvider(String[] services,
String[] searchScopes)
Supported API: true |
Enumeration |
parentGroups(WTPrincipal principal)
Supported API: true |
Enumeration |
queryPrincipals(Class principalClass,
String criteria,
DirectoryContextProvider context)
Supported API: true |
Enumeration |
queryPrincipals(Class principalClass,
String criteria,
DirectoryContextProvider[] contexts)
Supported API: true |
boolean |
removeMember(WTGroup group,
WTPrincipal principal)
Removes a principal from a group. |
boolean |
removeMember(WTGroup group,
WTPrincipal principal,
boolean bValidate)
Removes a principal from a group. |
boolean |
removeMembers(WTGroup group,
WTPrincipal[] principals)
Removes principals from a group. |
boolean |
removeMembers(WTGroup group,
WTPrincipal[] principals,
boolean bValidate)
Removes principals from a group. |
WTPrincipal |
rename(WTPrincipal principal,
String newName)
Supported API: true |
WTPrincipal |
repairPrincipal(String oldName,
String newDn,
String oldEnteredDn)
This method tries and repairs the principal given the "oldName" (name that is currently in the database and possibly will continue to be -- ie. |
WTPrincipal |
updatePrincipal(WTPrincipal principal)
Supported API: true |
| Methods inherited from class wt.services.StandardManager |
|---|
getManagerService, getManagerStatus, getName, getStartupType |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Method Detail |
|---|
public WTPrincipal getPrincipal(ObjectIdentifier reference)
throws WTException
getPrincipal in interface OrganizationServicesManagerreference -
WTException
public Enumeration getPrincipal(String name,
DirectoryContextProvider context)
throws WTException
getPrincipal in interface OrganizationServicesManagername - context -
WTException
public WTPrincipal getPrincipal(String name,
Class type,
DirectoryContextProvider context)
throws WTException
getPrincipal in interface OrganizationServicesManagername - type - context -
WTException
public WTPrincipal getPrincipalByDN(String dn)
throws WTException
getPrincipalByDN in interface OrganizationServicesManagerdn -
WTException
public Enumeration getPrincipalReference(String name,
DirectoryContextProvider context)
throws WTException
getPrincipalReference in interface OrganizationServicesManagername - context -
WTException
public WTPrincipalReference getPrincipalReference(String name,
Class type,
DirectoryContextProvider context)
throws WTException
getPrincipalReference in interface OrganizationServicesManagername - type - context -
WTException
public Enumeration queryPrincipals(Class principalClass,
String criteria,
DirectoryContextProvider context)
throws WTException
queryPrincipals in interface OrganizationServicesManagerprincipalClass - criteria - context -
WTException
public Enumeration queryPrincipals(Class principalClass,
String criteria,
DirectoryContextProvider[] contexts)
throws WTException
queryPrincipals in interface OrganizationServicesManagerprincipalClass - criteria - contexts -
WTException
public WTPrincipal createPrincipal(WTPrincipal principal)
throws WTException
createPrincipal in interface OrganizationServicesManagerprincipal -
WTException
public WTPrincipal disablePrincipal(WTPrincipal principal)
throws WTException
disablePrincipal in interface OrganizationServicesManagerprincipal -
WTException
public WTPrincipal enablePrincipal(WTPrincipal principal)
throws WTException
enablePrincipal in interface OrganizationServicesManagerprincipal -
WTException
public WTPrincipal updatePrincipal(WTPrincipal principal)
throws WTException
updatePrincipal in interface OrganizationServicesManagerprincipal -
WTException
public WTPrincipal rename(WTPrincipal principal,
String newName)
throws WTException
rename in interface OrganizationServicesManagerprincipal - newName -
WTException
public WTPrincipal move(WTPrincipal principal,
DirectoryContextProvider newContext)
throws WTException
move in interface OrganizationServicesManagerprincipal - newContext -
WTException
public WTUser getAuthenticatedUser(String auth_name)
throws WTException
getAuthenticatedUser in interface OrganizationServicesManagerauth_name -
WTException
public WTUser getUser(String name,
DirectoryContextProvider context)
throws WTException
getUser in interface OrganizationServicesManagername - context -
WTException
public Enumeration getUsers(String name,
DirectoryContextProvider context)
throws WTException
getUsers in interface OrganizationServicesManagername - context -
WTException
public Enumeration findLikeUsers(String attributeName,
String pattern,
DirectoryContextProvider context)
throws WTException
findLikeUsers in interface OrganizationServicesManagerattributeName - pattern - context -
WTException
public WTUser delete(WTUser user)
throws WTException
delete in interface OrganizationServicesManageruser -
WTException
public WTGroup getGroup(String name,
DirectoryContextProvider context)
throws WTException
getGroup in interface OrganizationServicesManagername - context -
WTException
public Enumeration getGroups(String name,
DirectoryContextProvider context)
throws WTException
getGroups in interface OrganizationServicesManagername - context -
WTException
public Enumeration findLikeGroups(String pattern,
DirectoryContextProvider context)
throws WTException
findLikeGroups in interface OrganizationServicesManagerpattern - context -
WTException
public WTGroup delete(WTGroup group)
throws WTException
delete in interface OrganizationServicesManagergroup -
WTException
public boolean addMember(WTGroup group,
WTPrincipal principal)
throws WTException,
UserNotFoundException
addMember in interface OrganizationServicesManagergroup - principal -
WTException
UserNotFoundException
public WTPrincipal[] addMembers(WTGroup group,
WTPrincipal[] principals)
throws WTException
addMembers in interface OrganizationServicesManagergroup - principals -
WTException
public boolean removeMember(WTGroup group,
WTPrincipal principal)
throws WTException,
UserNotFoundException
removeMember in interface OrganizationServicesManagergroup - principal -
WTException
UserNotFoundException
public boolean isMember(WTGroup group,
WTPrincipal principal)
throws WTException
isMember in interface OrganizationServicesManagergroup - principal -
WTException
public boolean isMember(WTPrincipalReference group,
WTPrincipal principal)
throws WTException
isMember in interface OrganizationServicesManagergroup - principal -
WTException
public Enumeration members(WTGroup group)
throws WTException
members in interface OrganizationServicesManagergroup -
WTException
public Enumeration members(WTGroup group,
boolean flatten)
throws WTException
members in interface OrganizationServicesManagergroup - flatten -
WTException
public Enumeration parentGroups(WTPrincipal principal)
throws WTException
parentGroups in interface OrganizationServicesManagerprincipal -
WTException
public WTOrganization getOrganization(WTPrincipal principal)
throws WTException
getOrganization in interface OrganizationServicesManagerprincipal -
WTException
public WTOrganization getOrganization(String name,
DirectoryContextProvider context)
throws WTException
getOrganization in interface OrganizationServicesManagername - context -
WTException
public Enumeration getOrganizations(String name,
DirectoryContextProvider context)
throws WTException
getOrganizations in interface OrganizationServicesManagername - context -
WTException
public Enumeration findLikeOrganizations(String attributeName,
String pattern,
DirectoryContextProvider context)
throws WTException
findLikeOrganizations in interface OrganizationServicesManagerattributeName - pattern - context -
WTException
public Enumeration findLikeOrganizations(String attributeName,
String pattern,
DirectoryContextProvider context,
boolean querySubtree)
throws WTException
findLikeOrganizations in interface OrganizationServicesManagerattributeName - pattern - context - querySubtree -
WTException
public Enumeration findLikeOrganizations(String attributeName,
String pattern,
DirectoryContextProvider context,
boolean querySubtree,
boolean applyAccessFilter)
throws WTException
findLikeOrganizations in interface OrganizationServicesManagerattributeName - pattern - context - querySubtree - applyAccessFilter -
WTException
public String[] getDirectoryServiceNames()
throws WTException
getDirectoryServiceNames in interface OrganizationServicesManagerWTException
public WTPrincipal repairPrincipal(String oldName,
String newDn,
String oldEnteredDn)
throws WTException
repairPrincipal in interface OrganizationServicesManageroldName - newDn - oldEnteredDn -
WTException
public DirectoryContextProvider newDirectoryContextProvider(DirectoryContextProvider baseContext,
String[] searchScopes)
throws WTException
newDirectoryContextProvider in interface OrganizationServicesManagerbaseContext - searchScopes -
WTException
public DirectoryContextProvider newDirectoryContextProvider(String[] services,
String[] searchScopes)
throws WTException
newDirectoryContextProvider in interface OrganizationServicesManagerservices - searchScopes -
WTException
public boolean removeMembers(WTGroup group,
WTPrincipal[] principals)
throws WTException,
UserNotFoundException
removeMembers in interface OrganizationServicesManagergroup - principals -
WTException
UserNotFoundException
public Enumeration findLikeActiveAndDisabledUsers(Class principalClass,
String criteria,
DirectoryContextProvider[] contexts)
throws WTException
findLikeActiveAndDisabledUsers in interface OrganizationServicesManagerprincipalClass - criteria - contexts -
WTException
public Enumeration findLikeDisabledUsers(String criteria)
throws WTException
findLikeDisabledUsers in interface OrganizationServicesManagercriteria -
WTException
public boolean removeMember(WTGroup group,
WTPrincipal principal,
boolean bValidate)
throws WTException,
UserNotFoundException
removeMember in interface OrganizationServicesManagergroup - principal - bValidate -
WTException
UserNotFoundException
public boolean removeMembers(WTGroup group,
WTPrincipal[] principals,
boolean bValidate)
throws WTException,
UserNotFoundException
removeMembers in interface OrganizationServicesManagergroup - principals - bValidate -
WTException
UserNotFoundException
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||