DDPEngine

java.lang.Object
- org.kepler.ddp.director.DDPEngine

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

HadoopEngine, SparkEngine, StratosphereEngine
```
public abstract class DDPEngine
extends java.lang.Object
implements java.lang.Cloneable
```
A base class for DDP engines.

Author:

Daniel Crawl

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.Set<java.lang.String>`	`_additionalJars` A set of additional jar names to send to the server.
`protected java.lang.ClassLoader`	`_classLoader` The ClassLoader class for loading implementation class for DDP actors.
`protected java.lang.String`	`_configDirStr` DDP Engine configuration directory.
`protected static int`	`_CONNECT_TIMEOUT` Timeout when seeing if server is running.
`protected CompositeActor`	`_container` The container of this director.
`protected int`	`_degreeOfParallelism` The default degree of parallelism for ddp pattern actors.
`protected DDPDirector`	`_director` The containing director.
`protected java.lang.String`	`_displayRedirectDir` Directory for display redirect.
`protected java.lang.String`	`_engineName` The name of the engine.
`protected java.util.Map<java.lang.String,java.lang.String>`	`_jobArgumentsMap` A collection of job arguments as key-values.
`protected java.lang.String`	`_jobDir` Directory for the current job.
`protected java.lang.Object`	`_jobLock` A lock for DDP jobs.
`protected boolean`	`_sameJVM` If true, run and use server in the same JVM as Kepler.
`protected static java.lang.Object`	`_serverStartStopLock` A static object used for synchronization.
`protected static java.util.Map<java.lang.String,SingleInputPatternActor>`	`_subWorkflows` A mapping of model name to model.
`protected boolean`	`_writeSubWorkflowsToFiles` If true, write the sub-workflows to files, otherwise pass them as to in the configuration object.

Constructor Summary

Constructors
Constructor and Description

DDPEngine(DDPDirector director)
Create a new DDPEngine.

Constructors
Constructor and Description
`DDPEngine(DDPDirector director)` Create a new DDPEngine.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`_addParameters()` Add parameters to the containing director.
`protected void`	`_checkConfigDir()` Check that the configuration directory is set and exists on the file system.
`protected boolean`	`_checkFilesBeforeStartingServer()` Check the existence of required files before starting the DDP server.
`protected void`	`_checkModel()` Check the container of this director for incorrect actors, etc.
`protected void`	`_checkModelForNonDDPActors(CompositeActor container)` Make sure the container only contains DDP actors.
`protected boolean`	`_checkServer(java.net.InetSocketAddress socketAddress, java.lang.String startScriptStr)` Check if the DDP engine server is running.
`protected void`	`_copyParameters(DDPPatternActor sourceSubWorkflow, DDPPatternActor destSubWorkflow)` Copy the workflow parameters from one sub-workflow to another including the parameters in all the containers of the source.
`protected void`	`_createJobDirectory()` Create a new directory for this job.
`protected abstract void`	`_executeDDPJob()` Execute the DDP job.
`protected java.util.List<java.net.URI>`	`_getJarList()` Get a list of jars required for director to start.
`protected static java.util.Map<java.lang.String,Variable>`	`_getParametersInHierarchy(NamedObj namedObj)` Get the parameters for a NamedObj and all its containers.
`protected java.net.InetSocketAddress`	`_parseOutputFromStartingServer(java.io.InputStream input)` Parse the output from the script that starts the server.
`protected void`	`_removeParameters()` Remove engine-specific parameters from the director.
`protected java.util.Map<java.lang.String,Type>`	`_setPortTypes(DDPPatternActor actor)` Set the port types inside a cloned pattern actor.
`void`	`attributeChanged(Attribute attribute)` React to a parameter change.
`java.lang.Object`	`clone()` Clone the engine into the containing director's workspace.
`java.lang.Object`	`clone(Workspace workspace)` Clone the object into the specified workspace.
`static void`	`closeAllEffigies()` Close all the effigies created.
`static void`	`createEffigy(CompositeActor model)` Create an Effigy for a model so that windows may be opened by gui actors.
`void`	`fire()` Execute the engine.
`java.lang.String`	`getDisplayRedirectDir()` Get the directory to redirect display related actors.
`static CompositeActor`	`getModel(java.lang.String name)` Get the model for a specific name.
`java.lang.String`	`getName()` Get the name of the engine.
`java.lang.String[]`	`getServerTypes()` Valid types of servers that can be started.
`boolean`	`postfire()` Postfire the engine.
`void`	`preinitialize()` Initialize fields from parameters.
`void`	`stop()` Stop any running DDP jobs.
`void`	`wrapup()` Perform cleanup.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - _configDirStr
```
protected java.lang.String _configDirStr
```
    DDP Engine configuration directory.
  - _jobDir
```
protected java.lang.String _jobDir
```
    Directory for the current job.
  - _classLoader
```
protected java.lang.ClassLoader _classLoader
```
    The ClassLoader class for loading implementation class for DDP actors.
  - _CONNECT_TIMEOUT
```
protected static final int _CONNECT_TIMEOUT
```
    Timeout when seeing if server is running.
    
    See Also:
    
    Constant Field Values
  - _displayRedirectDir
```
protected java.lang.String _displayRedirectDir
```
    Directory for display redirect.
  - _writeSubWorkflowsToFiles
```
protected boolean _writeSubWorkflowsToFiles
```
    If true, write the sub-workflows to files, otherwise pass them as to in the configuration object.
  - _container
```
protected CompositeActor _container
```
    The container of this director.
  - _degreeOfParallelism
```
protected int _degreeOfParallelism
```
    The default degree of parallelism for ddp pattern actors.
  - _jobArgumentsMap
```
protected java.util.Map<java.lang.String,java.lang.String> _jobArgumentsMap
```
    A collection of job arguments as key-values.
  - _director
```
protected DDPDirector _director
```
    The containing director.
  - _engineName
```
protected java.lang.String _engineName
```
    The name of the engine.
  - _subWorkflows
```
protected static final java.util.Map<java.lang.String,SingleInputPatternActor> _subWorkflows
```
    A mapping of model name to model. FIXME: change to full name
  - _sameJVM
```
protected boolean _sameJVM
```
    If true, run and use server in the same JVM as Kepler.
  - _additionalJars
```
protected java.util.Set<java.lang.String> _additionalJars
```
    A set of additional jar names to send to the server.
  - _jobLock
```
protected java.lang.Object _jobLock
```
    A lock for DDP jobs.
  - _serverStartStopLock
```
protected static final java.lang.Object _serverStartStopLock
```
    A static object used for synchronization.
- Constructor Detail
  - DDPEngine
```
public DDPEngine(DDPDirector director)
          throws IllegalActionException,
                 NameDuplicationException
```
    Create a new DDPEngine.
    
    Parameters:
    
    director - The director containing this engine.
    
    Throws:
    
    IllegalActionException
    
    NameDuplicationException
- Method Detail
  - attributeChanged
```
public void attributeChanged(Attribute attribute)
                      throws IllegalActionException
```
    React to a parameter change.
    
    Throws:
    
    IllegalActionException
  - clone
```
public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
```
    Clone the engine into the containing director's workspace.
    
    Overrides:
    
    clone in class java.lang.Object
    
    Throws:
    
    java.lang.CloneNotSupportedException
  - clone
```
public java.lang.Object clone(Workspace workspace)
                       throws java.lang.CloneNotSupportedException
```
    Clone the object into the specified workspace.
    
    Parameters:
    
    workspace - The workspace for the cloned object.
    
    Returns:
    
    The new Attribute.
    
    Throws:
    
    java.lang.CloneNotSupportedException - Not thrown in this base class
  - closeAllEffigies
```
public static void closeAllEffigies()
                             throws IllegalActionException
```
    Close all the effigies created.
    
    Throws:
    
    IllegalActionException
  - createEffigy
```
public static void createEffigy(CompositeActor model)
```
    Create an Effigy for a model so that windows may be opened by gui actors.
  - getDisplayRedirectDir
```
public java.lang.String getDisplayRedirectDir()
                                       throws IllegalActionException
```
    Get the directory to redirect display related actors.
    
    Throws:
    
    IllegalActionException
  - getModel
```
public static CompositeActor getModel(java.lang.String name)
```
    Get the model for a specific name.
  - getName
```
public final java.lang.String getName()
```
    Get the name of the engine.
  - getServerTypes
```
public java.lang.String[] getServerTypes()
```
    Valid types of servers that can be started. The first value is the default for the startServerType parameter.
  - fire
```
public void fire()
          throws IllegalActionException
```
    Execute the engine. In this base class, does nothing.
    
    Throws:
    
    IllegalActionException
  - postfire
```
public boolean postfire()
                 throws IllegalActionException
```
    Postfire the engine. In this base class, returns true.
    
    Throws:
    
    IllegalActionException
  - preinitialize
```
public void preinitialize()
                   throws IllegalActionException
```
    Initialize fields from parameters.
    
    Throws:
    
    IllegalActionException
  - stop
```
public void stop()
          throws IllegalActionException
```
    Stop any running DDP jobs.
    
    Throws:
    
    IllegalActionException
  - wrapup
```
public void wrapup()
            throws IllegalActionException
```
    Perform cleanup.
    
    Throws:
    
    IllegalActionException
  - _addParameters
```
protected void _addParameters()
                       throws IllegalActionException,
                              NameDuplicationException
```
    Add parameters to the containing director. In this base class, does nothing.
    
    Throws:
    
    IllegalActionException
    
    NameDuplicationException
  - _checkConfigDir
```
protected void _checkConfigDir()
                        throws IllegalActionException
```
    Check that the configuration directory is set and exists on the file system.
    
    Throws:
    
    IllegalActionException
  - _checkFilesBeforeStartingServer
```
protected boolean _checkFilesBeforeStartingServer()
                                           throws IllegalActionException
```
    Check the existence of required files before starting the DDP server. The list of required files is found in configuration.xml for each engine, in Engine.Server.Required.
    
    Throws:
    
    IllegalActionException
  - _checkModel
```
protected void _checkModel()
                    throws IllegalActionException
```
    Check the container of this director for incorrect actors, etc.
    
    Throws:
    
    IllegalActionException
  - _checkModelForNonDDPActors
```
protected void _checkModelForNonDDPActors(CompositeActor container)
                                   throws IllegalActionException
```
    Make sure the container only contains DDP actors.
    
    Throws:
    
    IllegalActionException
  - _checkServer
```
protected boolean _checkServer(java.net.InetSocketAddress socketAddress,
                               java.lang.String startScriptStr)
                        throws IllegalActionException
```
    Check if the DDP engine server is running. If not, try to start it.
    
    Parameters:
    
    socketAddress - Host and port of the server to check.
    
    startScriptStr - The script to start the server if not running.
    
    Returns:
    
    True if a server was started, false if could connect to already running server.
    
    Throws:
    
    IllegalActionException
  - _copyParameters
```
protected void _copyParameters(DDPPatternActor sourceSubWorkflow,
                               DDPPatternActor destSubWorkflow)
                        throws IllegalActionException
```
    Copy the workflow parameters from one sub-workflow to another including the parameters in all the containers of the source.
    
    Parameters:
    
    sourceSubWorkflow - the source sub-workflow
    
    destSubWorkflow - the destination sub-workflow
    
    Throws:
    
    IllegalActionException
  - _createJobDirectory
```
protected void _createJobDirectory()
                            throws IllegalActionException
```
    Create a new directory for this job.
    
    Throws:
    
    IllegalActionException
  - _getParametersInHierarchy
```
protected static java.util.Map<java.lang.String,Variable> _getParametersInHierarchy(NamedObj namedObj)
```
    Get the parameters for a NamedObj and all its containers.
  - _getJarList
```
protected java.util.List<java.net.URI> _getJarList()
                                            throws IllegalActionException
```
    Get a list of jars required for director to start. It also set _classLoader value based on the jars.
    
    Throws:
    
    IllegalActionException
  - _executeDDPJob
```
protected abstract void _executeDDPJob()
                                throws IllegalActionException
```
    Execute the DDP job.
    
    Throws:
    
    IllegalActionException
  - _parseOutputFromStartingServer
```
protected java.net.InetSocketAddress _parseOutputFromStartingServer(java.io.InputStream input)
                                                             throws java.io.IOException,
                                                                    IllegalActionException
```
    Parse the output from the script that starts the server. In this class, does nothing and returns null.
    
    Returns:
    
    If the start script specifies a server URL, returns the socket address for that URL. Otherwise, returns null.
    
    Throws:
    
    java.io.IOException
    
    IllegalActionException
  - _removeParameters
```
protected void _removeParameters()
                          throws IllegalActionException,
                                 NameDuplicationException
```
    Remove engine-specific parameters from the director. Does nothing in this base class.
    
    Throws:
    
    IllegalActionException
    
    NameDuplicationException
  - _setPortTypes
```
protected java.util.Map<java.lang.String,Type> _setPortTypes(DDPPatternActor actor)
                                                      throws IllegalActionException
```
    Set the port types inside a cloned pattern actor.
    
    Parameters:
    
    actor - the cloned actor
    
    Throws:
    
    IllegalActionException

Class DDPEngine

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_configDirStr

_jobDir

_classLoader

_CONNECT_TIMEOUT

_displayRedirectDir

_writeSubWorkflowsToFiles

_container

_degreeOfParallelism

_jobArgumentsMap

_director

_engineName

_subWorkflows

_sameJVM

_additionalJars

_jobLock

_serverStartStopLock

Constructor Detail

DDPEngine

Method Detail

attributeChanged

clone

clone

closeAllEffigies

createEffigy

getDisplayRedirectDir

getModel

getName

getServerTypes

fire

postfire

preinitialize

stop

wrapup

_addParameters

_checkConfigDir

_checkFilesBeforeStartingServer

_checkModel

_checkModelForNonDDPActors

_checkServer

_copyParameters

_createJobDirectory

_getParametersInHierarchy

_getJarList

_executeDDPJob

_parseOutputFromStartingServer

_removeParameters

_setPortTypes