com.ibm.itim.apps.pim
Class SABatchLoadManager

java.lang.Object
  com.ibm.itim.apps.pim.SABatchLoadManager

public class SABatchLoadManager
extends java.lang.Object

This class provides credential vault administration capabilities. It provides interface to load credential vault in batch mode.

Since:

ISIM 6.0

Constructor Summary

SABatchLoadManager(PlatformContext platform, javax.security.auth.Subject subject)
This API constructs the manager with a platform context and a subject.

Method Summary

Request

processBatchLoad(byte[] data, java.lang.String loadName, java.util.Date effectiveDate) This API submits a workflow request for batch loading of credentials into vault.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SABatchLoadManager

public SABatchLoadManager(PlatformContext platform,
                          javax.security.auth.Subject subject)

This API constructs the manager with a platform context and a subject.

Parameters:

platform - This parameter holds the platform connection information.

subject - This parameter represents the authenticated caller.

Method Detail

processBatchLoad

public Request processBatchLoad(byte[] data,
                                java.lang.String loadName,
                                java.util.Date effectiveDate)
                         throws java.rmi.RemoteException,
                                ApplicationException

This API submits a workflow request for batch loading of credentials into vault.

Parameters:

data - A byte array representation of the Comma Separated Value (CSV) file that contains accounts that must be added to a credential vault. The following description provides brief information about the expected CSV format. A CSV file can be made up of multiple sections that are identified by a section header -"#Credentials". A section header is followed by a header section. See the Security Identity Manager information center for more details about header section. The CSV data must follow the grammar of Request for Comment (RFC) 4180. Fields can be quoted or unquoted. If a comma appears as part of a field value, the field must be in double quotation marks. Blank rows are permitted in the CSV file.

loadName - Name for the batch load process. This is an optional parameter and can be null.

effectiveDate - Specifies the scheduled start time of the process. If it is null, the process starts immediately. If you call the method remotely, passing this parameter as the current date or time of the client workstation is not a safe because the date or time of the client workstation might not be the same as the date or time of the Security Identity Manager server workstation.

Returns:

Returns an object that represents the status of the operation. If the schedule time is set for the future, the request getStatus() returns the current status.

Throws:

java.rmi.RemoteException - This exception is thrown if the API is unable to communicate with the platform.

ApplicationException - This exception is thrown if the API is unable to submit the request.A problem accessing the underlying data store might be one of the reasons the API is unable to submit the request.