Package com.identityworksllc.iiq.common.task.export

Class ExportPartition

java.lang.Object

com.identityworksllc.iiq.common.threads.SailPointWorker

com.identityworksllc.iiq.common.task.export.ExportPartition

All Implemented Interfaces:

Serializable, Runnable

Direct Known Subclasses:

CleanupLinksPartition, ExportIdentitiesPartition, ExportLinksPartition, OracleGatherStatsPartition

public abstract class ExportPartition
extends SailPointWorker
implements Serializable

An abstract superclass for all export partitions.

It will open a connection to the target database and then invoke export() on the subclass.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.identityworksllc.iiq.common.threads.SailPointWorker

SailPointWorker.ExceptionHandler

Field Summary

Fields

Modifier and Type	Field	Description
protected sailpoint.object.Configuration	configuration	The configuration loaded in execute(SailPointContext, Log)
protected long	cutoffDate	The cutoff date, milliseconds.
protected long	exportTimestamp	The export timestamp in epoch milliseconds.
protected String	filterString	The filter string
protected String	filterString2	The second filter string if any

Fields inherited from class com.identityworksllc.iiq.common.threads.SailPointWorker

monitor, MULTI_SERIALIZED_WORKERS_ATTR, outcome

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ExportPartition()	Constructs a new ExportPartition

Method Summary

Modifier and Type	Method	Description
protected static void	addCommonDateFields(NamedParameterStatement statement, Date exportDate, Date created, Date modified, Date lastRefresh)	Adds the common date fields (which must have the given names) to the given prepared statement.
Object	execute(sailpoint.api.SailPointContext context, org.apache.commons.logging.Log _logger)	The worker entrypoint
abstract void	export(sailpoint.api.SailPointContext context, Connection connection, org.apache.commons.logging.Log logger)	Exports the data required to the listed database
static Connection	openConnection(sailpoint.api.SailPointContext context, ExportConnectionInfo connectionInfo)	Opens the connection to the target database using the provided connection info
void	setConnectionInfo(ExportConnectionInfo connectionInfo)	Sets the filter string
void	testExportSingleObject(sailpoint.api.SailPointContext context, org.apache.commons.logging.Log logger, String taskDefinitionName, String id)	Tests the export of a single object.
String	toString()

Methods inherited from class com.identityworksllc.iiq.common.threads.SailPointWorker

addChild, addDependency, addTaskCallback, checkCancel, getDependencyOutput, getDependentPhase, getExceptionHandler, getMonitor, getParent, getPhase, getWorkerName, isTerminated, isTimedOut, run, runnable, setCompletedCounter, setDependentPhase, setExceptionHandler, setFailedCounter, setMonitor, setParent, setPhase, setTimeout, submitWithListeners, terminate, toCallable, toForkJoinTask, toFutureTask, toRequest, toRequest

Methods inherited from class java.lang.Object

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

Field Detail

configuration

protected transient sailpoint.object.Configuration configuration

The configuration loaded in execute(SailPointContext, Log)

cutoffDate

protected long cutoffDate

The cutoff date, milliseconds.

We should not export records older than this date.

exportTimestamp

protected long exportTimestamp

The export timestamp in epoch milliseconds.

We should not export records newer than this date.

filterString

protected String filterString

The filter string

filterString2

protected String filterString2

The second filter string if any

Constructor Detail

ExportPartition

protected ExportPartition()

Constructs a new ExportPartition

Method Detail

addCommonDateFields

protected static void addCommonDateFields(NamedParameterStatement statement,
                                          Date exportDate,
                                          Date created,
                                          Date modified,
                                          Date lastRefresh)
                                   throws SQLException

Adds the common date fields (which must have the given names) to the given prepared statement.

The modified and last refresh dates can be null.

Parameters:

statement - The named parameter statement

exportDate - The export date

created - The creation date

modified - The modified date (which can be null)

lastRefresh - The last refresh date (which can be null)

Throws:

SQLException - if any failures occur (unlikely)

openConnection

public static Connection openConnection(sailpoint.api.SailPointContext context,
                                        ExportConnectionInfo connectionInfo)
                                 throws sailpoint.tools.GeneralException

Opens the connection to the target database using the provided connection info

Parameters:

context - The sailpoint context, used to decrypt the password

connectionInfo - The provided connection info, extracted from the export task def

Returns:

The open connection

Throws:

sailpoint.tools.GeneralException - if any failures occur

execute

public final Object execute(sailpoint.api.SailPointContext context,
                            org.apache.commons.logging.Log _logger)
                     throws Exception

The worker entrypoint

Specified by:

execute in class SailPointWorker

Parameters:

context - The private context to use for this thread worker

_logger - The log attached to this Worker

Returns:

Always null, nothing required here

Throws:

Exception - if anything goes wrong

export

public abstract void export(sailpoint.api.SailPointContext context,
                            Connection connection,
                            org.apache.commons.logging.Log logger)
                     throws sailpoint.tools.GeneralException

Exports the data required to the listed database

Parameters:

context - The context

connection - The connection to the target database

logger - The logger

Throws:

sailpoint.tools.GeneralException - if any failures occur

setConnectionInfo

public void setConnectionInfo(ExportConnectionInfo connectionInfo)

Sets the filter string

Parameters:

connectionInfo - The connection info

testExportSingleObject

public void testExportSingleObject(sailpoint.api.SailPointContext context,
                                   org.apache.commons.logging.Log logger,
                                   String taskDefinitionName,
                                   String id)
                            throws Exception

Tests the export of a single object.

The subclass will determine which object type it is. This can be invoked via a Run Rule task, the Debug page, or the Rule Runner plugin.

Each test will use a unique “run key” so that it doesn’t interfere with the incremental export mechanism used by the main task.

Parameters:

context - The IIQ context

logger - The logger

taskDefinitionName - The name of the existing TaskDefinition

id - The ID of the object to export

Throws:

Exception - if any failures occur

toString

public String toString()

Overrides:

toString in class SailPointWorker

See Also:

Object.toString()