Package cmion.level2.competencies

Class Migration

java.lang.Object

ion.Meta.Element

cmion.architecture.CmionComponent

cmion.level2.Competency

cmion.level2.competencies.Migration

All Implemented Interfaces:

java.lang.Runnable

public class Migration
extends Competency

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	Migration.Device

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	SUCCESS_TAG

Fields inherited from class cmion.level2.Competency

available, competencyName, competencyType, plan, running

Fields inherited from class cmion.architecture.CmionComponent

architecture

Constructor Summary

Constructors

Constructor	Description
Migration(IArchitecture architecture, java.lang.String configFile)

Method Summary

Modifier and Type	Method	Description
void	addMigrationData(org.w3c.dom.Element xmlElement)
protected boolean	competencyCode(java.util.HashMap<java.lang.String,java.lang.String> parameters)	every competency sub class must implement this method and in it perform the competency code.
java.util.Set<Migration.Device>	getAllDevices()
java.util.Set<Migration.Device>	getAvailableDevices()
java.util.Map<java.lang.String,Migration.Device>	getDeviceList()
protected Synchronizer	getNewSynchronizer(int listenPort)
void	importConfig(org.w3c.dom.Document doc)
void	initialize()	custom competency initialisation code should go in here
boolean	isOccupied()
protected java.io.InputStream	openConfigFile(java.lang.String configFile)	This method is responsible for opening the configuration file correctly.
void	registerHandlers()	registers request and event handlers of the competency execution system, if overridden, remember to call super.registerHandlers(); from within
boolean	runsInBackground()	every competency must provide information of whether it will run in the background permanently (returns true) or whether it will be invoked through the competency execution system (returns false)

Methods inherited from class cmion.level2.Competency

cancel, getCompetencyName, getCompetencyType, isAvailable, isRunning, requestStartCompetency, run, setAdditionalData

Methods inherited from class cmion.architecture.CmionComponent

getArchitecture, isConnected, onDestroy, raise

Methods inherited from class ion.Meta.Element

destroy, getEventFilters, getEventHandlers, getRequestFilters, getRequestHandlers, getSimulation, getUID, schedule, wasDestroyed

Methods inherited from class java.lang.Object

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

Field Detail

SUCCESS_TAG

public static final java.lang.String SUCCESS_TAG

See Also:

Constant Field Values

Constructor Detail

Migration

public Migration(IArchitecture architecture,
                 java.lang.String configFile)

Method Detail

openConfigFile

protected java.io.InputStream openConfigFile(java.lang.String configFile)

This method is responsible for opening the configuration file correctly. It should be different depending on the platform and the way it provides access to resources.

Returns:

InputStream for the configuration file of the migration competency.

initialize

public void initialize()

Description copied from class: Competency

custom competency initialisation code should go in here

Specified by:

initialize in class Competency

getNewSynchronizer

protected Synchronizer getNewSynchronizer(int listenPort)
                                   throws java.io.IOException,
                                          javax.xml.parsers.ParserConfigurationException

Throws:

java.io.IOException

javax.xml.parsers.ParserConfigurationException

registerHandlers

public final void registerHandlers()

Description copied from class: Competency

registers request and event handlers of the competency execution system, if overridden, remember to call super.registerHandlers(); from within

Overrides:

registerHandlers in class Competency

runsInBackground

public boolean runsInBackground()

Description copied from class: Competency

every competency must provide information of whether it will run in the background permanently (returns true) or whether it will be invoked through the competency execution system (returns false)

Specified by:

runsInBackground in class Competency

competencyCode

protected boolean competencyCode(java.util.HashMap<java.lang.String,java.lang.String> parameters)

Description copied from class: Competency

every competency sub class must implement this method and in it perform the competency code. This method will run in a seperate thread, so can take its time. It should not be called from outside, instead a request should be scheduled or the convenience function requestStartComptency of this class should be used

Specified by:

competencyCode in class Competency

Parameters:

parameters - a map including running parameters and their values

Returns:

the return value of this method should indicate, whether the competency execution was a success (true) or failure (false)

addMigrationData

public void addMigrationData(org.w3c.dom.Element xmlElement)

getDeviceList

public java.util.Map<java.lang.String,Migration.Device> getDeviceList()

getAllDevices

public java.util.Set<Migration.Device> getAllDevices()

getAvailableDevices

public java.util.Set<Migration.Device> getAvailableDevices()

importConfig

public void importConfig(org.w3c.dom.Document doc)

isOccupied

public boolean isOccupied()