OpenVeo Core server

API Docs for: 7.0.0
Show:

ApplicationServer

Extends Server
Defined in: app/server/servers/ApplicationServer.js:51
Module: core-servers

Summary

Defines an HTTP server for the openveo application, which serves front and back end pages.

Constructor

ApplicationServer

Defined in app/server/servers/ApplicationServer.js:51

Syntax

ApplicationServer

(
  • configuration
)

Summary

Parameters:

  • configuration Object

    Service configuration

    • sessionSecret String

      Hash to encrypt sessions

    • httpPort Number

      HTTP server port

    • socketPort Number

      Socket server port

Methods

async

Inherited from Server but overwritten in app/server/servers/ApplicationServer.js:400

Syntax

async

(
  • callback
)

Summary

Finalizes the ApplicationServer initialization.

Mounts the assets directories of core and plugins, sets views folders, sets permissions and set default route and error handling. Default route must load the main view due to AngularJS single application.

Parameters:

  • callback Function

    Function to call when its done with:

    • Error An error if something went wrong

initializePassport

Defined in app/server/servers/ApplicationServer.js:146

Syntax

initializePassport

() private

Summary

Initializes passport strategies to manage user authentication.

onDatabaseAvailable

Inherited from Server but overwritten in app/server/servers/ApplicationServer.js:207

Syntax

onDatabaseAvailable

(
  • db
  • callback
)
async

Summary

Prepares the express application.

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/ApplicationServer.js:241

Syntax

onPluginLoaded

(
  • plugin
  • callback
)
async

Summary

Loads plugin.

Mounts plugin's assets directories, public router, private router, menu views folders and permissions.

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/ApplicationServer.js:441

Syntax

startServer

(
  • callback
)
async

Summary

Starts the HTTP and socket servers.

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.

imagesStyle

Defined in app/server/servers/ApplicationServer.js:75

Syntax

imagesStyle

Object final

Summary

Image styles for image processing.

menu

Defined in app/server/servers/ApplicationServer.js:84

Syntax

menu

Array

Summary

Back end menu description object.

migrations

Defined in app/server/servers/ApplicationServer.js:92

Syntax

migrations

Object final

Summary

Migrations scripts to execute.

sessionMiddleware

Defined in app/server/servers/ApplicationServer.js:118

Syntax

sessionMiddleware

Object

Summary

Express session middleware.

sessionStore

Defined in app/server/servers/ApplicationServer.js:110

Syntax

sessionStore

Object

Summary

Database session storage.

socketServer

Defined in app/server/servers/ApplicationServer.js:101

Syntax

socketServer

SocketServer final

Summary

Socket server.

viewsFolders

Defined in app/server/servers/ApplicationServer.js:67

Syntax

viewsFolders

Array

Summary

List of path holding template engine views.