net.ssehub.easy.standalone.cmd

Class InstantiationCommands

java.lang.Object

net.ssehub.easy.standalone.cmd.InstantiationCommands

public final class InstantiationCommands
extends java.lang.Object

Static commands for instantiating projects via the command line or by a build tool. Files/Folders to be passed in through this interface shall be absolute! This class considers ProjectNameMapper.
Before calling any of the methods here, EASy must be loaded via calling LowlevelCommands.startEASy().

Author:

El-Sharkawy

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	InstantiationCommands.InstantiationListener Listener to collect VilExceptions during script execution.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	InstantiationCommands() Should prevent instantiation of this utility class.

Method Summary

Modifier and Type	Method and Description
private static boolean	checkIsNestedFile(java.io.File possibleParent, java.io.File maybeChild) Checks whether maybeChild is nested inside of possibleParent.
private static net.ssehub.easy.producer.core.mgmt.VilArgumentProvider	createArgumentProvider(java.util.Map<java.lang.String,java.lang.Object> arguments) Creates an argument provider and registers it with VilArgumentProvider if necessary.
private static void	createPLPsAndInstantiate(java.io.File projectSource, java.io.File projectTarget, net.ssehub.easy.varModel.model.Project ivmlProject, net.ssehub.easy.instantiation.core.model.buildlangModel.Script buildScript, java.util.Map<java.lang.String,java.lang.Object> arguments) Creates two (temporary) PLPInfos, links them (sets prede-/successor), and instantiates the successor.
private static void	createTargetFolder(java.io.File projectSource, java.io.File projectTarget) Creates projectTarget if it does not exist.
static void	instantiate(java.io.File projectSource, java.io.File projectTarget) Instantiates the project projectTarget, while using source files (and IVML/VIL information) provided by projectSource.
static void	instantiate(java.io.File projectSource, java.io.File projectTarget, java.io.File ivmlFile, java.io.File scriptFile) Uses projectSource to instantiate projectTarget.
static void	instantiate(java.io.File projectSource, java.io.File projectTarget, java.io.File ivmlFile, java.io.File scriptFile, java.util.Map<java.lang.String,java.lang.Object> arguments) Uses projectSource to instantiate projectTarget.
static void	instantiate(java.io.File projectSource, java.io.File projectTarget, java.util.Map<java.lang.String,java.lang.Object> arguments) Instantiates the project projectTarget, while using source files (and IVML/VIL information) provided by projectSource.
static void	instantiate(java.io.File projectSource, java.io.File projectTarget, ModelLoadDefinition ivmlDefinition, ModelLoadDefinition vilDefinition) Uses projectSource to instantiate projectTarget.
static void	instantiate(java.io.File projectSource, java.io.File projectTarget, ModelLoadDefinition ivmlDefinition, ModelLoadDefinition vilDefinition, java.util.Map<java.lang.String,java.lang.Object> arguments) Uses projectSource to instantiate projectTarget.
private static void	instantiateEASyProjects(java.io.File projectSource, java.io.File projectTarget, java.util.Map<java.lang.String,java.lang.Object> arguments) Instantiates the project projectTarget, while using source files (and IVML/VIL information) provided by projectSource.
static void	instantiateSelf(java.io.File project) Instantiates the given project.
static void	instantiateSelf(java.io.File project, java.io.File ivmlFile) Instantiates the given project.
static void	instantiateSelf(java.io.File project, java.io.File ivmlFile, java.io.File buildScriptFile) Instantiates the given project.
static void	instantiateSelf(java.io.File project, java.io.File ivmlFile, java.io.File buildScriptFile, java.util.Map<java.lang.String,java.lang.Object> arguments) Instantiates the given project.
static void	instantiateSelf(java.io.File project, java.io.File ivmlFile, java.util.Map<java.lang.String,java.lang.Object> arguments) Instantiates the given project.
static void	instantiateSelf(java.io.File project, java.util.Map<java.lang.String,java.lang.Object> arguments) Instantiates the given project.

Methods inherited from class java.lang.Object

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

Constructor Detail

InstantiationCommands

private InstantiationCommands()

Should prevent instantiation of this utility class.

Method Detail

instantiateSelf

public static void instantiateSelf(java.io.File project)
                            throws net.ssehub.easy.producer.core.persistence.PersistenceException,
                                   net.ssehub.easy.instantiation.core.model.common.VilException

Instantiates the given project. The project must:

• be a valid EASy project with the usual configuration files and folders.
• contain a frozen configuration
• contain VIL script which can be applied to itself

Parameters:

project - The toplevel absolute folder of the project (must have a valid EASy structure)

Throws:

net.ssehub.easy.producer.core.persistence.PersistenceException - Will be thrown if the project could not be loaded, e.g. if the project has no valid EASy structure.

net.ssehub.easy.instantiation.core.model.common.VilException - In case that artifact operations or script execution fails

instantiateSelf

public static void instantiateSelf(java.io.File project,
                                   java.util.Map<java.lang.String,java.lang.Object> arguments)
                            throws net.ssehub.easy.producer.core.persistence.PersistenceException,
                                   net.ssehub.easy.instantiation.core.model.common.VilException

Instantiates the given project. The project must:

• be a valid EASy project with the usual configuration files and folders.
• contain a frozen configuration
• contain VIL script which can be applied to itself

Parameters:

project - The toplevel absolute folder of the project (must have a valid EASy structure)

arguments - a name-element mapping specifying the top-level parameter of a VIL instantiation (may be null)

Throws:

net.ssehub.easy.producer.core.persistence.PersistenceException - Will be thrown if the project could not be loaded, e.g. if the project has no valid EASy structure.

net.ssehub.easy.instantiation.core.model.common.VilException - In case that artifact operations or script execution fails

instantiateSelf

public static void instantiateSelf(java.io.File project,
                                   java.io.File ivmlFile)
                            throws net.ssehub.easy.basics.modelManagement.ModelManagementException,
                                   net.ssehub.easy.instantiation.core.model.common.VilException,
                                   net.ssehub.easy.producer.core.persistence.PersistenceException

Instantiates the given project. The project must:

• contain VIL script which can be applied to itself, which uses the usual EASy naming convention for VIL scripts in Version 0.

This method is a convenience wrapper for instantiateSelf(File, File, Map) with null as arguments.

Parameters:

project - The toplevel absolute folder of the project

ivmlFile - A frozen configuration, which should be used for instantiation.

Throws:

net.ssehub.easy.basics.modelManagement.ModelManagementException - In case that the available information may be come inconsistent due to this update

net.ssehub.easy.instantiation.core.model.common.VilException - In case that artifact operations or script execution fails

net.ssehub.easy.producer.core.persistence.PersistenceException - Will be thrown if at least one of the IVML or VIL files could not be loaded.

instantiateSelf

public static void instantiateSelf(java.io.File project,
                                   java.io.File ivmlFile,
                                   java.util.Map<java.lang.String,java.lang.Object> arguments)
                            throws net.ssehub.easy.basics.modelManagement.ModelManagementException,
                                   net.ssehub.easy.instantiation.core.model.common.VilException,
                                   net.ssehub.easy.producer.core.persistence.PersistenceException

Instantiates the given project. The project must:

• contain VIL script which can be applied to itself, which uses the usual EASy naming convention for VIL scripts in Version 0.

Parameters:

project - The toplevel absolute folder of the project

ivmlFile - A frozen configuration, which should be used for instantiation.

arguments - a name-element mapping specifying the top-level parameter of a VIL instantiation (may be null)

Throws:

net.ssehub.easy.basics.modelManagement.ModelManagementException - In case that the available information may be come inconsistent due to this update

net.ssehub.easy.instantiation.core.model.common.VilException - In case that artifact operations or script execution fails

net.ssehub.easy.producer.core.persistence.PersistenceException - Will be thrown if at least one of the IVML or VIL files could not be loaded.

instantiateSelf

public static void instantiateSelf(java.io.File project,
                                   java.io.File ivmlFile,
                                   java.io.File buildScriptFile)
                            throws net.ssehub.easy.basics.modelManagement.ModelManagementException,
                                   net.ssehub.easy.instantiation.core.model.common.VilException,
                                   net.ssehub.easy.producer.core.persistence.PersistenceException

Instantiates the given project.
It's not necessary that the project has a valid EASy structure. This method is a convenience wrapper for instantiateSelf(File, File, File, Map) with null as arguments.

Parameters:

project - The toplevel absolute folder of the project

ivmlFile - A frozen configuration, which should be used for instantiation.

buildScriptFile - The main build script (starting point) which should be used for instantiation.

Throws:

net.ssehub.easy.basics.modelManagement.ModelManagementException - In case that the available information may become inconsistent due to this update

net.ssehub.easy.instantiation.core.model.common.VilException - In case that artifact operations or script execution fails

net.ssehub.easy.producer.core.persistence.PersistenceException - Will be thrown if at least one of the IVML or VIL files could not be loaded.

instantiateSelf

public static void instantiateSelf(java.io.File project,
                                   java.io.File ivmlFile,
                                   java.io.File buildScriptFile,
                                   java.util.Map<java.lang.String,java.lang.Object> arguments)
                            throws net.ssehub.easy.basics.modelManagement.ModelManagementException,
                                   net.ssehub.easy.instantiation.core.model.common.VilException,
                                   net.ssehub.easy.producer.core.persistence.PersistenceException

Instantiates the given project.
It's not necessary that the project has a valid EASy structure.

Parameters:

project - The toplevel absolute folder of the project

ivmlFile - A frozen configuration, which should be used for instantiation.

buildScriptFile - The main build script (starting point) which should be used for instantiation.

arguments - a name-element mapping specifying the top-level parameter of a VIL instantiation (may be null)

Throws:

net.ssehub.easy.basics.modelManagement.ModelManagementException - In case that the available information may become inconsistent due to this update

net.ssehub.easy.instantiation.core.model.common.VilException - In case that artifact operations or script execution fails

net.ssehub.easy.producer.core.persistence.PersistenceException - Will be thrown if at least one of the IVML or VIL files could not be loaded.

createArgumentProvider

private static net.ssehub.easy.producer.core.mgmt.VilArgumentProvider createArgumentProvider(java.util.Map<java.lang.String,java.lang.Object> arguments)

Creates an argument provider and registers it with VilArgumentProvider if necessary.

Parameters:

arguments - the arguments to be passed to VIL (may be null)

Returns:

the argument provider if one was created and registered, null else

instantiate

public static void instantiate(java.io.File projectSource,
                               java.io.File projectTarget)
                        throws net.ssehub.easy.producer.core.persistence.PersistenceException,
                               net.ssehub.easy.instantiation.core.model.common.VilException,
                               java.io.IOException

Instantiates the project projectTarget, while using source files (and IVML/VIL information) provided by projectSource. The following conditions must be hold:

1. Both projects must exist and have a valid EASy project structure with the usual configuration files, IDs, and folders.
2. projectTarget must contain a contain a frozen configuration.
3. projectTarget must contain VIL script.
4. projectSource must contain a infrastructure, which cen be instantiated, e.g. annotated source files.

If projectTarget does not exist, this method will create the folder. In this case, 2.) and 3.) must be included in projectSource. This method is a convenience wrapper for instantiate(File, File, Map) with null as arguments.

Parameters:

projectSource - The toplevel absolute folder of an EASy project (must have a valid EASy structure), which serves as a basis for instantiation.

projectTarget - The toplevel absolute folder of an EASy project (must have a valid EASy structure), which should be instantiated.

Throws:

net.ssehub.easy.producer.core.persistence.PersistenceException - Will be thrown if one of the projects could not be loaded, e.g. if the project has no valid EASy structure.

net.ssehub.easy.instantiation.core.model.common.VilException - In case that artifact operations or script execution fails

java.io.IOException - If source or destination is invalid, or if an IO error occurs during copying

instantiate

public static void instantiate(java.io.File projectSource,
                               java.io.File projectTarget,
                               java.util.Map<java.lang.String,java.lang.Object> arguments)
                        throws net.ssehub.easy.producer.core.persistence.PersistenceException,
                               net.ssehub.easy.instantiation.core.model.common.VilException,
                               java.io.IOException

Instantiates the project projectTarget, while using source files (and IVML/VIL information) provided by projectSource. The following conditions must be hold:

1. Both projects must exist and have a valid EASy project structure with the usual configuration files, IDs, and folders.
2. projectTarget must contain a contain a frozen configuration.
3. projectTarget must contain VIL script.
4. projectSource must contain a infrastructure, which cen be instantiated, e.g. annotated source files.

If projectTarget does not exist, this method will create the folder. In this case, 2.) and 3.) must be included in projectSource.

Parameters:

projectSource - The toplevel absolute folder of an EASy project (must have a valid EASy structure), which serves as a basis for instantiation.

projectTarget - The toplevel absolute folder of an EASy project (must have a valid EASy structure), which should be instantiated.

arguments - a name-element mapping specifying the top-level parameter of a VIL instantiation (may be null)

Throws:

net.ssehub.easy.producer.core.persistence.PersistenceException - Will be thrown if one of the projects could not be loaded, e.g. if the project has no valid EASy structure.

net.ssehub.easy.instantiation.core.model.common.VilException - In case that artifact operations or script execution fails

java.io.IOException - If source or destination is invalid, or if an IO error occurs during copying

instantiateEASyProjects

private static void instantiateEASyProjects(java.io.File projectSource,
                                            java.io.File projectTarget,
                                            java.util.Map<java.lang.String,java.lang.Object> arguments)
                                     throws net.ssehub.easy.producer.core.persistence.PersistenceException,
                                            net.ssehub.easy.instantiation.core.model.common.VilException

Instantiates the project projectTarget, while using source files (and IVML/VIL information) provided by projectSource. The following conditions must be hold:

• Both projects must exist and have a valid EASy project structure with the usual configuration files, IDs, and folders.
• projectTarget must contain a contain a frozen configuration.
• projectTarget must contain VIL script.
• projectSource must contain a infrastructure, which cen be instantiated, e.g. annotated source files.

Parameters:

projectSource - The toplevel absolute folder of an EASy project (must have a valid EASy structure), which serves as a basis for instantiation.

projectTarget - The toplevel absolute folder of an EASy project (must have a valid EASy structure), which should be instantiated.

arguments - a name-element mapping specifying the top-level parameter of a VIL instantiation (may be null)

Throws:

net.ssehub.easy.producer.core.persistence.PersistenceException - Will be thrown if one of the projects could not be loaded, e.g. if the project has no valid EASy structure.

net.ssehub.easy.instantiation.core.model.common.VilException - In case that artifact operations or script execution fails

instantiate

public static void instantiate(java.io.File projectSource,
                               java.io.File projectTarget,
                               java.io.File ivmlFile,
                               java.io.File scriptFile)
                        throws net.ssehub.easy.basics.modelManagement.ModelManagementException,
                               java.lang.SecurityException,
                               net.ssehub.easy.producer.core.persistence.PersistenceException,
                               net.ssehub.easy.instantiation.core.model.common.VilException,
                               java.io.IOException

Uses projectSource to instantiate projectTarget. The folder projectTarget will be created, if it does not exist. This method is a convenience wrapper for instantiate(File, File, File, File, Map) with null as arguments.

Parameters:

projectSource - An absolute folder/project, which contains the product line infrastructure, i.e. files to instantiate.

projectTarget - An absolute folder/project where the files should be instantiated in. The folder will be created if it does not exist.

ivmlFile - The model definition including its frozen configuration, which should be used for instantiation. (Must be inside either of projectSource or projectTarget).

scriptFile - The main build script (starting point) which should be used for instantiation. (Must be inside either of projectSource or projectTarget).

Throws:

java.lang.SecurityException - If projectTarget does not exist, a security manager exists, and its SecurityManager.checkWrite(java.lang.String) method does not permit projectTarget directory to be created

net.ssehub.easy.basics.modelManagement.ModelManagementException - In case that the available information may become inconsistent due to this update

net.ssehub.easy.instantiation.core.model.common.VilException - In case that artifact operations or script execution fails

net.ssehub.easy.producer.core.persistence.PersistenceException - Will be thrown if at least one of the IVML or VIL files could not be loaded.

java.io.IOException - If source or destination is invalid, or if an IO error occurs during copying

instantiate

public static void instantiate(java.io.File projectSource,
                               java.io.File projectTarget,
                               java.io.File ivmlFile,
                               java.io.File scriptFile,
                               java.util.Map<java.lang.String,java.lang.Object> arguments)
                        throws net.ssehub.easy.basics.modelManagement.ModelManagementException,
                               java.lang.SecurityException,
                               net.ssehub.easy.producer.core.persistence.PersistenceException,
                               net.ssehub.easy.instantiation.core.model.common.VilException,
                               java.io.IOException

Uses projectSource to instantiate projectTarget. The folder projectTarget will be created, if it does not exist.

Parameters:

projectSource - An absolute folder/project, which contains the product line infrastructure, i.e. files to instantiate.

projectTarget - An absolute folder/project where the files should be instantiated in. The folder will be created if it does not exist.

ivmlFile - The model definition including its frozen configuration, which should be used for instantiation. (Must be inside either of projectSource or projectTarget).

scriptFile - The main build script (starting point) which should be used for instantiation. (Must be inside either of projectSource or projectTarget).

arguments - a name-element mapping specifying the top-level parameter of a VIL instantiation (may be null)

Throws:

java.lang.SecurityException - If projectTarget does not exist, a security manager exists, and its SecurityManager.checkWrite(java.lang.String) method does not permit projectTarget directory to be created

net.ssehub.easy.basics.modelManagement.ModelManagementException - In case that the available information may become inconsistent due to this update

net.ssehub.easy.instantiation.core.model.common.VilException - In case that artifact operations or script execution fails

net.ssehub.easy.producer.core.persistence.PersistenceException - Will be thrown if at least one of the IVML or VIL files could not be loaded.

java.io.IOException - If source or destination is invalid, or if an IO error occurs during copying

createPLPsAndInstantiate

private static void createPLPsAndInstantiate(java.io.File projectSource,
                                             java.io.File projectTarget,
                                             net.ssehub.easy.varModel.model.Project ivmlProject,
                                             net.ssehub.easy.instantiation.core.model.buildlangModel.Script buildScript,
                                             java.util.Map<java.lang.String,java.lang.Object> arguments)
                                      throws net.ssehub.easy.instantiation.core.model.common.VilException

Creates two (temporary) PLPInfos, links them (sets prede-/successor), and instantiates the successor.

Parameters:

projectSource - An absolute folder/project, which contains the product line infrastructure, i.e. files to instantiate.

projectTarget - An existing absolute folder/project where the files should be instantiated in.

ivmlProject - A loaded configuration, which should be used for instantiation (Must not be null).

buildScript - A loaded build script, which should be used for instantiation (Must not be null).

arguments - a name-element mapping specifying the top-level parameter of a VIL instantiation (may be null)

Throws:

net.ssehub.easy.instantiation.core.model.common.VilException - In case that artifact operations or script execution fails

instantiate

public static void instantiate(java.io.File projectSource,
                               java.io.File projectTarget,
                               ModelLoadDefinition ivmlDefinition,
                               ModelLoadDefinition vilDefinition)
                        throws net.ssehub.easy.producer.core.persistence.PersistenceException,
                               java.io.IOException,
                               net.ssehub.easy.basics.modelManagement.ModelManagementException,
                               net.ssehub.easy.instantiation.core.model.common.VilException

Uses projectSource to instantiate projectTarget. The folder projectTarget will be created, if it does not exist. This method is a convenience wrapper for instantiate(File, File, ModelLoadDefinition, ModelLoadDefinition, Map) with null as arguments.

Parameters:

projectSource - An absolute folder/project, which contains the product line infrastructure, i.e. files to instantiate.

projectTarget - An absolute folder/project where the files should be instantiated in. The folder will be created if it does not exist.

ivmlDefinition - A (model name, version) pair for specifying which Project should be used for instantantion. The Project must be located inside of projectTarget or projectSource. This method first tries to load the Project from the projectTarget before it tries to load the Project from the projectSource.

vilDefinition - A (model name, version) pair for specifying which Script should be used for instantantion. The Script must be located inside of projectTarget or projectSource. This method first tries to load the Script from the projectTarget before it tries to load the Script from the projectSource.

Throws:

net.ssehub.easy.producer.core.persistence.PersistenceException - Will be thrown if at least one of the IVML or VIL files could not be loaded.

java.io.IOException - If source or destination is invalid, or if an IO error occurs during copying

net.ssehub.easy.basics.modelManagement.ModelManagementException - In case that the available information may become inconsistent due to this update

net.ssehub.easy.instantiation.core.model.common.VilException - In case that artifact operations or script execution fails

instantiate

public static void instantiate(java.io.File projectSource,
                               java.io.File projectTarget,
                               ModelLoadDefinition ivmlDefinition,
                               ModelLoadDefinition vilDefinition,
                               java.util.Map<java.lang.String,java.lang.Object> arguments)
                        throws net.ssehub.easy.producer.core.persistence.PersistenceException,
                               java.io.IOException,
                               net.ssehub.easy.basics.modelManagement.ModelManagementException,
                               net.ssehub.easy.instantiation.core.model.common.VilException

Uses projectSource to instantiate projectTarget. The folder projectTarget will be created, if it does not exist.

Parameters:

projectSource - An absolute folder/project, which contains the product line infrastructure, i.e. files to instantiate.

projectTarget - An absolute folder/project where the files should be instantiated in. The folder will be created if it does not exist.

ivmlDefinition - A (model name, version) pair for specifying which Project should be used for instantantion. The Project must be located inside of projectTarget or projectSource. This method first tries to load the Project from the projectTarget before it tries to load the Project from the projectSource.

vilDefinition - A (model name, version) pair for specifying which Script should be used for instantantion. The Script must be located inside of projectTarget or projectSource. This method first tries to load the Script from the projectTarget before it tries to load the Script from the projectSource.

arguments - a name-element mapping specifying the top-level parameter of a VIL instantiation (may be null)

Throws:

net.ssehub.easy.producer.core.persistence.PersistenceException - Will be thrown if at least one of the IVML or VIL files could not be loaded.

java.io.IOException - If source or destination is invalid, or if an IO error occurs during copying

net.ssehub.easy.basics.modelManagement.ModelManagementException - In case that the available information may become inconsistent due to this update

net.ssehub.easy.instantiation.core.model.common.VilException - In case that artifact operations or script execution fails

checkIsNestedFile

private static boolean checkIsNestedFile(java.io.File possibleParent,
                                         java.io.File maybeChild)

Checks whether maybeChild is nested inside of possibleParent.

Parameters:

possibleParent - A folder which may contain maybeChild.

maybeChild - A file or folder which should be located inside of possibleParent.

Returns:

true if maybeChild is nested inside of possibleParent, false otherwise.

See Also:

http://stackoverflow.com/questions/4746671/how-to-check-if-a-given-path-is-possible-child-of-another-path

createTargetFolder

private static void createTargetFolder(java.io.File projectSource,
                                       java.io.File projectTarget)
                                throws net.ssehub.easy.producer.core.persistence.PersistenceException,
                                       java.io.IOException

Creates projectTarget if it does not exist. Copies also all configuration files, i.e. the EASy folder from projectSource to projectTarget.

Parameters:

projectSource - A EASy project which contains a EASy folder with IVML/VIL files.

projectTarget - The folder which shall be created.

Throws:

net.ssehub.easy.producer.core.persistence.PersistenceException - Will be thrown if the folder could not be created.

java.io.IOException - If source or destination is invalid, or if an IO error occurs during copying