SipConfigurationAPI

Version 59 (Anonymous, 04/21/2011 04:31 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 59 Adrian Georgescu
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. A simple [wiki:SipConfigurationAPI#FileBackend text file backend] and a [wiki:SipConfigurationAPI#MemoryBackend volatile memory] are 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 59 Adrian Georgescu
 '''start'''(''self'')::
44 59 Adrian Georgescu
 The start method allows the ConfigurationManager instance to use the backend specified in {{{SIPApplication}}} complying to the {{{Storage API}}} 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 46 Luci Stanescu
 * SettingsObjects without an ID, i.e. there should be only one instance of this SettingsObject in an application. The application should define these objects using the {{{Singleton}}} metaclass. 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 46 Luci Stanescu
 * SettingsObjects with an associated 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. The ID can be changed, which means these objects cannot be Singletons.
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 1 Adrian Georgescu
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 46 Luci Stanescu
from application.python.util import Singleton
72 33 Luci Stanescu
from sipsimple.configuration import SettingsObject
73 1 Adrian Georgescu
74 33 Luci Stanescu
class SIPSimpleSettings(SettingsObject):
75 46 Luci Stanescu
    __metaclass__ = Singleton
76 33 Luci Stanescu
    __group__ = 'Global'
77 33 Luci Stanescu
    __id__ = 'SIPSimple'
78 33 Luci Stanescu
}}}
79 33 Luci Stanescu
80 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.
81 33 Luci Stanescu
82 33 Luci Stanescu
83 33 Luci Stanescu
==== Defining a per-id SettingsObject ====
84 33 Luci Stanescu
85 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:
86 33 Luci Stanescu
{{{
87 33 Luci Stanescu
from sipsimple.configuration import SettingsObject
88 33 Luci Stanescu
89 33 Luci Stanescu
class Account(SettingsObject):
90 33 Luci Stanescu
    __group__ = 'Accounts'
91 33 Luci Stanescu
    def __init__(self, id):
92 33 Luci Stanescu
        """Do something each time the Account is loaded"""
93 33 Luci Stanescu
}}}
94 33 Luci Stanescu
95 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.
96 33 Luci Stanescu
97 44 Adrian Georgescu
==== methods ====
98 33 Luci Stanescu
99 33 Luci Stanescu
 '''save'''(''self'')::
100 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.
101 33 Luci Stanescu
 '''delete'''(''self'')::
102 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.
103 44 Adrian Georgescu
104 1 Adrian Georgescu
==== notifications ====
105 33 Luci Stanescu
106 33 Luci Stanescu
 '''CFGSettingsObjectDidChange'''::
107 46 Luci Stanescu
 This notification is sent when the save method of a SettingsObject is called and some settings were previously changed. Attributes:
108 1 Adrian Georgescu
 [[BR]]''modified'':[[BR]]
109 1 Adrian Georgescu
 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.
110 46 Luci Stanescu
 [[BR]]''timestamp'':[[BR]]
111 46 Luci Stanescu
 A {{{datetime.datetime}}} object representing the moment the notification was sent.
112 57 Adrian Georgescu
113 57 Adrian Georgescu
 '''CFGSettingsObjectWasCreated'''::
114 57 Adrian Georgescu
 This notification is sent after a SettingsObject has been fully initialized. Attributes:
115 57 Adrian Georgescu
 [[BR]]''timestamp'':[[BR]]
116 57 Adrian Georgescu
 A {{{datetime.datetime}}} object representing the moment the notification was sent.
117 57 Adrian Georgescu
118 57 Adrian Georgescu
 '''CFGSettingsObjectWasDeleted'''::
119 57 Adrian Georgescu
 This notification is sent after a SettingsObject has been deleted. Attributes:
120 57 Adrian Georgescu
 [[BR]]''timestamp'':[[BR]]
121 57 Adrian Georgescu
 A {{{datetime.datetime}}} object representing the moment the notification was sent.
122 57 Adrian Georgescu
123 33 Luci Stanescu
=== Setting ===
124 33 Luci Stanescu
125 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:
126 33 Luci Stanescu
 '''!__init!__'''(''self'', '''type''', '''default'''={{{None}}}, '''nillable'''={{{False}}})::
127 1 Adrian Georgescu
 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.
128 33 Luci Stanescu
129 33 Luci Stanescu
An example of using a setting:
130 33 Luci Stanescu
{{{
131 46 Luci Stanescu
from application.python.util import Singleton
132 1 Adrian Georgescu
from sipsimple import __version__
133 42 Luci Stanescu
from sipsimple.configuration import Setting, SettingsObject
134 33 Luci Stanescu
135 33 Luci Stanescu
class SIPSimpleSettings(SettingsObject):
136 46 Luci Stanescu
    __metaclass__ = Singleton
137 33 Luci Stanescu
    __group__ = 'Global'
138 33 Luci Stanescu
    __id__ = 'SIPSimple'
139 33 Luci Stanescu
140 33 Luci Stanescu
    user_agent = Setting(type=str, default='sipsimple %s' % __version__)
141 33 Luci Stanescu
}}}
142 33 Luci Stanescu
143 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:
144 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.
145 33 Luci Stanescu
 * int, long and basestring: the type is called using the value as an argument.
146 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.
147 33 Luci Stanescu
148 33 Luci Stanescu
Saving a setting value is done similarly, according to type. The builtin types which are handled are the same:
149 33 Luci Stanescu
 * bool: the unicode objects {{{u'true'}}} and {{{u'false}}} are used depending on the value.
150 33 Luci Stanescu
 * int, long and basestring: {{{unicode}}} is called with the value as the sole argument.
151 33 Luci Stanescu
For all other types, the {{{__getstate__}}} method is called which should return an appropriate value.
152 33 Luci Stanescu
153 33 Luci Stanescu
154 1 Adrian Georgescu
=== SettingsGroup ===
155 33 Luci Stanescu
156 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:
157 33 Luci Stanescu
{{{
158 46 Luci Stanescu
from application.python.util import Singleton
159 42 Luci Stanescu
from sipsimple import __version__
160 33 Luci Stanescu
from sipsimple.configuration import Setting, SettingsGroup, SettingsObject
161 33 Luci Stanescu
162 1 Adrian Georgescu
class TLSSettings(SettingsGroup):
163 33 Luci Stanescu
    verify_server = Setting(type=bool, default=False)
164 33 Luci Stanescu
165 33 Luci Stanescu
class SIPSimpleSettings(SettingsObject):
166 46 Luci Stanescu
    __metaclass__ = Singleton
167 33 Luci Stanescu
    __group__ = 'Global'
168 33 Luci Stanescu
    __id__ = 'SIPSimple'
169 33 Luci Stanescu
170 33 Luci Stanescu
    user_agent = Setting(type=str, default='sipsimple %s' % __version__)
171 33 Luci Stanescu
172 33 Luci Stanescu
    tls = TLSSettings
173 33 Luci Stanescu
}}}
174 33 Luci Stanescu
175 1 Adrian Georgescu
=== SettingsObjectExtension ===
176 33 Luci Stanescu
177 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:
178 33 Luci Stanescu
{{{
179 46 Luci Stanescu
from application.python.util import Singleton
180 42 Luci Stanescu
from sipsimple import __version__
181 42 Luci Stanescu
from sipsimple.configuration import Setting, SettingsGroup, SettingsObject, SettingsObjectExtension
182 33 Luci Stanescu
183 1 Adrian Georgescu
class TLSSettings(SettingsGroup):
184 33 Luci Stanescu
    verify_server = Setting(type=bool, default=False)
185 33 Luci Stanescu
186 33 Luci Stanescu
class SIPSimpleSettings(SettingsObject):
187 46 Luci Stanescu
    __metaclass__ = Singleton
188 33 Luci Stanescu
    __group__ = 'Global'
189 33 Luci Stanescu
    __id__ = 'SIPSimple'
190 33 Luci Stanescu
191 33 Luci Stanescu
    user_agent = Setting(type=str, default='sipsimple %s' % __version__)
192 33 Luci Stanescu
193 33 Luci Stanescu
    tls = TLSSettings
194 33 Luci Stanescu
195 33 Luci Stanescu
class TLSSettingsExtension(TLSSettings):
196 33 Luci Stanescu
    verify_client = Setting(type=bool, default=True)
197 33 Luci Stanescu
198 33 Luci Stanescu
class SIPSimpleSettingsExtension(SettingsObjectExtension):
199 33 Luci Stanescu
    default_account = Setting(type=str, default=None, nillable=True)
200 33 Luci Stanescu
201 33 Luci Stanescu
    tls = TLSSettingsExtension
202 33 Luci Stanescu
203 33 Luci Stanescu
SIPSimpleSettings.register_extension(SIPSimpleSettingsExtension)
204 33 Luci Stanescu
}}}
205 33 Luci Stanescu
206 33 Luci Stanescu
=== Backend API ===
207 33 Luci Stanescu
208 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.
209 33 Luci Stanescu
210 33 Luci Stanescu
The interface '''sipsimple.configuration.backend.IBackend''' describes the backend:
211 33 Luci Stanescu
 '''load'''()::
212 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].
213 33 Luci Stanescu
 '''save'''('''data''')::
214 33 Luci Stanescu
 Given a dictionary conforming to the definition in this interface, save the data using whatever means employed by the backend implementation.
215 33 Luci Stanescu
216 33 Luci Stanescu
217 33 Luci Stanescu
==== FileBackend ====
218 33 Luci Stanescu
219 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:
220 33 Luci Stanescu
221 33 Luci Stanescu
 '''!__init!__'''(''self'', '''filename''', '''encoding'''={{{'utf-8'}}})::
222 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.
223 33 Luci Stanescu
224 33 Luci Stanescu
This object saves the data using a simple text file format with the following syntax:
225 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.
226 33 Luci Stanescu
 {{{
227 33 Luci Stanescu
 Accounts:
228 33 Luci Stanescu
    user@domain:
229 33 Luci Stanescu
      display_name = User
230 33 Luci Stanescu
      tls:
231 33 Luci Stanescu
        certificate =
232 33 Luci Stanescu
 }}}
233 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:
234 33 Luci Stanescu
  * None is represented by the absence of a value.
235 33 Luci Stanescu
  {{{
236 33 Luci Stanescu
    setting =
237 33 Luci Stanescu
  }}}
238 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.
239 33 Luci Stanescu
  {{{
240 33 Luci Stanescu
    setting1 = value
241 33 Luci Stanescu
    setting2 = value with spaces
242 33 Luci Stanescu
    setting3 = "  value with leading and trailing spaces  "
243 33 Luci Stanescu
    setting4 = value with a line feed\n
244 33 Luci Stanescu
  }}}
245 33 Luci Stanescu
  * Lists are represented by unicode strings as described above separated by commas (''','''). Any not-quoted whitespace around the comma is ignored.
246 33 Luci Stanescu
  {{{
247 33 Luci Stanescu
    setting = a, b  , c
248 33 Luci Stanescu
  }}}
249 33 Luci Stanescu
  * Complex settings can be represented just like a group:
250 33 Luci Stanescu
  {{{
251 33 Luci Stanescu
    complex_setting:
252 33 Luci Stanescu
      field1 = value
253 33 Luci Stanescu
      field2 = 123
254 33 Luci Stanescu
  }}}
255 33 Luci Stanescu
  
256 33 Luci Stanescu
257 35 Luci Stanescu
== Middleware Settings ==
258 4 Adrian Georgescu
259 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].
260 1 Adrian Georgescu
261 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}}}.
262 4 Adrian Georgescu
263 33 Luci Stanescu
=== General ===
264 1 Adrian Georgescu
265 22 Adrian Georgescu
{{{
266 22 Adrian Georgescu
SIP SIMPLE settings:
267 27 Luci Stanescu
             +-- default_account = user@example.com
268 48 Adrian Georgescu
SIP SIMPLE --|-- user_agent = sipsimple 0.16.2
269 22 Adrian Georgescu
             |-- audio
270 4 Adrian Georgescu
             |-- chat
271 22 Adrian Georgescu
             |-- desktop_sharing
272 1 Adrian Georgescu
             |-- file_transfer
273 23 Adrian Georgescu
             |-- logs
274 1 Adrian Georgescu
             |-- rtp
275 17 Adrian Georgescu
             |-- sip
276 48 Adrian Georgescu
             |-- sounds
277 1 Adrian Georgescu
             +-- tls
278 1 Adrian Georgescu
279 1 Adrian Georgescu
        +-- alert_device = system_default
280 48 Adrian Georgescu
audio --|-- input_device = system_default                   
281 17 Adrian Georgescu
        |-- output_device = system_default
282 1 Adrian Georgescu
        |-- sample_rate = 44100
283 1 Adrian Georgescu
        |-- silent = False
284 48 Adrian Georgescu
        +-- tail_length = 0
285 27 Luci Stanescu
286 1 Adrian Georgescu
       +
287 23 Adrian Georgescu
chat --|
288 23 Adrian Georgescu
       +
289 22 Adrian Georgescu
290 17 Adrian Georgescu
                  +
291 17 Adrian Georgescu
desktop_sharing --|
292 22 Adrian Georgescu
                  +
293 23 Adrian Georgescu
294 1 Adrian Georgescu
                +
295 18 Adrian Georgescu
file_transfer --|
296 22 Adrian Georgescu
                +
297 1 Adrian Georgescu
298 48 Adrian Georgescu
logs --|-- pjsip_level = 5
299 1 Adrian Georgescu
300 48 Adrian Georgescu
      +-- audio_codec_list = AudioCodecList(['G722', 'PCMU', 'GSM', 'speex', 'PCMA'])
301 48 Adrian Georgescu
rtp --|-- port_range = PortRange(start=50000, end=50500)
302 1 Adrian Georgescu
      +-- timeout = 30
303 1 Adrian Georgescu
304 48 Adrian Georgescu
      +-- invite_timeout = 90
305 48 Adrian Georgescu
sip --|-- tcp_port = 0
306 48 Adrian Georgescu
      |-- tls_port = 0
307 1 Adrian Georgescu
      |-- transport_list = SIPTransportList(['tls', 'tcp', 'udp'])
308 1 Adrian Georgescu
      +-- udp_port = 0
309 1 Adrian Georgescu
310 49 Adrian Georgescu
      +-- ca_list = None
311 1 Adrian Georgescu
tls --|-- protocol = TLSv1
312 48 Adrian Georgescu
      +-- timeout = 3000
313 1 Adrian Georgescu
314 48 Adrian Georgescu
315 28 Luci Stanescu
}}}
316 28 Luci Stanescu
317 1 Adrian Georgescu
The {{{sipsimple.configuration.settings.SIPSimpleSettings}}} class is a singleton can be instantiated and used anywhere after the [wiki:SipConfigurationAPI#ConfigurationManager ConfigurationManager] has been started. 
318 28 Luci Stanescu
319 1 Adrian Georgescu
The settings are explained below:
320 28 Luci Stanescu
321 28 Luci Stanescu
 '''SIPSimpleSettings.default_account''' (type={{{str}}}, default={{{'bonjour@local'}}}, nillable={{{True}}})::
322 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.
323 1 Adrian Georgescu
324 28 Luci Stanescu
 '''SIPSimpleSettings.user_agent''' (type={{{str}}}, default={{{'sipsimple VERSION'}}})::
325 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.
326 1 Adrian Georgescu
327 33 Luci Stanescu
==== Audio ====
328 17 Adrian Georgescu
329 48 Adrian Georgescu
 '''SIPSimpleSettings.audio.alert_device''' (type={{{AudioOutputDevice}}}, default={{{'system_default'}}}, nillable={{{True}}})::
330 48 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.
331 48 Adrian Georgescu
332 1 Adrian Georgescu
 '''SIPSimpleSettings.audio.input_device''' (type={{{AudioInputDevice}}}, default={{{'system_default'}}}, nillable={{{True}}})::
333 4 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.
334 24 Adrian Georgescu
335 1 Adrian Georgescu
 '''SIPSimpleSettings.audio.output_device''' (type={{{AudioOutputDevice}}}, default={{{'system_default'}}}, nillable={{{True}}})::
336 1 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.
337 24 Adrian Georgescu
338 4 Adrian Georgescu
 '''SIPSimpleSettings.audio.tail_length''' (type={{{NonNegativeInteger}}}, default={{{200}}})::
339 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.
340 24 Adrian Georgescu
341 48 Adrian Georgescu
 '''SIPSimpleSettings.audio.sample_rate''' (type={{{SampleRate}}}, default={{{44100}}})::
342 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.
343 1 Adrian Georgescu
 
344 1 Adrian Georgescu
 '''SIPSimpleSettings.audio.silent''' (type={{{bool}}}, default={{{False}}})::
345 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).
346 1 Adrian Georgescu
347 1 Adrian Georgescu
==== Chat ====
348 1 Adrian Georgescu
349 4 Adrian Georgescu
Empty section for future use.
350 1 Adrian Georgescu
351 1 Adrian Georgescu
==== Desktop Sharing ====
352 33 Luci Stanescu
353 1 Adrian Georgescu
Empty section for future use.
354 23 Adrian Georgescu
355 1 Adrian Georgescu
==== File Transfer ====
356 33 Luci Stanescu
357 1 Adrian Georgescu
Empty section for future use.
358 1 Adrian Georgescu
359 23 Adrian Georgescu
==== Logs ====
360 33 Luci Stanescu
361 1 Adrian Georgescu
 '''SIPSimpleSettings.logs.pjsip_level''' (type={{{NonNegativeInteger}}}, default={{{5}}})::
362 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.
363 28 Luci Stanescu
364 1 Adrian Georgescu
==== RTP ====
365 33 Luci Stanescu
366 48 Adrian Georgescu
 '''SIPSimpleSettings.rtp.port_range''' (type={{{PortRange}}}, default={{{PortRange(50000, 50500)}}})::
367 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.
368 34 Luci Stanescu
369 48 Adrian Georgescu
 '''SIPSimpleSettings.rtp.audio_codec_list''' (type={{{AudioCodecLis}t}}, default={{{AudioCodecList(('G722', 'speex', 'PCMU', 'PCMA'))}}})::
370 33 Luci Stanescu
  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.
371 23 Adrian Georgescu
372 48 Adrian Georgescu
'''SIPSimpleSettings.rtp.timeout''' (type={{{NonNegativeInteger}t}}, default={{{30))}}})::
373 48 Adrian Georgescu
  This setting is used to specify the time after which a notification is raised should no RTP be received from the other end. It can be used by an application to decide to terminate the session or print an alert.
374 48 Adrian Georgescu
375 43 Adrian Georgescu
==== SIP ====
376 43 Adrian Georgescu
377 48 Adrian Georgescu
 '''SIPSimpleSettings.sip.invite_timeout''' (type={{{NonNegativeInteger}}}, default={{{90}}})::
378 48 Adrian Georgescu
  This setting is used to terminate an outgoing session request in progress that does not receive a final answer before this internal in seconds is reached.
379 48 Adrian Georgescu
380 28 Luci Stanescu
 '''SIPSimpleSettings.sip.udp_port''' (type={{{Port}}}, default={{{0}}})::
381 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.
382 28 Luci Stanescu
383 1 Adrian Georgescu
 '''SIPSimpleSettings.sip.tcp_port''' (type={{{Port}}}, default={{{0}}})::
384 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.
385 1 Adrian Georgescu
386 28 Luci Stanescu
 '''SIPSimpleSettings.sip.tls_port''' (type={{{Port}}}, default={{{0}}})::
387 54 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. The port must be different than the port used for TCP connections.
388 1 Adrian Georgescu
389 1 Adrian Georgescu
 '''SIPSimpleSettings.sip.transport_list''' (type={{{SIPTransportList}}}, default={{{SIPTransportList(('tls', 'tcp', 'udp'))}}})::
390 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:
391 27 Luci Stanescu
   * Only the transports specified here are used to SIP requests associated with normal accounts.
392 29 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.
393 27 Luci Stanescu
394 33 Luci Stanescu
==== TLS ====
395 27 Luci Stanescu
396 1 Adrian Georgescu
 '''SIPSimpleSettings.tls.ca_list''' (type={{{Path}}}, default={{{None}}}, nillable={{{True}}})::
397 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:
398 27 Luci Stanescu
  {{{
399 27 Luci Stanescu
  SIPSimpleSettings().tls.ca_list.normalized
400 31 Luci Stanescu
  }}}
401 27 Luci Stanescu
402 27 Luci Stanescu
 '''SIPSimpleSettings.tls.protocol''' (type={{{TLSProtocol}}}, default={{{'TLSv1'}}})::
403 53 Adrian Georgescu
  This setting sets the version of the TLS protocol which will be used. It is a string and must be one of {{{'TLSv1'}}}.
404 27 Luci Stanescu
405 48 Adrian Georgescu
 '''SIPSimpleSettings.tls.timeout''' (type={{{NonNegativeInteger}}}, default={{{3000}}})::
406 27 Luci Stanescu
  This is the timeout for negotiating TLS connections, in milliseconds. It must be an non-negative integer.
407 1 Adrian Georgescu
408 1 Adrian Georgescu
=== Account ===
409 1 Adrian Georgescu
410 1 Adrian Georgescu
{{{
411 27 Luci Stanescu
Account user@example.com:
412 33 Luci Stanescu
          +-- display_name = Example User
413 1 Adrian Georgescu
account --|-- enabled = True
414 1 Adrian Georgescu
          |-- auth
415 29 Luci Stanescu
          |-- dialog_event
416 29 Luci Stanescu
          |-- message_summary
417 48 Adrian Georgescu
          |-- msrp
418 45 Luci Stanescu
          |-- nat_traversal
419 29 Luci Stanescu
          |-- presence
420 29 Luci Stanescu
          |-- rtp
421 1 Adrian Georgescu
          |-- sip
422 1 Adrian Georgescu
          |-- tls
423 1 Adrian Georgescu
          +-- xcap
424 1 Adrian Georgescu
425 45 Luci Stanescu
       +-- password = xyz
426 45 Luci Stanescu
auth --|-- username = None
427 45 Luci Stanescu
       +
428 45 Luci Stanescu
429 29 Luci Stanescu
               +-- enabled = True
430 29 Luci Stanescu
dialog_event --|
431 29 Luci Stanescu
               +
432 29 Luci Stanescu
433 1 Adrian Georgescu
                  +-- enabled = True
434 29 Luci Stanescu
message_summary --|-- voicemail_uri = None
435 29 Luci Stanescu
                  +
436 29 Luci Stanescu
437 48 Adrian Georgescu
       +-- connection_model = relay
438 48 Adrian Georgescu
msrp --|-- transport = tls
439 48 Adrian Georgescu
       +
440 48 Adrian Georgescu
441 1 Adrian Georgescu
                +-- msrp_relay = None
442 1 Adrian Georgescu
nat_traversal --|-- stun_server_list = None
443 1 Adrian Georgescu
                |-- use_ice = False
444 1 Adrian Georgescu
                |-- use_msrp_relay_for_inbound = True
445 1 Adrian Georgescu
                +-- use_msrp_relay_for_outbound = False
446 1 Adrian Georgescu
447 30 Luci Stanescu
           +-- enabled = True
448 1 Adrian Georgescu
presence --|-- use_rls = True
449 1 Adrian Georgescu
           +
450 1 Adrian Georgescu
451 1 Adrian Georgescu
      +-- audio_codec_list = None
452 1 Adrian Georgescu
rtp --|-- inband_dtmf = False
453 30 Luci Stanescu
      |-- srtp_encryption = optional
454 1 Adrian Georgescu
      +-- use_srtp_without_tls = False
455 1 Adrian Georgescu
456 51 Adrian Georgescu
      +-- always_use_my_proxy = False
457 51 Adrian Georgescu
sip --|-- outbound_proxy = SIPProxyAddress('sip.example.com', port=5060, transport='udp')
458 51 Adrian Georgescu
      |-- publish_interval = 3600
459 30 Luci Stanescu
      |-- register = True
460 51 Adrian Georgescu
      |-- register_interval = 3600
461 51 Adrian Georgescu
      +-- subscribe_interval = 3600
462 1 Adrian Georgescu
463 1 Adrian Georgescu
      +-- certificate = tls/user@example.com.crt
464 1 Adrian Georgescu
tls --|-- verify_server = False
465 1 Adrian Georgescu
      +
466 1 Adrian Georgescu
467 1 Adrian Georgescu
       +-- enabled = True
468 52 Adrian Georgescu
xcap --|-- xcap_root = None
469 1 Adrian Georgescu
       +
470 1 Adrian Georgescu
}}}
471 1 Adrian Georgescu
472 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]. 
473 1 Adrian Georgescu
474 1 Adrian Georgescu
The settings that can be accessed on an Account are described below:
475 1 Adrian Georgescu
476 56 Adrian Georgescu
 '''Account.id''' (type={{{SIPAddress}}})::
477 1 Adrian Georgescu
  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.
478 1 Adrian Georgescu
479 57 Adrian Georgescu
 '''Account.display_name''' (type={{{unicode}}}, default={{{None}}}, nillable={{{True}}})::
480 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.
481 1 Adrian Georgescu
482 30 Luci Stanescu
 '''Account.enabled''' (type={{{bool}}}, default={{{False}}})::
483 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].
484 1 Adrian Georgescu
485 1 Adrian Georgescu
==== Auth ====
486 1 Adrian Georgescu
487 1 Adrian Georgescu
 '''Account.auth.username''' (type={{{str}}}, default={{{None}}}, nillable={{{True}}})::
488 1 Adrian Georgescu
  The username used for authentication if it is different from the one in the SIP ID of the account. If it is {{{None}}} or an empty string, the account SIP ID username will be used instead.
489 1 Adrian Georgescu
490 1 Adrian Georgescu
 '''Account.auth.password''' (type={{{str}}}, default={{{''}}})::
491 1 Adrian Georgescu
  The password, which will be used with this account for authentication.
492 1 Adrian Georgescu
493 1 Adrian Georgescu
494 45 Luci Stanescu
==== Dialog Event ====
495 45 Luci Stanescu
496 45 Luci Stanescu
 '''Account.dialog_event.enabled''' (type={{{bool}}}, default={{{True}}})::
497 45 Luci Stanescu
  If this setting is set to {{{True}}}, the Account will subscribe to the ''dialog'' event as specified by RFC4235.
498 45 Luci Stanescu
499 48 Adrian Georgescu
==== MSRP ====
500 48 Adrian Georgescu
501 48 Adrian Georgescu
 '''Account.msrp.transport''' (type={{{MSRPTransport}}}, default={{{'tls'}}})::
502 48 Adrian Georgescu
  MSRP can use either TLS or TCP and this setting controls which one should be used for normal accounts.
503 48 Adrian Georgescu
504 48 Adrian Georgescu
 '''Account.msrp.connection_model''' (type={{{MSRPConnectionModel}}}, default={{{'relay'}}})::
505 48 Adrian Georgescu
  Whether {{{relay}}} or {{{acm}}} connection models shall be used for NAT traversal purposes.
506 48 Adrian Georgescu
507 48 Adrian Georgescu
508 33 Luci Stanescu
==== Message Summary ====
509 1 Adrian Georgescu
510 1 Adrian Georgescu
 '''Account.message_summary.enabled''' (type={{{bool}}}, default={{{True}}})::
511 1 Adrian Georgescu
  If this setting is set to {{{True}}}, the Account will subscribe to the ''message-summary'' event, as specified by RFC3842.
512 1 Adrian Georgescu
513 1 Adrian Georgescu
 '''Account.message_summary.voicemail_uri''' (type={{{str}}}, default={{{None}}}, nillable={{{True}}})::
514 47 Adrian Georgescu
  This is the SIP URI where the Subscribe is sent and where the user can call to listen to the voicemail messages.
515 1 Adrian Georgescu
516 1 Adrian Georgescu
==== NAT Traversal ====
517 33 Luci Stanescu
518 1 Adrian Georgescu
 '''Account.nat_traversal.use_ice''' (type={{{bool}}}, default={{{False}}})::
519 1 Adrian Georgescu
  If this setting is set to {{{True}}}, ICE will be used for finding media candidates for communication over NAT-ed networks.
520 1 Adrian Georgescu
521 1 Adrian Georgescu
 '''Account.nat_traversal.stun_server_list''' (type={{{StunServerAddressList}}}, default={{{None}}}, nillable={{{True}}})::
522 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).
523 1 Adrian Georgescu
524 1 Adrian Georgescu
 '''Account.nat_traversal.msrp_relay''' (type={{{MSRPRelayAddress}}}, default={{{None}}}, nillable={{{True}}})::
525 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).
526 1 Adrian Georgescu
527 1 Adrian Georgescu
 '''Account.nat_traversal.use_msrp_relay_for_inbound''' (type={{{bool}}}, default={{{True}}})::
528 1 Adrian Georgescu
  If this setting is set to {{{True}}}, the MSRP relay will be used for all incoming MSRP connections.
529 1 Adrian Georgescu
530 1 Adrian Georgescu
 '''Account.nat_traversal.use_msrp_relay_for_outbound''' (type={{{bool}}}, default={{{False}}})::
531 1 Adrian Georgescu
  If this setting is set to {{{True}}}, the MSRP relay will be used for all outgoing MSRP connections.
532 30 Luci Stanescu
533 30 Luci Stanescu
==== Presence ====
534 33 Luci Stanescu
535 1 Adrian Georgescu
 '''Account.presence.enabled''' (type={{{bool}}}, default={{{True}}})::
536 30 Luci Stanescu
  If this setting is set to {{{True}}}, the Account will publish its presence state and subscribe to presence and presence.winfo Event packages.
537 1 Adrian Georgescu
538 50 Adrian Georgescu
 '''Account.presence.use_rls''' (type={{{bool}}}, default={{{False}}})::
539 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.
540 30 Luci Stanescu
541 30 Luci Stanescu
==== RTP ====
542 33 Luci Stanescu
543 30 Luci Stanescu
 '''Account.rtp.audio_codecs''' (type={{{AudioCodecList}}}, default={{{None}}}, nillable={{{True}}})::
544 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.
545 1 Adrian Georgescu
546 1 Adrian Georgescu
 '''Account.audio.srtp_encryption''' (type={{{SRTPEncryption}}}, default={{{'optional'}}})::
547 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'}}}.
548 1 Adrian Georgescu
549 1 Adrian Georgescu
 '''Account.audio.use_srtp_without_tls''' (type={{{bool}}}, default={{{False}}})::
550 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.
551 1 Adrian Georgescu
552 1 Adrian Georgescu
553 1 Adrian Georgescu
==== SIP ====
554 51 Adrian Georgescu
555 51 Adrian Georgescu
 '''Account.sip.always_use_my_proxy''' (type={{{bool}}}, default={{{False}}})::
556 51 Adrian Georgescu
  If this setting is set to {{{True}}} and the outbound proxy is not set, the signalling for outbound requests going to foreign domains will be sent to the account proxy instead of sending it to the foreign proxy.
557 1 Adrian Georgescu
558 30 Luci Stanescu
 '''Account.sip.outbound_proxy''' (type={{{SIPProxyAddress}}}, default={{{None}}}, nillable={{{True}}})::
559 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.
560 1 Adrian Georgescu
561 1 Adrian Georgescu
 '''Account.sip.register''' (type={{{bool}}}, default={{{True}}})::
562 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].
563 1 Adrian Georgescu
564 48 Adrian Georgescu
 '''Account.sip.publish_interval''' (type={{{NonNegativeInteger}}}, default={{{3600}}})::
565 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.
566 31 Luci Stanescu
567 48 Adrian Georgescu
 '''Account.sip.subscribe_interval''' (type={{{NonNegativeInteger}}}, default={{{3600}}})::
568 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.
569 31 Luci Stanescu
570 31 Luci Stanescu
 '''Account.registration.interval''' (type={{{NonNegativeInteger}}}, default={{{600}}})::
571 31 Luci Stanescu
  This setting controls the number of seconds used for the ''Expire'' header when registering. It must be a non-negative integer.
572 31 Luci Stanescu
573 33 Luci Stanescu
==== TLS ====
574 31 Luci Stanescu
575 1 Adrian Georgescu
 '''Account.tls.certificate''' (type={{{Path}}}, default={{{None}}}, nillable={{{True}}})::
576 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:
577 31 Luci Stanescu
  {{{
578 31 Luci Stanescu
  account.tls.certificate.normalized
579 31 Luci Stanescu
  }}}
580 31 Luci Stanescu
581 31 Luci Stanescu
 '''Account.tls.verify_server''' (type={{{bool}}}, default={{{False}}})::
582 31 Luci Stanescu
  If this setting is set to {{{True}}}, the middleware will verify the server's certificate when connecting via TLS.
583 31 Luci Stanescu
584 33 Luci Stanescu
==== XCAP  ====
585 31 Luci Stanescu
586 31 Luci Stanescu
 '''Account.xcap.enabled''' (type={{{bool}}}, default={{{True}}})::
587 31 Luci Stanescu
  If this setting is set to {{{True}}}, The use of XCAP root set below will be activated.
588 31 Luci Stanescu
589 31 Luci Stanescu
 '''Account.xcap.xcap_root''' (type={{{XCAPRoot}}}, default={{{None}}}, nillable={{{True}}})::
590 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.
591 31 Luci Stanescu
592 1 Adrian Georgescu
593 1 Adrian Georgescu
594 33 Luci Stanescu
=== BonjourAccount ===
595 1 Adrian Georgescu
596 30 Luci Stanescu
{{{
597 1 Adrian Georgescu
Account bonjour@local:
598 1 Adrian Georgescu
          +-- display_name = Bonjour User
599 1 Adrian Georgescu
account --|-- enabled = False
600 34 Luci Stanescu
          |-- msrp
601 1 Adrian Georgescu
          |-- rtp
602 34 Luci Stanescu
          |-- sip
603 1 Adrian Georgescu
          +-- tls
604 34 Luci Stanescu
605 34 Luci Stanescu
       +-- transport = tcp
606 34 Luci Stanescu
msrp --|
607 34 Luci Stanescu
       +
608 1 Adrian Georgescu
609 1 Adrian Georgescu
      +-- audio_codec_list = None
610 1 Adrian Georgescu
rtp --|-- inband_dtmf = False
611 1 Adrian Georgescu
      |-- srtp_encryption = optional
612 30 Luci Stanescu
      +-- use_srtp_without_tls = False
613 1 Adrian Georgescu
614 45 Luci Stanescu
      +-- transport_list = SIPTransportList(['udp'])
615 34 Luci Stanescu
sip --|
616 34 Luci Stanescu
      +
617 34 Luci Stanescu
618 30 Luci Stanescu
      +-- certificate = tls/bonjour@local.crt
619 1 Adrian Georgescu
tls --|-- verify_server = False
620 30 Luci Stanescu
      +
621 1 Adrian Georgescu
}}}
622 30 Luci Stanescu
623 1 Adrian Georgescu
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. 
624 30 Luci Stanescu
625 30 Luci Stanescu
The settings of the BonjourAccount are described below:
626 30 Luci Stanescu
 
627 30 Luci Stanescu
 '''BonjourAccount.id''' (type={{{SIPAddress}}})::
628 30 Luci Stanescu
  This is not a setting, as it is the static string 'bonjour@local' which represents the id of the BonjourAccount.
629 30 Luci Stanescu
630 30 Luci Stanescu
 '''BonjourAccount.enabled''' (type={{{bool}}}, default={{{True}}})::
631 1 Adrian Georgescu
  If this setting is set to {{{True}}}, the account will be used. More information about this is in [wiki:SipMiddlewareApi#BonjourAccount BonjourAccount].
632 30 Luci Stanescu
633 57 Adrian Georgescu
 '''BonjourAccount.display_name''' (type={{{unicode}}}, default={{{None}}}, nillable={{{True}}})::
634 1 Adrian Georgescu
  The contents of this setting will be sent as part of the ''From'' header when sending SIP requests.
635 1 Adrian Georgescu
636 34 Luci Stanescu
==== MSRP ====
637 34 Luci Stanescu
638 1 Adrian Georgescu
 '''SIPSimpleSettings.msrp.transport''' (type={{{MSRPTransport}}}, default={{{'tcp'}}})::
639 1 Adrian Georgescu
  MSRP can use either TLS or TCP and this setting controls which one should be used for the bonjour account.
640 1 Adrian Georgescu
641 1 Adrian Georgescu
==== RTP ====
642 34 Luci Stanescu
643 34 Luci Stanescu
 '''BonjourAccount.rtp.audio_codec_list''' (type={{{AudioCodecList}}}, default={{{('speex', 'g722', 'g711', 'ilbc', 'gsm')}}})::
644 34 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.
645 33 Luci Stanescu
646 30 Luci Stanescu
 '''BonjourAccount.rtp.srtp_encryption''' (type={{{SRTPEncryption}}}, default={{{'optional'}}})::
647 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'}}}.
648 32 Luci Stanescu
649 30 Luci Stanescu
 '''BonjourAccount.rtp.use_srtp_without_tls''' (type={{{bool}}}, default={{{False}}})::
650 30 Luci Stanescu
  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.
651 30 Luci Stanescu
652 34 Luci Stanescu
==== TLS ====
653 34 Luci Stanescu
654 34 Luci Stanescu
 '''BonjourAccount.tls.certificate''' (type={{{Path}}}, default={{{None}}}, nillable={{{True}}})::
655 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:
656 33 Luci Stanescu
  {{{
657 30 Luci Stanescu
  BonjourAccount().tls.ca_list.normalized
658 30 Luci Stanescu
  }}}
659 30 Luci Stanescu
660 30 Luci Stanescu
 '''BonjourAccount.tls.verify_server''' (type={{{bool}}}, default={{{False}}})::
661 30 Luci Stanescu
  If this setting is set to {{{True}}}, the middleware will verify the server's certificate when connecting via TLS.
662 30 Luci Stanescu
663 30 Luci Stanescu
== SIPClients Settings ==
664 30 Luci Stanescu
665 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.
666 29 Luci Stanescu
667 35 Luci Stanescu
=== General ===
668 30 Luci Stanescu
669 30 Luci Stanescu
 '''SIPSimpleSettings.user_data_directory''' (type={{{AbsolutePath}}}, default={{{'~/.sipclient}}})::
670 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.
671 48 Adrian Georgescu
672 48 Adrian Georgescu
 '''SIPSimpleSettings.resources_directory''' (type={{{AbsolutePath}}}, default={{{None}}})::
673 48 Adrian Georgescu
  This is the directory, which will be used by default for storing the sound files played for various notifications.
674 48 Adrian Georgescu
675 29 Luci Stanescu
676 33 Luci Stanescu
==== Audio ====
677 29 Luci Stanescu
678 29 Luci Stanescu
 '''SIPSimpleSettings.audio.directory''' (type={{{DataPath}}}, default={{{DataPath('history')}}})::
679 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:
680 29 Luci Stanescu
  {{{
681 29 Luci Stanescu
  SIPSimpleSettings().audio.directory.value
682 29 Luci Stanescu
  }}}
683 29 Luci Stanescu
684 33 Luci Stanescu
==== File Transfer ====
685 29 Luci Stanescu
686 29 Luci Stanescu
 '''SIPSimpleSettings.file_transfer.directory''' (type={{{DataPath}}}, default={{{DataPath('file_transfers')}}})::
687 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:
688 29 Luci Stanescu
  {{{
689 29 Luci Stanescu
  SIPSimpleSettings().file_transfer.directory.value
690 29 Luci Stanescu
  }}}
691 29 Luci Stanescu
692 33 Luci Stanescu
==== Logs ====
693 29 Luci Stanescu
694 29 Luci Stanescu
 '''SIPSimpleSettings.logs.directory''' (type={{{DataPath}}}, default={{{DataPath('logs')}}})::
695 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:
696 29 Luci Stanescu
  {{{
697 29 Luci Stanescu
  SIPSimpleSettings().logs.directory.value
698 29 Luci Stanescu
  }}}
699 29 Luci Stanescu
700 29 Luci Stanescu
 '''SIPSimpleSettings.logs.trace_sip''' (type={{{bool}}}, default={{{False}}})::
701 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}}}.
702 29 Luci Stanescu
703 29 Luci Stanescu
 '''SIPSimpleSettings.logs.trace_pjsip''' (type={{{bool}}}, default={{{False}}})::
704 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}}}.
705 29 Luci Stanescu
706 29 Luci Stanescu
 '''SIPSimpleSettings.logs.trace_msrp''' (type={{{bool}}}, default={{{False}}})::
707 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}}}.
708 29 Luci Stanescu
709 29 Luci Stanescu
 '''SIPSimpleSettings.logs.trace_xcap''' (type={{{bool}}}, default={{{False}}})::
710 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}}}.
711 29 Luci Stanescu
712 33 Luci Stanescu
==== Sounds ====
713 29 Luci Stanescu
714 29 Luci Stanescu
 '''SIPSimpleSettings.sounds.audio_inbound''' (type={{{AbsolutePath}}}, default={{{None}}}, nillable={{{True}}})::
715 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.
716 29 Luci Stanescu
717 29 Luci Stanescu
 '''SIPSimpleSettings.sounds.audio_outbound''' (type={{{AbsolutePath}}}, default={{{None}}}, nillable={{{True}}})::
718 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.
719 29 Luci Stanescu
720 29 Luci Stanescu
 '''SIPSimpleSettings.sounds.file_sent''' (type={{{AbsolutePath}}}, default={{{None}}}, nillable={{{True}}})::
721 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.
722 29 Luci Stanescu
723 29 Luci Stanescu
 '''SIPSimpleSettings.sounds.file_received''' (type={{{AbsolutePath}}}, default={{{None}}}, nillable={{{True}}})::
724 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.
725 29 Luci Stanescu
726 29 Luci Stanescu
 '''SIPSimpleSettings.sounds.message_sent''' (type={{{AbsolutePath}}}, default={{{None}}}, nillable={{{True}}})::
727 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.
728 29 Luci Stanescu
729 29 Luci Stanescu
 '''SIPSimpleSettings.sounds.message_received''' (type={{{AbsolutePath}}}, default={{{None}}}, nillable={{{True}}})::
730 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.
731 29 Luci Stanescu
732 33 Luci Stanescu
=== Account ===
733 29 Luci Stanescu
734 33 Luci Stanescu
==== Sounds ====
735 29 Luci Stanescu
736 29 Luci Stanescu
 '''Account.sounds.audio_inbound''' (type={{{AbsolutePath}}}, default={{{None}}}, nillable={{{True}}})::
737 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.
738 29 Luci Stanescu
739 33 Luci Stanescu
=== BonjourAccount ===
740 29 Luci Stanescu
741 33 Luci Stanescu
==== Sounds ====
742 29 Luci Stanescu
743 29 Luci Stanescu
 '''BonjourAccount.sounds.audio_inbound''' (type={{{AbsolutePath}}}, default={{{None}}}, nillable={{{True}}})::
744 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.