com.filenet.api.engine

Interface DirectoryMigrationProvider



  • public interface DirectoryMigrationProvider
    For Internal Use Only.

    Defines the public interface that a directory service needs to implement to support directory migration operations. The end target repository is a directory server. A DirectoryMigrationProvider object can communicate with the directory server via LDAP or some other form of API.

    This is a singleton object. For a given type of directory server, the Content Engine makes sure that only one instance of the implementation class is created.

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      GroupInfo[] getGroupsByShortName(java.lang.String groupShortName, java.lang.String[] requestedProperties)
      For Internal Use Only.
      java.lang.String getSearchableSid(RealmInfo realmInfo, boolean isGroup, byte[] sid)
      For Internal Use Only.
      UserInfo[] getUsersByShortName(java.lang.String userShortName, java.lang.String[] requestedProperties)
      For Internal Use Only.
    • Method Detail

      • getUsersByShortName

        UserInfo[] getUsersByShortName(java.lang.String userShortName,
                                     java.lang.String[] requestedProperties)
                                       throws javax.naming.NamingException
        For Internal Use Only. Searches by user short name and returns all users with the given short name.
        Parameters:
        userShortName - User short name (for example, user1).
        requestedProperties - Requested property names. Needs to be converted to directory service attributes inside the method.
        Returns:
        UserInfo object array which contains users with the requested properties. If not found, returns an empty array.
        Throws:
        javax.naming.NamingException
      • getGroupsByShortName

        GroupInfo[] getGroupsByShortName(java.lang.String groupShortName,
                                       java.lang.String[] requestedProperties)
                                         throws javax.naming.NamingException
        For Internal Use Only. Searches by group short name and returns all groups with the given short name.
        Parameters:
        groupShortName - Group short name (for example, group1).
        requestedProperties - Requested property names. Needs to be converted to directory service attributes inside the method.
        Returns:
        GroupInfo object array which contains groups with the requested group properties. If not found, returns an empty array.
        Throws:
        javax.naming.NamingException
      • getSearchableSid

        java.lang.String getSearchableSid(RealmInfo realmInfo,
                                        boolean isGroup,
                                        byte[] sid)
        For Internal Use Only. Find the LDAP searchable sid given a sid bytes.
        Parameters:
        realmInfo - The P8 realm this sid belongs to.
        isGroup - is this a group or a user.
        sid - SID in P8 byte format.
        Returns:
        LDAP seachable SID String.

© Copyright IBM Corporation 2006, 2013. All rights reserved.