Package wt.org

Class StandardOrganizationServicesManager

java.lang.Object

wt.services.StandardManager

wt.org.StandardOrganizationServicesManager

All Implemented Interfaces:

Serializable, wt.fc._NetFactor, NetFactor, OrganizationServicesManager, wt.services.Manager

public class StandardOrganizationServicesManager
extends StandardManager
implements OrganizationServicesManager, Serializable

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

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
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.
Enumeration	findActiveAndDisabledUsersByName(Class<?> principalClass, String name)	This API returns an enumeration containing all the active and disabled users with the given name.
Enumeration	findActiveAndDisabledUsersByName(Class<?> principalClass, String name, DirectoryContextProvider[] contexts)	This API returns an enumeration containing all the active and disabled users with the given name.
WTUser	findDisabledUser(long key)	This API can be used to query for a disabled user given the id value associated to the user object.
Enumeration	findLikeActiveAndDisabledUsers(Class principalClass, Map<String,List<String>> criteriaMap)	This API returns an enumeration containing all the active and disabled users.
Enumeration	findLikeActiveAndDisabledUsers(Class principalClass, Map<String,List<String>> criteriaMap, DirectoryContextProvider[] contexts)	This API returns an enumeration 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)	This method will search for groups whose name matches the name pattern provided.
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)	This API returns all the organizations matching the name provided as a pattern.
Enumeration	findLikeOrganizations(String attributeName, String pattern, DirectoryContextProvider context)	Deprecated. deprecated in release 12.1
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)	This API returns all the users 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)	Deprecated.
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)	Supported API: true
Enumeration	getGroups(String name, DirectoryContextProvider context)	Supported API: true
WTOrganization	getOrganization(String name)	Get the organization by providing its name Supported API: true
Enumeration	getPrincipal(Class principalClass, String name, DirectoryContextProvider context)	This method will search for given type of principals with the given name in the given organization.
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	getPrincipal(ObjectIdentifier reference)	Gets the user or group for the specified principal reference.
WTPrincipalReference	getPrincipalReference(String name, Class type)	This method will search for a principal with the given name in the given organization, and return its reference.
WTPrincipalReference	getPrincipalReference(String name, Class type, DirectoryContextProvider context)	Returns a reference to a principal, given the name, Class type and DirectoryContextProvider.
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)	Gets the first user matched with the name passed as argument.
WTUser	getUser(String name, DirectoryContextProvider context)	Supported API: true
Enumeration	getUsers(String name)	This API will search and return all users whose name attribute value matches the given name
Enumeration	getUsers(String name, DirectoryContextProvider context)	Supported API: true
boolean	isMember(ObjectIdentifier group, WTPrincipal principal, boolean cacheUser)	Check if this user is a member of this LicenseGroups instance.
boolean	isMember(LicenseGroups licenseGroup, WTPrincipal principal)	Check if this user is a member of this LicenseGroups instance.
boolean	isMember(WTGroup group, WTPrincipal principal)	Supported API: true
boolean	isMember(WTPrincipalReference group, WTPrincipal principal)	Supported API: true
Enumeration	members(WTGroup group)	This API takes a set of groups and retrieves all the direct members from the MembershipLink table.
Enumeration	members(WTGroup group, boolean flatten)	This API takes a set of groups and retrieves all the direct members from the MembershipLink table.
WTPrincipal	move(WTPrincipal principal, DirectoryContextProvider newContext)	Supported API: true
DirectoryContextProvider	newDirectoryContextProvider(String[] services, String[] searchScopes)	Supported API: true
DirectoryContextProvider	newDirectoryContextProvider(DirectoryContextProvider baseContext, String[] searchScopes)	Supported API: true
DirectoryContextProvider	newDirectoryContextProviderForDataBaseRepository()	Supported API: true
Enumeration	queryPrincipals(Class principalClass, Map<String,List<String>> criteriaMap)	Supported API: true
Enumeration	queryPrincipals(Class principalClass, Map<String,List<String>> criteriaMap, DirectoryContextProvider context)	Supported API: true This method is used to pass extra criteriaMap parameter in the flow of method queryPrincipals(Class principalClass, String criteria, DirectoryContextProvider context)
Enumeration	queryPrincipals(Class principalClass, Map<String,List<String>> criteriaMap, 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.
boolean	removeMembers(WTGroup group, WTPrincipal[] principals, boolean validate, boolean validateLicenseGroup)	Removes principals from a group.
WTPrincipal	rename(WTPrincipal principal, String newName)	Supported API: true
WTPrincipal	rename(WTPrincipal principal, String newName, boolean validateLicenseGroup)	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
WTPrincipal	updatePrincipal(WTPrincipal principal, boolean validateLicenseGroup)	Supported API: true

Methods inherited from class wt.services.StandardManager

getManagerService, getManagerStatus, getName, getStartupType, initialize, performShutdownProcess, registerEvents

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

getPrincipal

public WTPrincipal getPrincipal(ObjectIdentifier reference)
                         throws WTException

Gets the user or group for the specified principal reference.

Supported API: true

Specified by:

getPrincipal in interface OrganizationServicesManager

Parameters:

reference -

Returns:

WTPrincipal

Throws:

WTException

getPrincipal

public Enumeration getPrincipal(String name,
 DirectoryContextProvider context)
                         throws WTException

This method will search for principals with the given name in the given organization.

Supported API: true

Specified by:

getPrincipal in interface OrganizationServicesManager

Parameters:

name -

context -

Returns:

Enumeration

Throws:

WTException

getPrincipal

public Enumeration getPrincipal(Class principalClass,
 String name,
 DirectoryContextProvider context)
                         throws WTException

This method will search for given type of principals with the given name in the given organization.

Supported API: true

Specified by:

getPrincipal in interface OrganizationServicesManager

Parameters:

name -

context -

Returns:

Enumeration

Throws:

WTException

getPrincipal

public WTPrincipal getPrincipal(String name,
 Class type,
 DirectoryContextProvider context)
                         throws WTException

This method will search for a principal with the given name in the given organization. If more than one principal is found, an exception is thrown.

Supported API: true

Specified by:

getPrincipal in interface OrganizationServicesManager

Parameters:

name -

type -

context -

Returns:

WTPrincipal

Throws:

WTException

getPrincipalReference

public Enumeration getPrincipalReference(String name,
 DirectoryContextProvider context)
                                  throws WTException

This method will search for principals with the given name in the given organization, and references to them will be returned.

Supported API: true

Specified by:

getPrincipalReference in interface OrganizationServicesManager

Parameters:

name -

context -

Returns:

Enumeration

Throws:

WTException

getPrincipalReference

public WTPrincipalReference getPrincipalReference(String name,
 Class type,
 DirectoryContextProvider context)
                                           throws WTException

Returns a reference to a principal, given the name, Class type and DirectoryContextProvider. If more than one principal is found, an exception is thrown.

Supported API: true

Specified by:

getPrincipalReference in interface OrganizationServicesManager

Parameters:

name -

type -

context -

Returns:

WTPrincipalReference

Throws:

WTException

getPrincipalReference

public WTPrincipalReference getPrincipalReference(String name,
 Class type)
                                           throws WTException

This method will search for a principal with the given name in the given organization, and return its reference. If more than one principal is found, an exception is thrown.

Supported API: true

Specified by:

getPrincipalReference in interface OrganizationServicesManager

Parameters:

name -

type -

Returns:

WTPrincipalReference

Throws:

WTException

queryPrincipals

public Enumeration queryPrincipals(Class principalClass,
 Map<String,List<String>> criteriaMap,
 DirectoryContextProvider context)
                            throws WTException

Supported API: true This method is used to pass extra criteriaMap parameter in the flow of method queryPrincipals(Class principalClass, String criteria, DirectoryContextProvider context)

Specified by:

queryPrincipals in interface OrganizationServicesManager

Parameters:

principalClass -

criteriaMap -

context -

Returns:

Enumeration

Throws:

WTException

queryPrincipals

public Enumeration queryPrincipals(Class principalClass,
 Map<String,List<String>> criteriaMap)
                            throws WTException

Supported API: true

Specified by:

queryPrincipals in interface OrganizationServicesManager

Parameters:

principalClass -

criteria -

context -

Returns:

Enumeration

Throws:

WTException

queryPrincipals

public Enumeration queryPrincipals(Class principalClass,
 Map<String,List<String>> criteriaMap,
 DirectoryContextProvider[] contexts)
                            throws WTException

Supported API: true

Specified by:

queryPrincipals in interface OrganizationServicesManager

Parameters:

principalClass -

criteria -

contexts -

Returns:

Enumeration

Throws:

WTException

createPrincipal

public WTPrincipal createPrincipal(WTPrincipal principal)
                            throws WTException

This API persists the principal object in the database. In addition it also creates a corresponding entry in LDAP if necessary.

Supported API: true

Specified by:

createPrincipal in interface OrganizationServicesManager

Parameters:

principal -

Returns:

WTPrincipal

Throws:

WTException

updatePrincipal

public WTPrincipal updatePrincipal(WTPrincipal principal,
 boolean validateLicenseGroup)
                            throws WTException

Supported API: true

Specified by:

updatePrincipal in interface OrganizationServicesManager

Parameters:

principal -

validateLicenseGroup - : This flag will decide to invoked LicenceBundled Group validation. Ideally this should always be set to true, when invoking this method outside of org services.

Returns:

WTPrincipal

Throws:

WTException

updatePrincipal

public WTPrincipal updatePrincipal(WTPrincipal principal)
                            throws WTException

Supported API: true

Specified by:

updatePrincipal in interface OrganizationServicesManager

Parameters:

principal -

Returns:

WTPrincipal

Throws:

WTException

rename

public WTPrincipal rename(WTPrincipal principal,
 String newName,
 boolean validateLicenseGroup)
                   throws WTException

Supported API: true

Specified by:

rename in interface OrganizationServicesManager

Parameters:

principal -

newName -

validateLicenseGroup - : This flag will decide to invoked LicenceBundled Group validation. Ideally this should always be set to true, when invoking this method outside of org services.

Returns:

WTPrincipal

Throws:

WTException

rename

public WTPrincipal rename(WTPrincipal principal,
 String newName)
                   throws WTException

Supported API: true

Specified by:

rename in interface OrganizationServicesManager

Parameters:

principal -

newName -

Returns:

WTPrincipal

Throws:

WTException

move

public WTPrincipal move(WTPrincipal principal,
 DirectoryContextProvider newContext)
                 throws WTException

Supported API: true

Specified by:

move in interface OrganizationServicesManager

Parameters:

principal -

newContext -

Returns:

WTPrincipal

Throws:

WTException

getAuthenticatedUser

public WTUser getAuthenticatedUser(String auth_name)
                            throws WTException

Supported API: true

Specified by:

getAuthenticatedUser in interface OrganizationServicesManager

Parameters:

auth_name -

Returns:

WTUser

Throws:

WTException

getUser

public WTUser getUser(String name)
               throws WTException

Gets the first user matched with the name passed as argument. Returns null if there is no such user.

Supported API: true

Specified by:

getUser in interface OrganizationServicesManager

Parameters:

name -

Returns:

WTUser

Throws:

WTException

getUser

public WTUser getUser(String name,
 DirectoryContextProvider context)
               throws WTException

Supported API: true

Specified by:

getUser in interface OrganizationServicesManager

Parameters:

name -

context -

Returns:

WTUser

Throws:

WTException

getUsers

public Enumeration getUsers(String name,
 DirectoryContextProvider context)
                     throws WTException

Supported API: true

Specified by:

getUsers in interface OrganizationServicesManager

Parameters:

name -

context -

Returns:

Enumeration

Throws:

WTException

getUsers

public Enumeration getUsers(String name)
                     throws WTException

This API will search and return all users whose name attribute value matches the given name

A few behaviors to note:

• All configured Idp services will be searched.
• The search is performed on the name attribute in Idp and an exact match is expected. If user has multiple names in Idp (aliases, alternate names), any of those can be considered a match
• A user that is only as-yet in Idp and not yet persisted in Windchill can also be found and returned by this API. The Persistence attributes of the user can be checked to determine if this is a persisted user or not
• Since the search for a match occurs on the Idp end, a Windchill user whose Idp record is missing (e.g user has been disabled) or has been renamed (user is in a repair-needed state), will not be found. For the same reason, Internal users (users that are in Pending or Replicated states) will not be found, since they do not have corresponding Idp records
• This API makes use of caching and is suitable for repeat lookups

Also see other related APIs that can be used to find principals, to know if there's a more suitable API: OrganizationServicesManager.getUser(String, DirectoryContextProvider) OrganizationServicesManager.findLikeDisabledUsers(String) OrganizationServicesManager.findActiveAndDisabledUsersByName(Class, String, DirectoryContextProvider[]) OrganizationServicesManager.findUserAnyState(String) OrganizationServicesManager.findLikeUsers(String, String, DirectoryContextProvider) OrganizationServicesManager.getPrincipal(String, DirectoryContextProvider) OrganizationServicesManager.getPrincipal(String, Class, DirectoryContextProvider) OrganizationServicesManager.getPrincipalByDN(String)

Supported API: true

Specified by:

getUsers in interface OrganizationServicesManager

Parameters:

name - - Name of the user

Returns:

WTUser - The user found, or null if none found with that name

Throws:

WTException

findLikeUsers

public Enumeration findLikeUsers(String attributeName,
 String pattern,
 DirectoryContextProvider context)
                          throws WTException

This API returns all the users matching the name provided as a pattern. For this API the attribute name would typically be "name". The pattern would be the user name that is being searched for. The pattern would also accept a wild card search. Org services package documentation has a detailed description on how to create a DirectoryContexttProvider that needs to be passed into this API.

Supported API: true

Specified by:

findLikeUsers in interface OrganizationServicesManager

Parameters:

attributeName -

pattern -

context -

Returns:

Enumeration

Throws:

WTException

findLikeUsers

public Enumeration findLikeUsers(String attributeName,
 String pattern)
                          throws WTException

This API returns all the users matching the name provided as a pattern. For this API the attribute name would typically be "name". The pattern would be the user name that is being searched for. The pattern would also accept a wild card search.

Supported API: true

Specified by:

findLikeUsers in interface OrganizationServicesManager

Parameters:

attributeName -

pattern -

Returns:

Enumeration

Throws:

WTException

delete

public WTUser delete(WTUser user)
              throws WTException

The API is used to delete a user object from the database and its corresponding entry in LDAP. Users are not completely deleted from the database. Instead when a user object is deleted, the correspodning user name in the database is renamed to the format of the user's object identifier and the disabled bit is set.

Supported API: true

Specified by:

delete in interface OrganizationServicesManager

Parameters:

user -

Returns:

WTUser

Throws:

WTException

getGroup

@Deprecated
public WTGroup getGroup(String name)
                 throws WTException

Deprecated.

Gets the group with the name passed as argument. Returns null if there is no such group.

Supported API: true

Specified by:

getGroup in interface OrganizationServicesManager

Parameters:

name -

Returns:

WTGroup

Throws:

WTException - {@link Deprecated. Use #getPrincipal(String name, WTContainer container, boolean persist) }

getGroup

public WTGroup getGroup(String name,
 DirectoryContextProvider context)
                 throws WTException

This method will search for groups whose name attribute matches the given name in the given directory context.

Supported API: true

Specified by:

getGroup in interface OrganizationServicesManager

Parameters:

name -

context -

Returns:

WTGroup

Throws:

WTException

getGroups

public Enumeration getGroups(String name,
 DirectoryContextProvider context)
                      throws WTException

Supported API: true

Specified by:

getGroups in interface OrganizationServicesManager

Parameters:

name -

context -

Returns:

Enumeration

Throws:

WTException

getGroups

public Enumeration getGroups(String name)
                      throws WTException

Supported API: true

Specified by:

getGroups in interface OrganizationServicesManager

Parameters:

name -

Returns:

Enumeration

Throws:

WTException

findLikeGroups

public Enumeration findLikeGroups(String pattern,
 DirectoryContextProvider context)
                           throws WTException

This method will search the given directory context for groups whose name matches the name pattern provided. The "pattern" parameter could be something like "name=group1" or "name=g*.

Supported API: true

Specified by:

findLikeGroups in interface OrganizationServicesManager

Parameters:

pattern -

context -

Returns:

Enumeration returns the groups whose name matches the pattern that is specified for name

Throws:

WTException

findLikeGroups

public Enumeration findLikeGroups(String pattern)
                           throws WTException

This method will search for groups whose name matches the name pattern provided. The "pattern" parameter could be something like "name=group1" or "name=g*.

Supported API: true

Specified by:

findLikeGroups in interface OrganizationServicesManager

Parameters:

pattern -

Returns:

Enumeration returns the groups whose name matches the pattern that is specified for name

Throws:

WTException

delete

public WTGroup delete(WTGroup group)
               throws WTException

The API is used to delete a group from the database and its corresponding entry in LDAP. Groups are not completely deleted from the database. Instead when a group is deleted, the corresponding group name in the database is renamed to the format of the groups's object identifier and the disabled bit is set.

Supported API: true

Specified by:

delete in interface OrganizationServicesManager

Parameters:

group -

Returns:

WTGroup

Throws:

WTException

addMember

public boolean addMember(WTGroup group,
 WTPrincipal principal)
                  throws WTException,
UserNotFoundException

Adds a principal to a group. Returns 'true' if principal was successfully added to the group, 'false' otherwise.

Supported API: true

Specified by:

addMember in interface OrganizationServicesManager

Parameters:

group -

principal -

Returns:

boolean

Throws:

WTException

UserNotFoundException

addMembers

public WTPrincipal[] addMembers(WTGroup group,
 WTPrincipal[] principals)
                         throws WTException

Adds principals to a group. Returns an array containing principals that were newly added as members of the group.. For the License group , it will check if the new members can be added. If all the Licenses of Named License group is already consumed, it will not allow to add member. In case of exception , while adding user to license group due to unavailability of license or available count, it checks if group is member of License Exclusion group, then computeAvailableCountForLicenseGroup() calculated the count.

Supported API: true

Specified by:

addMembers in interface OrganizationServicesManager

Parameters:

group -

principals -

Returns:

WTPrincipal[]

Throws:

WTException

removeMember

public boolean removeMember(WTGroup group,
 WTPrincipal principal)
                     throws WTException,
UserNotFoundException

Removes a principal from a group. Returns true if principal belonged to the group, false otherwise.

Supported API: true

Specified by:

removeMember in interface OrganizationServicesManager

Parameters:

group -

principal -

Returns:

boolean

Throws:

WTException

UserNotFoundException

isMember

public boolean isMember(LicenseGroups licenseGroup,
 WTPrincipal principal)
                 throws WTException

Check if this user is a member of this LicenseGroups instance.

Supported API: true

Specified by:

isMember in interface OrganizationServicesManager

Parameters:

licenseGroup - the LicenseGroups instance

principal - the user

Returns:

boolean

Throws:

WTException

isMember

public boolean isMember(ObjectIdentifier group,
 WTPrincipal principal,
 boolean cacheUser)
                 throws WTException

Check if this user is a member of this LicenseGroups instance.

Supported API: true

Specified by:

isMember in interface OrganizationServicesManager

Parameters:

group - the group instance

principal - the user

cacheUser -

Returns:

boolean

Throws:

WTException

isMember

public boolean isMember(WTGroup group,
 WTPrincipal principal)
                 throws WTException

Supported API: true

Specified by:

isMember in interface OrganizationServicesManager

Parameters:

group -

principal -

Returns:

boolean

Throws:

WTException

isMember

public boolean isMember(WTPrincipalReference group,
 WTPrincipal principal)
                 throws WTException

Supported API: true

Specified by:

isMember in interface OrganizationServicesManager

Parameters:

group -

principal -

Returns:

boolean

Throws:

WTException

members

public Enumeration members(WTGroup group)
                    throws WTException

This API takes a set of groups and retrieves all the direct members from the MembershipLink table. returns members in given group to reflect the user's current membership. Enumeration the members of the given group

Supported API: true

Specified by:

members in interface OrganizationServicesManager

Parameters:

group -

Returns:

Enumeration the members of the given group

Throws:

WTException

members

public Enumeration members(WTGroup group,
 boolean flatten)
                    throws WTException

This API takes a set of groups and retrieves all the direct members from the MembershipLink table. returns members in given group to reflect the user's current membership. If parameter flatten is true, it will recursively query all children or sub groups, but only return all WTUsers. If parameter flatten is false, it will return all the first level members, including WTUsers and WTGroups. Enumeration the members of the given group

Supported API: true

Specified by:

members in interface OrganizationServicesManager

Parameters:

group -

flatten -

Returns:

Enumeration the members of the given group

Throws:

WTException

getOrganization

public WTOrganization getOrganization(String name)
                               throws WTException

Get the organization by providing its name

Supported API: true

Specified by:

getOrganization in interface OrganizationServicesManager

Parameters:

name -

Returns:

WTOrganization

Throws:

WTException

findLikeOrganizations

public Enumeration findLikeOrganizations(String attributeName,
 String pattern)
                                  throws WTException

This API returns all the organizations matching the name provided as a pattern. For this API the attribute name would typically be "name". The pattern would be the organization name that is being searched for. The pattern would also accept a wild card search.

Supported API: true

Specified by:

findLikeOrganizations in interface OrganizationServicesManager

Parameters:

attributeName -

pattern -

Returns:

Enumeration

Throws:

WTException

findLikeOrganizations

@Deprecated
public Enumeration findLikeOrganizations(String attributeName,
 String pattern,
 DirectoryContextProvider context)
                                  throws WTException

Deprecated.

deprecated in release 12.1

This API returns all the organizations matching the name provided as a pattern. For this API the attribute name would typically be "name". The pattern would be the organization name that is being searched for. The pattern would also accept a wild card search.

Supported API: true

Specified by:

findLikeOrganizations in interface OrganizationServicesManager

Parameters:

attributeName -

pattern -

context -

Returns:

Enumeration

Throws:

WTException

findLikeOrganizations

public Enumeration findLikeOrganizations(String attributeName,
 String pattern,
 DirectoryContextProvider context,
 boolean querySubtree)
                                  throws WTException

This API returns all the organizations matching the name provided as a pattern. For this API the attribute name would typically be "name". The pattern would be the organization name that is being searched for. The pattern also accepts a wild card search. Typically organizations are stored directly in the default search base i.e. within a one level search scope of the base where organizations are searched. On some occasions, there could be a new search base that may be created as a sub node of the default search base, to hold all the organizations. In this case a subtree search scope is necessary to retrieve the organizations. So if the parameter querySubTree is set to true, it seaches with the search scope of subtree, else it searches with a default search scope of one-level.

Supported API: true

Specified by:

findLikeOrganizations in interface OrganizationServicesManager

Parameters:

attributeName -

pattern -

context -

querySubtree -

Returns:

Enumeration

Throws:

WTException

findLikeOrganizations

public Enumeration findLikeOrganizations(String attributeName,
 String pattern,
 DirectoryContextProvider context,
 boolean querySubtree,
 boolean applyAccessFilter)
                                  throws WTException

This API returns all the organizations matching the name provided as a pattern. For this API the attribute name would typically be "name". The pattern would be the organization name that is being searched for. The pattern also accepts a wild card search. Typically organizations are stored directly in the default search base i.e. within a one level search scope of the base where organizations are searched. On some occasions, there could be a new search base that may be created as a sub node of the default search base, to hold all the organizations. In this case a subtree search scope is necessary to retrieve the organizations. So if the parameter querySubTree is set to true, it seaches with the search scope of subtree, else it searches with a default search scope of one-level. If the boolean value applyAccessFilter is set to true, then the only organizations that the user has access to would be returned, else all organizations that match the search criteria would be returned.

Supported API: true

Specified by:

findLikeOrganizations in interface OrganizationServicesManager

Parameters:

attributeName -

pattern -

context -

querySubtree -

applyAccessFilter -

Returns:

Enumeration

Throws:

WTException

getDirectoryServiceNames

public String[] getDirectoryServiceNames()
                                  throws WTException

Supported API: true

Specified by:

getDirectoryServiceNames in interface OrganizationServicesManager

Returns:

String []

Throws:

WTException

repairPrincipal

public WTPrincipal repairPrincipal(String oldName,
 String newDn,
 String oldEnteredDn)
                            throws WTException

This method tries and repairs the principal given the "oldName" (name that is currently in the database and possibly will continue to be -- ie. only the UFID has changed) and the new DN (Distinguished name in the DIrectory).

Supported API: true

Specified by:

repairPrincipal in interface OrganizationServicesManager

Parameters:

oldName -

newDn -

oldEnteredDn -

Returns:

WTPrincipal

Throws:

WTException

newDirectoryContextProvider

public DirectoryContextProvider newDirectoryContextProvider(DirectoryContextProvider baseContext,
 String[] searchScopes)
                                                     throws WTException

Supported API: true

Specified by:

newDirectoryContextProvider in interface OrganizationServicesManager

Parameters:

baseContext -

searchScopes -

Returns:

DirectoryContextProvider

Throws:

WTException

newDirectoryContextProvider

public DirectoryContextProvider newDirectoryContextProvider(String[] services,
 String[] searchScopes)
                                                     throws WTException

Supported API: true

Specified by:

newDirectoryContextProvider in interface OrganizationServicesManager

Parameters:

services -

searchScopes -

Returns:

DirectoryContextProvider

Throws:

WTException

newDirectoryContextProviderForDataBaseRepository

public DirectoryContextProvider newDirectoryContextProviderForDataBaseRepository()
                                                                          throws WTException

Supported API: true

Specified by:

newDirectoryContextProviderForDataBaseRepository in interface OrganizationServicesManager

Returns:

DirectoryContextProvider

Throws:

WTException

removeMembers

public boolean removeMembers(WTGroup group,
 WTPrincipal[] principals)
                      throws WTException,
UserNotFoundException

Removes principals from a group. Returns true if principals belonged to the group, false otherwise.

Supported API: true

Specified by:

removeMembers in interface OrganizationServicesManager

Parameters:

group -

principals -

Returns:

boolean

Throws:

WTException

UserNotFoundException

findLikeActiveAndDisabledUsers

public Enumeration findLikeActiveAndDisabledUsers(Class principalClass,
 Map<String,List<String>> criteriaMap,
 DirectoryContextProvider[] contexts)
                                           throws WTException

This API returns an enumeration containing all the active and disabled users. 'criteriaMap' parameter has info similar to criteria but in a map format which supports multiple ; separated values and quoting is not needed The "criteria" parameter in deprecated API was something like "name=user1" or email="user1@email.com". Note that this parameter must use proper quoting (like name="some user") where spaces are involved and proper escaping when special characters are involved. Org services package documentation has a detailed description on how to create a DirectoryContextProvider that needs to be passed into this API.

Supported API: true

Specified by:

findLikeActiveAndDisabledUsers in interface OrganizationServicesManager

Parameters:

principalClass -

criteriaMap -

contexts -

Returns:

Enumeration

Throws:

WTException

findLikeActiveAndDisabledUsers

public Enumeration findLikeActiveAndDisabledUsers(Class principalClass,
 Map<String,List<String>> criteriaMap)
                                           throws WTException

This API returns an enumeration containing all the active and disabled users. 'criteriaMap' parameter has info similar to criteria but in a map format which supports multiple ; separated values and quoting is not needed The "criteria" parameter in deprecated API was something like "name=user1" or email="user1@email.com". Note that this parameter must use proper quoting (like name="some user") where spaces are involved and proper escaping when special characters are involved.

Supported API: true

Specified by:

findLikeActiveAndDisabledUsers in interface OrganizationServicesManager

Parameters:

principalClass -

criteriaMap -

Returns:

Enumeration

Throws:

WTException

findActiveAndDisabledUsersByName

public Enumeration findActiveAndDisabledUsersByName(Class<?> principalClass,
 String name,
 DirectoryContextProvider[] contexts)
                                             throws WTException

This API returns an enumeration containing all the active and disabled users with the given name. This is an easier-to-use convenience method wrapping findActiveAndDisabledUsersByName(java.lang.Class, java.lang.String, wt.org.DirectoryContextProvider[]) and doing all necessary quoting and escaping internally. Org services package documentation has a detailed description on how to create a DirectoryContextProvider that needs to be passed into this API.

Supported API: true

Specified by:

findActiveAndDisabledUsersByName in interface OrganizationServicesManager

Parameters:

principalClass -

name -

contexts -

Returns:

Enumeration

Throws:

WTException

findActiveAndDisabledUsersByName

public Enumeration findActiveAndDisabledUsersByName(Class<?> principalClass,
 String name)
                                             throws WTException

This API returns an enumeration containing all the active and disabled users with the given name.

Supported API: true

Specified by:

findActiveAndDisabledUsersByName in interface OrganizationServicesManager

Parameters:

principalClass -

name -

Returns:

Enumeration

Throws:

WTException

findLikeDisabledUsers

public Enumeration findLikeDisabledUsers(String criteria)
                                  throws WTException

Provides a result set of all disabled users that match the search criteria provided as a parameter. The search crteira should be along the lines "name = user1" or "name = u*" or "name=*"

Supported API: true

Specified by:

findLikeDisabledUsers in interface OrganizationServicesManager

Parameters:

criteria -

Returns:

Enumeration

Throws:

WTException

removeMember

public boolean removeMember(WTGroup group,
 WTPrincipal principal,
 boolean bValidate)
                     throws WTException,
UserNotFoundException

Removes a principal from a group. Returns true if principal belonged to the group, false otherwise.

Supported API: true

Specified by:

removeMember in interface OrganizationServicesManager

Parameters:

group -

principal -

bValidate - - This should always be set to true, when ivoking this method outside of org services. This is only set to false within org services when deleting a principal since there is no need to prevent additionally unnecessary checks.

Returns:

boolean

Throws:

WTException

UserNotFoundException

removeMembers

public boolean removeMembers(WTGroup group,
 WTPrincipal[] principals,
 boolean validate,
 boolean validateLicenseGroup)
                      throws WTException

Removes principals from a group. Returns true if principals belonged to the group, false otherwise. Also if Principal is removed from Named License group it will Checkin the License User is member of 2 groups and both are members of Named License, If user removed from one group , it will still consume the Named License.

Supported API: true

Specified by:

removeMembers in interface OrganizationServicesManager

Parameters:

group -

principals -

bValidate - This should always be set to true, when invoking this method outside of org services. This is only set to false within org services when deleting a principal since there is no need to prevent additionally unnecessary checks.

validateLicenseGroup - : This flag will decide to invoked LicenceBundled Group validation. Ideally this should always be set to true, when invoking this method outside of org services.

Returns:

boolean

Throws:

WTException

UserNotFoundException

removeMembers

public boolean removeMembers(WTGroup group,
 WTPrincipal[] principals,
 boolean bValidate)
                      throws WTException

Removes principals from a group. Returns true if principals belonged to the group, false otherwise. Also if Principal is removed from Named License group it will Checkin the License User is member of 2 groups and both are members of Named License, If user removed from one group , it will still consume the Named License.

Supported API: true

Specified by:

removeMembers in interface OrganizationServicesManager

Parameters:

group -

principals -

bValidate - This should always be set to true, when ivoking this method outside of org services. This is only set to false within org services when deleting a principal since there is no need to prevent additionally unnecessary checks.

Returns:

boolean

Throws:

WTException

UserNotFoundException

findDisabledUser

public WTUser findDisabledUser(long key)
                        throws WTException

This API can be used to query for a disabled user given the id value associated to the user object.

Supported API: true

Specified by:

findDisabledUser in interface OrganizationServicesManager

Parameters:

key -

Returns:

WTUser

Throws:

WTException