BLOB stores methods. For usage examples see:

• App.blobStores.getContent - load content of BLOB into memory
• App.blobStores.getContentPath - get a path to the file based store BLOB content
• App.blobStores.putContent - put a BLOB content to the temporary storage
• App.blobStores.markRevisionAsPermanent - mark specified revision of a historical store as permanent
• App.blobStores.internalWriteDocumentToResp - mark specified revision of a historical store as permanent

Databases connections pool

Application default language

Extended information about application domain (metadata)

Is event emitter enabled for App singleton. Default is false

Starting from 1.11 this property ignored (always TRUE)

Endpoint context. Application logic can store here some data what required during single HTTP method call; Starting from UB@5.17.9 server reset App.endpointContext to {} after endpoint implementation execution, so in the beginning of execution it's always empty

App.endpointContext.MYMODEL_mykey = 'some value we need to share between different methods during a single user request handling'

URL that the User from the internet will use to access your server. To be used in case server is behind a reverse proxy

List of a local server IP addresses CRLF (or CR for non-windows) separated

Application package.json content (parsed)

Server configuration - result of argv.getServerConfiguration

Defense edition only, Base64 encoded public server certificate

Contains non empty value in case security.dstu.trafficEncryption === true and key name defined in security.dstu.novaLib.keyName

Full URl HTTP server is listen on (if HTTP server enabled, else - empty string)

Full path to application static folder if any, '' if static folder not set

Use App.registerEndpoint instead

Try retrieve or create new session from request headers. Return true if success, false if more auth handshakes is required. In case of invalid credential throw security exception

Commit active database transaction if any. In case connectionName is not passed will commit all active transactions for all connections. Return true if transaction is committed, or false if database not in use or no active transaction.

Check database are used in current endpoint context and DB transaction is already active.

Rollback active database transaction if any. In case connectionName is not passed will rollback all active transactions for all connections. Return true if transaction is rollback'ed, or false if database not in use or no active transaction.

Start a transaction for a specified database. If database is not used in this context will create a connection to the database and start transaction.

For Oracle with DBLink first statement to DBLink'ed table must be either update/insert/delete or you MUST manually start transaction to prevent "ORA-01453: SET TRANSACTION be first statement"

Delete row from FTS index for exemplar with instanceID of entity entityName (mixin fts must be enabled for entity)

Check Entity-Level-Security for specified entity/method

  
      if App.els('uba_user', 'insert'){
       // do something
}
  

Waits for ownership of the specified critical section object. The function returns when the calling thread is granted ownership.

** IMPORTANT** A thread must call App.leaveCriticalSection once for each time that it entered the critical section.

Use App.serverConfig.uiSettings: Object instead

Return stringified JSON specified in serverConfig.uiSettings

Get value from global cache. Global cache shared between all threads.

Return '' (empty string) in case key not present in cache.

Put value to global cache.

Grant endpoint to role

Return:

true if endpoint exists and role not already granted, false otherwise

Releases ownership of the specified critical section

Enter a log recursion call. ** IMPORTANT** A thread must call App.logLeave once for each time that it entered the log recursion

  
      function wrapEnterLeave(enterText, originalMethod) {
    return function(ctx) {
      App.logEnter(enterText)
      try {
        originalMethod(ctx)
      } finally {
        App.logLeave()
      }
    }
  }
  

Exit a log recursion call

Logout a current user (kill current session)

Logout all users with the same name as current user, except currently logged user

Accessible inside app-level :before event handler. Call to prevent default method handler. In this case developer are responsible to fill response object, otherwise HTTP 400 is returned.

Register a named critical section. Can be done only in initialization mode. In case section with the same name already registered in another thread - returns existed CS index

All threads MUST register section in the same way, do not put call into condition what may evaluates too the different values in the different threads.

  
      const App = require('@unitybase/ub').App
// critical section must be registered once in the moment modules are evaluated without any conditions
const MY_CS = App.registerCriticalSection('SHARED_FILE_ACCESS')

function concurrentFileAccess() {
  // prevents mutual access to the same file from the different threads
  App.enterCriticalSection(FSSTORAGE_CS)
  try {
    const data = fs.readfileSync('/tmp/concurrent.txt', 'utf8')
    // do some operation what modify data
    fs.writefileSync('/tmp/concurrent.txt', data)
  } finally {
    // important to leave critical section in finally block to prevent forever lock
    App.leaveCriticalSection(FSSTORAGE_CS)
  }
}
  

Register a server endpoint. One of the endpoints can be default endpoint - it will be used as a fallback in case URL do not start with any of known endpoints name.

Exceptions inside endpoint handler are intercepted by UB server. In case exception is occurred server will rollback any active DB transactions and serialize an exception message to response depending on server execution mode:

• for dev mode - original exception text will be serialized (for debugging purpose)
• for production mode - in case exception message is wrapped into <<<..>>> then this message will be serialized, if not - text will be always Internal server error (for security reason)

Recommended way to throw an handled error inside endpoint handler is throw new UB.UBAbort('.....')

  
      // Write a custom request body to file FIXTURES/req and echo file back to client
 // @param {THTTPRequest} req
 // @param {THTTPResponse} resp
 //
 function echoToFile(req, resp) {
   var fs = require('fs');
   fs.writeFileSync(FIXTURES + 'req', req.read('bin'));
   resp.statusCode = 200;
   resp.writeEnd(fs.readFileSync(FIXTURES + 'req', {encoding: 'bin'}));
 }
 App.registerEndpoint('echoToFile', echoToFile);
  

Remove all user sessions (logout user).

Return:

true if user had had any session

Use App.registerEndpoint instead

Update FTS index for for exemplar with instanceID of entity entityName (mixin fts must be enabled for entity). In case row dose not exist in FTS perform insert action automatically.