Gets the container's communication manager.
Gets the container object of this controller.
Gets the core type of objects to be cached.
The default value returned is CoatyObject.
Sets the core type of objects to be cached.
To filter out specific object core types you should set
the core type once in the OnInit
method of your custom controller.
Sets a filter predicate on objects to be resolved.
To filter out specific objects or object types you should set an object
filter once in the OnInit method of your custom controller.
Gets the controller's options as specified in the configuration options.
Gets the registered name of this controller.
The registered name is either defined by the corresponding key in the
Components.controllers object in the container configuration, or by
invoking Container.registerController method with this name.
Gets the container's Runtime object.
Whenever one of the controller's log methods (e.g. logDebug, logInfo,
logWarning, logError, logFatal) is called by application code, the
controller creates a Log object with appropriate property values and
passes it to this method before advertising it.
You can override this method to additionally set certain properties (such
as LogHost.hostname or Log.logLabels). Ensure that
super.extendLogObject is called in your override. The base method does
nothing.
log object to be extended before being advertised
Advertise a Log object for debugging purposes.
a debug message
any number of log tags
Advertise a Log object for an error.
an error (object)
additional error message
any number of log tags
Advertise a Log object for an error with stacktrace information.
an error (object)
additional error message
any number of log tags
Advertise a Log object for a fatal error.
an error (object)
additional error message
any number of log tags
Advertise an informational Log object.
an informational message
any number of log tags
Advertise a Log object for a warning.
a warning message
any number of log tags
Called when the communication manager is about to start or restart.
Override this method to implement side effects here. Ensure that
super.onCommunicationManagerStarting is called in your override. The
base implementation does nothing.
Called when the communication manager is about to stop.
Override this method to implement side effects here. Ensure that
super.onCommunicationManagerStopping is called in your override. The
base implementation does nothing.
Called by the container when this instance should be disposed.
Implement cleanup side effects here. Ensure that super.onDispose is
called in your override. The base implementation does nothing.
Called when the container has completely set up and injected all dependency components, including all its controllers.
Override this method to perform initializations in your custom controller
class instead of defining a constructor. Although the base implementation
does nothing it is good practice to call super.onInit() in your
override method; especially if your custom controller class does not
extend from the base Controller class directly.
Gets an observable that emits the first object resolved for the given object Id, then completes.
the object Id of the object to resolve
true if an already pending resolution should be rediscovered; false otherwise (default)
Generated using TypeDoc
Discovers objects by given object Ids and maintains a local cache of resolved objects. The controller will also update existing objects in its cache whenever such objects are advertised by other parties.
To realize an object cache controller for a specific core types or for specific objects, define a custom controller class that extends this abstract class and set the core type and/or the filter predicate of objects to be cached in the
OnInitmethod.