SipConfigurationAPI

Version 43 (Adrian Georgescu, 04/08/2010 02:02 pm)

1 1 Adrian Georgescu
= Configuration API =
2 1 Adrian Georgescu
3 41 Adrian Georgescu
[[TOC(SipMiddlewareApi, SipConfigurationAPI, SipCoreApiDocumentation, depth=3)]]
4 1 Adrian Georgescu
5 28 Luci Stanescu
The configuration API is used by the [wiki:SipMiddlewareApi Middleware API] to store and read its settings. By managing the settings of the middleware through this configuration API one can create different applications that behave consistently and inherit the same settings. For example a command line client or a GUI program can read and write their settings through this API. In addition, the configuration API offers an extensibility framework, by which applications can add their specific settings which will be managed in the same way as the middleware settings. The settings are loaded and saved from/to persistent storage using a backend; a backend is provided which has a simple text file format.
6 1 Adrian Georgescu
7 33 Luci Stanescu
The settings can be managed by API calls. The middleware settings have appropriate defaults so that it can function properly with a minimum amount of changes.
8 1 Adrian Georgescu
9 33 Luci Stanescu
== Architecture ==
10 33 Luci Stanescu
11 33 Luci Stanescu
Configuration API consists of the low-level classes that can be used for storing and retrieving configuration objects. Moreover, it allows the creation of a higher level API for accessing configuration items. The SIP SIMPLE settings are defined using this API, however application-specific settings can also make use of it in order to define a consistent view of all the settings, by either extending the settings objects defined in the middleware or creating new settings objects.
12 33 Luci Stanescu
13 33 Luci Stanescu
The module '''sipsimple.configuration''' contains the main classes of the configuration API. These are:
14 33 Luci Stanescu
15 33 Luci Stanescu
 * ConfigurationManager
16 33 Luci Stanescu
 * SettingsObject
17 33 Luci Stanescu
 * SettingsGroup
18 33 Luci Stanescu
 * Setting
19 33 Luci Stanescu
 * SettingsObjectExtension
20 33 Luci Stanescu
21 33 Luci Stanescu
In addition, the exceptions which make up this package are:
22 33 Luci Stanescu
23 33 Luci Stanescu
 * ConfigurationError (base class for all other configuration errors)
24 33 Luci Stanescu
 * ObjectNotFoundError
25 33 Luci Stanescu
26 39 Adrian Georgescu
The package '''sipsimple.configuration.backend''' contains the abstract interface for configuration backends, as well as concrete implementations of backends. This package is explained in more detail in [wiki:SipConfigurationAPI#BackendAPI Configuration Backend API].
27 33 Luci Stanescu
28 37 Adrian Georgescu
=== ConfigurationManager ===
29 33 Luci Stanescu
30 33 Luci Stanescu
The central entity is the ConfigurationManager, which is used for storing and retrieving settings. Within the ConfigurationManager, settings can be represented in a hierarchical structure, where the root the of tree is the configuration ''document''. This structure is represented using a dictionary, defined recursively as:
31 33 Luci Stanescu
 * the keys of the dictionary are unicode objects
32 33 Luci Stanescu
 * the values of the dictionary can be:
33 33 Luci Stanescu
   * the None object (this represents a default value)
34 33 Luci Stanescu
   * unicode objects
35 33 Luci Stanescu
   * lists of unicode objects
36 33 Luci Stanescu
   * dictionaries using this specification
37 33 Luci Stanescu
An item in the dictionary with an unicode object or a list as the value is a single setting: the name of the item is the name of the setting. An item with a dictionary as the value is a group of settings: the name of the item is the name of the group. This dictionary representation is stored to a persistent storage and loaded using the configuration backend as explained in [wiki:SipConfigurationAPI#ConfigurationBackendAPI Configuration Backend API]. Any backend which is able to store and load such data can be used, but a simple [wiki:SipConfigurationAPI#FileBackend text file backend] is provided. After configuration data is loaded from the backend, it is saved on the ConfigurationManager and can be managed using its methods; in order to save the data using the backend provided, the {{{save}}} method needs to be called; any calls to {{{update}}} or {{{delete}}} will not ask the backend to store the data as well.
38 33 Luci Stanescu
39 33 Luci Stanescu
The ConfigurationManager class is a singleton to allow any part of the code to access it without the need to pass references. However, its '''start''' method needs to be called before it can be used. Once this is done, objects can be added, retrieved or deleted from the underlying storage; if using the [wiki:SipMiddlewareApi#SIPApplication SIPApplication] class, its start method takes care of this passing as the backend the one it receives as an argument. The methods of ConfigurationManager are:
40 33 Luci Stanescu
41 33 Luci Stanescu
 '''!__init!__'''(''self'')::
42 33 Luci Stanescu
 References to the ConfigurationManager instance can be obtained anytime without passing any arguments. However, it needs the manager needs to be started in order to be used, otherwise all methods will raise a RuntimeError.
43 33 Luci Stanescu
 '''start'''(''self'', '''backend''')::
44 33 Luci Stanescu
 The start method allows the ConfigurationManager instance to use the specified backend for accessing the underlying storage. See [wiki:SipConfigurationAPI#ConfigurationBackendAPI Configuration Backend API] for information on what the required interface for the passed object is. Raises a {{{ConfigurationBackendError}}} if the backend cannot load the configuration data from persistent storage.
45 33 Luci Stanescu
 '''update'''(''self'', '''group''', '''name''', '''data''')::
46 33 Luci Stanescu
 The partial {{{data}}} which must be a dictionary as formerly defined corresponding to an object having the specified name under the specified group. If {{{group}}} is {{{None}}}, the object will be saved top-level (its name will the a top-level key in the data dictionary). Note that changes will not be written to the underlying storage until the '''save''' method is called.
47 33 Luci Stanescu
 '''delete'''(''self'', '''group''', '''name''')::
48 33 Luci Stanescu
 If an object stored as {{{name}}} exists in {{{group}}}, then it will be deleted. If {{{group}}} is {{{None}}}, then the top-level object identified by {{{name}}} will be deleted.
49 33 Luci Stanescu
 '''get'''(''self'', '''group''', '''name''')::
50 33 Luci Stanescu
 Retrieves the object stored with {{{name}}} in {{{group}}}, if it exists. Otherwise, the method will raise an {{{ObjectNotFoundError}}}. If {{{group}}} is {{{None}}}, the top-level object identified by {{{name}}} will be retrieved.
51 33 Luci Stanescu
 '''get_names'''(''self'', '''group''')::
52 33 Luci Stanescu
 Returns a list with all the names of the objects in {{{group}}}. Returns an empty list if the group does not exist.
53 33 Luci Stanescu
 '''save'''(''self'')::
54 33 Luci Stanescu
 Flushes the changes made to the configuration to the backend. This method must be called to ensure that all changes have been written to persistent storage. Raises a {{{ConfigurationBackendError}}} if the backend cannot store the data to persistent storage. 
55 33 Luci Stanescu
56 33 Luci Stanescu
57 33 Luci Stanescu
=== SettingsObject ===
58 33 Luci Stanescu
59 33 Luci Stanescu
A SettingsObject is used to represent a hierarchy of settings, which are managed via the ConfigurationManager. There are two types of SettingsObject:
60 33 Luci Stanescu
 * pure Singleton SettingsObjects, i.e. there is only one instance of this SettingsObject in an application. This also means that the object cannot be deleted. An example of such a SettingsObject is SIPSimpleSettings. These SettingsObjects are useful to represent global settings.
61 33 Luci Stanescu
 * SettingsObject with an associated id. These are Singleton as well, but there is more than one instance: one per id. The instances are not necessarily persistent. New ones can be created and existing ones can be deleted. An example of such a SettingsObject is the Account. These SettingsObjects are useful to represent settings which apply to entities identifiable by a string id.
62 33 Luci Stanescu
63 33 Luci Stanescu
SettingsObjects can belong to a group, depending on whether the {{{__group__}}} attribute was specified. If it wasn't, the data will be saved top-level using the id of the SettingsObject; otherwise, the data will be saved under the group specified using the id. It is recommended that SettingsObjects with instances per id be saved in a group, although this is not enforced. For example, the Account instances are saved in a group named '''Accounts'''.
64 33 Luci Stanescu
65 33 Luci Stanescu
When a SettingsObject is instantiated its contained settings are loaded from the configuration storage. If it is the first time a SettingsObject is created, the default values for the settings will apply. The SettingsObject will only be copied to storage when its '''save''' method is called.
66 33 Luci Stanescu
67 33 Luci Stanescu
==== Defining a global SettingsObject ====
68 33 Luci Stanescu
69 33 Luci Stanescu
In order to define a global SettingsObject, the {{{__id__}}} attribute must be defined on the class, while the {{{__group__}}} attribute can be defined. The {{{__id__}}} must not be used in any other SettingsObject which is stored in the same group (or globally if the {{{__group__}}} attribute is missing). An example of defining a global SettingsObject:
70 33 Luci Stanescu
{{{
71 33 Luci Stanescu
from sipsimple.configuration import SettingsObject
72 33 Luci Stanescu
73 33 Luci Stanescu
class SIPSimpleSettings(SettingsObject):
74 33 Luci Stanescu
    __group__ = 'Global'
75 33 Luci Stanescu
    __id__ = 'SIPSimple'
76 33 Luci Stanescu
}}}
77 33 Luci Stanescu
78 33 Luci Stanescu
The {{{__init__}}} method must not accept any other argument except ''self''. It will be called each time the settings are loaded from the storage, not only the first time the object is created.
79 33 Luci Stanescu
80 33 Luci Stanescu
81 33 Luci Stanescu
==== Defining a per-id SettingsObject ====
82 33 Luci Stanescu
83 33 Luci Stanescu
In order to define a per-id SettingsObject, the {{{__group__}}} attribute should be defined on the class, while the {{{__id__}}} attribute must be left to None. When instantiating the resulting class, exactly one argument must be given, which represents the string id. Each class defined as a per-id SettingsObject should be allocated a different group from all the other SettingsObjects (including global ones), otherwise the keys under which the SettingsObjects are stored could overlap. An example of defining a per-id SettingsObject:
84 33 Luci Stanescu
{{{
85 33 Luci Stanescu
from sipsimple.configuration import SettingsObject
86 33 Luci Stanescu
87 33 Luci Stanescu
class Account(SettingsObject):
88 33 Luci Stanescu
    __group__ = 'Accounts'
89 33 Luci Stanescu
    def __init__(self, id):
90 33 Luci Stanescu
        """Do something each time the Account is loaded"""
91 33 Luci Stanescu
}}}
92 33 Luci Stanescu
93 33 Luci Stanescu
The {{{__init__}}} method must accept exactly one argument except ''self''. It will be called each time the object is loaded from the storage, in addition to the first time the object is created. This allows the SettingsObject to be more than a simple collection of settings.
94 33 Luci Stanescu
95 33 Luci Stanescu
==== Instance methods of SettingsObjects ====
96 33 Luci Stanescu
97 33 Luci Stanescu
 '''save'''(''self'')::
98 33 Luci Stanescu
 If the contained Settings of this SettingsObject have changed, the object will be saved to the persistent storage. A CFGSettingsObjectDidChange notification will be issued which contains the modified settings. If the save fails, a CFGManagerSaveFailed notification is issued in addition.
99 33 Luci Stanescu
 '''delete'''(''self'')::
100 33 Luci Stanescu
 This method can only be called on per-id SettingsObjects. It will delete the object from the persistent storage. All references to this SettingsObject must be removed.
101 33 Luci Stanescu
102 33 Luci Stanescu
==== Notifications ====#SettingsObjectNotifications
103 33 Luci Stanescu
104 33 Luci Stanescu
 '''CFGSettingsObjectDidChange'''::
105 33 Luci Stanescu
 This notification is sent when the save method of a SettingsObject is called. Attributes:
106 33 Luci Stanescu
 [[BR]]''modified'':[[BR]]
107 33 Luci Stanescu
 A dict instance which maps settings keys in their fully qualified form (attribute names seperated by '.', relative to the SettingsObject) to a ModifiedValue instance; the ModifiedValue instance contains two attributes: ''old'' and ''new'' which are set to the old and the new Setting's value respectively.
108 33 Luci Stanescu
109 33 Luci Stanescu
110 33 Luci Stanescu
=== Setting ===
111 33 Luci Stanescu
112 33 Luci Stanescu
The Setting descriptor is used to describe a setting in SettingsObjects. The following methods are part of the public API of it:
113 33 Luci Stanescu
 '''!__init!__'''(''self'', '''type''', '''default'''={{{None}}}, '''nillable'''={{{False}}})::
114 33 Luci Stanescu
 Create a new Setting descriptor which represents a setting in all instances of a SettingsObject. The default value must be specified if the setting is not nillable. The type will be applied to the values which are set to this descriptor if the value is not already an instance of the type; it is not applied to the default value.
115 33 Luci Stanescu
116 33 Luci Stanescu
An example of using a setting:
117 33 Luci Stanescu
{{{
118 42 Luci Stanescu
from sipsimple import __version__
119 33 Luci Stanescu
from sipsimple.configuration import Setting, SettingsObject
120 33 Luci Stanescu
121 33 Luci Stanescu
class SIPSimpleSettings(SettingsObject):
122 33 Luci Stanescu
    __group__ = 'Global'
123 33 Luci Stanescu
    __id__ = 'SIPSimple'
124 33 Luci Stanescu
125 33 Luci Stanescu
    user_agent = Setting(type=str, default='sipsimple %s' % __version__)
126 33 Luci Stanescu
}}}
127 33 Luci Stanescu
128 33 Luci Stanescu
When a setting value is read from the configuration backend, the type is used to reconstruct the value from a unicode object, a list of unicode objects, or a dictionary containing unicode keys and values with any of these three types. Several built-in types are recognised and are handled automatically:
129 33 Luci Stanescu
 * bool: the unicode strings {{{u'yes'}}}, {{{u'true', {{{u'on'}}} and {{{u'1'}}} are considered to have the value {{{True}}}, while {{{u'no'}}}, {{{u'false'}}}, {{{u'off'}}} and {{{u'0'}}} are considered to have the value False; the comparison is done case insensitively; all other strings are considered invalid.
130 33 Luci Stanescu
 * int, long and basestring: the type is called using the value as an argument.
131 33 Luci Stanescu
All other types are instantiated using an un-pickling like mechanism. The {{{__new__}}} method is called without any arguments and {{{__setstate__}}} is called on the object returned by {{{__new__}}} using the value as the sole argument.
132 33 Luci Stanescu
133 33 Luci Stanescu
Saving a setting value is done similarly, according to type. The builtin types which are handled are the same:
134 33 Luci Stanescu
 * bool: the unicode objects {{{u'true'}}} and {{{u'false}}} are used depending on the value.
135 33 Luci Stanescu
 * int, long and basestring: {{{unicode}}} is called with the value as the sole argument.
136 33 Luci Stanescu
For all other types, the {{{__getstate__}}} method is called which should return an appropriate value.
137 33 Luci Stanescu
138 33 Luci Stanescu
139 33 Luci Stanescu
=== SettingsGroup ===
140 33 Luci Stanescu
141 33 Luci Stanescu
A SettingsGroup allows settings to be structured hierarchically. Subclasses of SettingsGroup are containers for Settings and other SettingsGroups just as SettingsObjects are. In addition, the subclasses of SettingsGroup are descriptors and can be used as such to assign a SettingsGroup as a child of another SettingsGroup or a SettingsObject. An example usage containing Setting, SettingsGroup and SettingsObject:
142 33 Luci Stanescu
{{{
143 42 Luci Stanescu
from sipsimple import __version__
144 33 Luci Stanescu
from sipsimple.configuration import Setting, SettingsGroup, SettingsObject
145 33 Luci Stanescu
146 33 Luci Stanescu
class TLSSettings(SettingsGroup):
147 33 Luci Stanescu
    verify_server = Setting(type=bool, default=False)
148 33 Luci Stanescu
149 33 Luci Stanescu
class SIPSimpleSettings(SettingsObject):
150 33 Luci Stanescu
    __group__ = 'Global'
151 33 Luci Stanescu
    __id__ = 'SIPSimple'
152 33 Luci Stanescu
153 33 Luci Stanescu
    user_agent = Setting(type=str, default='sipsimple %s' % __version__)
154 33 Luci Stanescu
155 33 Luci Stanescu
    tls = TLSSettings
156 33 Luci Stanescu
}}}
157 33 Luci Stanescu
158 33 Luci Stanescu
=== SettingsObjectExtension ===
159 33 Luci Stanescu
160 33 Luci Stanescu
The SettingsObjectExtension allows an application to add or customize the settings of the middleware according to its needs. In order to add or replace settings/settings groups defined in another SettingsObject, SettingsObjectExtension can be subclassed and the register_extension class method of the original SettingsObject can be called passing the SettingObjectExtension subclass as the sole argument. In order to add/replace settings in a group of settings, the original SettingsGroup can be subclassed. Example:
161 1 Adrian Georgescu
{{{
162 42 Luci Stanescu
from sipsimple import __version__
163 42 Luci Stanescu
from sipsimple.configuration import Setting, SettingsGroup, SettingsObject, SettingsObjectExtension
164 33 Luci Stanescu
165 33 Luci Stanescu
class TLSSettings(SettingsGroup):
166 33 Luci Stanescu
    verify_server = Setting(type=bool, default=False)
167 33 Luci Stanescu
168 33 Luci Stanescu
class SIPSimpleSettings(SettingsObject):
169 33 Luci Stanescu
    __group__ = 'Global'
170 33 Luci Stanescu
    __id__ = 'SIPSimple'
171 33 Luci Stanescu
172 33 Luci Stanescu
    user_agent = Setting(type=str, default='sipsimple %s' % __version__)
173 33 Luci Stanescu
174 33 Luci Stanescu
    tls = TLSSettings
175 33 Luci Stanescu
176 33 Luci Stanescu
class TLSSettingsExtension(TLSSettings):
177 33 Luci Stanescu
    verify_client = Setting(type=bool, default=True)
178 33 Luci Stanescu
179 33 Luci Stanescu
class SIPSimpleSettingsExtension(SettingsObjectExtension):
180 33 Luci Stanescu
    default_account = Setting(type=str, default=None, nillable=True)
181 33 Luci Stanescu
182 33 Luci Stanescu
    tls = TLSSettingsExtension
183 33 Luci Stanescu
184 33 Luci Stanescu
SIPSimpleSettings.register_extension(SIPSimpleSettingsExtension)
185 33 Luci Stanescu
}}}
186 33 Luci Stanescu
187 33 Luci Stanescu
=== Backend API ===
188 33 Luci Stanescu
189 33 Luci Stanescu
The backend API provides a way to use the configuration framework consistently, while using any system for storing the data persistently. The ConfigurationManager makes use of a backend whenever it needs to write/read something to the persistent storage. The backend only needs to know how to handle data in the dictionary format explained in [wiki:SipConfigurationAPI#ConfigurationManager Configuration Manager]. In order to use a specific backend, it is given to the ConfigurationManager in its start method.
190 33 Luci Stanescu
191 33 Luci Stanescu
The interface '''sipsimple.configuration.backend.IBackend''' describes the backend:
192 33 Luci Stanescu
 '''load'''()::
193 33 Luci Stanescu
 Load the configuration data using whatever means employed by the backend implementation and return a dictionary conforming to the definition in [wiki:SipConfigurationAPI#ConfigurationManager Configuration Manager].
194 33 Luci Stanescu
 '''save'''('''data''')::
195 33 Luci Stanescu
 Given a dictionary conforming to the definition in this interface, save the data using whatever means employed by the backend implementation.
196 33 Luci Stanescu
197 33 Luci Stanescu
198 33 Luci Stanescu
==== FileBackend ====
199 33 Luci Stanescu
200 33 Luci Stanescu
A concrete implementation of the '''IBackend''' interface resides in '''sipsimple.configuration.backend.file.FileBackend'''. The methods different from the ones in '''IBackend''' are:
201 33 Luci Stanescu
202 33 Luci Stanescu
 '''!__init!__'''(''self'', '''filename''', '''encoding'''={{{'utf-8'}}})::
203 33 Luci Stanescu
 Create a new FileBackend which uses the specified filename for loading and storing the data to; the data is written using the specified encoding, defaulting to UTF-8.
204 33 Luci Stanescu
205 33 Luci Stanescu
This object saves the data using a simple text file format with the following syntax:
206 33 Luci Stanescu
 * SettingGroups, SettingsObjects or Groups of SettingsObjects are represented by their name (or id in the case of SettingsObjects) followed by a colon (''':'''). These containers can contain other such containers or simple settings. Their children need to be indented more that the container itself. The indentation need not be consistent.
207 33 Luci Stanescu
 {{{
208 33 Luci Stanescu
 Accounts:
209 33 Luci Stanescu
    user@domain:
210 33 Luci Stanescu
      display_name = User
211 33 Luci Stanescu
      tls:
212 33 Luci Stanescu
        certificate =
213 33 Luci Stanescu
 }}}
214 33 Luci Stanescu
 * Simple settings are represented by a name followed by an equals sign and the value; whitespace anywhere in between is ignored. The different values are represented in the following way:
215 33 Luci Stanescu
  * None is represented by the absence of a value.
216 33 Luci Stanescu
  {{{
217 33 Luci Stanescu
    setting =
218 33 Luci Stanescu
  }}}
219 33 Luci Stanescu
  * Unicode objects are represented by a simple string (which can be quoted to include leading and trailing whitespace by either single or double quotes) and can have the following espace sequances: '''\' ''', '''\"''', '''\n''', '''\r'''. The unicode characters are encoded using the encoding specified in the constructor.
220 33 Luci Stanescu
  {{{
221 33 Luci Stanescu
    setting1 = value
222 33 Luci Stanescu
    setting2 = value with spaces
223 33 Luci Stanescu
    setting3 = "  value with leading and trailing spaces  "
224 33 Luci Stanescu
    setting4 = value with a line feed\n
225 33 Luci Stanescu
  }}}
226 33 Luci Stanescu
  * Lists are represented by unicode strings as described above separated by commas (''','''). Any not-quoted whitespace around the comma is ignored.
227 33 Luci Stanescu
  {{{
228 33 Luci Stanescu
    setting = a, b  , c
229 33 Luci Stanescu
  }}}
230 33 Luci Stanescu
  * Complex settings can be represented just like a group:
231 33 Luci Stanescu
  {{{
232 33 Luci Stanescu
    complex_setting:
233 33 Luci Stanescu
      field1 = value
234 33 Luci Stanescu
      field2 = 123
235 33 Luci Stanescu
  }}}
236 33 Luci Stanescu
  
237 33 Luci Stanescu
238 35 Luci Stanescu
== Middleware Settings ==
239 4 Adrian Georgescu
240 4 Adrian Georgescu
These are the current settings, kept in the modules '''sipsimple.configuration.settings''' and '''sipsimple.account'''. The main classes used to access the settings are Account, BonjourAccount and SIPSimpleSettings. All settings can be accessed as simple attributes. The types of attributes is described for each setting below. When setting the value of an attribute, if it's not of the required type, it will be given to the specified type as the only argument. The modified settings are not saved to the persistent storage until the '''save''' method is called on the main object. Once this is done, a CFGSettingsObjectDidChange notification is sent, the data of which is explained in [wiki:SipConfigurationAPI#SettingsObjectNotifications SettingsObject Notifications].
241 1 Adrian Georgescu
242 1 Adrian Georgescu
Only a nillable setting can be assigned the value {{{None}}}, even if the type of the setting would otherwise accept {{{None}}} as an argument. The settings as described below are ''not'' nillable, unless specified explicitely. To reset the value of a setting, the special object {{{sipsimple.configuration.DefaultValue}}} can be assigned to it. If a default value is not explicitely specified below, it defaults to {{{None}}}. Note that a non-nillable setting cannot have the default value of {{{None}}}.
243 4 Adrian Georgescu
244 33 Luci Stanescu
=== General ===
245 1 Adrian Georgescu
246 22 Adrian Georgescu
{{{
247 22 Adrian Georgescu
SIP SIMPLE settings:
248 27 Luci Stanescu
             +-- default_account = user@example.com
249 17 Adrian Georgescu
SIP SIMPLE --|-- user_agent = sipsimple
250 22 Adrian Georgescu
             |-- audio
251 4 Adrian Georgescu
             |-- chat
252 22 Adrian Georgescu
             |-- desktop_sharing
253 1 Adrian Georgescu
             |-- file_transfer
254 1 Adrian Georgescu
             |-- logs
255 23 Adrian Georgescu
             |-- msrp
256 17 Adrian Georgescu
             |-- rtp
257 1 Adrian Georgescu
             |-- sip
258 1 Adrian Georgescu
             +-- tls
259 1 Adrian Georgescu
260 1 Adrian Georgescu
        +-- alert_device = system_default
261 27 Luci Stanescu
audio --|-- input_device = system_default
262 17 Adrian Georgescu
        |-- output_device = system_default
263 1 Adrian Georgescu
        |-- sample_rate = 44100
264 1 Adrian Georgescu
        |-- silent = False
265 27 Luci Stanescu
        +-- tail_length = 200
266 27 Luci Stanescu
267 1 Adrian Georgescu
       +
268 23 Adrian Georgescu
chat --|
269 23 Adrian Georgescu
       +
270 22 Adrian Georgescu
271 17 Adrian Georgescu
                  +
272 17 Adrian Georgescu
desktop_sharing --|
273 22 Adrian Georgescu
                  +
274 23 Adrian Georgescu
275 23 Adrian Georgescu
                +
276 23 Adrian Georgescu
file_transfer --|
277 23 Adrian Georgescu
                +
278 23 Adrian Georgescu
279 18 Adrian Georgescu
       +-- pjsip_level = 5
280 22 Adrian Georgescu
logs --|
281 18 Adrian Georgescu
       +
282 17 Adrian Georgescu
283 22 Adrian Georgescu
       +-- transport = tls
284 4 Adrian Georgescu
msrp --|
285 1 Adrian Georgescu
       +
286 1 Adrian Georgescu
287 1 Adrian Georgescu
      +-- audio_codec_list = AudioCodecList(['speex', 'G722', 'PCMU', 'PCMA', 'iLBC', 'GSM'])
288 1 Adrian Georgescu
rtp --|-- port_range = PortRange(start=50000, end=50400)
289 2 Adrian Georgescu
      +-- timeout = 30
290 1 Adrian Georgescu
291 1 Adrian Georgescu
      +-- tcp_port = 0
292 1 Adrian Georgescu
sip --|-- tls_port = 0
293 1 Adrian Georgescu
      |-- transport_list = SIPTransportList(['tls', 'tcp', 'udp'])
294 1 Adrian Georgescu
      +-- udp_port = 0
295 1 Adrian Georgescu
296 1 Adrian Georgescu
      +-- ca_list = None
297 28 Luci Stanescu
tls --|-- protocol = TLSv1
298 28 Luci Stanescu
      +-- timeout = 1000
299 1 Adrian Georgescu
300 28 Luci Stanescu
}}}
301 1 Adrian Georgescu
302 28 Luci Stanescu
The {{{sipsimple.configuration.settings.SIPSimpleSettings}}} class is a singleton can be instantiated and used anywhere after the [wiki:SipConfigurationAPI#ConfigurationManager ConfigurationManager] has been started. 
303 28 Luci Stanescu
304 24 Adrian Georgescu
The settings are explained below:
305 1 Adrian Georgescu
306 1 Adrian Georgescu
 '''SIPSimpleSettings.default_account''' (type={{{str}}}, default={{{'bonjour@local'}}}, nillable={{{True}}})::
307 1 Adrian Georgescu
  A string, which contains the id of the default Account. This setting is managed by the AccountManager and should not be changed manually. See [wiki:SipMiddlewareApi#AccountManager AccountManager] for more information.
308 28 Luci Stanescu
309 1 Adrian Georgescu
 '''SIPSimpleSettings.user_agent''' (type={{{str}}}, default={{{'sipsimple VERSION'}}})::
310 28 Luci Stanescu
  This setting will be used to set the value of the User-Agent header in outgoing SIP requests and of the Server header in all SIP responses.
311 1 Adrian Georgescu
312 33 Luci Stanescu
==== Audio ====
313 17 Adrian Georgescu
314 1 Adrian Georgescu
 '''SIPSimpleSettings.audio.input_device''' (type={{{AudioInputDevice}}}, default={{{'system_default'}}}, nillable={{{True}}})::
315 1 Adrian Georgescu
  The name of the audio device, which will be used for input (recording). If it is set to {{{'system_default'}}}, one will be selected automatically by the operating system; if it is set to {{{None}}}, a dummy device will be used which doesn't record anything.
316 23 Adrian Georgescu
317 1 Adrian Georgescu
 '''SIPSimpleSettings.audio.output_device''' (type={{{AudioOutputDevice}}}, default={{{'system_default'}}}, nillable={{{True}}})::
318 4 Adrian Georgescu
  The name of the audio device, which will be used for output (playback). If it is set to {{{'system_default'}}, one will be selected automatically by the operating system; if it is set to {{{None}}}, a dummy device will be used which will discard any audio data.
319 24 Adrian Georgescu
320 1 Adrian Georgescu
 '''SIPSimpleSettings.audio.alert_device''' (type={{{AudioOutputDevice}}}, default={{{'system_default'}}}, nillable={{{True}}})::
321 1 Adrian Georgescu
  The name of the alert device, which can be used for alerting the user. If it is set to {{{'system_default'}}}, one will be selected automatically by the operating system; if it is set to {{{None}}}, a dummy device will be used which will discard any audio data. This device is not used by the middleware but is provided for consistency.
322 24 Adrian Georgescu
323 4 Adrian Georgescu
 '''SIPSimpleSettings.audio.tail_length''' (type={{{NonNegativeInteger}}}, default={{{200}}})::
324 27 Luci Stanescu
  This setting is used as a parameter for the audio echo cancellation algorithm. It's value is a non-negative integer which represents milliseconds. It specifies the length of the echo cancellation filter.
325 24 Adrian Georgescu
326 1 Adrian Georgescu
 '''SIPSimpleSettings.audio.sample_rate''' (type={{{SampleRate}}}, default={{{16000}}})::
327 1 Adrian Georgescu
  This is the sample rate at which the audio system runs, in Hz. All playback and recording will be done at this rate. If an audio codec has a smaller or larger sample rate, it will be resampled to this value (if possible). Example values include 8000, 32000, 44100 etc.
328 1 Adrian Georgescu
 
329 1 Adrian Georgescu
 '''SIPSimpleSettings.audio.silent''' (type={{{bool}}}, default={{{False}}})::
330 1 Adrian Georgescu
  If this setting is set to True, no audio notifications will be played on the alert device (the volume of the alert device will be set to 0).
331 1 Adrian Georgescu
332 33 Luci Stanescu
==== Chat ====
333 23 Adrian Georgescu
334 1 Adrian Georgescu
Empty section for future use.
335 4 Adrian Georgescu
336 33 Luci Stanescu
==== Desktop Sharing ====
337 1 Adrian Georgescu
338 23 Adrian Georgescu
Empty section for future use.
339 1 Adrian Georgescu
340 33 Luci Stanescu
==== File Transfer ====
341 1 Adrian Georgescu
342 1 Adrian Georgescu
Empty section for future use.
343 23 Adrian Georgescu
344 33 Luci Stanescu
==== Logs ====
345 1 Adrian Georgescu
346 28 Luci Stanescu
 '''SIPSimpleSettings.logs.pjsip_level''' (type={{{NonNegativeInteger}}}, default={{{5}}})::
347 28 Luci Stanescu
  This setting controls the amount of log messages generated by the PJSIP core. It must be set to a non-negative integer.
348 1 Adrian Georgescu
349 33 Luci Stanescu
==== MSRP ====
350 1 Adrian Georgescu
351 23 Adrian Georgescu
 '''SIPSimpleSettings.msrp.transport''' (type={{{MSRPTransport}}}, default={{{'tls'}}})::
352 34 Luci Stanescu
  MSRP can use either TLS or TCP and this setting controls which one should be used for normal accounts.
353 23 Adrian Georgescu
354 33 Luci Stanescu
==== RTP ====
355 23 Adrian Georgescu
356 23 Adrian Georgescu
 '''SIPSimpleSettings.rtp.port_range''' (type={{{PortRange}}}, default={{{PortRange(50000, 50400)}}})::
357 23 Adrian Georgescu
  This setting controls the port range from which ports used by RTP transport will be assigned. The values of the ports need to be in the range 1-65535; the start port must not be larger than the end port.
358 23 Adrian Georgescu
359 43 Adrian Georgescu
 '''SIPSimpleSettings.rtp.audio_codec_list''' (type={{{AudioCodecLis}t}}, default={{{AudioCodecList(('speex', 'G722', 'PCMU', 'PCMA'))}}})::
360 43 Adrian Georgescu
  This setting is used to specify the preferred audio codecs, which should be used for audio calls. It must contain only strings, which represent the supported codecs (speex, G722, PCMA, PCMU, iLBC and GSM), in the order in which they are preferred. This setting can be overridden per account.
361 23 Adrian Georgescu
362 33 Luci Stanescu
==== SIP ====
363 23 Adrian Georgescu
364 28 Luci Stanescu
 '''SIPSimpleSettings.sip.udp_port''' (type={{{Port}}}, default={{{0}}})::
365 8 Adrian Georgescu
  This is the port on which the Engine will bind and for for sending and receiving UDP packets. It is an integer in the range 0-65535. If it is set to 0, it will be allocated automatically.
366 28 Luci Stanescu
367 1 Adrian Georgescu
 '''SIPSimpleSettings.sip.tcp_port''' (type={{{Port}}}, default={{{0}}})::
368 8 Adrian Georgescu
  This is the port on which the Engine will listen for TCP connections. It is an integer in the range 0-65535. If it is set to 0, it will be allocated automatically.
369 1 Adrian Georgescu
370 28 Luci Stanescu
 '''SIPSimpleSettings.sip.tls_port''' (type={{{Port}}}, default={{{0}}})::
371 8 Adrian Georgescu
  This is the port on which the Engine will listen for TLS connections. It is an integer in the range 0-65535. If it is set to 0, it will be allocated automatically.
372 1 Adrian Georgescu
373 27 Luci Stanescu
 '''SIPSimpleSettings.sip.transport_list''' (type={{{SIPTransportList}}}, default={{{SIPTransportList(('tls', 'tcp', 'udp'))}}})::
374 27 Luci Stanescu
  This setting's value is a tuple, which can only contain the strings 'tls', 'tcp' and 'udp'. It has a double purpose:
375 29 Luci Stanescu
   * Only the transports specified here are used to SIP requests associated with normal accounts.
376 27 Luci Stanescu
   * The order of the transports specified in this tuple represent the preferred order in which transports should be used. This applies to all SIP requests.
377 27 Luci Stanescu
378 33 Luci Stanescu
==== TLS ====
379 27 Luci Stanescu
380 1 Adrian Georgescu
 '''SIPSimpleSettings.tls.ca_list''' (type={{{Path}}}, default={{{None}}}, nillable={{{True}}})::
381 27 Luci Stanescu
  The settings points to a file which contains the CA certificates. In can be {{{None}}}, in which case no CAs are available. It is interpreted as an absolute path, with a leading ''~'' expanded to the home directory of the current user. In order to access the full path to the CA file, the normalized attribute on the setting can be used:
382 27 Luci Stanescu
  {{{
383 27 Luci Stanescu
  SIPSimpleSettings().tls.ca_list.normalized
384 31 Luci Stanescu
  }}}
385 27 Luci Stanescu
386 27 Luci Stanescu
 '''SIPSimpleSettings.tls.protocol''' (type={{{TLSProtocol}}}, default={{{'TLSv1'}}})::
387 27 Luci Stanescu
  This setting sets the version of the TLS protocol which will be used. It is a string and must be one of {{{'TLSv1'}}}, {{{'SSLv2'}}}, {{{'SSL3'}}}, {{{'SSL23'}}}.
388 27 Luci Stanescu
389 29 Luci Stanescu
 '''SIPSimpleSettings.tls.timeout''' (type={{{NonNegativeInteger}}}, default={{{1000}}})::
390 27 Luci Stanescu
  This is the timeout for negotiating TLS connections, in milliseconds. It must be an non-negative integer.
391 27 Luci Stanescu
392 33 Luci Stanescu
=== Account ===
393 1 Adrian Georgescu
394 1 Adrian Georgescu
{{{
395 29 Luci Stanescu
Account user@example.com:
396 29 Luci Stanescu
          +-- display_name = Example User
397 29 Luci Stanescu
account --|-- enabled = True
398 30 Luci Stanescu
          |-- password = xyz
399 29 Luci Stanescu
          |-- dialog_event
400 29 Luci Stanescu
          |-- message_summary
401 29 Luci Stanescu
          |-- nat_traversal
402 29 Luci Stanescu
          |-- presence
403 1 Adrian Georgescu
          |-- pstn
404 29 Luci Stanescu
          |-- rtp
405 1 Adrian Georgescu
          |-- sip
406 1 Adrian Georgescu
          |-- tls
407 1 Adrian Georgescu
          +-- xcap
408 29 Luci Stanescu
409 29 Luci Stanescu
               +-- enabled = True
410 29 Luci Stanescu
dialog_event --|
411 29 Luci Stanescu
               +
412 29 Luci Stanescu
413 29 Luci Stanescu
                  +-- enabled = True
414 29 Luci Stanescu
message_summary --|-- voicemail_uri = None
415 29 Luci Stanescu
                  +
416 29 Luci Stanescu
417 29 Luci Stanescu
                +-- msrp_relay = None
418 1 Adrian Georgescu
nat_traversal --|-- stun_server_list = None
419 29 Luci Stanescu
                |-- use_ice = False
420 1 Adrian Georgescu
                |-- use_msrp_relay_for_inbound = True
421 1 Adrian Georgescu
                +-- use_msrp_relay_for_outbound = False
422 1 Adrian Georgescu
423 1 Adrian Georgescu
           +-- enabled = True
424 1 Adrian Georgescu
presence --|-- use_rls = True
425 1 Adrian Georgescu
           +
426 1 Adrian Georgescu
427 1 Adrian Georgescu
       +
428 30 Luci Stanescu
pstn --|
429 1 Adrian Georgescu
       +
430 1 Adrian Georgescu
431 1 Adrian Georgescu
      +-- audio_codec_list = None
432 1 Adrian Georgescu
rtp --|-- inband_dtmf = False
433 1 Adrian Georgescu
      |-- srtp_encryption = optional
434 30 Luci Stanescu
      +-- use_srtp_without_tls = False
435 1 Adrian Georgescu
436 1 Adrian Georgescu
      +-- outbound_proxy = SIPProxyAddress('sip.example.com', port=5060, transport='udp')
437 1 Adrian Georgescu
sip --|-- publish_interval = 600
438 1 Adrian Georgescu
      |-- register = True
439 30 Luci Stanescu
      |-- register_interval = 600
440 1 Adrian Georgescu
      +-- subscribe_interval = 600
441 1 Adrian Georgescu
442 1 Adrian Georgescu
443 1 Adrian Georgescu
      +-- certificate = tls/user@example.com.crt
444 1 Adrian Georgescu
tls --|-- verify_server = False
445 1 Adrian Georgescu
      +
446 1 Adrian Georgescu
447 1 Adrian Georgescu
       +-- enabled = True
448 30 Luci Stanescu
xcap --|-- use_xcap_diff = True
449 1 Adrian Georgescu
       +-- xcap_root = https://xcap.example.com/xcap-root/
450 1 Adrian Georgescu
}}}
451 1 Adrian Georgescu
452 1 Adrian Georgescu
The Account object is used to represent a normal SIP account registered at a SIP provider. It is uniquely identifiable by it's SIP ID, in the form ''user@domain''. There is exactly one instance of Account per ID, which means that an Account can be accessed by instantianting it anywhere. However, this is not the recommended way of accessing accounts, since it can lead to creating new accounts. The recommended way is by using the [wiki:SipMiddlewareApi#AccountManager AccountManager]. Information about the roles of Account, apart from being a collection of settings, is explained in the [wiki:SipMiddlewareApi#Account Middleware API]. 
453 30 Luci Stanescu
454 1 Adrian Georgescu
The settings that can be accessed on an Account are described below:
455 1 Adrian Georgescu
456 1 Adrian Georgescu
 '''Account.id''' (type={{{SIPAddress}}})::
457 1 Adrian Georgescu
  This is not a setting, as it cannot be modified. Its type is a subclass of {{{str}}}, so it can be used as a normal string, however it also has two attributes {{{username}}} and {{{domain}}} which point to the specific parts of the SIP address.
458 1 Adrian Georgescu
459 1 Adrian Georgescu
 '''Account.display_name''' (type={{{str}}}, default={{{None}}}, nillable={{{True}}})::
460 1 Adrian Georgescu
  The contents of this setting will be sent as part of the ''From'' header when sending SIP requests, the ''From'' CPIM header and other similar information.
461 1 Adrian Georgescu
462 1 Adrian Georgescu
 '''Account.enabled''' (type={{{bool}}}, default={{{False}}})::
463 1 Adrian Georgescu
  If this setting is set to {{{True}}}, the Account will automatically activate and can be used in other parts of the middleware. More about this is described in [wiki:SipMiddlewareApi#Account Account].
464 1 Adrian Georgescu
465 1 Adrian Georgescu
 '''Account.password''' (type={{{str}}}, default={{{''}}})::
466 1 Adrian Georgescu
  The password, which will be used with this account for authentication.
467 1 Adrian Georgescu
468 1 Adrian Georgescu
469 33 Luci Stanescu
==== Dialog Event ====
470 1 Adrian Georgescu
471 1 Adrian Georgescu
 '''Account.dialog_event.enabled''' (type={{{bool}}}, default={{{True}}})::
472 1 Adrian Georgescu
  If this setting is set to {{{True}}}, the Account will subscribe to the ''dialog'' event as specified by RFC4235.
473 1 Adrian Georgescu
474 33 Luci Stanescu
==== Message Summary ====
475 1 Adrian Georgescu
476 1 Adrian Georgescu
 '''Account.message_summary.enabled''' (type={{{bool}}}, default={{{True}}})::
477 1 Adrian Georgescu
  If this setting is set to {{{True}}}, the Account will subscribe to the ''message-summary'' event, as specified by RFC3842.
478 1 Adrian Georgescu
479 1 Adrian Georgescu
 '''Account.message_summary.voicemail_uri''' (type={{{str}}}, default={{{None}}}, nillable={{{True}}})::
480 1 Adrian Georgescu
  This is the SIP URI which can be called to listen to the voicemail messages.
481 1 Adrian Georgescu
482 33 Luci Stanescu
==== NAT Traversal ====
483 1 Adrian Georgescu
484 1 Adrian Georgescu
 '''Account.nat_traversal.use_ice''' (type={{{bool}}}, default={{{False}}})::
485 1 Adrian Georgescu
  If this setting is set to {{{True}}}, ICE will be used for finding media candidates for communication over NAT-ed networks.
486 1 Adrian Georgescu
487 1 Adrian Georgescu
 '''Account.nat_traversal.stun_server_list''' (type={{{StunServerAddressList}}}, default={{{None}}}, nillable={{{True}}})::
488 1 Adrian Georgescu
  This setting used for NAT traversal can be used to specify the addresses of the STUN servers used for detecting server reflexive candidates in the context of ICE. The value of the setting is a tuple of objects of type {{{StunServerAddress}}}. If None, the servers will be looked up in the DNS (SRV record _stun._udp.domain).
489 1 Adrian Georgescu
490 1 Adrian Georgescu
 '''Account.nat_traversal.msrp_relay''' (type={{{MSRPRelayAddress}}}, default={{{None}}}, nillable={{{True}}})::
491 30 Luci Stanescu
  This setting can be used to specify a MSRP relay for use in MSRP connections. If it is set to {{{None}}}. If None, the servers will be looked up in the DNS (SRV record _msrps._tcp.domain).
492 1 Adrian Georgescu
493 1 Adrian Georgescu
 '''Account.nat_traversal.use_msrp_relay_for_inbound''' (type={{{bool}}}, default={{{True}}})::
494 1 Adrian Georgescu
  If this setting is set to {{{True}}}, the MSRP relay will be used for all incoming MSRP connections.
495 1 Adrian Georgescu
496 1 Adrian Georgescu
 '''Account.nat_traversal.use_msrp_relay_for_outbound''' (type={{{bool}}}, default={{{False}}})::
497 30 Luci Stanescu
  If this setting is set to {{{True}}}, the MSRP relay will be used for all outgoing MSRP connections.
498 30 Luci Stanescu
499 33 Luci Stanescu
==== Presence ====
500 1 Adrian Georgescu
501 30 Luci Stanescu
 '''Account.presence.enabled''' (type={{{bool}}}, default={{{True}}})::
502 1 Adrian Georgescu
  If this setting is set to {{{True}}}, the Account will publish its presence state and subscribe to presence and presence.winfo Event packages.
503 30 Luci Stanescu
504 30 Luci Stanescu
 '''Account.presence.use_rls''' (type={{{bool}}}, default={{{True}}})::
505 30 Luci Stanescu
  If this setting is set to {{{True}}}, the Account will store its Buddy Lists in '''rls-services''' XCAP document  and send a single Subscribe for the ''presence'' event to the RLS services address to obtain the presence information for its buddies. If it is set to {{{False}}}, it will subscribe to each buddy individually.
506 30 Luci Stanescu
507 33 Luci Stanescu
==== RTP ====
508 30 Luci Stanescu
509 1 Adrian Georgescu
 '''Account.rtp.audio_codecs''' (type={{{AudioCodecList}}}, default={{{None}}}, nillable={{{True}}})::
510 1 Adrian Georgescu
  This setting is used to specify the preferred audio codecs, which should be used for audio calls of this account. It must be a tuple containing only strings, which represent the supported codecs (speex, g722, g711, ilbc and gsm), in the order in which they are preferred, or {{{None}}} if the codec_list from the general rtp settings is to be used.
511 1 Adrian Georgescu
512 1 Adrian Georgescu
 '''Account.audio.srtp_encryption''' (type={{{SRTPEncryption}}}, default={{{'optional'}}})::
513 1 Adrian Georgescu
  The value of this setting specifies how the account requires the calls to be encrypted using SRTP. It can be one of the values {{{'disabled'}}}, {{{'optional'}}} or {{{'mandatory'}}}.
514 1 Adrian Georgescu
515 1 Adrian Georgescu
 '''Account.audio.use_srtp_without_tls''' (type={{{bool}}}, default={{{False}}})::
516 1 Adrian Georgescu
  If this setting is set to {{{True}}}, SRTP could be used even if the SIP signaling used to control the call is not over TLS.
517 1 Adrian Georgescu
518 33 Luci Stanescu
==== SIP ====
519 1 Adrian Georgescu
520 30 Luci Stanescu
 '''Account.sip.outbound_proxy''' (type={{{SIPProxyAddress}}}, default={{{None}}}, nillable={{{True}}})::
521 1 Adrian Georgescu
  This setting specifies whether to send all SIP requests when creating a new SIP dialog to a specific proxy. If this setting is set to {{{None}}}, then an RFC3263 lookup will be done based on the domain part of the SIP request URI.
522 1 Adrian Georgescu
523 1 Adrian Georgescu
 '''Account.sip.register''' (type={{{bool}}}, default={{{True}}})::
524 1 Adrian Georgescu
  If this setting is set to {{{True}}}, the Account will automatically register when it is active. More about this is described in [wiki:SipMiddlewareApi#Account Account].
525 1 Adrian Georgescu
526 1 Adrian Georgescu
 '''Account.sip.publish_interval''' (type={{{NonNegativeInteger}}}, default={{{600}}})::
527 31 Luci Stanescu
  This setting controls the number of seconds used for the ''Expire'' header when publishing events. It must be a non-negative integer.
528 31 Luci Stanescu
529 31 Luci Stanescu
 '''Account.sip.subscribe_interval''' (type={{{NonNegativeInteger}}}, default={{{600}}})::
530 31 Luci Stanescu
  This setting controls the number of seconds used for the ''Expire'' header when subscribing to events. It must be a non-negative integer.
531 31 Luci Stanescu
532 31 Luci Stanescu
 '''Account.registration.interval''' (type={{{NonNegativeInteger}}}, default={{{600}}})::
533 31 Luci Stanescu
  This setting controls the number of seconds used for the ''Expire'' header when registering. It must be a non-negative integer.
534 31 Luci Stanescu
535 33 Luci Stanescu
==== TLS ====
536 31 Luci Stanescu
537 1 Adrian Georgescu
 '''Account.tls.certificate''' (type={{{Path}}}, default={{{None}}}, nillable={{{True}}})::
538 31 Luci Stanescu
  The path to the file that contains the certificate and its private key used to authenticate on TLS connections. It is interpreted as an absolute path, with a leading ''~'' expanded to the home directory of the current user. In order to access the full path to the TLS certificate, the normalized attribute on the setting can be used:
539 31 Luci Stanescu
  {{{
540 31 Luci Stanescu
  account.tls.certificate.normalized
541 31 Luci Stanescu
  }}}
542 31 Luci Stanescu
543 31 Luci Stanescu
 '''Account.tls.verify_server''' (type={{{bool}}}, default={{{False}}})::
544 31 Luci Stanescu
  If this setting is set to {{{True}}}, the middleware will verify the server's certificate when connecting via TLS.
545 31 Luci Stanescu
546 33 Luci Stanescu
==== XCAP  ====
547 31 Luci Stanescu
548 31 Luci Stanescu
 '''Account.xcap.enabled''' (type={{{bool}}}, default={{{True}}})::
549 31 Luci Stanescu
  If this setting is set to {{{True}}}, The use of XCAP root set below will be activated.
550 31 Luci Stanescu
551 31 Luci Stanescu
 '''Account.xcap.xcap_root''' (type={{{XCAPRoot}}}, default={{{None}}}, nillable={{{True}}})::
552 31 Luci Stanescu
  The XCAP root is required for accessing documents via the XCAP protocol. It must be a URL with either the ''http'' or ''https'' schemes.
553 31 Luci Stanescu
554 31 Luci Stanescu
 '''Account.xcap.use_xcap_diff''' (type={{{bool}}}, default={{{True}}})::
555 31 Luci Stanescu
  If this setting is set to {{{True}}}, the Account will subscribe to the ''xcap-diff'' event in order to find out if the XCAP documents handled by the Account are modified by another entity.
556 1 Adrian Georgescu
557 1 Adrian Georgescu
558 33 Luci Stanescu
=== BonjourAccount ===
559 1 Adrian Georgescu
560 30 Luci Stanescu
{{{
561 1 Adrian Georgescu
Account bonjour@local:
562 1 Adrian Georgescu
          +-- display_name = Bonjour User
563 1 Adrian Georgescu
account --|-- enabled = False
564 34 Luci Stanescu
          |-- msrp
565 1 Adrian Georgescu
          |-- rtp
566 34 Luci Stanescu
          |-- sip
567 30 Luci Stanescu
          +-- tls
568 1 Adrian Georgescu
569 34 Luci Stanescu
       +-- transport = tcp
570 34 Luci Stanescu
msrp --|
571 34 Luci Stanescu
       +
572 34 Luci Stanescu
573 1 Adrian Georgescu
      +-- audio_codec_list = None
574 1 Adrian Georgescu
rtp --|-- inband_dtmf = False
575 1 Adrian Georgescu
      |-- srtp_encryption = optional
576 30 Luci Stanescu
      +-- use_srtp_without_tls = False
577 1 Adrian Georgescu
578 34 Luci Stanescu
      +-- transport_list = SIPTransportList(['tls', 'tcp', 'udp'])
579 34 Luci Stanescu
sip --|
580 34 Luci Stanescu
      +
581 34 Luci Stanescu
582 30 Luci Stanescu
      +-- certificate = tls/bonjour@local.crt
583 1 Adrian Georgescu
tls --|-- verify_server = False
584 30 Luci Stanescu
      +
585 30 Luci Stanescu
}}}
586 1 Adrian Georgescu
587 30 Luci Stanescu
The BonjourAccount is a singleton object as there can only be one bonjour account on a system. A bonjour account is used in P2P mode and does not interact with any server. Similar to the Account, it is used both as a complex object, which contains the required behavior for bonjour, as well as a container for the settings which apply to it. 
588 1 Adrian Georgescu
589 30 Luci Stanescu
The settings of the BonjourAccount are described below:
590 30 Luci Stanescu
 
591 30 Luci Stanescu
 '''BonjourAccount.id''' (type={{{SIPAddress}}})::
592 30 Luci Stanescu
  This is not a setting, as it is the static string 'bonjour@local' which represents the id of the BonjourAccount.
593 30 Luci Stanescu
594 30 Luci Stanescu
 '''BonjourAccount.enabled''' (type={{{bool}}}, default={{{True}}})::
595 30 Luci Stanescu
  If this setting is set to {{{True}}}, the account will be used. More information about this is in [wiki:SipMiddlewareApi#BonjourAccount BonjourAccount].
596 30 Luci Stanescu
597 30 Luci Stanescu
 '''BonjourAccount.display_name''' (type={{{str}}}, default={{{None}}}, nillable={{{True}}})::
598 1 Adrian Georgescu
  The contents of this setting will be sent as part of the ''From'' header when sending SIP requests.
599 1 Adrian Georgescu
600 34 Luci Stanescu
==== MSRP ====
601 34 Luci Stanescu
602 34 Luci Stanescu
 '''SIPSimpleSettings.msrp.transport''' (type={{{MSRPTransport}}}, default={{{'tcp'}}})::
603 34 Luci Stanescu
  MSRP can use either TLS or TCP and this setting controls which one should be used for the bonjour account.
604 34 Luci Stanescu
605 33 Luci Stanescu
==== RTP ====
606 30 Luci Stanescu
607 30 Luci Stanescu
 '''BonjourAccount.rtp.audio_codec_list''' (type={{{AudioCodecList}}}, default={{{('speex', 'g722', 'g711', 'ilbc', 'gsm')}}})::
608 32 Luci Stanescu
  This setting is used to specify the preferred audio codecs, which should be used for audio calls of this account. It must be a tuple containing only strings, which represent the supported codecs (speex, g722, g711, ilbc and gsm), in the order in which they are preferred.
609 30 Luci Stanescu
610 30 Luci Stanescu
 '''BonjourAccount.rtp.srtp_encryption''' (type={{{SRTPEncryption}}}, default={{{'optional'}}})::
611 30 Luci Stanescu
  The value of this setting specifies how the account requires the calls to be encrypted using SRTP. It can be one of the values {{{'disabled'}}}, {{{'optional'}}} or {{{'mandatory'}}}.
612 30 Luci Stanescu
613 30 Luci Stanescu
 '''BonjourAccount.rtp.use_srtp_without_tls''' (type={{{bool}}}, default={{{False}}})::
614 1 Adrian Georgescu
  If this setting is set to {{{True}}}, SRTP could be used even if the SIP signaling used to control the call is not over TLS.
615 34 Luci Stanescu
616 34 Luci Stanescu
==== SIP ====
617 34 Luci Stanescu
618 34 Luci Stanescu
 '''BonjourAccount.sip.transport_list''' (type={{{SIPTransportList}}}, default={{{SIPTransportList(['udp'])}}})::
619 34 Luci Stanescu
  This setting's value is a tuple, which can only contain the strings 'tls', 'tcp' and 'udp'. It specifies which transports should be used for publishing the bonjour account using mDNS and which bonjour contacts to browse for.
620 30 Luci Stanescu
621 33 Luci Stanescu
==== TLS ====
622 30 Luci Stanescu
623 30 Luci Stanescu
 '''BonjourAccount.tls.certificate''' (type={{{Path}}}, default={{{None}}}, nillable={{{True}}})::
624 30 Luci Stanescu
  The path to the file that contains the certificate and its private key used to authenticate on TLS connections. It is interpreted as an absolute path, with a leading ''~'' expanded to the home directory of the current user. In order to access the full path to the certificate file, the normalized attribute on the setting can be used:
625 30 Luci Stanescu
  {{{
626 30 Luci Stanescu
  BonjourAccount().tls.ca_list.normalized
627 30 Luci Stanescu
  }}}
628 30 Luci Stanescu
629 30 Luci Stanescu
 '''BonjourAccount.tls.verify_server''' (type={{{bool}}}, default={{{False}}})::
630 30 Luci Stanescu
  If this setting is set to {{{True}}}, the middleware will verify the server's certificate when connecting via TLS.
631 29 Luci Stanescu
632 35 Luci Stanescu
== SIPClients Settings ==
633 30 Luci Stanescu
634 30 Luci Stanescu
The SIPClients scripts use the Configuration API to extend the settings in the middleware with some application-specific settings. The following sections list these additional settings in order to provide an example for the kind of settings which, being application specific, do not find their place in the middleware and should be added by the application.
635 29 Luci Stanescu
636 38 Adrian Georgescu
=== General ===
637 29 Luci Stanescu
638 29 Luci Stanescu
 '''SIPSimpleSettings.user_data_directory''' (type={{{AbsolutePath}}}, default={{{'~/.sipclient}}})::
639 29 Luci Stanescu
  This is the directory, which will be used by default for storing the SIP SIMPLE data. The relative paths are calculated on runtime based on this setting, which means that if this setting is changed, all relative paths will point inside the new directory. It is a string, which must be an absolute path.
640 29 Luci Stanescu
641 33 Luci Stanescu
==== Audio ====
642 29 Luci Stanescu
643 29 Luci Stanescu
 '''SIPSimpleSettings.audio.directory''' (type={{{DataPath}}}, default={{{DataPath('history')}}})::
644 29 Luci Stanescu
  This directory will be used to store recorded audio conversations. Under this directory, a subdirectory per account with the id of the account as the name will be created. If it is set to relative path, it is taken relative to {{{SIPSimpleSettings.user_data_directory}}}; otherwise it is interpreted as an absolute path. In order to access the full path to the history directory, the value attribute on the setting can be used:
645 29 Luci Stanescu
  {{{
646 29 Luci Stanescu
  SIPSimpleSettings().audio.directory.value
647 29 Luci Stanescu
  }}}
648 29 Luci Stanescu
649 33 Luci Stanescu
==== File Transfer ====
650 29 Luci Stanescu
651 29 Luci Stanescu
 '''SIPSimpleSettings.file_transfer.directory''' (type={{{DataPath}}}, default={{{DataPath('file_transfers')}}})::
652 29 Luci Stanescu
  This directory is used to store the files obtained via MSRP file transfer. If it is set to relative path, it is taken relative to {{{SIPSimpleSettings.user_data_directory}}}; otherwise it is interpreted as an absolute path. In order to access the full path to the history directory, the value attribute on the setting can be used:
653 29 Luci Stanescu
  {{{
654 29 Luci Stanescu
  SIPSimpleSettings().file_transfer.directory.value
655 29 Luci Stanescu
  }}}
656 29 Luci Stanescu
657 33 Luci Stanescu
==== Logs ====
658 29 Luci Stanescu
659 29 Luci Stanescu
 '''SIPSimpleSettings.logs.directory''' (type={{{DataPath}}}, default={{{DataPath('logs')}}})::
660 29 Luci Stanescu
  This is the directory where the logs create by the SIP SIMPLE middleware will be stored. If it is set to relative path, it is taken relative to {{{SIPSimpleSettings.user_data_directory}}}; otherwise it is interpreted as an absolute path. In order to access the full path to the history directory, the value attribute on the setting can be used:
661 29 Luci Stanescu
  {{{
662 29 Luci Stanescu
  SIPSimpleSettings().logs.directory.value
663 29 Luci Stanescu
  }}}
664 29 Luci Stanescu
665 29 Luci Stanescu
 '''SIPSimpleSettings.logs.trace_sip''' (type={{{bool}}}, default={{{False}}})::
666 29 Luci Stanescu
  If this setting is set to True, the SIP packets will be written to a log file named 'sip_trace.txt', inside the directory pointed by {{{SIPSimpleSettings.logging.directory}}}.
667 29 Luci Stanescu
668 29 Luci Stanescu
 '''SIPSimpleSettings.logs.trace_pjsip''' (type={{{bool}}}, default={{{False}}})::
669 29 Luci Stanescu
  If this setting is set to True, the PJSIP log messages will be written to a log file named 'pjsip_trace.txt', inside the directory pointed by {{{SIPSimpleSettings.logging.directory}}}.
670 29 Luci Stanescu
671 29 Luci Stanescu
 '''SIPSimpleSettings.logs.trace_msrp''' (type={{{bool}}}, default={{{False}}})::
672 29 Luci Stanescu
  If this setting is set to True, the MSRP packets will be written to a log file named 'msrp_trace.txt', inside the directory pointed by {{{SIPSimpleSettings.logging.directory}}}.
673 29 Luci Stanescu
674 29 Luci Stanescu
 '''SIPSimpleSettings.logs.trace_xcap''' (type={{{bool}}}, default={{{False}}})::
675 29 Luci Stanescu
  If this setting is set to True, the XCAP packets will be written to a log file named 'xcap_trace.txt', inside the directory pointed by {{{SIPSimpleSettings.logging.directory}}}.
676 29 Luci Stanescu
677 33 Luci Stanescu
==== Sounds ====
678 29 Luci Stanescu
679 29 Luci Stanescu
 '''SIPSimpleSettings.sounds.audio_inbound''' (type={{{AbsolutePath}}}, default={{{None}}}, nillable={{{True}}})::
680 29 Luci Stanescu
  This setting should point to a wav file, which will be played when a SIP session request is received. If it is set to {{{None}}}, no sound will be played.
681 29 Luci Stanescu
682 29 Luci Stanescu
 '''SIPSimpleSettings.sounds.audio_outbound''' (type={{{AbsolutePath}}}, default={{{None}}}, nillable={{{True}}})::
683 29 Luci Stanescu
  This setting should point to a wav file, which will be used as ringtone during an outgoing SIP session request as a response to a 180 Ringing. If it is set to {{{None}}}, no sound will be played.
684 29 Luci Stanescu
685 29 Luci Stanescu
 '''SIPSimpleSettings.sounds.file_sent''' (type={{{AbsolutePath}}}, default={{{None}}}, nillable={{{True}}})::
686 29 Luci Stanescu
  This setting should point to a wav file, which will be played when an outgoing file transfer is finished. If it is set to {{{None}}}, no sound will be played.
687 29 Luci Stanescu
688 29 Luci Stanescu
 '''SIPSimpleSettings.sounds.file_received''' (type={{{AbsolutePath}}}, default={{{None}}}, nillable={{{True}}})::
689 29 Luci Stanescu
  This setting should point to a wav file, which will be played when an incoming file transfer is finished. If it is set to {{{None}}}, no sound will be played.
690 29 Luci Stanescu
691 29 Luci Stanescu
 '''SIPSimpleSettings.sounds.message_sent''' (type={{{AbsolutePath}}}, default={{{None}}}, nillable={{{True}}})::
692 29 Luci Stanescu
  This setting is a string representing an absolute path to a wav file, which is played when a message is sent in a chat session. If it is set to {{{None}}}, no sound is played.
693 29 Luci Stanescu
694 29 Luci Stanescu
 '''SIPSimpleSettings.sounds.message_received''' (type={{{AbsolutePath}}}, default={{{None}}}, nillable={{{True}}})::
695 29 Luci Stanescu
  This setting is a string representing an absolute path to a wav file, which is played when a message is received in a chat session. If it is set to {{{None}}}, no sound is played.
696 29 Luci Stanescu
697 33 Luci Stanescu
=== Account ===
698 29 Luci Stanescu
699 33 Luci Stanescu
==== Sounds ====
700 29 Luci Stanescu
701 29 Luci Stanescu
 '''Account.sounds.audio_inbound''' (type={{{AbsolutePath}}}, default={{{None}}}, nillable={{{True}}})::
702 29 Luci Stanescu
  This setting should point to a wav file, which will be used to play the incoming ringtone. If it is set to {{{None}}}, the wav file set in {{{SIPSimpleSettings.sounds.audio_inbound}}} will be used instead.
703 29 Luci Stanescu
704 33 Luci Stanescu
=== BonjourAccount ===
705 29 Luci Stanescu
706 33 Luci Stanescu
==== Sounds ====
707 29 Luci Stanescu
708 29 Luci Stanescu
 '''BonjourAccount.sounds.audio_inbound''' (type={{{AbsolutePath}}}, default={{{None}}}, nillable={{{True}}})::
709 1 Adrian Georgescu
  This setting should point to a wav file which will be used as the incoming ringtone. If it is set to {{{None}}}, the wav file set in {{{SIPSimpleSettings.sounds.audio_inbound}}} will be used instead.