Class EntityManagerFactory

This base class provides an lock interface to execute exclusive operations

Hierarchy

Lockable
- EntityManagerFactory

Index

Constructors

constructor

new EntityManagerFactory(options??: string | {
    basePath?: string;
    host?: string;
    port?: number;
    schema?: JsonMap;
    secure?: boolean;
    staleness?: number;
    tokenStorage?: TokenStorage;
    tokenStorageFactory?: TokenStorageFactory;
}): EntityManagerFactory
Creates a new EntityManagerFactory connected to the given destination
Parameters
- Optional options: string | {
      basePath?: string;
      host?: string;
      port?: number;
      schema?: JsonMap;
      secure?: boolean;
      staleness?: number;
      tokenStorage?: TokenStorage;
      tokenStorageFactory?: TokenStorageFactory;
  } = {}
  
  The destination to connect with, or an options object
Returns EntityManagerFactory
Overrides Lockable.constructor
- Defined in lib/EntityManagerFactory.ts:73

Properties

`Private` `Optional` [CONNECTED]

[CONNECTED]?: (() => any)

Type declaration

- (): any
- Returns any

`Private` `Optional` [WS]

[WS]?: WebSocketConnector

code

code: Code = ...

connectData

connectData: null | ConnectData = null

connection

connection: null | Connector = null

metamodel

metamodel: Metamodel = ...

staleness

staleness: null | number = null

tokenStorage

tokenStorage: null | TokenStorage = null

tokenStorageFactory

tokenStorageFactory: TokenStorageFactory = ...

Accessors

isReady

get isReady(): boolean
Indicates if there is currently no exclusive operation executed true If no exclusive lock is hold

Returns boolean
Inherited from Lockable.isReady
- Defined in lib/util/Lockable.ts:29

websocket

get websocket(): WebSocketConnector
Retrieves the websocket connection if the websocket SDK is available

Returns WebSocketConnector
- Defined in lib/EntityManagerFactory.ts:45

Methods

configure

configure(options: {
    staleness?: number;
    tokenStorage?: TokenStorage;
    tokenStorageFactory?: TokenStorageFactory;
}): void
Apply additional configurations to this EntityManagerFactory

Returns
Parameters
- options: {
      staleness?: number;
      tokenStorage?: TokenStorage;
      tokenStorageFactory?: TokenStorageFactory;
  }
  
  The additional configuration options
  - Optional staleness?: number
    
    The maximum staleness of objects that are acceptable while reading cached data, 0 to always bypass the browser cache
  - Optional tokenStorage?: TokenStorage
    
    The tokenStorage which should be used by this emf
  - Optional tokenStorageFactory?: TokenStorageFactory
    
    The tokenStorage factory implementation which should be used for token storage
Returns void
- Defined in lib/EntityManagerFactory.ts:158

connect

connect(hostOrApp: string, secure?: boolean, basePath?: string): Promise<EntityManagerFactory>
Connects this EntityManager to the given destination

Returns
Parameters
- hostOrApp: string
  
  The host or the app name to connect with
- Optional secure: boolean
  
  true To use a secure connection
- Optional basePath: string
  
  The base path of the api
Returns Promise<EntityManagerFactory>
- Defined in lib/EntityManagerFactory.ts:184
connect(hostOrApp: string, port?: number, secure?: boolean, basePath?: string): Promise<EntityManagerFactory>
Connects this EntityManager to the given destination

Returns
Parameters
- hostOrApp: string
  
  The host or the app name to connect with
- Optional port: number
  
  The port to connect to
- Optional secure: boolean
  
  true To use a secure connection
- Optional basePath: string
  
  The base path of the api
Returns Promise<EntityManagerFactory>
- Defined in lib/EntityManagerFactory.ts:194

createEntityManager

createEntityManager(useSharedTokenStorage?: boolean): EntityManager
Create a new application-managed EntityManager.

Returns
a new entityManager
Parameters
- Optional useSharedTokenStorage: boolean
  
  The token storage to persist the authorization token, or true To use the shared token storage of the emf. false To use a instance based storage.
Returns EntityManager
- Defined in lib/EntityManagerFactory.ts:229

createMetamodel

createMetamodel(): Metamodel
Creates a new Metamodel instance, which is not connected

Returns
A new Metamodel instance

Returns Metamodel
- Defined in lib/EntityManagerFactory.ts:216

ready

ready(doneCallback?: ((this: EntityManagerFactory) => any), failCallback?: ((error: Error) => any)): Promise<EntityManagerFactory>
Waits on the previously requested operation and calls the doneCallback if the operation is fulfilled

Returns
A promise which completes successfully, when the previously requested operation completes
Parameters
- Optional doneCallback: ((this: EntityManagerFactory) => any)
  
  The callback which will be invoked when the previously operations on this object is completed.
  - - (this: EntityManagerFactory): any
    - Parameters
      
      this: EntityManagerFactory
      
      Returns any
- Optional failCallback: ((error: Error) => any)
  
  When the lock can't be released caused by a none recoverable error
  - - (error: Error): any
    - Parameters
      
      error: Error
      
      Returns any
Returns Promise<EntityManagerFactory>
Inherited from Lockable.ready
- Defined in lib/util/Lockable.ts:42

send

send(msg: Message): Promise<Response>
Parameters
- msg: Message
Returns Promise<Response>
- Defined in lib/EntityManagerFactory.ts:243

`Protected` withLock

withLock<T>(callback: (() => Promise<T>), critical??: boolean): Promise<T>
Protected
Try to aquire an exclusive lock and executes the given callback.

Returns
A promise

Throws
If the lock can't be aquired
Type Parameters
- T
Parameters
- callback: (() => Promise<T>)
  
  The exclusive operation to execute
  - - (): Promise<T>
    - Returns Promise<T>
- Optional critical: boolean = false
  
  Indicates if the operation is critical. If the operation is critical and the operation fails, then the lock will not be released
Returns Promise<T>
Inherited from Lockable.withLock
- Defined in lib/util/Lockable.ts:55

Class EntityManagerFactory

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional options: string | { basePath?: string; host?: string; port?: number; schema?: JsonMap; secure?: boolean; staleness?: number; tokenStorage?: TokenStorage; tokenStorageFactory?: TokenStorageFactory; } = {}

Returns EntityManagerFactory

Properties

Private Optional [CONNECTED]

Type declaration

Returns any

Private Optional [WS]

code

connectData

connection

metamodel

staleness

tokenStorage

tokenStorageFactory

Accessors

isReady

Returns boolean

websocket

Returns WebSocketConnector

Methods

configure

Returns

Parameters

options: { staleness?: number; tokenStorage?: TokenStorage; tokenStorageFactory?: TokenStorageFactory; }

Optional staleness?: number

Optional tokenStorage?: TokenStorage

Optional tokenStorageFactory?: TokenStorageFactory

Returns void

connect

Returns

Parameters

hostOrApp: string

Optional secure: boolean

Optional basePath: string

Returns Promise<EntityManagerFactory>

Returns

Parameters

hostOrApp: string

Optional port: number

Optional secure: boolean

Optional basePath: string

Returns Promise<EntityManagerFactory>

createEntityManager

Returns

Parameters

Optional useSharedTokenStorage: boolean

Returns EntityManager

createMetamodel

Returns

Returns Metamodel

ready

Returns

Parameters

Optional doneCallback: ((this: EntityManagerFactory) => any)

Parameters

this: EntityManagerFactory

Returns any

Optional failCallback: ((error: Error) => any)

Parameters

error: Error

Returns any

Returns Promise<EntityManagerFactory>

send

Parameters

msg: Message

Returns Promise<Response>

Protected withLock

Returns

Throws

Type Parameters

`Optional` options: string | {
basePath?: string;
host?: string;
port?: number;
schema?: JsonMap;
secure?: boolean;
staleness?: number;
tokenStorage?: TokenStorage;
tokenStorageFactory?: TokenStorageFactory;
} = {}

`Private` `Optional` [CONNECTED]

`Private` `Optional` [WS]

options: {
staleness?: number;
tokenStorage?: TokenStorage;
tokenStorageFactory?: TokenStorageFactory;
}

`Optional` staleness?: number

`Optional` tokenStorage?: TokenStorage

`Optional` tokenStorageFactory?: TokenStorageFactory

`Optional` secure: boolean

`Optional` basePath: string

`Optional` port: number

`Optional` secure: boolean

`Optional` basePath: string

`Optional` useSharedTokenStorage: boolean

`Optional` doneCallback: ((this: EntityManagerFactory) => any)

`Optional` failCallback: ((error: Error) => any)

`Protected` withLock

`Optional` critical: boolean = false