org.mule.extension.maven.generator

Class GenerationContext

java.lang.Object

org.mule.extension.maven.generator.GenerationContext

public final class GenerationContext
extends Object

This class contains all the information that is required to generate the Studio Extension UpdateSite. Given the MavenProject, ExtensionManifest and ExtensionModel generates all the common information that is shared between generators.

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
GenerationContext(org.apache.maven.project.MavenProject project, org.mule.runtime.extension.api.manifest.ExtensionManifest manifest, org.mule.runtime.extension.api.introspection.ExtensionModel extensionModel, File outputDirectory)

Method Summary

Modifier and Type	Method and Description
String	getArtifactName()
String	getBundleVersion()
File	getClassesDirectory()
org.mule.runtime.extension.api.Category	getExtensionCategory()
org.mule.runtime.extension.api.manifest.ExtensionManifest	getExtensionManifest()
org.mule.runtime.extension.api.introspection.ExtensionModel	getExtensionModel()
String	getExtensionPluginName()
String	getFeatureId()
String	getFeatureJarName()
org.apache.maven.project.MavenProject	getMavenProject()
File	getOutputDirectory()
String	getPluginJarName()
File	getPluginOutputDirectory()
String	getSymbolicName()

Methods inherited from class java.lang.Object

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

Constructor Detail

GenerationContext

public GenerationContext(org.apache.maven.project.MavenProject project,
                         org.mule.runtime.extension.api.manifest.ExtensionManifest manifest,
                         org.mule.runtime.extension.api.introspection.ExtensionModel extensionModel,
                         File outputDirectory)
                  throws IOException

Throws:

IOException

Method Detail

getExtensionPluginName

public String getExtensionPluginName()

Returns:

the namespace of the extension, if not found, the hyphenated name of the extension.

Example:

• Namespace example: 'HTTP Connector' to 'http'
• Hyphenated name example: 'HTTP Connector' to 'http-connector'

getFeatureId

public String getFeatureId()

Returns:

the Feature Id of the extension plugin, this name is composed by the Studio prefix, the artifact Id and the minimum mule version of the extension.

Example: 'org.mule.tooling.ui.extension.http.4.0.0'

getFeatureJarName

public String getFeatureJarName()

Returns:

the feature JAR name, this is composed by getFeatureId() and the bundle version.

Example: 'org.mule.tooling.ui.extension.http.4.0.0_4.0.0.201606291903.jar'

getPluginJarName

public String getPluginJarName()

Returns:

the plugin JAR name, this is composed by the getSymbolicName() and the bundle version.

Example: 'org.mule.tooling.ui.contribution.http.4.0.0_4.0.0.201606291903.jar'

getSymbolicName

public String getSymbolicName()

Returns:

the extension plugin symbolic name, this is composed by STUDIO_CONTRIBUTION, the getExtensionPluginName() and the minimum mule version of the extension.

Example: 'org.mule.tooling.ui.contribution.http.4.0.0'

getBundleVersion

public String getBundleVersion()

Returns:

the extension plugin bundle version, this is composed by the version taken of the Maven project and the actual date in 'yyyyMMddHHmm' format.

Example: '4.0.0.201606291903'

getArtifactName

public String getArtifactName()

Returns:

the extension artifact name, this name is composed by the Maven Artifact Id and the project version.

Example: 'mule-module-http-4.0-SNAPSHOT.zip'

getExtensionCategory

public org.mule.runtime.extension.api.Category getExtensionCategory()

Returns:

the extension's Category.

See Also:

Category

getMavenProject

public org.apache.maven.project.MavenProject getMavenProject()

Returns:

the MavenProject of the extension project

getExtensionManifest

public org.mule.runtime.extension.api.manifest.ExtensionManifest getExtensionManifest()

Returns:

the extension's ExtensionManifest

getExtensionModel

public org.mule.runtime.extension.api.introspection.ExtensionModel getExtensionModel()

Returns:

the extension's ExtensionModel

getPluginOutputDirectory

public File getPluginOutputDirectory()

Returns:

a File pointing to the plugin output directory

getOutputDirectory

public File getOutputDirectory()

Returns:

a File pointing to the output/target project directory

getClassesDirectory

public File getClassesDirectory()

Returns:

a File pointing to the output classes directory