fr.fastconnect.factory.tibco.bw.maven.bwengine

Class AbstractServiceEngineMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

fr.fastconnect.factory.tibco.bw.maven.AbstractBWMojo

fr.fastconnect.factory.tibco.bw.maven.bwengine.AbstractServiceEngineMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

public abstract class AbstractServiceEngineMojo
extends AbstractBWMojo

This abstract class defines the core features for the execution of Service inside a BusinessWorks engine.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	BWENGINE_ERROR_STARTING
protected static java.lang.String	BWENGINE_MISSING
protected static java.lang.String	BWENGINE_STARTING
protected static java.lang.String	BWENGINE_STOPPING
protected static java.lang.String	BWENGINE_TIMEOUT_STARTING
protected int	maxPort The maximum value for the randomly chosen port.
protected int	minPort The minimum value for the randomly chosen port.
protected ServiceAgentInEngine<?>	serviceAgent A Service Agent is a Web Service representation in TIBCO BusinessWorks.
protected java.io.File	tibcoBWEnginePath Path to the BusinessWorks Engine binary.

Fields inherited from class fr.fastconnect.factory.tibco.bw.maven.AbstractBWMojo

ALIASES_FILE, APPMANAGE_BINARY_NOTFOUND, buildLibDirectory, buildSrcDirectory, BWEAR_DEPLOY_TYPE, BWEAR_EXTENSION, BWEAR_TYPE, BWPROJECT_NOTFOUND, BWPROJECT_PREF_LIB_ERROR_MSG, dependenciesIgnored, DESIGNER_BINARY_NOTFOUND, DESIGNER5_PREFS, directory, DTL_FILE_NAME, FILE_ALIAS_PREFIX, FILE_ALIAS_PREFIX_ESCAPED, HAWK_BINARY_NOTFOUND, hawkDomain, hawkRvDaemon, hawkRvNetwork, hawkRvService, hawkSubscribeInterval, hawkSubscribeNumberOfRetry, hawkVersion, hideLibraryResources, JAR_EXTENSION, JAR_TYPE, mavenPropertyPattern, outputDirectory, packageDirectory, POM_EXTENSION, POM_TYPE, projectDirectory, PROJLIB_EXTENSION, PROJLIB_TYPE, PROPERTIES_EXTENSION, session, SKIPPING, sourceEncoding, testDirectory, testLibDirectory, testSrcDirectory, TIBCO_ALIAS_PREFIX, TIBCO_HOME_DIR, tibcoAppManagePath, tibcoAppManageTRAPath, tibcoBuildEARTRAPath, tibcoBuildEARUseDesignerTRA, tibcoBuildLibraryTRAPath, tibcoBuildLibraryUseDesignerTRA, tibcoBWEngineTRAPath, tibcoDesignerPath, tibcoDesignerTRAPath, tibcoHome, tibcoRvHomePath, timeOut, XML_EXTENSION, XML_TYPE

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractServiceEngineMojo()

Method Summary

Modifier and Type	Method and Description
static boolean	available(int port, int minPort, int maxPort)
void	execute() The execute method of this Mojo will : check that the BusinessWorks project exists copy the Designer5.prefs file copy the .designtimelibs file useful for setting a TIBCO environment for the project being built.
abstract void	executeServiceMethods()
abstract java.lang.String	getBWEnginePort()
java.lang.Integer	getFreePort()
java.lang.Integer	getFreePort(int minPort, int maxPort)
protected abstract java.io.File	getProjectToRunPath()
abstract int	getRetryInterval()
abstract java.lang.String	getServiceFailureMessage()
abstract java.lang.String	getServiceName()
abstract java.lang.String	getServiceTimeoutMessage()
int	getTimeOut()
abstract void	initServiceAgent()
boolean	isStarted()
void	stopEngine() This will call the stopEngine() method of the Service Agent.

Methods inherited from class fr.fastconnect.factory.tibco.bw.maven.AbstractBWMojo

checkAppManage, checkDesigner, enableTestScope, getAliasesFile, getBWEARAlias, getBWEARName, getBWEARsDependencies, getDependencies, getDependencyPath, getDesigner5Prefs, getJarAlias, getJarDependencies, getJarName, getProject, getProjlibAlias, getProjlibName, getProjlibsDependencies, getPropertyValue, getPropertyValue, getPropertyValue, getPropertyValue, getPropertyValueInSettings, getRootProjectProperty, getRootProjectProperty, getSession, initHawk, isCurrentGoal, launchTIBCOBinary, launchTIBCOBinary, propertiesManager, propertyExists, propertyExists, propertyExistsInSettings, propertyExistsInSettings, readDependenciesFromFile, replaceProperties, setProject, setSession, setSettings

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Field Detail

BWENGINE_MISSING

protected static final java.lang.String BWENGINE_MISSING

See Also:

Constant Field Values

BWENGINE_STARTING

protected static final java.lang.String BWENGINE_STARTING

See Also:

Constant Field Values

BWENGINE_STOPPING

protected static final java.lang.String BWENGINE_STOPPING

See Also:

Constant Field Values

BWENGINE_ERROR_STARTING

protected static final java.lang.String BWENGINE_ERROR_STARTING

See Also:

Constant Field Values

BWENGINE_TIMEOUT_STARTING

protected static final java.lang.String BWENGINE_TIMEOUT_STARTING

See Also:

Constant Field Values

tibcoBWEnginePath

@Parameter(property="bwengine.path",
           required=true)
protected java.io.File tibcoBWEnginePath

Path to the BusinessWorks Engine binary.

minPort

@Parameter(property="bw.service.minPort",
           defaultValue="49152")
protected int minPort

The minimum value for the randomly chosen port.

maxPort

@Parameter(property="bw.service.maxPort",
           defaultValue="65535")
protected int maxPort

The maximum value for the randomly chosen port.

serviceAgent

protected ServiceAgentInEngine<?> serviceAgent

A Service Agent is a Web Service representation in TIBCO BusinessWorks. This Service Agent will be started when the BusinessWorks engine starts.

Constructor Detail

AbstractServiceEngineMojo

public AbstractServiceEngineMojo()

Method Detail

isStarted

public boolean isStarted()

Returns:

true si le Service Agent répond à l'invocation de la méthode isStarted qui agit comme une méthode de type "ping" pour savoir si le service est bien lancé, false sinon.

stopEngine

public void stopEngine()

This will call the stopEngine() method of the Service Agent. The Service Agent will then stop the BusinessWorks engine.

initServiceAgent

public abstract void initServiceAgent()
                               throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

executeServiceMethods

public abstract void executeServiceMethods()
                                    throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getBWEnginePort

public abstract java.lang.String getBWEnginePort()

getRetryInterval

public abstract int getRetryInterval()

getServiceName

public abstract java.lang.String getServiceName()

getServiceFailureMessage

public abstract java.lang.String getServiceFailureMessage()

getServiceTimeoutMessage

public abstract java.lang.String getServiceTimeoutMessage()

getTimeOut

public int getTimeOut()

available

public static boolean available(int port,
                                int minPort,
                                int maxPort)

getFreePort

public java.lang.Integer getFreePort(int minPort,
                                     int maxPort)

getFreePort

public java.lang.Integer getFreePort()

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException

Description copied from class: AbstractBWMojo

The execute method of this Mojo will :

• check that the BusinessWorks project exists
• copy the Designer5.prefs file
• copy the .designtimelibs file useful for setting a TIBCO environment for the project being built.

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Overrides:

execute in class AbstractBWMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

getProjectToRunPath

protected abstract java.io.File getProjectToRunPath()