SpringProcessApplication (Camunda BPM Javadocs 7.10.19-ee)

java.lang.Object
- org.camunda.bpm.application.AbstractProcessApplication
- - org.camunda.bpm.engine.spring.application.SpringProcessApplication

All Implemented Interfaces:

EventListener, ProcessApplicationInterface, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.context.ApplicationContextAware, org.springframework.context.ApplicationListener<org.springframework.context.event.ApplicationContextEvent>

Direct Known Subclasses:

SpringServletProcessApplication
```
public class SpringProcessApplication
extends AbstractProcessApplication
implements org.springframework.context.ApplicationContextAware, org.springframework.beans.factory.BeanNameAware, org.springframework.context.ApplicationListener<org.springframework.context.event.ApplicationContextEvent>
```
Process Application implementation to be used in a Spring Application.

This implementation is meant to be bootstrapped by a Spring Application Context. You can either reference the bean in a Spring application-context XML file or use spring annotation-based bootstrapping from a subclass.

HINT: If your application is a Web Application, consider using the SpringServletProcessApplication

The SpringProcessApplication will use the Bean Name assigned to the bean in the spring application context (see BeanNameAware). You should always assign a unique bean name to a process application bean. That is, the bean name must be unique accross all applications deployed to the camunda BPM platform.

Author:

Daniel Meyer

Field Summary

Fields
Modifier and Type	Field and Description
`protected org.springframework.context.ApplicationContext`	`applicationContext`
`protected String`	`beanName`
`protected Map<String,String>`	`properties`

Fields inherited from class org.camunda.bpm.application.AbstractProcessApplication
isDeployed, processApplicationBeanElResolver, processApplicationElResolver, processApplicationScriptEnvironment, variableSerializers

Constructor Summary

Constructors
Constructor and Description

SpringProcessApplication()

Constructors
Constructor and Description
`SpringProcessApplication()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`afterPropertiesSet()`
`protected String`	`autodetectProcessApplicationName()` Override this method to autodetect an application name in case the `ProcessApplication` annotation was used but without parameter.
`void`	`destroy()`
`org.springframework.context.ApplicationContext`	`getApplicationContext()`
`Map<String,String>`	`getProperties()` override this method in order to provide a map of properties.
`ProcessApplicationReference`	`getReference()` Returns a globally sharable reference to this process application.
`void`	`onApplicationEvent(org.springframework.context.event.ApplicationContextEvent event)`
`void`	`setApplicationContext(org.springframework.context.ApplicationContext applicationContext)`
`void`	`setBeanName(String name)`
`void`	`setProperties(Map<String,String> properties)`
`void`	`start()`
`void`	`stop()`

Methods inherited from class org.camunda.bpm.application.AbstractProcessApplication
createDeployment, deploy, execute, execute, getBeanElResolver, getElResolver, getEnvironmentScripts, getExecutionListener, getName, getProcessApplicationClassloader, getProcessApplicationScriptEnvironment, getRawObject, getScriptEngineForName, getTaskListener, getVariableSerializers, initProcessApplicationElResolver, setVariableSerializers, undeploy

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - properties
```
protected Map<String,String> properties
```
  - applicationContext
```
protected org.springframework.context.ApplicationContext applicationContext
```
  - beanName
```
protected String beanName
```
- Constructor Detail
  - SpringProcessApplication
```
public SpringProcessApplication()
```
- Method Detail
  - autodetectProcessApplicationName
```
protected String autodetectProcessApplicationName()
```
    Description copied from class: AbstractProcessApplication
    
    Override this method to autodetect an application name in case the ProcessApplication annotation was used but without parameter.
    
    Specified by:
    
    autodetectProcessApplicationName in class AbstractProcessApplication
  - getReference
```
public ProcessApplicationReference getReference()
```
    Description copied from interface: ProcessApplicationInterface
    
    Returns a globally sharable reference to this process application. This reference may be safely passed to the process engine. And other applications.
    
    Specified by:
    
    getReference in interface ProcessApplicationInterface
    
    Returns:
    
    a globally sharable reference to this process application.
  - setApplicationContext
```
public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException
```
    Specified by:
    
    setApplicationContext in interface org.springframework.context.ApplicationContextAware
    
    Throws:
    
    org.springframework.beans.BeansException
  - setBeanName
```
public void setBeanName(String name)
```
    Specified by:
    
    setBeanName in interface org.springframework.beans.factory.BeanNameAware
  - getProperties
```
public Map<String,String> getProperties()
```
    Description copied from interface: ProcessApplicationInterface
    
    override this method in order to provide a map of properties.
    
    The properties are made available globally through the ProcessApplicationService
    
    Specified by:
    
    getProperties in interface ProcessApplicationInterface
    
    Overrides:
    
    getProperties in class AbstractProcessApplication
    
    See Also:
    
    ProcessApplicationService, ProcessApplicationInfo.getProperties()
  - setProperties
```
public void setProperties(Map<String,String> properties)
```
  - getApplicationContext
```
public org.springframework.context.ApplicationContext getApplicationContext()
```
  - onApplicationEvent
```
public void onApplicationEvent(org.springframework.context.event.ApplicationContextEvent event)
```
    Specified by:
    
    onApplicationEvent in interface org.springframework.context.ApplicationListener<org.springframework.context.event.ApplicationContextEvent>
  - start
```
public void start()
```
  - stop
```
public void stop()
```
  - afterPropertiesSet
```
public void afterPropertiesSet()
                        throws Exception
```
    Throws:
    
    Exception
  - destroy
```
public void destroy()
             throws Exception
```
    Throws:
    
    Exception

Class SpringProcessApplication

Field Summary

Fields inherited from class org.camunda.bpm.application.AbstractProcessApplication

Constructor Summary

Method Summary

Methods inherited from class org.camunda.bpm.application.AbstractProcessApplication

Methods inherited from class java.lang.Object

Field Detail

properties

applicationContext

beanName

Constructor Detail

SpringProcessApplication

Method Detail

autodetectProcessApplicationName

getReference

setApplicationContext

setBeanName

getProperties

setProperties

getApplicationContext

onApplicationEvent

start

stop

afterPropertiesSet

destroy