Skip navigation links

oracle.idm.provisioning.tools
Class BulkProvStatusUpdate

java.lang.Object
oracle.idm.util.progress.ProgressReporter
oracle.idm.util.progress.ProgressProcessor
oracle.idm.provisioning.tools.BulkProvStatusUpdate

All Implemented Interfaces:

java.lang.Runnable

public class BulkProvStatusUpdate

extends ProgressProcessor

This class provides the necessary API to bulk update user provisioning status

Since:

OCS 2.1

Field Summary

Fields inherited from class oracle.idm.util.progress.ProgressProcessor

ABORTED, CANCELED, FINISHED, progressEventDurationInfo, progressEventLocalizedMessage, progressEventMessage, progressEventName, progressEventPercentInfo, progressEventProgressInfo, progressEventStateInfo, progressEventStatusInfo, progressEventStepInfo, progressEventThrowable, RESTORED, RESUMED, STARTED, STOPPED, SUSPENDED, TIMEDOUT, transitions

Constructor Summary

BulkProvStatusUpdate(javax.naming.ldap.LdapContext ldapCtx, java.lang.String realmName, Application[] apps, java.lang.String status, java.lang.String statusDesc)
Constructor

Method Summary

boolean	getContinueOnFailure() Getter for the continueOnFailure property.
protected java.lang.String	getProgressEventMessage() Creates progress event message.
protected PercentInfo	getProgressEventPercentInfo() Creates progress event percent info.
protected StepInfo	getProgressEventStepInfo() Creates progress event step info.
static void	main(java.lang.String[] args) Unit Test Driver program
protected void	process(boolean quiet) The main driver method that does the bulk update of the provisioning status of the user.
void	resume() Resume processing
void	setContinueOnFailure(boolean continueOnFailure) Setter for the continueOnFailure property.
void	start() Start processing, calls process();
void	stop() Stop processing
void	suspend() Suspend processing

Methods inherited from class oracle.idm.util.progress.ProgressProcessor

abort, block, block, block, canAbort, canCancel, cancel, cancel, canFinish, canReset, canRestore, canResume, canStart, canStop, canSuspend, canTimeout, canTransition, finish, getProgressEvent, getProgressEventDurationInfo, getProgressEventLocalizedMessage, getProgressEventName, getProgressEventProgressInfo, getProgressEventStateInfo, getProgressEventStatusInfo, getProgressEventThrowable, getTransitions, isAborted, isCanceled, isFinal, isFinished, isInitial, isIntermediate, isNext, isPrevious, isReachable, isReset, isRestored, isResumed, isStarted, isStopped, isSuspended, isTimedout, isUnreachable, ping, reset, restore, resume, run, sendProgressEvent, setTransitions, start, stop, suspend, timeout, transition

Methods inherited from class oracle.idm.util.progress.ProgressReporter

clearTransient, continuing, getDuration, getErrorTotal, getException, getLocalizedMessage, getLocalizedMessages, getMessage, getMessages, getProgressManager, getRuntimeException, getStateCurrent, getStateTimeStamp, getTimeout, getTransient, getWarningTotal, hasTimedout, isStateCurrent, isTransient, markTransient, resetDuration, sendProgressEvent, setErrorTotal, setProgressManager, setStateCurrent, setStateTimeStamp, setTimeout, setWarningTotal, throwErrorOrException, throwErrorOrRuntimeException, throwException, throwRuntimeException, unmarkTransient

Methods inherited from class java.lang.Object

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

Constructor Detail

BulkProvStatusUpdate

public BulkProvStatusUpdate(javax.naming.ldap.LdapContext ldapCtx,
                            java.lang.String realmName,
                            Application[] apps,
                            java.lang.String status,
                            java.lang.String statusDesc)
                     throws ProvisioningException

Constructor

Parameters:

realmName - The realm into which the bulk provisioning needs to be done. If realm Name is NULL then DEFAULT realm is considered

app - the applications for which the bulk provision needs to be done

ldapCtx - the OID to which the entries must be loaded

status - the status to used for updating

status - the status desc to be used for updating

Throws:

ProvisioningException

Method Detail

start

public void start()
           throws java.io.IOException,
                  ProvisioningException,
                  java.lang.Exception

Start processing, calls process();

Overrides:

start in class ProgressProcessor

Throws:

java.io.IOException

ProvisioningException

java.lang.Exception

stop

public void stop()

Stop processing

Overrides:

stop in class ProgressProcessor

suspend

public void suspend()

Suspend processing

Overrides:

suspend in class ProgressProcessor

resume

public void resume()

Resume processing

Overrides:

resume in class ProgressProcessor

process

protected void process(boolean quiet)
                throws java.io.IOException,
                       ProvisioningException

The main driver method that does the bulk update of the provisioning status of the user. This method MUST NOT be synchronized.

Specified by:

process in class ProgressProcessor

Parameters:

quiet - if quiet is true, this method does not throw transition exceptions

Throws:

java.io.IOException - when and I/O erroor occurs i.e while reading the LDIF input stream or writing the bad entries to the output stream.

ProvisioningException - when user creation/provisioning fails

getProgressEventMessage

protected java.lang.String getProgressEventMessage()

Creates progress event message.

Overrides:

getProgressEventMessage in class ProgressProcessor

getProgressEventStepInfo

protected StepInfo getProgressEventStepInfo()

Creates progress event step info.

Overrides:

getProgressEventStepInfo in class ProgressProcessor

getProgressEventPercentInfo

protected PercentInfo getProgressEventPercentInfo()

Creates progress event percent info.

Overrides:

getProgressEventPercentInfo in class ProgressProcessor

getContinueOnFailure

public boolean getContinueOnFailure()

Getter for the continueOnFailure property.

setContinueOnFailure

public void setContinueOnFailure(boolean continueOnFailure)

Setter for the continueOnFailure property. Default value is true.

Parameters:

continueOnFailure - true continue with the next user on failure

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

Unit Test Driver program

Throws:

java.lang.Exception

Skip navigation links