Package wt.org

Interface DirectoryContextProvider

All Known Implementing Classes:
wt.org._WTOrganization, GenericDirectoryContextProvider, WTOrganization
public interface DirectoryContextProvider
This interface provides a set of APIs which could be used to implement the necessary functionality of performing CRUD operations on participants within a given directory context. In addition this interface also contains API definitions that should be used to perform CRUD operations on system groups within a specific context.

Supported API: true

Extendable: false

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getCreationBase(String service)
    This API should be used to retrieve the base in LDAP where the participant nodes need to be created.
    String
    getPrimaryService()
    This API will return the primary directory service name defined in wt.properties.
    String
    getSearchBase(String service)
    This API should be used to retrieve the base distinguished name in LDAP where participants can be searched.
    String
    getSearchCriteria(String service, Class principalClass)
    This API is used to retrieve the actual filter if any, that needs to be applied while searching for participants within a specific search base.
    Enumeration
    getSearchCriteriaClasses(String service)
    This API is used to retrieve the type of object classes which are part of the search criteria defined if any, while searching for participants within a specific search base.
    String
    getSearchScope(String service)
    LDAP allows the following 3 different kinds to scopes for searches 1) base 2) onelevel 3) subtree This API returns the current scope that is set on all the searches being done within the context for which the Directory Context Provider is formulated.
    int
    getSizeLimit(String service)
    This API will return the results size limit that could be returned from LDAP for any specific search.
    String[]
    getSupportingServices()
    This API will return all the secondary directory service names that correspond to the JNDI adapters defined in Info* Engine

    Supported API: true

  • Method Details

    • getCreationBase

      String getCreationBase(String service) throws WTException
      This API should be used to retrieve the base in LDAP where the participant nodes need to be created.

      Supported API: true
      Parameters:
      service -
      Returns:
      String
      Throws:
      WTException

    • getPrimaryService

      String getPrimaryService() throws WTException
      This API will return the primary directory service name defined in wt.properties.

      Supported API: true
      Returns:
      String
      Throws:
      WTException

    • getSearchBase

      String getSearchBase(String service) throws WTException
      This API should be used to retrieve the base distinguished name in LDAP where participants can be searched.

      Supported API: true
      Parameters:
      service -
      Returns:
      String
      Throws:
      WTException

    • getSearchCriteria

      String getSearchCriteria(String service, Class principalClass)
      This API is used to retrieve the actual filter if any, that needs to be applied while searching for participants within a specific search base. This API should only be used while querying participants stored in LDAP.

      Supported API: true
      Parameters:
      service -
      principalClass -
      Returns:
      String

    • getSearchCriteriaClasses

      Enumeration getSearchCriteriaClasses(String service)
      This API is used to retrieve the type of object classes which are part of the search criteria defined if any, while searching for participants within a specific search base. Each directory service has its own definition of object classes that uniquely correspond to the type of Windchill objects that exist in the directory service. Aphelion has the following three definitions inetOrgPerson - WTUser groupOfUniqueNames - WTGroup ptcOrganization - WTOrganization

      Supported API: true
      Parameters:
      service -
      Returns:
      Enumeration

    • getSearchScope

      String getSearchScope(String service) throws WTException
      LDAP allows the following 3 different kinds to scopes for searches 1) base 2) onelevel 3) subtree This API returns the current scope that is set on all the searches being done within the context for which the Directory Context Provider is formulated.

      Supported API: true
      Parameters:
      service -
      Returns:
      String
      Throws:
      WTException

    • getSizeLimit

      int getSizeLimit(String service)
      This API will return the results size limit that could be returned from LDAP for any specific search. If more results are found for a specific search, LDAP will limit the returned resultset to only the first 'n' number of entries unitl the maximum limit set is reached.

      Supported API: true
      Parameters:
      service -
      Returns:
      int

    • getSupportingServices

      String[] getSupportingServices() throws WTException
      This API will return all the secondary directory service names that correspond to the JNDI adapters defined in Info* Engine

      Supported API: true
      Returns:
      String[]
      Throws:
      WTException