com.hyperion.css
Interface CSSSyncAPIIF


public interface CSSSyncAPIIF

This API is utilized by HSS and products to synchronize external users and groups identities with there respective repository.

Please note sync() method is invoked only by HSS to synchronize native directory.

Products should invoke updateIdentities() to know the status of the identities specified. Following are the status returned by updateIdentities() to the specified identities.

  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 status indicates that API has found more than one simillar identities, so it should be handled manually by Administrator.

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);
    CSSSyncAPIIF syncAPI = cssApiIf.getSyncAPI(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 syncEntryStatus = syncAPI.updateIdentities(productIdentities);
    }    
    catch (CSSException e)
    {
     
    }
 

Since:
CSS 9.3.0
Author:
Venu

Method Summary
 void sync()
          This method will update external user and group identities in the Hyperion Native Directory for those objects that have moved in the external directory.
 CSSSyncEntryIF updateIdentities(java.lang.String[] identities)
          This method will update external user and group identities status for those objects that have moved in the external directory.
 

Method Detail

sync

public void sync()
          throws CSSException
This method will update external user and group identities in the Hyperion Native Directory for those objects that have moved in the external directory. This method will also delete user and group entries from the Hyperion Native Directory that cannot be located in the external directory. If the external directory cannot be reached due to connectivity issues those user and group entries in the Hyperion Native Directory will not be deleted.

Throws:
CSSException - any abnormality

updateIdentities

public CSSSyncEntryIF updateIdentities(java.lang.String[] identities)
                                throws CSSException
This method will update external user and group identities status for those objects that have moved in the external directory. This method will also mark as delete for user and group entries that cannot be located in the external directory. If the external directory cannot be reached due to connectivity issues for those user and group entries will not be marked as deleted.

Parameters:
identities - a String object containing external user/group identities.
Returns:
CSSSyncEntryIF a object containing all the identities status.
Throws:
CSSException - any abnormality


Copyright 2005-2009 Oracle Corporation.