org.kie.internal.runtime.conf
Interface DeploymentDescriptor

public interface DeploymentDescriptor

Deployment descriptor defines configurable components of deployable unit - kjar that will be used upon deployment to execution environment providing flexible and independent setup per deployment unit

Field Summary

static String

META_INF_LOCATION

Method Summary

AuditMode	getAuditMode() Returns the audit type configuration
String	getAuditPersistenceUnit() Returns name of the JPA persistence unit to be used by audit component non empty should correspond to defined persistence unit in persistence.xml null to use default persistence unit
DeploymentDescriptorBuilder	getBuilder() Returns implementation specific builder to construct instances of the descriptor;
List<NamedObjectModel>	getConfiguration() List of kiesession configuration entries to be registered
List<NamedObjectModel>	getEnvironmentEntries() List of (kie) environment entries to be registered
List<ObjectModel>	getEventListeners() Returns list of event listeners (process, agenda, rule runtime) to be applied on KieSession
List<NamedObjectModel>	getGlobals() Return list of globals to be applied on KieSession
List<ObjectModel>	getMarshallingStrategies() Returns list of object marshaling strategies to be applied on KieSession
PersistenceMode	getPersistenceMode() Returns the runtime engine persistence type configuration
String	getPersistenceUnit() Returns name of the JPA persistence unit to be used for runtime engine non empty should correspond to defined persistence unit in persistence.xml null to use default persistence unit
List<String>	getRequiredRoles() Returns all required roles required to be granted access to the deployment.
DeploymentUnit.RuntimeStrategy	getRuntimeStrategy() Returns runtime strategy to be used, default Singleton.
List<ObjectModel>	getTaskEventListeners() Returns list of task event listeners to be applied on KieSession
List<NamedObjectModel>	getWorkItemHandlers() Return list of work item handlers to be applied on KieSession
String	toXml() Returns XML representation of this descriptor instance

Field Detail

META_INF_LOCATION

static final String META_INF_LOCATION

See Also:

Constant Field Values

Method Detail

getPersistenceUnit

String getPersistenceUnit()

Returns name of the JPA persistence unit to be used for runtime engine

• non empty should correspond to defined persistence unit in persistence.xml
• null to use default persistence unit

Returns:

non empty string should correspond to defined persistence unit in persistence.xml, in case null is returned persistence will use default one - org.jbpm.domain

getAuditPersistenceUnit

String getAuditPersistenceUnit()

Returns name of the JPA persistence unit to be used by audit component

• non empty should correspond to defined persistence unit in persistence.xml
• null to use default persistence unit

Returns:

non empty string should correspond to defined persistence unit in persistence.xml, in case null is returned persistence will use default one - org.jbpm.domain

getAuditMode

AuditMode getAuditMode()

Returns the audit type configuration

Returns:

getPersistenceMode

PersistenceMode getPersistenceMode()

Returns the runtime engine persistence type configuration

Returns:

getRuntimeStrategy

DeploymentUnit.RuntimeStrategy getRuntimeStrategy()

Returns runtime strategy to be used, default Singleton.

Returns:

getMarshallingStrategies

List<ObjectModel> getMarshallingStrategies()

Returns list of object marshaling strategies to be applied on KieSession

Returns:

getEventListeners

List<ObjectModel> getEventListeners()

Returns list of event listeners (process, agenda, rule runtime) to be applied on KieSession

Returns:

getGlobals

List<NamedObjectModel> getGlobals()

Return list of globals to be applied on KieSession

Returns:

getWorkItemHandlers

List<NamedObjectModel> getWorkItemHandlers()

Return list of work item handlers to be applied on KieSession

Returns:

getTaskEventListeners

List<ObjectModel> getTaskEventListeners()

Returns list of task event listeners to be applied on KieSession

Returns:

getEnvironmentEntries

List<NamedObjectModel> getEnvironmentEntries()

List of (kie) environment entries to be registered

Returns:

getConfiguration

List<NamedObjectModel> getConfiguration()

List of kiesession configuration entries to be registered

Returns:

getBuilder

DeploymentDescriptorBuilder getBuilder()

Returns implementation specific builder to construct instances of the descriptor;

Returns:

getRequiredRoles

List<String> getRequiredRoles()

Returns all required roles required to be granted access to the deployment. Empty list or null means no security will be applied.

Returns:

toXml

String toXml()

Returns XML representation of this descriptor instance

Returns: