org.switchyard.component.common.knowledge.config.builder.patch

Class PatchedRuntimeEnvironmentBuilder

java.lang.Object

org.switchyard.component.common.knowledge.config.builder.patch.PatchedRuntimeEnvironmentBuilder

All Implemented Interfaces:

org.kie.api.runtime.manager.RuntimeEnvironmentBuilder, org.kie.api.runtime.manager.RuntimeEnvironmentBuilderFactory

public class PatchedRuntimeEnvironmentBuilder
extends Object
implements org.kie.api.runtime.manager.RuntimeEnvironmentBuilderFactory, org.kie.api.runtime.manager.RuntimeEnvironmentBuilder

Builder implementation that follows fluent approach to build RuntimeEnvironments. Comes with short cut methods to get predefined configurations of the RuntimeEnvironment:

• getDefault() - returns preconfigured environment with enabled persistence
• getDefaultInMemory() - returns preconfigured environment with disabled persistence for runtime engine
• getDefault(ReleaseId) - returns preconfigured environment with enabled persistence that is tailored for kjar
• getDefault(ReleaseId, String, String) - returns preconfigured environment with enabled persistence that is tailored for kjar and allows to specify kbase and ksession name
• getDefault(String, String, String) - returns preconfigured environment with enabled persistence that is tailored for kjar
• getDefault(String, String, String, String, String) - returns preconfigured environment with enabled persistence that is tailored for kjar and allows to specify kbase and ksession name
• getEmpty() - completely empty environment for self configuration
• getClasspathKModuleDefault() - returns preconfigured environment with enabled persistence based on classpath kiecontainer
• getClasspathKModuleDefault(String, String) - returns preconfigured environment with enabled persistence based on classpath kiecontainer

Nested Class Summary

Nested classes/interfaces inherited from interface org.kie.api.runtime.manager.RuntimeEnvironmentBuilder

org.kie.api.runtime.manager.RuntimeEnvironmentBuilder.Factory

Constructor Summary

Constructors

Constructor and Description
PatchedRuntimeEnvironmentBuilder() Creates a new PatchedRuntimeEnvironmentBuilder.

Method Summary

Methods

Modifier and Type	Method and Description
org.kie.api.runtime.manager.RuntimeEnvironmentBuilder	addAsset(org.kie.api.io.Resource asset, org.kie.api.io.ResourceType type) Adds and asset.
org.kie.api.runtime.manager.RuntimeEnvironmentBuilder	addConfiguration(String name, String value) Adds a configuration name/value pair.
org.kie.api.runtime.manager.RuntimeEnvironmentBuilder	addEnvironmentEntry(String name, Object value) Adds an environmentEntry name/value pair.
org.kie.api.runtime.manager.RuntimeEnvironmentBuilder	classLoader(ClassLoader cl) Sets the classLoader.
org.kie.api.runtime.manager.RuntimeEnvironmentBuilder	entityManagerFactory(Object emf) Sets entityManagerFactory.
org.kie.internal.runtime.manager.RuntimeEnvironment	get() Inits and returns the RuntimeEnvironment.
static org.kie.api.runtime.manager.RuntimeEnvironmentBuilder	getClasspathKmoduleDefault() Provides default configuration of RuntimeEnvironmentBuilder that is based on.
static org.kie.api.runtime.manager.RuntimeEnvironmentBuilder	getClasspathKmoduleDefault(String kbaseName, String ksessionName) Provides default configuration of RuntimeEnvironmentBuilder that is based on.
static org.kie.api.runtime.manager.RuntimeEnvironmentBuilder	getDefault() Provides default configuration of RuntimeEnvironmentBuilder that is based on.
static org.kie.api.runtime.manager.RuntimeEnvironmentBuilder	getDefault(org.kie.api.builder.ReleaseId releaseId) Provides default configuration of RuntimeEnvironmentBuilder that is based on.
static org.kie.api.runtime.manager.RuntimeEnvironmentBuilder	getDefault(org.kie.api.builder.ReleaseId releaseId, String kbaseName, String ksessionName) Provides default configuration of RuntimeEnvironmentBuilder that is based on.
static org.kie.api.runtime.manager.RuntimeEnvironmentBuilder	getDefault(String groupId, String artifactId, String version) Provides default configuration of RuntimeEnvironmentBuilder that is based on.
static org.kie.api.runtime.manager.RuntimeEnvironmentBuilder	getDefault(String groupId, String artifactId, String version, String kbaseName, String ksessionName) Provides default configuration of RuntimeEnvironmentBuilder that is based on.
static org.kie.api.runtime.manager.RuntimeEnvironmentBuilder	getDefaultInMemory() Provides default configuration of RuntimeEnvironmentBuilder that is based on.
static org.kie.api.runtime.manager.RuntimeEnvironmentBuilder	getEmpty() Provides completely empty RuntimeEnvironmentBuilder instance that allows to manually set all required components instead of relying on any defaults.
protected static Object	getInstanceFromModel(org.kie.internal.runtime.conf.ObjectModel model, org.kie.api.runtime.KieContainer kieContainer, Map<String,Object> contaxtParams)
org.jbpm.runtime.manager.impl.SimpleRuntimeEnvironment	getRuntimeEnvironment() Gets the SimpleRuntimeEnvironment.
org.kie.api.runtime.manager.RuntimeEnvironmentBuilder	knowledgeBase(org.kie.api.KieBase kbase) Sets the knowledgeBase.
org.kie.api.runtime.manager.RuntimeEnvironmentBuilder	mapper(org.kie.internal.runtime.manager.Mapper mapper) Sets the mapper.
org.kie.api.runtime.manager.RuntimeEnvironmentBuilder	newClasspathKmoduleDefaultBuilder()
org.kie.api.runtime.manager.RuntimeEnvironmentBuilder	newClasspathKmoduleDefaultBuilder(String kbaseName, String ksessionName)
org.kie.api.runtime.manager.RuntimeEnvironmentBuilder	newDefaultBuilder()
org.kie.api.runtime.manager.RuntimeEnvironmentBuilder	newDefaultBuilder(org.kie.api.builder.ReleaseId releaseId)
org.kie.api.runtime.manager.RuntimeEnvironmentBuilder	newDefaultBuilder(org.kie.api.builder.ReleaseId releaseId, String kbaseName, String ksessionName)
org.kie.api.runtime.manager.RuntimeEnvironmentBuilder	newDefaultBuilder(String groupId, String artifactId, String version)
org.kie.api.runtime.manager.RuntimeEnvironmentBuilder	newDefaultBuilder(String groupId, String artifactId, String version, String kbaseName, String ksessionName)
org.kie.api.runtime.manager.RuntimeEnvironmentBuilder	newDefaultInMemoryBuilder()
org.kie.api.runtime.manager.RuntimeEnvironmentBuilder	newEmptyBuilder()
org.kie.api.runtime.manager.RuntimeEnvironmentBuilder	persistence(boolean persistenceEnabled) Sets persistenceEnabled.
org.kie.api.runtime.manager.RuntimeEnvironmentBuilder	registerableItemsFactory(org.kie.api.runtime.manager.RegisterableItemsFactory factory) Sets the registerableItemsFactory.
org.kie.api.runtime.manager.RuntimeEnvironmentBuilder	schedulerService(Object globalScheduler) Sets the schedulerService.
org.kie.api.runtime.manager.RuntimeEnvironmentBuilder	userGroupCallback(org.kie.api.task.UserGroupCallback callback) Sets the userGroupCallback.

Methods inherited from class java.lang.Object

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

Constructor Detail

PatchedRuntimeEnvironmentBuilder

public PatchedRuntimeEnvironmentBuilder()

Creates a new PatchedRuntimeEnvironmentBuilder.

Method Detail

getRuntimeEnvironment

public org.jbpm.runtime.manager.impl.SimpleRuntimeEnvironment getRuntimeEnvironment()

Gets the SimpleRuntimeEnvironment.

Returns:

the SimpleRuntimeEnvironment

getEmpty

public static org.kie.api.runtime.manager.RuntimeEnvironmentBuilder getEmpty()

Provides completely empty RuntimeEnvironmentBuilder instance that allows to manually set all required components instead of relying on any defaults.

Returns:

new instance of RuntimeEnvironmentBuilder

getDefault

public static org.kie.api.runtime.manager.RuntimeEnvironmentBuilder getDefault()

Provides default configuration of RuntimeEnvironmentBuilder that is based on.

• DefaultRuntimeEnvironment

Returns:

new instance of RuntimeEnvironmentBuilder that is already preconfigured with defaults

getDefaultInMemory

public static org.kie.api.runtime.manager.RuntimeEnvironmentBuilder getDefaultInMemory()

Provides default configuration of RuntimeEnvironmentBuilder that is based on.

• DefaultRuntimeEnvironment

but it does not have persistence for process engine configured so it will only store process instances in memory

Returns:

new instance of RuntimeEnvironmentBuilder that is already preconfigured with defaults

getDefault

public static org.kie.api.runtime.manager.RuntimeEnvironmentBuilder getDefault(String groupId,
                                                               String artifactId,
                                                               String version)

Provides default configuration of RuntimeEnvironmentBuilder that is based on.

• DefaultRuntimeEnvironment

This one is tailored to works smoothly with kjars as the notion of kbase and ksessions

Parameters:

groupId - group id of kjar

artifactId - artifact id of kjar

version - version number of kjar

Returns:

new instance of RuntimeEnvironmentBuilder that is already preconfigured with defaults

getDefault

public static org.kie.api.runtime.manager.RuntimeEnvironmentBuilder getDefault(String groupId,
                                                               String artifactId,
                                                               String version,
                                                               String kbaseName,
                                                               String ksessionName)

Provides default configuration of RuntimeEnvironmentBuilder that is based on.

• DefaultRuntimeEnvironment

This one is tailored to works smoothly with kjars as the notion of kbase and ksessions

Parameters:

groupId - group id of kjar

artifactId - artifact id of kjar

version - version number of kjar

kbaseName - name of the kbase defined in kmodule.xml stored in kjar

ksessionName - name of the ksession define in kmodule.xml stored in kjar

Returns:

new instance of RuntimeEnvironmentBuilder that is already preconfigured with defaults

getDefault

public static org.kie.api.runtime.manager.RuntimeEnvironmentBuilder getDefault(org.kie.api.builder.ReleaseId releaseId)

Provides default configuration of RuntimeEnvironmentBuilder that is based on.

• DefaultRuntimeEnvironment

This one is tailored to works smoothly with kjars as the notion of kbase and ksessions

Parameters:

releaseId - ReleaseId that described the kjar

Returns:

new instance of RuntimeEnvironmentBuilder that is already preconfigured with defaults

getDefault

public static org.kie.api.runtime.manager.RuntimeEnvironmentBuilder getDefault(org.kie.api.builder.ReleaseId releaseId,
                                                               String kbaseName,
                                                               String ksessionName)

Provides default configuration of RuntimeEnvironmentBuilder that is based on.

• DefaultRuntimeEnvironment

This one is tailored to works smoothly with kjars as the notion of kbase and ksessions

Parameters:

releaseId - ReleaseId that described the kjar

kbaseName - name of the kbase defined in kmodule.xml stored in kjar

ksessionName - name of the ksession define in kmodule.xml stored in kjar

Returns:

new instance of RuntimeEnvironmentBuilder that is already preconfigured with defaults

getClasspathKmoduleDefault

public static org.kie.api.runtime.manager.RuntimeEnvironmentBuilder getClasspathKmoduleDefault()

Provides default configuration of RuntimeEnvironmentBuilder that is based on.

• DefaultRuntimeEnvironment

It relies on KieClasspathContainer that requires to have kmodule.xml present in META-INF folder which defines the kjar itself. Expects to use default kbase and ksession from kmodule.

Returns:

new instance of RuntimeEnvironmentBuilder that is already preconfigured with defaults

getClasspathKmoduleDefault

public static org.kie.api.runtime.manager.RuntimeEnvironmentBuilder getClasspathKmoduleDefault(String kbaseName,
                                                                               String ksessionName)

Provides default configuration of RuntimeEnvironmentBuilder that is based on.

• DefaultRuntimeEnvironment

It relies on KieClasspathContainer that requires to have kmodule.xml present in META-INF folder which defines the kjar itself.

Parameters:

kbaseName - name of the kbase defined in kmodule.xml

ksessionName - name of the ksession define in kmodule.xml

Returns:

new instance of RuntimeEnvironmentBuilder that is already preconfigured with defaults

persistence

public org.kie.api.runtime.manager.RuntimeEnvironmentBuilder persistence(boolean persistenceEnabled)

Sets persistenceEnabled.

Specified by:

persistence in interface org.kie.api.runtime.manager.RuntimeEnvironmentBuilder

Parameters:

persistenceEnabled - persistenceEnabled

Returns:

this RuntimeEnvironmentBuilder

entityManagerFactory

public org.kie.api.runtime.manager.RuntimeEnvironmentBuilder entityManagerFactory(Object emf)

Sets entityManagerFactory.

Specified by:

entityManagerFactory in interface org.kie.api.runtime.manager.RuntimeEnvironmentBuilder

Parameters:

emf - entityManagerFactory

Returns:

this RuntimeEnvironmentBuilder

addAsset

public org.kie.api.runtime.manager.RuntimeEnvironmentBuilder addAsset(org.kie.api.io.Resource asset,
                                                             org.kie.api.io.ResourceType type)

Adds and asset.

Specified by:

addAsset in interface org.kie.api.runtime.manager.RuntimeEnvironmentBuilder

Parameters:

asset - asset

type - type

Returns:

this RuntimeEnvironmentBuilder

addEnvironmentEntry

public org.kie.api.runtime.manager.RuntimeEnvironmentBuilder addEnvironmentEntry(String name,
                                                                        Object value)

Adds an environmentEntry name/value pair.

Specified by:

addEnvironmentEntry in interface org.kie.api.runtime.manager.RuntimeEnvironmentBuilder

Parameters:

name - name

value - value

Returns:

this RuntimeEnvironmentBuilder

addConfiguration

public org.kie.api.runtime.manager.RuntimeEnvironmentBuilder addConfiguration(String name,
                                                                     String value)

Adds a configuration name/value pair.

Specified by:

addConfiguration in interface org.kie.api.runtime.manager.RuntimeEnvironmentBuilder

Parameters:

name - name

value - value

Returns:

this RuntimeEnvironmentBuilder

knowledgeBase

public org.kie.api.runtime.manager.RuntimeEnvironmentBuilder knowledgeBase(org.kie.api.KieBase kbase)

Sets the knowledgeBase.

Specified by:

knowledgeBase in interface org.kie.api.runtime.manager.RuntimeEnvironmentBuilder

Parameters:

kbase - knowledgeBase

Returns:

this RuntimeEnvironmentBuilder

userGroupCallback

public org.kie.api.runtime.manager.RuntimeEnvironmentBuilder userGroupCallback(org.kie.api.task.UserGroupCallback callback)

Sets the userGroupCallback.

Specified by:

userGroupCallback in interface org.kie.api.runtime.manager.RuntimeEnvironmentBuilder

Parameters:

callback - userGroupCallback

Returns:

this RuntimeEnvironmentBuilder

mapper

public org.kie.api.runtime.manager.RuntimeEnvironmentBuilder mapper(org.kie.internal.runtime.manager.Mapper mapper)

Sets the mapper.

Parameters:

mapper - mapper

Returns:

this RuntimeEnvironmentBuilder

registerableItemsFactory

public org.kie.api.runtime.manager.RuntimeEnvironmentBuilder registerableItemsFactory(org.kie.api.runtime.manager.RegisterableItemsFactory factory)

Sets the registerableItemsFactory.

Specified by:

registerableItemsFactory in interface org.kie.api.runtime.manager.RuntimeEnvironmentBuilder

Parameters:

factory - registerableItemsFactory

Returns:

this RuntimeEnvironmentBuilder

get

public org.kie.internal.runtime.manager.RuntimeEnvironment get()

Inits and returns the RuntimeEnvironment.

Specified by:

get in interface org.kie.api.runtime.manager.RuntimeEnvironmentBuilder

Returns:

the RuntimeEnvironment

schedulerService

public org.kie.api.runtime.manager.RuntimeEnvironmentBuilder schedulerService(Object globalScheduler)

Sets the schedulerService.

Specified by:

schedulerService in interface org.kie.api.runtime.manager.RuntimeEnvironmentBuilder

Parameters:

globalScheduler - schedulerService

Returns:

this RuntimeEnvironmentBuilder

classLoader

public org.kie.api.runtime.manager.RuntimeEnvironmentBuilder classLoader(ClassLoader cl)

Sets the classLoader.

Specified by:

classLoader in interface org.kie.api.runtime.manager.RuntimeEnvironmentBuilder

Parameters:

cl - classLoader

Returns:

this RuntimeEnvironmentBuilder

newEmptyBuilder

public org.kie.api.runtime.manager.RuntimeEnvironmentBuilder newEmptyBuilder()

Specified by:

newEmptyBuilder in interface org.kie.api.runtime.manager.RuntimeEnvironmentBuilderFactory

newDefaultBuilder

public org.kie.api.runtime.manager.RuntimeEnvironmentBuilder newDefaultBuilder()

Specified by:

newDefaultBuilder in interface org.kie.api.runtime.manager.RuntimeEnvironmentBuilderFactory

newDefaultInMemoryBuilder

public org.kie.api.runtime.manager.RuntimeEnvironmentBuilder newDefaultInMemoryBuilder()

Specified by:

newDefaultInMemoryBuilder in interface org.kie.api.runtime.manager.RuntimeEnvironmentBuilderFactory

newDefaultBuilder

public org.kie.api.runtime.manager.RuntimeEnvironmentBuilder newDefaultBuilder(String groupId,
                                                                      String artifactId,
                                                                      String version)

Specified by:

newDefaultBuilder in interface org.kie.api.runtime.manager.RuntimeEnvironmentBuilderFactory

newDefaultBuilder

public org.kie.api.runtime.manager.RuntimeEnvironmentBuilder newDefaultBuilder(String groupId,
                                                                      String artifactId,
                                                                      String version,
                                                                      String kbaseName,
                                                                      String ksessionName)

Specified by:

newDefaultBuilder in interface org.kie.api.runtime.manager.RuntimeEnvironmentBuilderFactory

newDefaultBuilder

public org.kie.api.runtime.manager.RuntimeEnvironmentBuilder newDefaultBuilder(org.kie.api.builder.ReleaseId releaseId)

Specified by:

newDefaultBuilder in interface org.kie.api.runtime.manager.RuntimeEnvironmentBuilderFactory

newDefaultBuilder

public org.kie.api.runtime.manager.RuntimeEnvironmentBuilder newDefaultBuilder(org.kie.api.builder.ReleaseId releaseId,
                                                                      String kbaseName,
                                                                      String ksessionName)

Specified by:

newDefaultBuilder in interface org.kie.api.runtime.manager.RuntimeEnvironmentBuilderFactory

newClasspathKmoduleDefaultBuilder

public org.kie.api.runtime.manager.RuntimeEnvironmentBuilder newClasspathKmoduleDefaultBuilder()

Specified by:

newClasspathKmoduleDefaultBuilder in interface org.kie.api.runtime.manager.RuntimeEnvironmentBuilderFactory

newClasspathKmoduleDefaultBuilder

public org.kie.api.runtime.manager.RuntimeEnvironmentBuilder newClasspathKmoduleDefaultBuilder(String kbaseName,
                                                                                      String ksessionName)

Specified by:

newClasspathKmoduleDefaultBuilder in interface org.kie.api.runtime.manager.RuntimeEnvironmentBuilderFactory

getInstanceFromModel

protected static Object getInstanceFromModel(org.kie.internal.runtime.conf.ObjectModel model,
                          org.kie.api.runtime.KieContainer kieContainer,
                          Map<String,Object> contaxtParams)