Shell

scope:

feature:

service:

path: /modules/core/multi-tenancy/lib/shell.js

source: https://github.com/DecentCMS/DecentCMS/blob/master/modules/core/multi-tenancy/lib/shell.js

Shell

Kind: global class

• Shell
  • new Shell(options)
  • instance
    • .canHandle(request) ⇒ Boolean
    • .enable(state)
    • .disable()
    • .load()
    • .loadModule(moduleName)
    • .middleware(request, response, next)
    • .handleRequest(request, response, next)
  • static
    • .empty
    • .list
    • .startRequestEvent : string
    • .endRequestEvent : string
    • .renderPageEvent : string
    • .renderErrorPage : string
    • .renderErrorPage_payload
    • .load(sitePath, [defaults]) ⇒ Shell
    • .discover(defaults, rootPath)
    • .resolve(request)

new Shell(options)

A shell is the representation of a tenant in the system. A shell has its own enabled services, that can be required by modules running in its context.

shell.canHandle(request) ⇒ Boolean

Determines if the shell can handle that request.

Kind: instance method of Shell
Returns: Boolean - true if the shell can handle the request.

shell.enable(state)

Enables or disables the tenant.

Kind: instance method of Shell

shell.disable()

Disables the tenant.

Kind: instance method of Shell

shell.load()

Scopes the shell, then loads all enabled services in each module, including modules and themes that are specific to this tenant.

Kind: instance method of Shell

shell.loadModule(moduleName)

Loads all the services in the module under the path passed as a parameter. Services are loaded while respecting the dependency order.

Kind: instance method of Shell

shell.middleware(request, response, next)

Middleware for use, for example, with Express.

Kind: instance method of Shell

shell.handleRequest(request, response, next)

Handles the request for the tenant Emits the following events and service calls:

• decent.core.shell.start-request
• 'route-handler'.handle({shell, request, response}, done)
• 'storage-manager'.fetchContent({shell, request, response}, done)
• 'renderer'.render({shell, request, response}, done)
• decent.core.shell.render-error
• decent.core.shell.end-request

Kind: instance method of Shell

Shell.empty

An empty shell that you can use to initialize services if you don't need multitenancy.

Kind: static property of Shell

Shell.list

The list of tenants.

Kind: static property of Shell

Shell.startRequestEvent : string

The event that is broadcast at the beginning of request handling. This is a good time to attach a service to the request object.

Kind: static property of Shell

Shell.endRequestEvent : string

The event that is broadcast at the end of request handling. This is a good time to detach services and events.

Kind: static property of Shell

Shell.renderPageEvent : string

The event that is broadcast when the page is ready to be rendered.

Kind: static property of Shell

Shell.renderErrorPage : string

This event is triggered when an error has happened during the page lifecycle.

Kind: static property of Shell

Shell.renderErrorPage_payload

The payload is the error object.

Kind: static property of Shell

Shell.load(sitePath, [defaults]) ⇒ Shell

Creates a shell from its settings file.

Kind: static method of Shell
Returns: Shell - The new shell

Shell.discover(defaults, rootPath)

Discovers all tenants in the ./sites directory.

Kind: static method of Shell

Shell.resolve(request)

Returns the shell that should handle this request.

Kind: static method of Shell