Skip navigation links

Oracle Fusion Middleware External Executors Java API Reference for Oracle Business Intelligence Data Warehouse Administration Console
11g Release 1 (11.1.1)

E20491-01


com.oracle.dac.thirdparty.executor
Interface DACExecutor


public interface DACExecutor

DACExecutor is an interface to an ETL execution engine. Executor is instantiated during ETL and is used to communicate with one ETL engine. Multiple instances of DACExecutors could be created during ETL to communicate with multiple ETL Engines of a specific type. DACExecutor is initialized with a set of properties (as defined in DAC Metadata) and is used to create DACExecutorJobs, one per DAC task. To that end a map of DAC parameters relevant for the task and DAC Task information are provided. Task information includes task name, command name (workflow name in case of Informatica), source and target table information.

Since:
DAC 11.1.1.5.0

Method Summary
 void cleanUp()
          Cleans up executor instance once execution is over.
 DACExecutorJob createJob(DACTaskDefinition taskDefinition, java.util.Map<java.lang.String,java.lang.String> runtimeParameters, java.util.Map<java.lang.String,java.lang.String> contextMap)
          Creates and initializes an instance of DACExecutorJob.
 int getParallelismLevel()
          Returns executor parallelism level.
 void init(java.util.Map<java.lang.Object,java.lang.Object> properties)
          Initializes executor with the properties specified in DAC repository.
 boolean isValid()
          Verifies if an executor is valid.
 void prepareForExecution()
          Prepares for execution.
 void test()
          Tests ETL engine availability.

 

Method Detail

init

void init(java.util.Map<java.lang.Object,java.lang.Object> properties)
          throws DACExecutorInitializationException
Initializes executor with the properties specified in DAC repository.
Parameters:
properties - executor properties
Throws:
DACExecutorInitializationException - if executor can't be initialized

isValid

boolean isValid()
                throws DACExecutorInvalidPropertiesException
Verifies if an executor is valid. Does that by checking that all required properties are specified and look correct.
Returns:
true, if all required properties are set, false otherwise
Throws:
DACExecutorInvalidPropertiesException - if there is an error while verifying validity

test

void test()
          throws DACExecutorConnectionException
Tests ETL engine availability. Does that by verifying that executor can perform its function using a given set of properties (e.g connect to an external ETL engine, start an embedded agent, etc).
Throws:
DACExecutorConnectionException - if connection to ETL engine can't be established

prepareForExecution

void prepareForExecution()
                         throws DACExecutorConnectionException
Prepares for execution. Does that by making all necessary preparations, e.g. establishing connections, instantiating embedded agent, etc.
Throws:
DACExecutorConnectionException - if connection to ETL engine can't be established

createJob

DACExecutorJob createJob(DACTaskDefinition taskDefinition,
                         java.util.Map<java.lang.String,java.lang.String> runtimeParameters,
                         java.util.Map<java.lang.String,java.lang.String> contextMap)
                         throws DACExecutorJobInitializationException
Creates and initializes an instance of DACExecutorJob. Uses supplied information about DAC task and parameters applicable to that task.
Parameters:
taskDefinition - DAC task definition with source&target table information, command name, etc.
runtimeParameters - DAC runtime parameters (currency, language, etc.)
contextMap - map of context names and values applicable to a given task (see getExecutionContextNames() in DACExecutorDescriptor for more detail)
Returns:
initialized DACExecutorJob
Throws:
DACExecutorJobInitializationException - if a job can't be initialized

getParallelismLevel

int getParallelismLevel()
Returns executor parallelism level.
Returns:
the number of jobs that could be executed by the instance of executor in parallel

cleanUp

void cleanUp()
Cleans up executor instance once execution is over. This function is called at the end of ETL. Implementation should close all connections, release resources and locks, etc.

Skip navigation links

Oracle Fusion Middleware External Executors Java API Reference for Oracle Business Intelligence Data Warehouse Administration Console
11g Release 1 (11.1.1)

E20491-01


Copyright © 2003, 2011, Oracle. All rights reserved.