bpmn-server / BPMNServer

Class: BPMNServer

Process-wide error handling belongs to the host.

Implements

• IBPMNServer

Table of contents

Constructors

• constructor

Properties

• legacyInstance
• engine
• listener
• configuration
• logger
• definitions
• appDelegate
• dataStore
• cache
• scriptHandler
• cron
• documentStore
• locker
• connectors
• testStubs
• error
• ready
• shuttingDown

Accessors

• engine

Methods

• launch
• create
• start
• onLifecycle
• shutdown
• stop
• report
• status
• getInstance
• getVersion

Constructors

constructor

• new BPMNServer(configuration, logger?, options?): BPMNServer

Server Constructor: builds the server's components and starts it; ready says when it has started.

Parameters

Name	Type	Description
configuration	IConfiguration	see
logger?	ILogger
options	Object	-

Returns

BPMNServer

Defined in

packages/bpmn-server/src/server/BPMNServer.ts:107

Properties

legacyInstance

▪ Static Private legacyInstance: BPMNServer

Legacy static access retained for existing consumers; new integrations use instances.

Defined in

packages/bpmn-server/src/server/BPMNServer.ts:49

---

engine

• engine: Engine

Implementation of

IBPMNServer.engine

Defined in

packages/bpmn-server/src/server/BPMNServer.ts:52

---

listener

• listener: Listener

Implementation of

IBPMNServer.listener

Defined in

packages/bpmn-server/src/server/BPMNServer.ts:53

---

configuration

• configuration: IConfiguration

Implementation of

IBPMNServer.configuration

Defined in

packages/bpmn-server/src/server/BPMNServer.ts:54

---

logger

• logger: ILogger

Implementation of

IBPMNServer.logger

Defined in

packages/bpmn-server/src/server/BPMNServer.ts:55

---

definitions

• definitions: any

Implementation of

IBPMNServer.definitions

Defined in

packages/bpmn-server/src/server/BPMNServer.ts:56

---

appDelegate

• appDelegate: IAppDelegate

Implementation of

IBPMNServer.appDelegate

Defined in

packages/bpmn-server/src/server/BPMNServer.ts:57

---

dataStore

• dataStore: IDataStore

Implementation of

IBPMNServer.dataStore

Defined in

packages/bpmn-server/src/server/BPMNServer.ts:58

---

cache

• cache: ICacheManager

Implementation of

IBPMNServer.cache

Defined in

packages/bpmn-server/src/server/BPMNServer.ts:59

---

scriptHandler

• scriptHandler: IScriptHandler

Implementation of

IBPMNServer.scriptHandler

Defined in

packages/bpmn-server/src/server/BPMNServer.ts:60

---

cron

• cron: Cron

Implementation of

IBPMNServer.cron

Defined in

packages/bpmn-server/src/server/BPMNServer.ts:61

---

documentStore

• Optional documentStore: IDocumentStore

The configuration's storage adapter, shared by the data stores (absent: each opens MongoDB).

Implementation of

IBPMNServer.documentStore

Defined in

packages/bpmn-server/src/server/BPMNServer.ts:63

---

locker

• locker: ILockManager

The lock port the engine uses.

Implementation of

IBPMNServer.locker

Defined in

packages/bpmn-server/src/server/BPMNServer.ts:65

---

connectors

• connectors: Connectors

The connectors an administrator added: REST APIs service tasks call (docs/docs/connectors.md).

Implementation of

IBPMNServer.connectors

Defined in

packages/bpmn-server/src/server/BPMNServer.ts:67

---

testStubs

• testStubs: TestStubs

What the tests running in here replace: no call of the engine reaches them.

Implementation of

IBPMNServer.testStubs

Defined in

packages/bpmn-server/src/server/BPMNServer.ts:69

---

error

• error: any

Defined in

packages/bpmn-server/src/server/BPMNServer.ts:70

---

ready

• Readonly ready: Promise\<void>

Settles when the server has started: the application delegate's start-up, then (unless cron: false) the timers. Rejects with the reason it could not start.

Defined in

packages/bpmn-server/src/server/BPMNServer.ts:72

---

shuttingDown

• Private shuttingDown: Promise\<void> = null

Defined in

packages/bpmn-server/src/server/BPMNServer.ts:73

Accessors

engine

• get engine(): Engine

Returns

Engine

Deprecated

Prefer server.engine.

Defined in

packages/bpmn-server/src/server/BPMNServer.ts:189

Methods

launch

▸ launch(configuration, logger?, options?): LaunchedServer

Launches a server, instead of embedding one as new BPMNServer does: what you get is outside its engine, and answers data, not running executions. The delegate and services are inside the engine, and keep them. engine says where the engine is: left out, in this process; 'http://...', there (startEngineService, with engineKey); 'none', nowhere: models can be edited and saved, and what would run answers EngineNotRunningError. calls adds to what the engine in this process can be asked; an engine elsewhere has its own (startEngineService's calls).

Parameters

Name	Type
configuration	IConfiguration
logger?	ILogger
options	Object
options.engine?	string
options.engineKey?	string
options.engineTimeout?	number
options.calls?	(server: BPMNServer) => Record\<string, (...args: any[]) => Promise\<any>>
options.cron?	boolean

Returns

LaunchedServer

Defined in

packages/bpmn-server/src/server/BPMNServer.ts:85

---

create

▸ create(configuration, logger?, options?): Promise\<BPMNServer>

Parameters

Name	Type
configuration	IConfiguration
logger?	ILogger
options	Object

Returns

Promise\<BPMNServer>

Defined in

packages/bpmn-server/src/server/BPMNServer.ts:94

---

start

▸ start(options): Promise\<void>

Parameters

Name	Type
options	any

Returns

Promise\<void>

Defined in

packages/bpmn-server/src/server/BPMNServer.ts:136

---

onLifecycle

▸ onLifecycle(listener): () => void

Subscribe without coupling the engine to application implementations.

Parameters

Name	Type
listener	ILifecycleListener

Returns

fn

▸ (): void

Returns

void

Defined in

packages/bpmn-server/src/server/BPMNServer.ts:142

---

shutdown

▸ shutdown(): Promise\<void>

Stops the server, once however often it is called: new engine calls are refused, its timers cancelled, running executions given shutdownTimeout ms to finish (then left to the locks' stale age), its cache, listeners and subscriptions cleared, and its connections closed.

Returns

Promise\<void>

Defined in

packages/bpmn-server/src/server/BPMNServer.ts:150

---

stop

▸ stop(): Promise\<void>

Returns

Promise\<void>

Defined in

packages/bpmn-server/src/server/BPMNServer.ts:154

---

report

▸ report(error): void

Parameters

Name	Type
error	any

Returns

void

Defined in

packages/bpmn-server/src/server/BPMNServer.ts:169

---

status

▸ status(): Object

Returns

Object

Name	Type
version	any
cache	any
engineRunning	number
engineCalls	number
timers	{ pending: number ; scheduled: number = 0; fired: number = 0; skipped: number = 0; failed: number = 0 }
timers.pending	number
timers.scheduled	number
timers.fired	number
timers.skipped	number
timers.failed	number
memoryUsage	MemoryUsage

Defined in

packages/bpmn-server/src/server/BPMNServer.ts:173

---

getInstance

▸ getInstance(): BPMNServer

Returns

BPMNServer

Deprecated

Prefer the instance returned by the constructor or create.

Defined in

packages/bpmn-server/src/server/BPMNServer.ts:184

---

getVersion

▸ getVersion(): any

Returns

any

Defined in

packages/bpmn-server/src/server/BPMNServer.ts:190

Comments