wt.org
Interface OrganizationServicesManager

All Known Implementing Classes:

OrganizationServicesManagerFwd, StandardOrganizationServicesManager

public interface OrganizationServicesManager

Interface containing methods for querying and manipulating users and groups. These methods are executed in the server side.

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.
Enumeration	allGroups() Deprecated.
Enumeration	allUsers() Deprecated.
AttributeHolder	createAttributeHolder() Creates an object that implements the AttributeHolder interface.
AttributeHolder	createAttributeHolder(String name, String javaNamingProviderTag) Deprecated.
void	createNode(DirectoryInfrastructureNode node) Supported API: false
ArrayList	createPendingUser(String email) This method returns a WTUser with the passed in email address.
WTPrincipal	createPrincipal(WTPrincipal principal) Supported API: true
void	createSubtree(DirectorySubtree subtree) Supported API: false
WTGroup	delete(WTGroup group) Deleted the group passed as argument.
WTUser	delete(WTUser user) Supported API: true
void	deleteNode(DirectoryInfrastructureNode node) Supported API: false
void	deleteSubtree(DirectorySubtree subtree) Supported API: false
WTPrincipal	disablePrincipal(WTPrincipal principal) Supported API: false
WTPrincipal	enablePrincipal(WTPrincipal principal) Supported API: false
Enumeration	filterPrincipals(Enumeration principals, AccessPermission permission) Traverse an enumeration of principals applying access control rules.
Enumeration	findAllActiveAndDisabledGroups() Deprecated.
Enumeration	findAllActiveAndDisabledUsers() Deprecated.
Enumeration	findAllGroups(String[] services, boolean includeLocalService, boolean includeDisabled) Deprecated.
Enumeration	findAllGroups(String service, boolean includeDisabled) Deprecated.
Enumeration	findAllUsers(String[] services, boolean includeLocalService, boolean includeDisabled) Deprecated.
Enumeration	findAllUsers(String service, boolean includeDisabled) Deprecated.
Enumeration	findLikeActiveAndDisabledUsers(String attr_name, String attr_value) Deprecated.
Enumeration	findLikeGroup(String name) Deprecated.
Enumeration	findLikeGroups(String pattern, DirectoryContextProvider context) This method will search the given directory context for groups whose name matches the name parameter.
Enumeration	findLikeGroups(String name, String service) Deprecated.
Enumeration	findLikeGroups(String name, String[] services) Deprecated.
Enumeration	findLikeGroups(String name, String[] services, boolean includeLocalService, boolean includeDisabled) Deprecated.
Enumeration	findLikeNodes(String pattern, DirectoryContextProvider context) Supported API: false
Enumeration	findLikeOrganizations(String attributeName, String pattern, DirectoryContextProvider context) Supported API: true
Enumeration	findLikeOrganizations(String attributeName, String pattern, DirectoryContextProvider context, boolean querySubtree) Supported API: false
Enumeration	findLikeOrganizations(String attributeName, String pattern, DirectoryContextProvider context, boolean querySubtree, boolean applyAccessFilter) Supported API: false
Enumeration	findLikeUser(String attr_name, String attr_value) Deprecated.
Enumeration	findLikeUsers(String attributeName, String pattern, DirectoryContextProvider context) This method will search the given directory context for users with the given attribute matching the given pattern.
Enumeration	findLikeUsers(String attributeName, String pattern, String[] services) Deprecated.
Enumeration	findLikeUsers(String name, String fullName, String[] services, boolean includeLocalService, boolean includeDisabled) Deprecated.
Enumeration	findLikeUsers(String name, String fullName, String service, boolean includeDisabled) Deprecated.
Enumeration	findUser(String attr_name, String attr_value) Deprecated.
Enumeration	findUser(String attr_name, String attr_value, String service) Deprecated.
WTPrincipal	fixUfid(String newDn, WTPrincipal principal, String oldEnteredDn) Supported API: false
WTUser	getAuthenticatedUser(String auth_name) Supported API: true
String	getDefaultDirectoryService() Supported API: false
DirectoryService	getDirectoryService(String name) Supported API: false
String	getDirectoryServiceDn(String name) Supported API: false
String	getDirectoryServiceName(String name) Supported API: false
String	getDirectoryServiceNameByDn(String dn) Supported API: false
String[]	getDirectoryServiceNames() Supported API: true
String	getDirectoryServiceOfDn(String dn) Determine which directory service holds the entry identified by a specific distinguished name.
String	getDnForName(String name, Class principalClass, String service) Generate a distinguished name for a principal held by a specific service.
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.
WTGroup	getGroup(String name, String service) Deprecated.
Enumeration	getGroup(String name, String[] services) Deprecated.
Enumeration	getGroup(String name, String[] services, boolean includeLocalService) Deprecated.
Enumeration	getGroups(String name, DirectoryContextProvider context) Supported API: true
Enumeration	getGroups(String name, String[] services) Deprecated.
DirectoryInfrastructureNode	getNode(String name, DirectoryContextProvider context) Supported API: false
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
String	getOrganizationUniqueIdentifier(OrganizationOwned object) Returns organization unique identifier without applying access rules restrictions.
WTPrincipal	getPrincipal(ObjectIdentifier reference) Gets the user or group for the specified principal reference.
WTPrincipal	getPrincipal(String name) Deprecated.
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(String name, String service) Deprecated.
Enumeration	getPrincipal(String name, String[] services) Deprecated.
Enumeration	getPrincipal(String name, String[] services, boolean includeLocalService) Deprecated.
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) Deprecated.
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.
WTPrincipalReference	getPrincipalReference(String name, String service) Deprecated.
Enumeration	getPrincipalReference(String name, String[] services) Deprecated.
Enumeration	getPrincipalReference(String name, String[] services, boolean includeLocalService) Deprecated.
Enumeration	getSubordinates(WTOrganization organization) Supported API: false
WTOrganization	getSuperior(WTOrganization organization) Supported API: false
String	getUfid(WTPrincipal principal) Returns the Unique Federation Identifier of a principal.
WTUser	getUser(String name) Deprecated.
WTUser	getUser(String name, DirectoryContextProvider context) Supported API: true
WTUser	getUser(String name, String service) Deprecated.
Enumeration	getUser(String name, String[] services) Deprecated.
Enumeration	getUser(String name, String[] services, boolean includeLocalService) Deprecated.
Hashtable	getUserElectronicIdentification(boolean getAll, WTUser a_user) Supported API: false
Hashtable	getUserElectronicIdentificationInfo(boolean getAll, WTUser a_user) Null if no objects found.
Enumeration	getUserLanguages() Returns the available languages for users.
Enumeration	getUsers(String name, DirectoryContextProvider context) Supported API: true
Enumeration	getUsers(String name, String[] services) Deprecated.
WTPrincipal	inflate(WTPrincipal principal) Supported API: false
WTPrincipal	inflate(WTPrincipalReference ref) Supported API: false
boolean	isMember(ObjectIdentifier group, WTPrincipal principal) Supported API: false
boolean	isMember(WTGroup group, WTPrincipal principal) Supported API: true
boolean	isMember(WTPrincipalReference group, WTPrincipal principal) Supported API: true
Vector	listOfInvalidPrincipals() This method returns all WTPrincipals in which the Ufid is no longer valid.
Enumeration	mapPrincipals(Enumeration principals, String service) Map an enumeration of Info*Engine Elements representing a set of principals to an enumeration of WTPrincipal objects.
Enumeration	members(WTGroup group) Supported API: true
Enumeration	members(WTGroup group, boolean flatten) Supported API: true
DirectoryInfrastructureNode	move(DirectoryInfrastructureNode node, DirectoryContextProvider newContext) Moves a directory infrastructure node to a new location and updates the UFID's of all principals that are subordinate to it.
WTPrincipal	move(WTPrincipal principal, DirectoryContextProvider newContext) Supported API: true
DirectoryContextProvider	newDirectoryContextProvider(DirectoryContextProvider baseContext, String[] searchScopes) Supported API: true
DirectoryContextProvider	newDirectoryContextProvider(DirectoryInfrastructureNode node) Supported API: false
DirectoryContextProvider	newDirectoryContextProvider(DirectorySubtree subtree) Supported API: false
DirectoryContextProvider	newDirectoryContextProvider(String[] services, String[] searchScopes) Supported API: true
Map	parentGroupMap(WTPrincipal principal) Returns a map identifying all of the groups of which a specified principal is a member.
Enumeration	parentGroups(WTPrincipal principal) Supported API: true
Enumeration	parentGroups(WTPrincipal principal, boolean flatten) Returns groups that the argument principal is a member of.
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.
DirectoryInfrastructureNode	rename(DirectoryInfrastructureNode node, String newName) Renames a directory infrastructure node and updates the UFID's of all principals that are subordinate to it.
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	savePrincipal(WTPrincipal principal) Deprecated.
ObjectReference	setUserElectronicIdentificationEnabled(ObjectReference objReference, boolean active) Sets the electronic identification object Active or InActive.
String[]	translateAttributeNames(String service, String[] attributeKeys, String[] defaultAttributeNames) Supported API: false
WTPrincipal	updatePrincipal(WTPrincipal principal) Supported API: true
boolean	validateDn(String dn, String service) Validate the given distinguished name with the service within the directory.
boolean	validDirectoryEntry(WTPrincipal principal) This method invokes a task to find if the given Principal has a valid Directory entry.

Method Detail

getPrincipal

public WTPrincipal getPrincipal(String name)
                         throws WTException

Deprecated.

Searches all services for the user or group with the name passed as argument. Returns null if there is no user or group with such a name. This method will throw an OrganizationServicesException if multiple results are found.

Supported API: false

Parameters:

name -

Returns:

WTPrincipal

Throws:

WTException

getPrincipal

public WTPrincipal getPrincipal(ObjectIdentifier reference)
                         throws WTException

Gets the user or group for the specified principal reference.

Supported API: true

Parameters:

reference -

Returns:

WTPrincipal

Throws:

WTException

getPrincipal

public WTPrincipal getPrincipal(String name,
                                String service)
                         throws WTException

Deprecated.

This method will search for the principal with the given name in the given service.

Supported API: false

Parameters:

name -

service -

Returns:

WTPrincipal

Throws:

WTException

getPrincipal

public Enumeration getPrincipal(String name,
                                String[] services,
                                boolean includeLocalService)
                         throws WTException

Deprecated.

This method will search for principals with the given name in the given federated services. If includeLocalService is true, then the local database will also be searched.

Supported API: false

Parameters:

name -

services -

includeLocalService -

Returns:

Enumeration

Throws:

WTException

getPrincipal

public Enumeration getPrincipal(String name,
                                String[] services)
                         throws WTException

Deprecated.

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

Supported API: false

Parameters:

name -

services -

Returns:

Enumeration

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

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

Parameters:

name -

type -

context -

Returns:

WTPrincipal

Throws:

WTException

getPrincipalByDN

public WTPrincipal getPrincipalByDN(String dn)
                             throws WTException

Returns the principal identified by a specific directory distinguished name, or null if no such principal exists.

Supported API: true

Parameters:

dn -

Returns:

WTPrincipal

Throws:

WTException

getPrincipalReference

public WTPrincipalReference getPrincipalReference(String name)
                                           throws WTException

Deprecated.

Returns a reference to a principal, given the name.

Supported API: false

Parameters:

name -

Returns:

WTPrincipalReference

Throws:

WTException

getPrincipalReference

public WTPrincipalReference getPrincipalReference(String name,
                                                  String service)
                                           throws WTException

Deprecated.

This method will search for the principal with the given name in the given service, and a reference to it will be returned.

Supported API: false

Parameters:

name -

service -

Returns:

WTPrincipalReference

Throws:

WTException

getPrincipalReference

public Enumeration getPrincipalReference(String name,
                                         String[] services,
                                         boolean includeLocalService)
                                  throws WTException

Deprecated.

This method will search for principals with the given name in the given federated services, and references to them will be returned. If includeLocalService is true, then the local database will also be searched.

Supported API: false

Parameters:

name -

services -

includeLocalService -

Returns:

Enumeration

Throws:

WTException

getPrincipalReference

public Enumeration getPrincipalReference(String name,
                                         String[] services)
                                  throws WTException

Deprecated.

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

Supported API: false

Parameters:

name -

services -

Returns:

Enumeration

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

Parameters:

name -

context -

Returns:

Enumeration

Throws:

WTException

getPrincipalReference

public WTPrincipalReference getPrincipalReference(String name,
                                                  Class type,
                                                  DirectoryContextProvider context)
                                           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

Parameters:

name -

type -

context -

Returns:

WTPrincipalReference

Throws:

WTException

inflate

public WTPrincipal inflate(WTPrincipal principal)
                    throws WTException

Supported API: false

Parameters:

principal -

Returns:

WTPrincipal

Throws:

WTException

inflate

public WTPrincipal inflate(WTPrincipalReference ref)
                    throws WTException

Supported API: false

Parameters:

ref -

Returns:

WTPrincipal

Throws:

WTException

queryPrincipals

public Enumeration queryPrincipals(Class principalClass,
                                   String criteria,
                                   DirectoryContextProvider context)
                            throws WTException

Supported API: true

Parameters:

principalClass -

criteria -

context -

Returns:

Enumeration

Throws:

WTException

queryPrincipals

public Enumeration queryPrincipals(Class principalClass,
                                   String criteria,
                                   DirectoryContextProvider[] contexts)
                            throws WTException

Supported API: true

Parameters:

principalClass -

criteria -

contexts -

Returns:

Enumeration

Throws:

WTException

createPrincipal

public WTPrincipal createPrincipal(WTPrincipal principal)
                            throws WTException

Supported API: true

Parameters:

principal -

Returns:

WTPrincipal

Throws:

WTException

disablePrincipal

public WTPrincipal disablePrincipal(WTPrincipal principal)
                             throws WTException

Supported API: false

Parameters:

principal -

Returns:

WTPrincipal

Throws:

WTException

enablePrincipal

public WTPrincipal enablePrincipal(WTPrincipal principal)
                            throws WTException

Supported API: false

Parameters:

principal -

Returns:

WTPrincipal

Throws:

WTException

updatePrincipal

public WTPrincipal updatePrincipal(WTPrincipal principal)
                            throws WTException

Supported API: true

Parameters:

principal -

Returns:

WTPrincipal

Throws:

WTException

savePrincipal

public WTPrincipal savePrincipal(WTPrincipal principal)
                          throws WTException

Deprecated.

Saves the user or group passed as argument.

Supported API: false

Parameters:

principal -

Returns:

WTPrincipal

Throws:

WTException

mapPrincipals

public Enumeration mapPrincipals(Enumeration principals,
                                 String service)
                          throws WTException

Map an enumeration of Info*Engine Elements representing a set of principals to an enumeration of WTPrincipal objects. Normally, the enumeration of Info*Engine Elements is obtained by querying an LDAP directory using the Info*Engine JNDI adapter.

Supported API: false

Parameters:

principals -

service -

Returns:

Enumeration

Throws:

WTException

filterPrincipals

public Enumeration filterPrincipals(Enumeration principals,
                                    AccessPermission permission)
                             throws WTException

Traverse an enumeration of principals applying access control rules. Return the principals to which a specified permission applies, and discard the ones to which it does not apply. For example, this method can be used to filter out principals that the caller is not allowed to read.

Supported API: false

Parameters:

principals -

permission -

Returns:

Enumeration

Throws:

WTException

rename

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

Supported API: true

Parameters:

principal -

newName -

Returns:

WTPrincipal

Throws:

WTException

move

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

Supported API: true

Parameters:

principal -

newContext -

Returns:

WTPrincipal

Throws:

WTException

getAuthenticatedUser

public WTUser getAuthenticatedUser(String auth_name)
                            throws WTException

Supported API: true

Parameters:

auth_name -

Returns:

WTUser

Throws:

WTException

getUser

public WTUser getUser(String name)
               throws WTException

Deprecated.

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

Supported API: false

Parameters:

name -

Returns:

WTUser

Throws:

WTException

getUser

public WTUser getUser(String name,
                      String service)
               throws WTException

Deprecated.

This method will search for the user whose name attribute matches the given name in the given service.

Supported API: false

Parameters:

name -

service -

Returns:

WTUser

Throws:

WTException

getUser

public Enumeration getUser(String name,
                           String[] services,
                           boolean includeLocalService)
                    throws WTException

Deprecated.

This method will search for users whose name attribute matches the given name in the given federated services. If includeLocalService is true, then the local database will also be searched.

Supported API: false

Parameters:

name -

services -

includeLocalService -

Returns:

Enumeration

Throws:

WTException

getUser

public Enumeration getUser(String name,
                           String[] services)
                    throws WTException

Deprecated.

This method will search for users whose name attribute matches the given name in the given services.

Supported API: false

Parameters:

name -

services -

Returns:

Enumeration

Throws:

WTException

getUser

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

Supported API: true

Parameters:

name -

context -

Returns:

WTUser

Throws:

WTException

getUsers

public Enumeration getUsers(String name,
                            String[] services)
                     throws WTException

Deprecated.

Supported API: false

Parameters:

name -

services -

Returns:

Enumeration

Throws:

WTException

getUsers

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

Supported API: true

Parameters:

name -

context -

Returns:

Enumeration

Throws:

WTException

findUser

public Enumeration findUser(String attr_name,
                            String attr_value)
                     throws WTException

Deprecated.

Finds all users in all services that have the given value for the specified attribute.

Supported API: false

Parameters:

attr_name -

attr_value -

Returns:

Enumeration

Throws:

WTException

findUser

public Enumeration findUser(String attr_name,
                            String attr_value,
                            String service)
                     throws WTException

Deprecated.

Finds all users in the given service that have the given value for the specified attribute.

Supported API: false

Parameters:

attr_name -

attr_value -

service -

Returns:

Enumeration

Throws:

WTException

findLikeUser

public Enumeration findLikeUser(String attr_name,
                                String attr_value)
                         throws WTException

Deprecated.

Finds all users in all services that the attribute matches the given value (string matching).

Supported API: false

Parameters:

attr_name -

attr_value -

Returns:

Enumeration

Throws:

WTException

findLikeUsers

public Enumeration findLikeUsers(String name,
                                 String fullName,
                                 String service,
                                 boolean includeDisabled)
                          throws WTException

Deprecated.

This method will search the given services for users whose userID matches the name parameter or whose userName matches the fullName parameter.

Supported API: false

Parameters:

name -

fullName -

service -

includeDisabled -

Returns:

Enumeration

Throws:

WTException

findLikeUsers

public Enumeration findLikeUsers(String name,
                                 String fullName,
                                 String[] services,
                                 boolean includeLocalService,
                                 boolean includeDisabled)
                          throws WTException

Deprecated.

This method will search the federated services for users whose userID matches the name parameter or whose userName matches the fullName parameter. If includeLocalServices is true, then the local service will also be searched. If includeDisabled is true, then disabled users will also be included in the search results. The elements in the Enumeration should be of type String.

Supported API: false

Parameters:

name -

fullName -

services -

includeLocalService -

includeDisabled -

Returns:

Enumeration

Throws:

WTException

findLikeUsers

public Enumeration findLikeUsers(String attributeName,
                                 String pattern,
                                 String[] services)
                          throws WTException

Deprecated.

This method will search the given services for users with the given attribute matching the given pattern.

Supported API: false

Parameters:

attributeName -

pattern -

services -

Returns:

Enumeration

Throws:

WTException

findLikeUsers

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

This method will search the given directory context for users with the given attribute matching the given pattern.

Supported API: true

Parameters:

attributeName -

pattern -

context -

Returns:

Enumeration

Throws:

WTException

findLikeActiveAndDisabledUsers

public Enumeration findLikeActiveAndDisabledUsers(String attr_name,
                                                  String attr_value)
                                           throws WTException

Deprecated.

Finds all users in all services that the attribute matches the given value (string matching), including users that have been disabled.

Supported API: false

Parameters:

attr_name -

attr_value -

Returns:

Enumeration

Throws:

WTException

allUsers

public Enumeration allUsers()
                     throws WTException

Deprecated.

Returns all the users defined in all services.

Supported API: false

Returns:

Enumeration

Throws:

WTException

findAllUsers

public Enumeration findAllUsers(String service,
                                boolean includeDisabled)
                         throws WTException

Deprecated.

This method will search the given service for all users. If includeDisabled is true, then disabled users will be included in the search results.

Supported API: false

Parameters:

service -

includeDisabled -

Returns:

Enumeration

Throws:

WTException

findAllUsers

public Enumeration findAllUsers(String[] services,
                                boolean includeLocalService,
                                boolean includeDisabled)
                         throws WTException

Deprecated.

This method will search the given federated services for all users. If includeLocalServices is true, then the local service will also be searched. If includeDisabled is true, then disabled users will be included in the search results. The elements in the Enumeration should be of type String.

Supported API: false

Parameters:

services -

includeLocalService -

includeDisabled -

Returns:

Enumeration

Throws:

WTException

findAllActiveAndDisabledUsers

public Enumeration findAllActiveAndDisabledUsers()
                                          throws WTException

Deprecated.

Returns all the users in all services, including users that have been disabled.

Supported API: false

Returns:

Enumeration

Throws:

WTException

delete

public WTUser delete(WTUser user)
              throws WTException

Supported API: true

Parameters:

user -

Returns:

WTUser

Throws:

WTException

getGroup

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: false

Parameters:

name -

Returns:

WTGroup

Throws:

WTException

getGroup

public WTGroup getGroup(String name,
                        String service)
                 throws WTException

Deprecated.

This method will search for the group whose name attribute matches the given name in the given service.

Supported API: false

Parameters:

name -

service -

Returns:

WTGroup

Throws:

WTException

getGroup

public Enumeration getGroup(String name,
                            String[] services,
                            boolean includeLocalService)
                     throws WTException

Deprecated.

This method will search for groups whose name attribute matches the given name in the given federated services. If includeLocalService is true, then the local database will also be searched.

Supported API: false

Parameters:

name -

services -

includeLocalService -

Returns:

Enumeration

Throws:

WTException

getGroup

public Enumeration getGroup(String name,
                            String[] services)
                     throws WTException

Deprecated.

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

Supported API: false

Parameters:

name -

services -

Returns:

Enumeration

Throws:

WTException

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

Parameters:

name -

context -

Returns:

WTGroup

Throws:

WTException

getGroups

public Enumeration getGroups(String name,
                             String[] services)
                      throws WTException

Deprecated.

Supported API: false

Parameters:

name -

services -

Returns:

Enumeration

Throws:

WTException

getGroups

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

Supported API: true

Parameters:

name -

context -

Returns:

Enumeration

Throws:

WTException

findLikeGroup

public Enumeration findLikeGroup(String name)
                          throws WTException

Deprecated.

Finds all groups in all services that the name matches the given value (string matching).

Supported API: false

Parameters:

name -

Returns:

Enumeration

Throws:

WTException

findLikeGroups

public Enumeration findLikeGroups(String name,
                                  String service)
                           throws WTException

Deprecated.

This method will search the given service for groups whose name matches the name parameter.

Supported API: false

Parameters:

name -

service -

Returns:

Enumeration

Throws:

WTException

findLikeGroups

public Enumeration findLikeGroups(String name,
                                  String[] services,
                                  boolean includeLocalService,
                                  boolean includeDisabled)
                           throws WTException

Deprecated.

This method will search the given federated services for groups whose name matches the name parameter. If includeLocalServices is true, then the local service will also be searched. If includeDisabled is true, then disabled groups will also be included in the search results. The elements in the Enumeration should be of type String.

Supported API: false

Parameters:

name -

services -

includeLocalService -

includeDisabled -

Returns:

Enumeration

Throws:

WTException

findLikeGroups

public Enumeration findLikeGroups(String name,
                                  String[] services)
                           throws WTException

Deprecated.

This method will search the given services for groups whose name matches the name parameter.

Supported API: false

Parameters:

name -

services -

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

Supported API: true

Parameters:

pattern -

context -

Returns:

Enumeration

Throws:

WTException

allGroups

public Enumeration allGroups()
                      throws WTException

Deprecated.

Returns all the groups defined in all services.

Supported API: false

Returns:

Enumeration

Throws:

WTException

findAllGroups

public Enumeration findAllGroups(String service,
                                 boolean includeDisabled)
                          throws WTException

Deprecated.

This method will search the given service for all groups. If includeDisabled is true, then disabled groups will also be included in the search results.

Supported API: false

Parameters:

service -

includeDisabled -

Returns:

Enumeration

Throws:

WTException

findAllGroups

public Enumeration findAllGroups(String[] services,
                                 boolean includeLocalService,
                                 boolean includeDisabled)
                          throws WTException

Deprecated.

This method will search the given federated services for all groups. If includeLocalServices is true, then the local service will also be searched. If includeDisabled is true, then disabled groups will also be included in the search results.

Supported API: false

Parameters:

services -

includeLocalService -

includeDisabled -

Returns:

Enumeration

Throws:

WTException

findAllActiveAndDisabledGroups

public Enumeration findAllActiveAndDisabledGroups()
                                           throws WTException

Deprecated.

Returns all the groups in the system, including groups that have been disabled.

Supported API: false

Returns:

Enumeration

Throws:

WTException

delete

public WTGroup delete(WTGroup group)
               throws WTException

Deleted the group passed as argument.

Supported API: true

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 didn't belong to the group; 'false' otherwise.

Supported API: true

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 the principals that were not already members of the group..

Supported API: true

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

Parameters:

group -

principal -

Returns:

boolean

Throws:

WTException

UserNotFoundException

isMember

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

Supported API: true

Parameters:

group -

principal -

Returns:

boolean

Throws:

WTException

isMember

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

Supported API: true

Parameters:

group -

principal -

Returns:

boolean

Throws:

WTException

isMember

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

Supported API: false

Parameters:

group -

principal -

Returns:

boolean

Throws:

WTException

members

public Enumeration members(WTGroup group)
                    throws WTException

Supported API: true

Parameters:

group -

Returns:

Enumeration

Throws:

WTException

members

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

Supported API: true

Parameters:

group -

flatten -

Returns:

Enumeration

Throws:

WTException

parentGroups

public Enumeration parentGroups(WTPrincipal principal)
                         throws WTException

Supported API: true

Parameters:

principal -

Returns:

Enumeration

Throws:

WTException

parentGroupMap

public Map parentGroupMap(WTPrincipal principal)
                   throws WTException

Returns a map identifying all of the groups of which a specified principal is a member. Each value in the map is a WTPrincipalReference that references a parent group. Each key is the ObjectIdentifier of the parent group.

Supported API: false

Parameters:

principal -

Returns:

Map

Throws:

WTException

getOrganization

public WTOrganization getOrganization(WTPrincipal principal)
                               throws WTException

Returns the organization with which a principal is associated.

Supported API: true

Parameters:

principal -

Returns:

WTOrganization

Throws:

WTException

getOrganization

public WTOrganization getOrganization(String name,
                                      DirectoryContextProvider context)
                               throws WTException

Supported API: true

Parameters:

name -

context -

Returns:

WTOrganization

Throws:

WTException

getOrganizations

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

Supported API: true

Parameters:

name -

context -

Returns:

Enumeration

Throws:

WTException

findLikeOrganizations

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

Supported API: true

Parameters:

attributeName -

pattern -

context -

Returns:

Enumeration

Throws:

WTException

findLikeOrganizations

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

Supported API: false

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

Supported API: false

Parameters:

attributeName -

pattern -

context -

querySubtree -

applyAccessFilter -

Returns:

Enumeration

Throws:

WTException

getSuperior

public WTOrganization getSuperior(WTOrganization organization)
                           throws WTException

Supported API: false

Parameters:

organization -

Returns:

WTOrganization

Throws:

WTException

getSubordinates

public Enumeration getSubordinates(WTOrganization organization)
                            throws WTException

Supported API: false

Parameters:

organization -

Returns:

Enumeration

Throws:

WTException

getDirectoryService

public DirectoryService getDirectoryService(String name)
                                     throws WTException

Supported API: false

Parameters:

name -

Returns:

DirectoryService

Throws:

WTException

getDirectoryServiceNames

public String[] getDirectoryServiceNames()
                                  throws WTException

Supported API: true

Returns:

String []

Throws:

WTException

getDirectoryServiceName

public String getDirectoryServiceName(String name)
                               throws WTException

Supported API: false

Parameters:

name -

Returns:

String

Throws:

WTException

getDirectoryServiceNameByDn

public String getDirectoryServiceNameByDn(String dn)
                                   throws WTException

Supported API: false

Parameters:

dn -

Returns:

String

Throws:

WTException

getDirectoryServiceDn

public String getDirectoryServiceDn(String name)
                             throws WTException

Supported API: false

Parameters:

name -

Returns:

String

Throws:

WTException

getDirectoryServiceOfDn

public String getDirectoryServiceOfDn(String dn)
                               throws WTException

Determine which directory service holds the entry identified by a specific distinguished name.

Supported API: false

Parameters:

dn -

Returns:

String

Throws:

WTException

getDefaultDirectoryService

public String getDefaultDirectoryService()
                                  throws WTException

Supported API: false

Returns:

String

Throws:

WTException

getDnForName

public String getDnForName(String name,
                           Class principalClass,
                           String service)
                    throws WTException

Generate a distinguished name for a principal held by a specific service.

Supported API: false

Parameters:

name -

principalClass -

service -

Returns:

String

Throws:

WTException

createAttributeHolder

public AttributeHolder createAttributeHolder()
                                      throws WTException

Creates an object that implements the AttributeHolder interface.

Supported API: false

Returns:

AttributeHolder

Throws:

WTException

createAttributeHolder

public AttributeHolder createAttributeHolder(String name,
                                             String javaNamingProviderTag)
                                      throws WTException

Deprecated.

Creates an object that implements the AttributeHolder interface.

Supported API: false

Parameters:

name -

javaNamingProviderTag -

Returns:

AttributeHolder

Throws:

WTException

getUserLanguages

public Enumeration getUserLanguages()
                             throws WTException

Returns the available languages for users. Defaults to US English if no language property is defined.

Supported API: false

Returns:

Enumeration

Throws:

WTException

setUserElectronicIdentificationEnabled

public ObjectReference setUserElectronicIdentificationEnabled(ObjectReference objReference,
                                                              boolean active)
                                                       throws WTPropertyVetoException,
                                                              WTException

Sets the electronic identification object Active or InActive. Returns an ObjectReference to the electronic identification in the parameter list.

Supported API: false

Parameters:

objReference - An ObjectReference to the electronic identification object.

active - boolean value to set the ObjectReference Active or InActive.

Returns:

ObjectReference

Throws:

WTPropertyVetoException

WTException

getUserElectronicIdentificationInfo

public Hashtable getUserElectronicIdentificationInfo(boolean getAll,
                                                     WTUser a_user)
                                              throws PropertyVetoException,
                                                     QueryException,
                                                     WTException

Null if no objects found. A hastable containing a reference to the ElectronicSignature and necessary display information.

Supported API: false

Parameters:

getAll - (true) Gets all electronic identification object References for a user

a_user -

Returns:

Hashtable

Throws:

PropertyVetoException

QueryException

WTException

getUserElectronicIdentification

public Hashtable getUserElectronicIdentification(boolean getAll,
                                                 WTUser a_user)
                                          throws QueryException,
                                                 WTException

Supported API: false

Parameters:

getAll - getAll (true) Gets all electronic identification objects for a user

a_user -

Returns:

Hashtable

Throws:

QueryException

WTException

createPendingUser

public ArrayList createPendingUser(String email)
                            throws WTException

This method returns a WTUser with the passed in email address. If a single WTUser object exists with this, then this user is returned. If multiple WTUser objects exist in the database with this email then all WTUser objects with the matching email are returned in the ArrayList. If there does not exist a persistent user with the passed in email then a pending user is created and returned. This user is eventually resolved to a real user when a user with this email address is found to be registered in one of Windchills directory services.

Supported API: false

Parameters:

email -

Returns:

ArrayList

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

Parameters:

oldName -

newDn -

oldEnteredDn -

Returns:

WTPrincipal

Throws:

WTException

validateDn

public boolean validateDn(String dn,
                          String service)
                   throws WTException

Validate the given distinguished name with the service within the directory.

Supported API: false

Parameters:

dn -

service -

Returns:

boolean

Throws:

WTException

fixUfid

public WTPrincipal fixUfid(String newDn,
                           WTPrincipal principal,
                           String oldEnteredDn)
                    throws WTException

Supported API: false

Parameters:

newDn -

principal -

oldEnteredDn -

Returns:

WTPrincipal

Throws:

WTException

listOfInvalidPrincipals

public Vector listOfInvalidPrincipals()
                               throws WTException

This method returns all WTPrincipals in which the Ufid is no longer valid.

Supported API: false

Returns:

Vector

Throws:

WTException

validDirectoryEntry

public boolean validDirectoryEntry(WTPrincipal principal)
                            throws WTException

This method invokes a task to find if the given Principal has a valid Directory entry. It returns true if the Principal is associated with a valid Directory entry, false if not.

Supported API: false

Parameters:

principal -

Returns:

boolean

Throws:

WTException

getUfid

public String getUfid(WTPrincipal principal)
               throws WTException

Returns the Unique Federation Identifier of a principal.

Supported API: false

Parameters:

principal -

Returns:

String

Throws:

WTException

translateAttributeNames

public String[] translateAttributeNames(String service,
                                        String[] attributeKeys,
                                        String[] defaultAttributeNames)
                                 throws WTException

Supported API: false

Parameters:

service -

attributeKeys -

defaultAttributeNames -

Returns:

String[]

Throws:

WTException

createNode

public void createNode(DirectoryInfrastructureNode node)
                throws WTException

Supported API: false

Parameters:

node -

Throws:

WTException

deleteNode

public void deleteNode(DirectoryInfrastructureNode node)
                throws WTException

Supported API: false

Parameters:

node -

Throws:

WTException

getNode

public DirectoryInfrastructureNode getNode(String name,
                                           DirectoryContextProvider context)
                                    throws WTException

Supported API: false

Parameters:

name -

context -

Returns:

DirectoryInfrastructureNode

Throws:

WTException

findLikeNodes

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

Supported API: false

Parameters:

pattern -

context -

Returns:

Enumeration

Throws:

WTException

rename

public DirectoryInfrastructureNode rename(DirectoryInfrastructureNode node,
                                          String newName)
                                   throws WTException

Renames a directory infrastructure node and updates the UFID's of all principals that are subordinate to it.

Supported API: false

Parameters:

node -

newName -

Returns:

DirectoryInfrastructureNode

Throws:

WTException

move

public DirectoryInfrastructureNode move(DirectoryInfrastructureNode node,
                                        DirectoryContextProvider newContext)
                                 throws WTException

Moves a directory infrastructure node to a new location and updates the UFID's of all principals that are subordinate to it.

Supported API: false

Parameters:

node -

newContext -

Returns:

DirectoryInfrastructureNode

Throws:

WTException

createSubtree

public void createSubtree(DirectorySubtree subtree)
                   throws WTException

Supported API: false

Parameters:

subtree -

Throws:

WTException

deleteSubtree

public void deleteSubtree(DirectorySubtree subtree)
                   throws WTException

Supported API: false

Parameters:

subtree -

Throws:

WTException

newDirectoryContextProvider

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

Supported API: true

Parameters:

baseContext -

searchScopes -

Returns:

DirectoryContextProvider

Throws:

WTException

newDirectoryContextProvider

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

Supported API: true

Parameters:

services -

searchScopes -

Returns:

DirectoryContextProvider

Throws:

WTException

newDirectoryContextProvider

public DirectoryContextProvider newDirectoryContextProvider(DirectoryInfrastructureNode node)
                                                     throws WTException

Supported API: false

Parameters:

node -

Returns:

DirectoryContextProvider

Throws:

WTException

newDirectoryContextProvider

public DirectoryContextProvider newDirectoryContextProvider(DirectorySubtree subtree)
                                                     throws WTException

Supported API: false

Parameters:

subtree -

Returns:

DirectoryContextProvider

Throws:

WTException

getOrganizationUniqueIdentifier

public String getOrganizationUniqueIdentifier(OrganizationOwned object)
                                       throws WTException

Returns organization unique identifier without applying access rules restrictions. This method is providing information about organization unique identifier for users, who have access to Organization Owned object, but may have no access to a particular organization, associated to the object.

Supported API: false

Parameters:

object -

Returns:

String

Throws:

WTException

parentGroups

public Enumeration parentGroups(WTPrincipal principal,
                                boolean flatten)
                         throws WTException

Returns groups that the argument principal is a member of. If the flatten variable is false, parentGroups will return only the immediate parent groups, otherwise all nested parent groups will be returned.

Supported API: false

Parameters:

principal -

flatten - If false, only immediate parent groups will be returned If true, all nested groups for which principal is a member will be returned, e.g. the parent groups of principal's parent groups, and the parent groups of those groups, etc.,

Returns:

Enumeration

Throws:

WTException