com.hyperion.css
Interface CSSMigrationAPIIF

public interface CSSMigrationAPIIF

Interface that defines utility methods to facilitate migration.

Sample use of the API:

    Map context = new HashMap(5);
    context.put(CSSAPIIF.LOCALE, new Locale("en", "US"));
    String logPath = "<ORACLE_INSTANCE>/diagnostics/logs/";

    CSSSystem instance = CSSSystem.getInstance(context, logPath);
    CSSAPIIF css = instance.getCSSAPI();

    CSSMigrationAPIIF migrationAPI = css.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)
    {
        // handle exception
    }
 

Since:

CSS 9.3.0

Author:

Venu

Method Summary

boolean	isMigrationRequired() Retrieves the value of property "css.DN.migrationRequired" stored in registry and by default the value of this property is false.
boolean	updateApplicationID(java.util.Map context, java.lang.String oldApplicationID, java.lang.String newApplicationID) ESSBASE only API.
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

boolean isMigrationRequired()
                            throws CSSException

Retrieves the value of property "css.DN.migrationRequired" stored in registry and by default the value of this property is false. If DN identity migration is required the caller need to modify the value of property to true to have CSSMigrateAPIIF perform DN identity migration.

Throws:

CSSException - any abnormality

validateIdentities

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 com.hyperion.css.sync.impl.CSSIdenticalEntry - This status indicates the identities is identical and has no changes.
2. CSSUpdatedEntry com.hyperion.css.sync.impl.CSSUpdatedEntry - This status indicates the identities has been updated and requires update.
3. CSSDeletedEntry com.hyperion.css.sync.impl.CSSDeletedEntry - This status indicates the identities is deleted in external provider.
4. CSSIgnoredEntry com.hyperion.css.sync.impl.CSSIgnoredEntry - This status indicates that API is unable to find the status.
5. CSSAmbiguousEntry com.hyperion.css.sync.impl.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 their 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, LDAP) 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

updateApplicationID

boolean updateApplicationID(java.util.Map context,
                            java.lang.String oldApplicationID,
                            java.lang.String newApplicationID)
                            throws CSSException

ESSBASE only API. This API will update the application id in the provisioning table with passed in new application id. This API does not perform any special character handling.

Parameters:

context -

oldApplicationID -

newApplicationID -

Returns:

- false, if none of the applications exists in the provisioning table. true, in all other cases.

Throws:

CSSException