OpenVeo Core server

API Docs for: 7.0.0
Show:

WebServiceServer

Extends Server
Defined in: app/server/servers/WebServiceServer.js:23
Module: core-servers

Summary

Defines an HTTP server for the web service.

Constructor

WebServiceServer

Defined in app/server/servers/WebServiceServer.js:23

Syntax

WebServiceServer

(
  • configuration
)

Summary

Parameters:

  • configuration Object

    Service configuration

    • port Number

      Web service HTTP server port

Methods

async

Inherited from Server but overwritten in app/server/servers/WebServiceServer.js:113

Syntax

async

(
  • callback
)

Summary

Sets errors routes.

Sets errors routes when all plugins are loaded to handle not found endpoints and errors.

Parameters:

  • callback Function

    Function to call when its done with:

    • Error An error if something went wrong

onDatabaseAvailable

Inherited from Server: app/server/servers/Server.js:45

Syntax

onDatabaseAvailable

(
  • db
  • callback
)
async

Summary

Handles database available event.

It assures that the database is loaded and can be accessed.

Parameters:

  • db Database

    The application database

  • callback Function

    Function to call when its done with:

    • Error An error if something went wrong

onPluginLoaded

Inherited from Server but overwritten in app/server/servers/WebServiceServer.js:76

Syntax

onPluginLoaded

(
  • plugin
  • callback
)
async

Summary

Loads plugin.

Parameters:

  • plugin Object

    The openveo plugin

  • callback Function

    Function to call when its done with:

    • Error An error if something went wrong

startServer

Inherited from Server but overwritten in app/server/servers/WebServiceServer.js:143

Syntax

startServer

(
  • callback
)
async

Summary

Starts the HTTP server.

Parameters:

  • callback Function

    Function to call when it's done with :

    • Error An error if something went wrong, null otherwise

Properties

configuration

Inherited from Server: app/server/servers/Server.js:20

Syntax

configuration

Object final

Summary

Server configuration object.

httpServer

Inherited from Server: app/server/servers/Server.js:29

Syntax

httpServer

Application final

Summary

Express application.

migrations

Defined in app/server/servers/WebServiceServer.js:37

Syntax

migrations

Object final

Summary

migrations Script description object.