org.kie.api.builder.helper
Class FluentKieModuleDeploymentHelper

java.lang.Object
  org.kie.api.builder.helper.KieModuleDeploymentHelper
      org.kie.api.builder.helper.FluentKieModuleDeploymentHelper

public abstract class FluentKieModuleDeploymentHelper
extends KieModuleDeploymentHelper

A fluent interface to the KieModuleDeploymentHelper functionality. See the KieModuleDeploymentHelper for more info.

Constructor Summary

FluentKieModuleDeploymentHelper()

Method Summary

abstract FluentKieModuleDeploymentHelper	addClass(Class<?>... classForKjar) Add a class that should be included in the Kjar.
abstract FluentKieModuleDeploymentHelper	addDependencies(String... dependency) Add one or more dependencies (specified by a "G:A:V" string) that the Kjar should use.
abstract FluentKieModuleDeploymentHelper	addResourceFilePath(String... resourceFilePath) Add a path containing one or more resources.
abstract org.kie.api.builder.KieModule	createKieJar() Create the Kjar
abstract void	createKieJarAndDeployToMaven() Create the Kjar and deploy (install) it to the local maven repository.
abstract org.kie.api.builder.model.KieModuleModel	getKieModuleModel() Get the KieModuleModel.
abstract FluentKieModuleDeploymentHelper	resetHelper() Reset the helper.
abstract FluentKieModuleDeploymentHelper	setArtifactId(String artifactId) Set the artifact id of the Kjar
abstract FluentKieModuleDeploymentHelper	setClasses(List<Class<?>> classesForKjar) Set the list of classes to be added to the Kjar.
abstract FluentKieModuleDeploymentHelper	setDependencies(List<String> dependencies) Set the list of dependencies that the Kjar should use.
abstract FluentKieModuleDeploymentHelper	setGroupId(String groupId) Set the group id of the Kjar
abstract FluentKieModuleDeploymentHelper	setKBaseName(String kbaseName) Set a KieBase name.
abstract FluentKieModuleDeploymentHelper	setKieSessionname(String ksessionName) Set the KieSession name.
abstract FluentKieModuleDeploymentHelper	setResourceFilePaths(List<String> resourceFilePaths) Set the list of paths containing resources.
abstract FluentKieModuleDeploymentHelper	setVersion(String version) Set the (pom) version of the Kjar

Methods inherited from class org.kie.api.builder.helper.KieModuleDeploymentHelper

newFluentInstance, newSingleInstance

Methods inherited from class java.lang.Object

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

Constructor Detail

FluentKieModuleDeploymentHelper

public FluentKieModuleDeploymentHelper()

Method Detail

setGroupId

public abstract FluentKieModuleDeploymentHelper setGroupId(String groupId)

Set the group id of the Kjar

Parameters:

groupId - The group id

Returns:

The helper instance

setArtifactId

public abstract FluentKieModuleDeploymentHelper setArtifactId(String artifactId)

Set the artifact id of the Kjar

Parameters:

artifactId - The artifact id

Returns:

The helper instance

setVersion

public abstract FluentKieModuleDeploymentHelper setVersion(String version)

Set the (pom) version of the Kjar

Parameters:

version - The version

Returns:

The helper instance

setKBaseName

public abstract FluentKieModuleDeploymentHelper setKBaseName(String kbaseName)

Set a KieBase name.

If you want to add multiple KieBase's, use the getKieModuleModel() method.

Parameters:

kbaseName - The KieBase name

Returns:

The helper instance

setKieSessionname

public abstract FluentKieModuleDeploymentHelper setKieSessionname(String ksessionName)

Set the KieSession name.

If you want to add multiple KieSession's, use the getKieModuleModel() method.

Parameters:

ksessionName - The KieSession name

Returns:

The helper instance

setResourceFilePaths

public abstract FluentKieModuleDeploymentHelper setResourceFilePaths(List<String> resourceFilePaths)

Set the list of paths containing resources. If the path refers to a directory, all files in that directory will be added as resource files.

Parameters:

resourceFilePaths - The list of resource file paths

Returns:

The helper instance

addResourceFilePath

public abstract FluentKieModuleDeploymentHelper addResourceFilePath(String... resourceFilePath)

Add a path containing one or more resources. If the path is a directory, all files in the directory will be added as resource files.

Parameters:

resourceFilePath - The resource file path

Returns:

The helper instance

setClasses

public abstract FluentKieModuleDeploymentHelper setClasses(List<Class<?>> classesForKjar)

Set the list of classes to be added to the Kjar.

Parameters:

classesForKjar - The list of classes

Returns:

The helper instance

addClass

public abstract FluentKieModuleDeploymentHelper addClass(Class<?>... classForKjar)

Add a class that should be included in the Kjar.

Parameters:

classForKjar - The class

Returns:

The helper instance

setDependencies

public abstract FluentKieModuleDeploymentHelper setDependencies(List<String> dependencies)

Set the list of dependencies that the Kjar should use.

Parameters:

dependencies - The list of dependencies

Returns:

The helper instance

addDependencies

public abstract FluentKieModuleDeploymentHelper addDependencies(String... dependency)

Add one or more dependencies (specified by a "G:A:V" string) that the Kjar should use.

Parameters:

dependency - One or more strings specifying a dependency

Returns:

The helper instance

getKieModuleModel

public abstract org.kie.api.builder.model.KieModuleModel getKieModuleModel()

Get the KieModuleModel. Use the KieModuleModel instance to add more KieBase or KieSession instances as well as add or change the default configuration of the KieSession's.

Returns:

The KieModuleModel instance

resetHelper

public abstract FluentKieModuleDeploymentHelper resetHelper()

Reset the helper. This clears ALL configuration that has been done up to this point on the helper instance.

Returns:

The helper instance

createKieJar

public abstract org.kie.api.builder.KieModule createKieJar()

Create the Kjar

Returns:

The KieModule that represents the Kjar

createKieJarAndDeployToMaven

public abstract void createKieJarAndDeployToMaven()

Create the Kjar and deploy (install) it to the local maven repository.