1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240
|
ALIAS_DB Module
Daniel-Constantin Mierla
<miconda@gmail.com>
Elena-Ramona Modroiu
<ramona@asipto.com>
Edited by
Daniel-Constantin Mierla
<miconda@gmail.com>
Copyright 2005 Voice Sistem SRL
Copyright 2008 asipto.com
__________________________________________________________________
Table of Contents
1. Admin Guide
1. Overview
2. Dependencies
2.1. Kamailio Modules
2.2. External Libraries or Applications
3. Parameters
3.1. db_url (str)
3.2. user_column (str)
3.3. domain_column (str)
3.4. alias_user_column (str)
3.5. alias_domain_column (str)
3.6. use_domain (int)
3.7. domain_prefix (str)
3.8. append_branches (int)
4. Functions
4.1. alias_db_lookup(table_name)
List of Examples
1.1. Set db_url parameter
1.2. Set user_column parameter
1.3. Set domain_column parameter
1.4. Set alias_user_column parameter
1.5. Set alias_domain_column parameter
1.6. Set use_domain parameter
1.7. Set domain_prefix parameter
1.8. Set append_branches parameter
1.9. alias_db_lookup() usage
Chapter 1. Admin Guide
Table of Contents
1. Overview
2. Dependencies
2.1. Kamailio Modules
2.2. External Libraries or Applications
3. Parameters
3.1. db_url (str)
3.2. user_column (str)
3.3. domain_column (str)
3.4. alias_user_column (str)
3.5. alias_domain_column (str)
3.6. use_domain (int)
3.7. domain_prefix (str)
3.8. append_branches (int)
4. Functions
4.1. alias_db_lookup(table_name)
1. Overview
The ALIAS_DB module can be used as an alternative for user aliases via
usrloc. The main feature is that it does not store all addiacent data
as for user location and always uses the database for search (no memory
caching). A common use case is to provide additional user aliases, i.e.
to supplement the registration in the location database. Users are this
way on a proxy reachable with several request URIs.
As the module use no memory caching the lookup is a bit slower but the
data provisioning is easier. With very fast databases like MySQL the
speed penalty can be lowered. Also, the search can be performed on
different tables in the same script.
2. Dependencies
2.1. Kamailio Modules
2.2. External Libraries or Applications
2.1. Kamailio Modules
The following modules must be loaded before this module:
* database module (mysql, dbtext, ...).
2.2. External Libraries or Applications
The following libraries or applications must be installed before
running Kamailio with this module loaded:
* None.
3. Parameters
3.1. db_url (str)
3.2. user_column (str)
3.3. domain_column (str)
3.4. alias_user_column (str)
3.5. alias_domain_column (str)
3.6. use_domain (int)
3.7. domain_prefix (str)
3.8. append_branches (int)
3.1. db_url (str)
Database URL.
Default value is "mysql://openserro:openserro@localhost/openser".
Example 1.1. Set db_url parameter
...
modparam("alias_db", "db_url", "dbdriver://username:password@dbhost/dbname")
...
3.2. user_column (str)
Name of the column storing username.
Default value is "username".
Example 1.2. Set user_column parameter
...
modparam("alias_db", "user_column", "susername")
...
3.3. domain_column (str)
Name of the column storing user's domain.
Default value is "domain".
Example 1.3. Set domain_column parameter
...
modparam("alias_db", "domain_column", "sdomain")
...
3.4. alias_user_column (str)
Name of the column storing alias username.
Default value is "alias_username".
Example 1.4. Set alias_user_column parameter
...
modparam("alias_db", "alias_user_column", "auser")
...
3.5. alias_domain_column (str)
Name of the column storing alias domain.
Default value is "alias_domain".
Example 1.5. Set alias_domain_column parameter
...
modparam("alias_db", "alias_domain_column", "adomain")
...
3.6. use_domain (int)
Specifies whether to use or not the domain from R-URI when searching
for alias. If set to 0, the domain from R-URI is not used, if set to 1
the domain from R-URI is used.
Default value is "0".
Example 1.6. Set use_domain parameter
...
modparam("alias_db", "use_domain", 1)
...
3.7. domain_prefix (str)
Specifies the prefix to be stripped from the domain in R-URI before
doing the search.
Default value is "NULL".
Example 1.7. Set domain_prefix parameter
...
modparam("alias_db", "domain_prefix", "sip.")
...
3.8. append_branches (int)
If the alias resolves to many SIP IDs, the first is replacing the
R-URI, the rest are added as branches.
Default value is "0" (0 - don't add branches; 1 - add branches).
Example 1.8. Set append_branches parameter
...
modparam("alias_db", "append_branches", 1)
...
4. Functions
4.1. alias_db_lookup(table_name)
4.1. alias_db_lookup(table_name)
The function takes the R-URI and search to see whether it is an alias
or not. If it is an alias for a local user, the R-URI is replaced with
user's SIP uri.
The function returns TRUE if R-URI is alias and it was replaced by
user's SIP uri.
Meaning of the parameters is as follows:
* table_name - the name of the table where to search for alias. It
can include pseudo-variables.
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
Example 1.9. alias_db_lookup() usage
...
alias_db_lookup("dbaliases");
alias_db_lookup("dba_$(rU{s.substr,0,1})");
...
|