com.ibm.itim.apps

Class BulkRequest

java.lang.Object

com.ibm.itim.apps.Request

com.ibm.itim.apps.BulkRequest

public class BulkRequest
extends Request

Represents a bulk request submitted to the provisioning platform.

Field Summary

Fields inherited from class com.ibm.itim.apps.Request

FAILED, IN_PROCESS, NOT_STARTED, SUCCEEDED, WARNING

Constructor Summary

Constructors

Constructor and Description
BulkRequest(PlatformContext platform, javax.security.auth.Subject subject, long id, BulkException exception) Creates a BulkRequest.
BulkRequest(PlatformContext platform, javax.security.auth.Subject subject, long id, java.util.Date scheduledTime, BulkException exception) Constructs with a user Context, request id, and scheduled time.

Method Summary

Modifier and Type	Method and Description
boolean	anyFailures() Returns whether the request had any failures.
BulkException	getException() Returns the exception holding the failed portion (if any) of the bulk request.

Methods inherited from class com.ibm.itim.apps.Request

abort, abort, getAuditData, getID, getScheduledTime, getStatus

Methods inherited from class java.lang.Object

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

Constructor Detail

BulkRequest

public BulkRequest(PlatformContext platform,
                   javax.security.auth.Subject subject,
                   long id,
                   BulkException exception)

Creates a BulkRequest.

Parameters:

platform - PlatformContext holding platform connection information.

subject - Subject representing the authenticated caller.

id - A long request id.

exception - BulkException holding any failures of the request. May be null.

BulkRequest

public BulkRequest(PlatformContext platform,
                   javax.security.auth.Subject subject,
                   long id,
                   java.util.Date scheduledTime,
                   BulkException exception)

Constructs with a user Context, request id, and scheduled time.

Parameters:

platform - PlatformContext holding platform connection information.

subject - Subject representing the authenticated caller.

id - A long request id.

scheduledTime - The scheduled starting time of the process. If null, the process will start immediately. In case this method is invoked remotely, passing this parameter as the current date/time of the client machine is not a safe technique to use, since the date/time of the client machine may not be the same as the date/time of the ITIM server machine.

exception - BulkException holding any failures of the request. May be null.

Method Detail

getException

public BulkException getException()

Returns the exception holding the failed portion (if any) of the bulk request.

Returns:

BulkException holding any exceptions identifying the failed portion of the bulk request. May be null if nothing failed.

anyFailures

public boolean anyFailures()

Returns whether the request had any failures.

Returns:

True if there were failures, false if there were not.