Module: caf_components/gen_proxy

A proxy is a stateless, frozen object that enables secure access to local services from application code.

A proxy provides a restricted interface to a service, enforces security checks on arguments, and piggybacks trusted source information to all requests.

Proxies are a key enabler of the internal trusted bus architecture of a CAF application that facilitates multi-tenancy with collaboration.

By convention proxies are always named proxy in a description, and this makes it easier for internal code to discover them.

See module:caf_components/gen_plug for a discussion of the plug-in architecture in CAF.

Source:

Extends

Members

__ca_isNotUnknown__ :boolean

Disable shutdown of unknown proxies in a container.

This allows dynamically adding proxy objects in (static) containers without modifying specs.

Type:
  • boolean
Source:

__ca_isProxy__ :boolean

Run-time type information.

Type:
  • boolean
Source:

Methods

(static) constructor($, spec) → {Object}

Helper constructor method for a proxy component.

Description of types in file types.js.

Parameters:
Name Type Description
$ ctxType

A context containing references to other components.

spec specType

Configuration data for this component.

Source:
Throws:

If inputs are invalid.

Type
Error
Returns:

A new generic component.

Type
Object

__ca_getCAName__() → {string}

Returns the name of the CA that contains this proxy.

Source:
Returns:

A name for the containing CA.

Type
string