com.hyperion.css
Interface CSSMigrationAPIIF

public interface CSSMigrationAPIIF

Interface that definies utility methods to facilate migration.

Sample use of the API:

    Map context = new HashMap(5);

    CSSSystem instance = CSSSystem.getInstance();
    CSSAPIIF css = instance.getCSSAPI();

    context.put(CSSAPIIF.LOCALE, new Locale("en", "US"));
    context.put(CSSAPIIF.LOG_PREPEND_TEXT, "[APP_NAME/IPADDRESS]");
    css.initialize(context, appCallback);
    CSSMigrationAPIIF migrationAPI = cssApiIf.getMigrationAPI(context);
    String productIdentities[] = 
      {
              "msad://DN=CN=jeff,OU=East,DC=yuma,DC=hyperion,DC=com?USER",
              "ldap://DN=uid=john,ou=West,ou=People,dc=puma,dc=hyperion,dc=com?USER"
      }
    try
    {
      CSSSyncEntryIF syncEntry = migrationAPI.validateIdentities(productIdentities);
    }    
    catch (CSSException e)
    {
     
    }
 

Since:

CSS 9.3.0

Author:

Venu

Method Summary

boolean	isMigrationRequired() Returns true if the CSS configuration file has been updated for the identity attribute to a value other than "DN".
CSSSyncEntryIF	validateIdentities(java.lang.String[] identities) Utility API that validates the specified CSS Identities to mark them with one of the following status.

Method Detail

isMigrationRequired

public boolean isMigrationRequired()
                            throws CSSException

Returns true if the CSS configuration file has been updated for the identity attribute to a value other than "DN". This method will return true even if one of the LDAP or MSAD providers configuration is updated like mentioned.

Note that this method will check only providers of type LDAP and MSAD. The other providers do not need a migration.

Throws:

CSSException - any abnormality

validateIdentities

public CSSSyncEntryIF validateIdentities(java.lang.String[] identities)
                                  throws CSSException

Utility API that validates the specified CSS Identities to mark them with one of the following status.

1. CSSIdenticalEntry CSSIdenticalEntry - This status indicates the identities is identical and has no changes.
2. CSSUpdatedEntry CSSUpdatedEntry - This status indicates the identities has been updated and requires update.
3. CSSDeletedEntry CSSDeletedEntry - This status indicates the identities is deleted in external provider.
4. CSSIgnoredEntry CSSIgnoredEntry - This status indicates that API is unable to find the status.
5. CSSAmbiguousEntry CSSAmbiguousEntry - This

This API helps identify if the specified identities are still valid and if not act accordingly. The caller of this API might make updates to thier repository with the information returned by this API. Note that this API does not make any changes to any repository including Native Directory.

In case the provider is down the specified CSS Identity will be marked as ignored.

This API does not perform provider migration by default i.e., migrating identities from one provider (e.g, NTLM) to other provider (e.g, MSAD).

If API has to perform provider migration, caller of this API has to set option "doprovider=true" in CSSMigration.properties and set the properties file to System environment property using one of the below mentioned methods while calling this API,

-Dproperties="location of CSSMigration.properties"

Sytem.setProperty("properties","location of CSSMigration.properties")

Note: If "doprovider=false" the API will not perform provider migration.

Parameters:

identities - a String object containing external user/group identities.

Returns:

CSSSyncEntryIF a object containing all the identities status.

Throws:

CSSException - any abnormality