This page describes how the configuration of C++ plugins is changing in 4.3.

For related issues, see #Tracking below.

Configuration File Names and Structure

There are 4 parts to the configuration for a plugin (with the colors used for them below):

• The hook that the plugin module should be called by (effectively what subclass of 'Plugin' it is); shown in red.
• The name of the plugin instance (it is possible to configure more than one copy of the same plugin with different names, each with its configuration values); shown in blue
• The shared library that implements the plugin; shown in green
• Any configuration name/value pairs required by the plugin; shown in orange

Configuration File Names and Structure

The Old Way

In 4.2 and earlier, all plugins for a component were configured by adding lines to the (single) *-config file for the component; in the case of the registrar, this is /etc/sipxpbx/registrar-config

...

So, to add the mappingrules redirector plugin and assign its file name, the file /etc/sipxpbx/redirect-hook/130-mapping.plugin is written:

List of Plugins

...

Component	PluginClass	Description	Old Prefix	New Directory
sipXregistry	RegisterPlugin	Registration side effects	SIP_REGISTRAR	/etc/sipxpbx/registrar-hook
sipXregistry	RedirectPlugin	Routing lookups	SIP_REDIRECT	/etc/sipxpbx/redirect-hook
sipXproxy	AuthPlugin	Authorization checks	SIPX_PROXY	/etc/sipxpbx/auth-hook

Redirect Plugin Interface Change

In 4.2, the authority level of a plugin was configured using the naming convention of a plugin parameter, like this:

but it was actually read and acted on by the SipRouter class in the redirect server directly. This was cumbersome, but reasonable since all the directives were in the same configuration file.

In order to avoid the SipRouter needing to scan the now-separate plugin configurations a second time (the first being the scan that instatiates the plugins), the base RedirectPlugin class has had two methods added:

• void readAuthorityLevel(OsConfigDb& configDb which must now be called from the readConfig method of any plugin to read the authority level configuration from its own configuration file
• int authorityLevel(void) which is now called from the SipRouter after the configurations are loaded. The default base class implementation of readConfig has been modified to make this call.

Tracking