Package wt.org.delegate

Class ImportedUserByEmailIdMatchDelegate

java.lang.Object
wt.org.delegate.ImportedUserByEmailIdMatchDelegate
All Implemented Interfaces:
PrincipalMatchDelegate
public class ImportedUserByEmailIdMatchDelegate extends Object implements PrincipalMatchDelegate
Delegate for finding a user on the local system, matching the user referenced in the context replication data being imported.

This delegate implementation adheres to the contract elaborated in the PrincipalMatchDelegate interface. This delegate implementation is specifically for finding a match for a NON-DISABLED user in the import, using a pre-determined set of match rules. See the API match(WTPrincipal querySpec) in this class for specifics on the rules applied in this implementation.

IMPORTANT: The value of the Windchill preference User Email in Context Replication Deliveries set on the Source system, can impact the behavior of this delegate implementation (ImportedUserByEmailIdMatchDelegate) at the time of import. If this preference is set to No on the Source system, user email addresses are not included with the user information during delivery ZIP file creation. If Windchill systems exchanging data have this preference set to No, this delegate implementation should not be configured for finding matching users. That is because this delegate implementation relies on email addresses to identify the users.

For more information about configuring a delegate service for finding users on import, see the Windchill Customization Guide.

Supported API: true

Extendable: false
See Also:

  • Method Details

    • match

      public WTPrincipal match(WTPrincipal querySpec) throws WTException
      Finds a user in the local system with an email id matching that of the user being imported. The matching user is found based on values populated in the input principal, which acts as the query specification.

      The input query specification must be a WTUser object with the following field populated with a valid value, which will be used for finding a matching user:
      • email

      Following rules are applied in finding a matching user:
      • If a email is provided in querySpec, a non-disabled user (may be active, pending, or replicated) with a matching email id will be returned, if found
      • If no match is found, a NULL result will be returned
      • If no email can be read from the querySpec or if the querySpec is not a WTUser, a NULL result will be returned

      Exception conditions:
      • AmbiguousPrincipalException - If multiple matches are found
      Refer to the interface for the complete API contract: PrincipalMatchDelegate

      Supported API: true
      Specified by:
      match in interface PrincipalMatchDelegate
      Parameters:
      querySpec -
      Returns:
      Throws:
      WTException