Home Explore Help
Sign In
Kamailio
/
kamailio
mirror of https://github.com/kamailio/kamailio.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: fc425b1c36
Branches Tags
kamailio
/
modules
/
app_java
/
doc
/
html
/
app_java_admin.html

app_java_admin.html 27 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585 
  1. <html><head>
    2. 

  2.       <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
    3. 

  3.    <title>Chapter&nbsp;1.&nbsp;Admin Guide</title><meta name="generator" content="DocBook XSL Stylesheets V1.77.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a name="d6e1"></a>Chapter&nbsp;1.&nbsp;Admin Guide</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#d6e3">Overview</a></span></dt><dt><span class="section"><a href="#d6e6">Dependencies</a></span></dt><dd><dl><dt><span class="section"><a href="#d6e8">Kamailio Modules</a></span></dt><dt><span class="section"><a href="#d6e15">External Libraries or Applications</a></span></dt></dl></dd><dt><span class="section"><a href="#d6e67">Java runtime</a></span></dt><dd><dl><dt><span class="section"><a href="#d6e69"></a></span></dt></dl></dd><dt><span class="section"><a href="#d6e72">Parameters</a></span></dt><dd><dl><dt><span class="section"><a href="#d6e74"><code class="varname">class_name</code> (string)</a></span></dt><dt><span class="section"><a href="#d6e87"><code class="varname">child_init_method</code> (string)</a></span></dt><dt><span class="section"><a href="#d6e98"><code class="varname">java_options</code> (string)</a></span></dt><dt><span class="section"><a href="#d6e123"><code class="varname">force_kam_cmd_exec</code> (int)</a></span></dt></dl></dd><dt><span class="section"><a href="#d6e135">Functions</a></span></dt><dd><dl><dt><span class="section"><a href="#d6e137">
    4. 

  4.     			Common requirements
    5. 

  5.     		</a></span></dt><dt><span class="section"><a href="#d6e146">java_method_exec(method, method_signature, [param1[, param2[, ...]]])</a></span></dt><dt><span class="section"><a href="#d6e181">java_staticmethod_exec(method, method_signature, [param1[, param2[, ...]]])</a></span></dt><dt><span class="section"><a href="#d6e216">java_s_method_exec(method, method_signature, [param1[, param2[, ...]]])</a></span></dt><dt><span class="section"><a href="#d6e254">java_s_staticmethod_exec(method, method_signature, [param1[, param2[, ...]]])</a></span></dt></dl></dd><dt><span class="section"><a href="#d6e292">Java Module API</a></span></dt><dd><dl><dt><span class="section"><a href="#d6e295">Minimal program skeleton</a></span></dt></dl></dd></dl></div>
    6. 

  6.     
    7. 

  7.     
    8. 

  8.     
    9. 

  9.     
    10. 

  10.     <div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d6e3"></a>Overview</h2></div></div></div>
    11. 

  11. 		
    12. 

  12. 		<p>
    13. 

  13. 			This module allows executing Java compiled classes from config file, exporting
    14. 

  14. 			functions to access the SIP message from Java using Java Native Interface (JNI).
    15. 

  15. 		</p>
    16. 

  16.     </div>
    17. 

  17. 	
    18. 

  18. 	
    19. 

  19. 	
    20. 

  20.     <div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d6e6"></a>Dependencies</h2></div></div></div>
    21. 

  21. 		
    22. 

  22.     	
    23. 

  23. 		<div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="d6e8"></a>Kamailio Modules</h3></div></div></div>
    24. 

  24. 		    
    25. 

  25. 		    <p>
    26. 

  26. 			The following modules must be loaded before this module:
    27. 

  27. 		    	</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
    28. 

  28. 				<p>
    29. 

  29. 				    <span class="emphasis"><em>none</em></span>.
    30. 

  30. 				</p>
    31. 

  31. 			    </li></ul></div><p>
    32. 

  32. 		    </p>
    33. 

  33. 		</div>
    34. 

  34.     	
    35. 

  35.     	
    36. 

  36.     	
    37. 

  37. 		<div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="d6e15"></a>External Libraries or Applications</h3></div></div></div>
    38. 

  38. 		    
    39. 

  39. 		    <p>
    40. 

  40. 			
    41. 

  41. 		    	</p><div class="itemizedlist"><p><span class="emphasis"><em>The following packages are runtime libraries, required to launch</em></span></p><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem" style="list-style-type: disc"><p><span class="emphasis"><em>java-common</em></span> Base of all Java packages.</p></li><li class="listitem" style="list-style-type: disc"><p><span class="emphasis"><em>default-jre</em></span> Standard Java or Java compatible Runtime.</p></li><li class="listitem" style="list-style-type: disc"><p><span class="emphasis"><em>gcj-jre</em></span> Java runtime environment using GIJ/classpath.</p></li><li class="listitem" style="list-style-type: disc"><p><span class="emphasis"><em>libgcj12 (&gt;=12)</em></span> Java runtime library for use with gcj.</p></li></ul></div><p>
    42. 

  42. 		    	</p><div class="itemizedlist"><p><span class="emphasis"><em>The following packages are optional, required for development</em></span></p><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem" style="list-style-type: square"><p><span class="emphasis"><em>ant</em></span> Java based build tool like make.</p></li><li class="listitem" style="list-style-type: square"><p><span class="emphasis"><em>ant-contrib</em></span> Collection of tasks, types and other tools for Apache Ant.</p></li><li class="listitem" style="list-style-type: square"><p><span class="emphasis"><em>ant-gcj</em></span> Java based build tool like make (GCJ).</p></li><li class="listitem" style="list-style-type: square"><p><span class="emphasis"><em>default-jdk</em></span> Standard Java or Java compatible Development Kit</p></li><li class="listitem" style="list-style-type: square"><p><span class="emphasis"><em>gcj-jdk</em></span> gcj and classpath development tools for Java(TM)</p></li><li class="listitem" style="list-style-type: square"><p><span class="emphasis"><em>libgcj13-dev (&gt;=12)</em></span> Java development headers for use with gcj</p></li><li class="listitem" style="list-style-type: square"><p><span class="emphasis"><em>jdk</em></span> JDK Development Kit (either oracle jdk or openjdk)</p></li></ul></div><p>
    43. 

  43. 		    </p>
    44. 

  44. 			<p>
    45. 

  45. 				The following libraries or applications must be compiled before
    46. 

  46. 				running Kamailio with this module loaded:
    47. 

  47. 				</p><div class="itemizedlist"><p><span class="emphasis"><em>The following packages are runtime libraries, required to launch</em></span></p><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem" style="list-style-type: circle"><p><span class="emphasis"><em>&lt;class_name&gt;</em></span>.class</p></li><li class="listitem" style="list-style-type: circle"><p><span class="emphasis"><em>kamailio</em></span>.jar</p></li></ul></div><p>
    48. 

  48. 			</p>
    49. 

  49. 		</div>
    50. 

  50.     	
    51. 

  51.     </div>
    52. 

  52. 	
    53. 

  53. 	
    54. 

  54. 	
    55. 

  55. 	<div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d6e67"></a>Java runtime</h2></div></div></div>
    56. 

  56. 		
    57. 

  57. 		<div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="d6e69"></a></h3></div></div></div>
    58. 

  58. 			
    59. 

  59. 			<p>Java runtime library (JRE or JDK) is required to use this module.</p>
    60. 

  60. 		</div>
    61. 

  61. 	</div>
    62. 

  62. 	
    63. 

  63. 	
    64. 

  64. 	
    65. 

  65. 	<div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d6e72"></a>Parameters</h2></div></div></div>
    66. 

  66. 		
    67. 

  67. 

  68. 		
    69. 

  69. 		<div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="d6e74"></a><code class="varname">class_name</code> (string)</h3></div></div></div>
    70. 

  70. 			
    71. 

  71. 		    <p>
    72. 

  72. 		    	The class name should have the same compiled file name.
    73. 

  73. 		    	If the value is <span class="emphasis"><em>"Kamailio"</em></span>, then the compiled file should be named as <span class="emphasis"><em>"Kamailio.class"</em></span>.
    74. 

  74. 		    </p>
    75. 

  75. 		    <p>
    76. 

  76. 				<span class="emphasis"><em>
    77. 

  77. 					Default value is <span class="quote">&#8220;<span class="quote">Kamailio</span>&#8221;</span>.
    78. 

  78. 				</em></span>
    79. 

  79. 		    </p>
    80. 

  80. 		    <div class="example"><a name="d6e83"></a><p class="title"><b>Example&nbsp;1.1.&nbsp;Set <code class="varname">class_name</code> parameter</b></p><div class="example-contents">
    81. 

  81. 		    	
    82. 

  82. 				<pre class="programlisting">
    83. 

  83. ...
    84. 

  84. modparam("app_java", "class_name", "Kamailio")
    85. 

  85. ...
    86. 

  86. </pre>
    87. 

  87. 		    </div></div><br class="example-break">
    88. 

  88. 		</div>
    89. 

  89. 

  90. 		
    91. 

  91. 		<div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="d6e87"></a><code class="varname">child_init_method</code> (string)</h3></div></div></div>
    92. 

  92. 			
    93. 

  93. 			<p>
    94. 

  94. 				TBD.
    95. 

  95. 			</p>
    96. 

  96. 			<p>
    97. 

  97. 				<span class="emphasis"><em>
    98. 

  98. 					Default value is <span class="quote">&#8220;<span class="quote">child_init</span>&#8221;</span>.
    99. 

  99. 				</em></span>
    100. 

  100. 			</p>
    101. 

  101. 			<div class="example"><a name="d6e94"></a><p class="title"><b>Example&nbsp;1.2.&nbsp;Set <code class="varname">child_init_method</code> parameter</b></p><div class="example-contents">
    102. 

  102. 				
    103. 

  103. 				<pre class="programlisting">
    104. 

  104. ...
    105. 

  105. modparam("app_java", "child_init_method", "my_mod_init")
    106. 

  106. ...
    107. 

  107. </pre>
    108. 

  108. 			</div></div><br class="example-break">
    109. 

  109. 		</div>
    110. 

  110. 

  111. 		
    112. 

  112. 		<div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="d6e98"></a><code class="varname">java_options</code> (string)</h3></div></div></div>
    113. 

  113. 			
    114. 

  114. 			<p>
    115. 

  115. 				Java options for Java Virtual Machine.
    116. 

  116. 				For more info read <a class="ulink" href="http://docs.oracle.com/javase/6/docs/technotes/tools/windows/java.html" target="_top"><em class="citetitle">java docs</em></a>
    117. 

  117. 			</p>
    118. 

  118. 			<p>
    119. 

  119. 				<span class="emphasis"><em>
    120. 

  120. 					Default value is <span class="quote">&#8220;<span class="quote">-Djava.compiler=NONE</span>&#8221;</span>.
    121. 

  121. 				</em></span>
    122. 

  122. 			</p>
    123. 

  123. 			<div class="example"><a name="d6e107"></a><p class="title"><b>Example&nbsp;1.3.&nbsp;Set <code class="varname">java_options</code> parameter</b></p><div class="example-contents">
    124. 

  124. 				
    125. 

  125. 				<pre class="programlisting">
    126. 

  126. ...
    127. 

  127. modparam("app_java", "java_options", "-Djava.compiler=NONE")
    128. 

  128. ...
    129. 

  129. </pre>
    130. 

  130. 			</div></div><br class="example-break">
    131. 

  131. 			<div class="example"><a name="d6e111"></a><p class="title"><b>Example&nbsp;1.4.&nbsp;Set <code class="varname">java_options</code> parameter (live configuration)</b></p><div class="example-contents">
    132. 

  132. 				
    133. 

  133. 				<pre class="programlisting">
    134. 

  134. ...
    135. 

  135. # Assumes "application java folder" is located at /opt/kamailio/java
    136. 

  136. modparam("app_java", "java_options", "-Djava.compiler=NONE -Djava.class.path=/path/to/kamailio/modules:/opt/kamailio/java:/opt/kamailio/java/kamailio.jar")
    137. 

  137. ...
    138. 

  138. </pre>
    139. 

  139. 			</div></div><br class="example-break">
    140. 

  140. 			<div class="example"><a name="d6e115"></a><p class="title"><b>Example&nbsp;1.5.&nbsp;Set <code class="varname">java_options</code> parameter (verbose configuration)</b></p><div class="example-contents">
    141. 

  141. 				
    142. 

  142. 				<pre class="programlisting">
    143. 

  143. ...
    144. 

  144. # Assumes "application java folder" is located at /opt/kamailio/java
    145. 

  145. modparam("app_java", "java_options", "-verbose:gc,class,jni -Djava.compiler=NONE -Djava.class.path=/path/to/kamailio/modules:/opt/kamailio/java:/opt/kamailio/java/kamailio.jar")
    146. 

  146. ...
    147. 

  147. </pre>
    148. 

  148. 			</div></div><br class="example-break">
    149. 

  149. 			<div class="example"><a name="d6e119"></a><p class="title"><b>Example&nbsp;1.6.&nbsp;Set <code class="varname">java_options</code> parameter (debug configuration)</b></p><div class="example-contents">
    150. 

  150. 				
    151. 

  151. 				<pre class="programlisting">
    152. 

  152. ...
    153. 

  153. # Assumes "application java folder" is located at /opt/kamailio/java
    154. 

  154. modparam("app_java", "java_options", "-Xdebug -verbose:gc,class,jni -Djava.compiler=NONE -Djava.class.path=/path/to/kamailio/modules:/opt/kamailio/java:/opt/kamailio/java/kamailio.jar")
    155. 

  155. ...
    156. 

  156. </pre>
    157. 

  157. 			</div></div><br class="example-break">
    158. 

  158. 		</div>
    159. 

  159. 

  160. 		
    161. 

  161. 		<div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="d6e123"></a><code class="varname">force_kam_cmd_exec</code> (int)</h3></div></div></div>
    162. 

  162. 			
    163. 

  163. 			<p>
    164. 

  164. 				This parameter forces execution a kamailio comnmand with java native method <span class="quote">&#8220;<span class="quote">KamExec</span>&#8221;</span>.
    165. 

  165. 				# Note: this is an untested yet feature, may cause (but may not) a memory leaks if used from embedded languages.
    166. 

  166. 			</p>
    167. 

  167. 			<p>
    168. 

  168. 				<span class="emphasis"><em>
    169. 

  169. 					Default value is <span class="quote">&#8220;<span class="quote">0 (off)</span>&#8221;</span>.
    170. 

  170. 				</em></span>
    171. 

  171. 			</p>
    172. 

  172. 			<div class="example"><a name="d6e131"></a><p class="title"><b>Example&nbsp;1.7.&nbsp;Set <code class="varname">force_kam_cmd_exec</code> parameter</b></p><div class="example-contents">
    173. 

  173. 				
    174. 

  174. 				<pre class="programlisting">
    175. 

  175. ...
    176. 

  176. modparam("app_java", "force_kam_cmd_exec", 1)
    177. 

  177. ...
    178. 

  178. </pre>
    179. 

  179. 			</div></div><br class="example-break">
    180. 

  180. 		</div>
    181. 

  181. 	</div>
    182. 

  182. 	
    183. 

  183. 	
    184. 

  184. 	
    185. 

  185.     <div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d6e135"></a>Functions</h2></div></div></div>
    186. 

  186. 		
    187. 

  187.     	
    188. 

  188.     	
    189. 

  189.     	<div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="d6e137"></a>
    190. 

  190.     			Common requirements
    191. 

  191.     		</h3></div></div></div>
    192. 

  192.     		
    193. 

  193.     		<p>Each function has a required parameter <span class="quote">&#8220;<span class="quote">method_signature</span>&#8221;</span>. For more info
    194. 

  194. 				see <a class="ulink" href="http://www.rgagnon.com/javadetails/java-0286.html" target="_top"><em class="citetitle">Determine the signature of a method</em></a>.
    195. 

  195. 				Signature represents the variable type. The mapping between the Java type and C type
    196. 

  196. 				is
    197. 

  197. 				</p><pre class="programlisting">
    198. 

  198. 		Type     Chararacter 
    199. 

  199. 		boolean      Z 
    200. 

  200. 		byte         B 
    201. 

  201. 		char         C 
    202. 

  202. 		double       D 
    203. 

  203. 		float        F 
    204. 

  204. 		int          I 
    205. 

  205. 		long         J 
    206. 

  206. 		object       L 
    207. 

  207. 		short        S 
    208. 

  208. 		void         V 
    209. 

  209. 		Note that to specify an object, the "L" is followed by the object's class name and ends with a semi-colon, ';' .
    210. 

  210.     			</pre><p>
    211. 

  211. 			</p>
    212. 

  212.     		<p> app_java supports the following signatures:
    213. 

  213. 				</p><pre class="programlisting">
    214. 

  214. 		Primitives: Z,B,C,D,F,I,J,L,S,V
    215. 

  215. 		Objects: 
    216. 

  216. 			Ljava/lang/Boolean;
    217. 

  217. 			Ljava/lang/Byte;
    218. 

  218. 			Ljava/lang/Character;
    219. 

  219. 			Ljava/lang/Double;
    220. 

  220. 			Ljava/lang/Float;
    221. 

  221. 			Ljava/lang/Integer;
    222. 

  222. 			Ljava/lang/Long;
    223. 

  223. 			Ljava/lang/Short;
    224. 

  224. 			Ljava/lang/String;
    225. 

  225. 			NULL parameter: V
    226. 

  226. 

  227. 	Each parameter passed to function will be cast according to given signature.
    228. 

  228. 	
    229. 

  229. 	Parameters are optional, ommitting a parameter meant the passed value is NULL.
    230. 

  230. 	Parameters count should be exactly the same as signature count.
    231. 

  231. 	Note 1: Arrays representation (symbol '[') is not supported yet.
    232. 

  232. 	Note 2: You shall use a correct signature, e.g. the following examples of combinations are invalid:    
    233. 

  233.     	java_method_exec("ExampleMethod", "ZI", "False");
    234. 

  234.         java_method_exec("ExampleMethod", "LI", "something", "5");
    235. 

  235. </pre><p>
    236. 

  236. 			</p>
    237. 

  237. 

  238.  
    239. 

  239.     	</div>
    240. 

  240.     	
    241. 

  241.   
    242. 

  242.     	
    243. 

  243.     	<div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="d6e146"></a>java_method_exec(method, method_signature, [param1[, param2[, ...]]])</h3></div></div></div>
    244. 

  244.     		
    245. 

  245.     		<p>Executes a java class method <span class="emphasis"><em>method</em></span>. Parameter <span class="emphasis"><em>method_signature</em></span> is required.</p>
    246. 

  246.     		<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
    247. 

  247. 			    	<div class="example"><a name="d6e153"></a><p class="title"><b>Example&nbsp;1.8.&nbsp;Signature: "V"</b></p><div class="example-contents">
    248. 

  248. 						
    249. 

  249. 			    		<p>Kamailio prototype</p>
    250. 

  250. 			    		<pre class="programlisting">java_method_exec("ExampleMethod", "V");</pre>
    251. 

  251. 			    		<p>Java prototype</p>
    252. 

  252. 			    		<pre class="programlisting">public int ExampleMethod();</pre>
    253. 

  253. 			    		<p>Example of usage:</p>
    254. 

  254. 			    		<pre class="programlisting">
    255. 

  255. # Kamailio
    256. 

  256. java_method_exec("ExampleMethod", "V");
    257. 

  257. 

  258. # Java
    259. 

  259. public int ExampleMethod()
    260. 

  260. {
    261. 

  261. 		... do something;
    262. 

  262. 		return 1;
    263. 

  263. }
    264. 

  264. </pre>
    265. 

  265. 			    	</div></div><br class="example-break">
    266. 

  266. 	    		</li><li class="listitem">
    267. 

  267. 	    			<div class="example"><a name="d6e162"></a><p class="title"><b>Example&nbsp;1.9.&nbsp;Signature: "Ljava/lang/String;I"</b></p><div class="example-contents">
    268. 

  268. 	    				
    269. 

  269. 	    				<p>Kamailio prototype</p>
    270. 

  270. 		    			<pre class="programlisting">java_method_exec("ExampleMethod", "Ljava/lang/String;I", "Hello world", "5");</pre>
    271. 

  271. 	    				<p>Java prototype</p>
    272. 

  272. 	    				<pre class="programlisting">public int ExampleMethod(String param1, int param2);</pre>
    273. 

  273. 	    				<p>In the above scenario parameter 2 ("5") will be cast to integer representation.</p>
    274. 

  274. 	    				<p>Example of usage:</p>
    275. 

  275. 	    				<pre class="programlisting">
    276. 

  276. # Kamailio
    277. 

  277. java_method_exec("ExampleMethod", "Ljava/lang/String;I", "$mb", "$ml");
    278. 

  278. 

  279. # Java
    280. 

  280. public int ExampleMethod(String SipMessageBuffer, int SipMessageLenght)
    281. 

  281. {
    282. 

  282. 		... do something with buffer;
    283. 

  283. 		return 1;
    284. 

  284. }
    285. 

  285. </pre>
    286. 

  286. 	    			</div></div><br class="example-break">
    287. 

  287. 	    		</li><li class="listitem">
    288. 

  288.     				<div class="example"><a name="d6e172"></a><p class="title"><b>Example&nbsp;1.10.&nbsp;Signature: "ZB"</b></p><div class="example-contents">
    289. 

  289.     					
    290. 

  290.     					<p>Kamailio prototype</p>
    291. 

  291.     					<pre class="programlisting">java_method_exec("ExampleMethod", "ZB", "true", "0x05");</pre>
    292. 

  292.     					<p>Java prototype</p>
    293. 

  293.     					<pre class="programlisting">public int ExampleMethod(boolean param1, byte param2);</pre>
    294. 

  294.     					<p>In the above scenario parameter 1 ("true") will be cast to boolean representation.</p>
    295. 

  295.     					<p>Example of usage:</p>
    296. 

  296.     					<pre class="programlisting">
    297. 

  297. # Kamailio
    298. 

  298. java_method_exec("ExampleMethod", "ZB", "true", "0x05");
    299. 

  299. 

  300. # Java
    301. 

  301. public int ExampleMethod(boolean flagSet, byte bFlag);
    302. 

  302. {
    303. 

  303. 		if (flagSet)
    304. 

  304. 		{
    305. 

  305. 			... do something with flags;
    306. 

  306. 		}
    307. 

  307. 		return 1;
    308. 

  308. }
    309. 

  309. </pre>
    310. 

  310.     				</div></div><br class="example-break">
    311. 

  311.     			</li></ul></div>
    312. 

  312.     	</div>
    313. 

  313.     	
    314. 

  314. 

  315.     	
    316. 

  316.     	<div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="d6e181"></a>java_staticmethod_exec(method, method_signature, [param1[, param2[, ...]]])</h3></div></div></div>
    317. 

  317.     		
    318. 

  318.     		<p>Executes a java static method <span class="emphasis"><em>method</em></span>. Parameter <span class="emphasis"><em>method_signature</em></span> is required.</p>
    319. 

  319.     		<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
    320. 

  320.     				<div class="example"><a name="d6e188"></a><p class="title"><b>Example&nbsp;1.11.&nbsp;Signature: "V"</b></p><div class="example-contents">
    321. 

  321.     					
    322. 

  322.     					<p>Kamailio prototype</p>
    323. 

  323.     					<pre class="programlisting">java_staticmethod_exec("ExampleMethod", "V");</pre>
    324. 

  324.     					<p>Java prototype</p>
    325. 

  325.     					<pre class="programlisting">public static int ExampleMethod();</pre>
    326. 

  326.     					<p>Example of usage:</p>
    327. 

  327.     					<pre class="programlisting">
    328. 

  328. # Kamailio
    329. 

  329. java_staticmethod_exec("ExampleMethod", "V");
    330. 

  330. 

  331. # Java
    332. 

  332. public static int ExampleMethod()
    333. 

  333. {
    334. 

  334. 		... do something;
    335. 

  335. 		return 1;
    336. 

  336. }
    337. 

  337. </pre>
    338. 

  338.     				</div></div><br class="example-break">
    339. 

  339.     			</li><li class="listitem">
    340. 

  340.     				<div class="example"><a name="d6e197"></a><p class="title"><b>Example&nbsp;1.12.&nbsp;Signature: "Ljava/lang/String;I"</b></p><div class="example-contents">
    341. 

  341.     					
    342. 

  342.     					<p>Kamailio prototype</p>
    343. 

  343.     					<pre class="programlisting">java_staticmethod_exec("ExampleMethod", "Ljava/lang/String;I", "Hello world", "5");</pre>
    344. 

  344.     					<p>Java prototype</p>
    345. 

  345.     					<pre class="programlisting">public static int ExampleMethod(String param1, int param2);</pre>
    346. 

  346.     					<p>In the above scenario parameter 2 ("5") will be cast to integer representation.</p>
    347. 

  347.     					<p>Example of usage:</p>
    348. 

  348.     					<pre class="programlisting">
    349. 

  349. # Kamailio
    350. 

  350. java_staticmethod_exec("ExampleMethod", "Ljava/lang/String;I", "$mb", "$ml");
    351. 

  351. 

  352. # Java
    353. 

  353. public static int ExampleMethod(String SipMessageBuffer, int SipMessageLenght)
    354. 

  354. {
    355. 

  355. 		... do something with buffer;
    356. 

  356. 		return 1;
    357. 

  357. }
    358. 

  358. </pre>
    359. 

  359.     				</div></div><br class="example-break">
    360. 

  360.     			</li><li class="listitem">
    361. 

  361.     				<div class="example"><a name="d6e207"></a><p class="title"><b>Example&nbsp;1.13.&nbsp;Signature: "ZB"</b></p><div class="example-contents">
    362. 

  362.     					
    363. 

  363.     					<p>Kamailio prototype</p>
    364. 

  364.     					<pre class="programlisting">java_staticmethod_exec("ExampleMethod", "ZB", "true", "0x05");</pre>
    365. 

  365.     					<p>Java prototype</p>
    366. 

  366.     					<pre class="programlisting">public static int ExampleMethod(boolean param1, byte param2);</pre>
    367. 

  367.     					<p>In the above scenario parameter 1 ("true") will be cast to boolean representation.</p>
    368. 

  368.     					<p>Example of usage:</p>
    369. 

  369.     					<pre class="programlisting">
    370. 

  370. # Kamailio
    371. 

  371. java_staticmethod_exec("ExampleMethod", "ZB", "true", "0x05");
    372. 

  372. 

  373. # Java
    374. 

  374. public static int ExampleMethod(boolean flagSet, byte bFlag);
    375. 

  375. {
    376. 

  376. 		if (flagSet)
    377. 

  377. 		{
    378. 

  378. 			... do something with flags;
    379. 

  379. 		}
    380. 

  380. 		return 1;
    381. 

  381. }
    382. 

  382. </pre>
    383. 

  383.     				</div></div><br class="example-break">
    384. 

  384.     			</li></ul></div>
    385. 

  385.     	</div>
    386. 

  386.     	
    387. 

  387.     	
    388. 

  388.     	
    389. 

  389.     	<div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="d6e216"></a>java_s_method_exec(method, method_signature, [param1[, param2[, ...]]])</h3></div></div></div>
    390. 

  390.     		
    391. 

  391.     		<p>Executes a java class synchronized method <span class="emphasis"><em>method</em></span>. Parameter <span class="emphasis"><em>method_signature</em></span> is required.</p>
    392. 

  392.     		<p>For more info see <a class="ulink" href="http://docs.oracle.com/javase/tutorial/essential/concurrency/syncmeth.html" target="_top"><em class="citetitle">Synchronized Methods</em></a></p>
    393. 

  393.     		<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
    394. 

  394.     				<div class="example"><a name="d6e226"></a><p class="title"><b>Example&nbsp;1.14.&nbsp;Signature: "V"</b></p><div class="example-contents">
    395. 

  395.     					
    396. 

  396.     					<p>Kamailio prototype</p>
    397. 

  397.     					<pre class="programlisting">java_s_method_exec("ExampleMethod", "V");</pre>
    398. 

  398.     					<p>Java prototype</p>
    399. 

  399.     					<pre class="programlisting">public synchronized int ExampleMethod();</pre>
    400. 

  400.     					<p>Example of usage:</p>
    401. 

  401.     					<pre class="programlisting">
    402. 

  402. # Kamailio
    403. 

  403. java_s_method_exec("ExampleMethod", "V");
    404. 

  404. 

  405. # Java
    406. 

  406. public synchronized int ExampleMethod()
    407. 

  407. {
    408. 

  408. 		... do something;
    409. 

  409. 		return 1;
    410. 

  410. }
    411. 

  411. </pre>
    412. 

  412.     				</div></div><br class="example-break">
    413. 

  413.     			</li><li class="listitem">
    414. 

  414.     				<div class="example"><a name="d6e235"></a><p class="title"><b>Example&nbsp;1.15.&nbsp;Signature: "Ljava/lang/String;I"</b></p><div class="example-contents">
    415. 

  415.     					
    416. 

  416.     					<p>Kamailio prototype</p>
    417. 

  417.     					<pre class="programlisting">java_s_method_exec("ExampleMethod", "Ljava/lang/String;I", "Hello world", "5");</pre>
    418. 

  418.     					<p>Java prototype</p>
    419. 

  419.     					<pre class="programlisting">public synchronized int ExampleMethod(String param1, int param2);</pre>
    420. 

  420.     					<p>In the above scenario parameter 2 ("5") will be cast to integer representation.</p>
    421. 

  421.     					<p>Example of usage:</p>
    422. 

  422.     					<pre class="programlisting">
    423. 

  423. # Kamailio
    424. 

  424. java_s_method_exec("ExampleMethod", "Ljava/lang/String;I", "$mb", "$ml");
    425. 

  425. 

  426. # Java
    427. 

  427. public synchronized int ExampleMethod(String SipMessageBuffer, int SipMessageLenght)
    428. 

  428. {
    429. 

  429. 		... do something with buffer;
    430. 

  430. 		return 1;
    431. 

  431. }
    432. 

  432. </pre>
    433. 

  433.     				</div></div><br class="example-break">
    434. 

  434.     			</li><li class="listitem">
    435. 

  435.     				<div class="example"><a name="d6e245"></a><p class="title"><b>Example&nbsp;1.16.&nbsp;Signature: "ZB"</b></p><div class="example-contents">
    436. 

  436.     					
    437. 

  437.     					<p>Kamailio prototype</p>
    438. 

  438.     					<pre class="programlisting">java_s_method_exec("ExampleMethod", "ZB", "true", "0x05");</pre>
    439. 

  439.     					<p>Java prototype</p>
    440. 

  440.     					<pre class="programlisting">public synchronized int ExampleMethod(boolean param1, byte param2);</pre>
    441. 

  441.     					<p>In the above scenario parameter 1 ("true") will be cast to boolean representation.</p>
    442. 

  442.     					<p>Example of usage:</p>
    443. 

  443.     					<pre class="programlisting">
    444. 

  444. # Kamailio
    445. 

  445. java_s_method_exec("ExampleMethod", "ZB", "true", "0x05");
    446. 

  446. 

  447. # Java
    448. 

  448. public synchronized int ExampleMethod(boolean flagSet, byte bFlag);
    449. 

  449. {
    450. 

  450. 		if (flagSet)
    451. 

  451. 		{
    452. 

  452. 			... do something with flags;
    453. 

  453. 		}
    454. 

  454. 		return 1;
    455. 

  455. }
    456. 

  456. </pre>
    457. 

  457.     				</div></div><br class="example-break">
    458. 

  458.     			</li></ul></div>
    459. 

  459.     	</div>
    460. 

  460.     	
    461. 

  461.     	
    462. 

  462.     	
    463. 

  463.     	<div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="d6e254"></a>java_s_staticmethod_exec(method, method_signature, [param1[, param2[, ...]]])</h3></div></div></div>
    464. 

  464.     		
    465. 

  465.     		<p>Executes a java synchronized static method <span class="emphasis"><em>method</em></span>. Parameter <span class="emphasis"><em>method_signature</em></span> is required.</p>
    466. 

  466.     		<p>For more info see <a class="ulink" href="http://docs.oracle.com/javase/tutorial/essential/concurrency/syncmeth.html" target="_top"><em class="citetitle">Synchronized Methods</em></a></p>
    467. 

  467.     		<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
    468. 

  468.     				<div class="example"><a name="d6e264"></a><p class="title"><b>Example&nbsp;1.17.&nbsp;Signature: "V"</b></p><div class="example-contents">
    469. 

  469.     					
    470. 

  470.     					<p>Kamailio prototype</p>
    471. 

  471.     					<pre class="programlisting">java_s_staticmethod_exec("ExampleMethod", "V");</pre>
    472. 

  472.     					<p>Java prototype</p>
    473. 

  473.     					<pre class="programlisting">public static synchronized int ExampleMethod();</pre>
    474. 

  474.     					<p>Example of usage:</p>
    475. 

  475.     					<pre class="programlisting">
    476. 

  476. # Kamailio
    477. 

  477. java_s_staticmethod_exec("ExampleMethod", "V");
    478. 

  478. 

  479. # Java
    480. 

  480. public static synchronized int ExampleMethod()
    481. 

  481. {
    482. 

  482. 		... do something;
    483. 

  483. 		return 1;
    484. 

  484. }
    485. 

  485. </pre>
    486. 

  486.     				</div></div><br class="example-break">
    487. 

  487.     			</li><li class="listitem">
    488. 

  488.     				<div class="example"><a name="d6e273"></a><p class="title"><b>Example&nbsp;1.18.&nbsp;Signature: "Ljava/lang/String;I"</b></p><div class="example-contents">
    489. 

  489.     					
    490. 

  490.     					<p>Kamailio prototype</p>
    491. 

  491.     					<pre class="programlisting">java_s_staticmethod_exec("ExampleMethod", "Ljava/lang/String;I", "Hello world", "5");</pre>
    492. 

  492.     					<p>Java prototype</p>
    493. 

  493.     					<pre class="programlisting">public static synchronized int ExampleMethod(String param1, int param2);</pre>
    494. 

  494.     					<p>In the above scenario parameter 2 ("5") will be cast to integer representation.</p>
    495. 

  495.     					<p>Example of usage:</p>
    496. 

  496.     					<pre class="programlisting">
    497. 

  497. # Kamailio
    498. 

  498. java_s_staticmethod_exec("ExampleMethod", "Ljava/lang/String;I", "$mb", "$ml");
    499. 

  499. 

  500. # Java
    501. 

  501. public static synchronized int ExampleMethod(String SipMessageBuffer, int SipMessageLenght)
    502. 

  502. {
    503. 

  503. 		... do something with buffer;
    504. 

  504. 		return 1;
    505. 

  505. }
    506. 

  506. </pre>
    507. 

  507.     				</div></div><br class="example-break">
    508. 

  508.     			</li><li class="listitem">
    509. 

  509.     				<div class="example"><a name="d6e283"></a><p class="title"><b>Example&nbsp;1.19.&nbsp;Signature: "ZB"</b></p><div class="example-contents">
    510. 

  510.     					
    511. 

  511.     					<p>Kamailio prototype</p>
    512. 

  512.     					<pre class="programlisting">java_s_staticmethod_exec("ExampleMethod", "ZB", "true", "0x05");</pre>
    513. 

  513.     					<p>Java prototype</p>
    514. 

  514.     					<pre class="programlisting">public static synchronized int ExampleMethod(boolean param1, byte param2);</pre>
    515. 

  515.     					<p>In the above scenario parameter 1 ("true") will be cast to boolean representation.</p>
    516. 

  516.     					<p>Example of usage:</p>
    517. 

  517.     					<pre class="programlisting">
    518. 

  518. # Kamailio
    519. 

  519. java_s_staticmethod_exec("ExampleMethod", "ZB", "true", "0x05");
    520. 

  520. 

  521. # Java
    522. 

  522. public static synchronized int ExampleMethod(boolean flagSet, byte bFlag);
    523. 

  523. {
    524. 

  524. 		if (flagSet)
    525. 

  525. 		{
    526. 

  526. 			... do something with flags;
    527. 

  527. 		}
    528. 

  528. 		return 1;
    529. 

  529. }
    530. 

  530. </pre>
    531. 

  531.     				</div></div><br class="example-break">
    532. 

  532.     			</li></ul></div>
    533. 

  533.     	</div>
    534. 

  534.     	
    535. 

  535. 

  536.     </div>
    537. 

  537. 	
    538. 

  538. 	
    539. 

  539. 	
    540. 

  540.     <div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d6e292"></a>Java Module API</h2></div></div></div>
    541. 

  541. 		
    542. 

  542.     	<p></p>
    543. 

  543.     	
    544. 

  544.     	
    545. 

  545.     	<div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="d6e295"></a>Minimal program skeleton</h3></div></div></div>
    546. 

  546.     		
    547. 

  547.     		<p></p>
    548. 

  548.     		<div class="example"><a name="d6e298"></a><p class="title"><b>Example&nbsp;1.20.&nbsp;Minimal program skeleton</b></p><div class="example-contents">
    549. 

  549.     			
    550. 

  550.     			<p></p>
    551. 

  551.     			<pre class="programlisting">
    552. 

  552. import org.siprouter.*;
    553. 

  553. import org.siprouter.NativeInterface.*;
    554. 

  554. 

  555. public class Kamailio extends NativeMethods
    556. 

  556. {
    557. 

  557. 		/* Here you should specify a full path to app_java.so */
    558. 

  558. 		static
    559. 

  559. 		{
    560. 

  560. 				System.load("/opt/kamailio/lib/kamailio/modules/app_java.so");
    561. 

  561. 		}
    562. 

  562. 

  563. 		/* Constructor. Do not remove !!! */
    564. 

  564. 		public Kamailio()
    565. 

  565. 		{
    566. 

  566. 		}
    567. 

  567. 

  568. 		/*
    569. 

  569. 		This method should be executed for each children process, immediately after forking.
    570. 

  570. 		Required. Do not remove !!!
    571. 

  571. 		*/
    572. 

  572. 		public int child_init(int rank)
    573. 

  573. 		{
    574. 

  574. 				return 1;
    575. 

  575. 		}
    576. 

  576. }
    577. 

  577. </pre>
    578. 

  578.     		</div></div><br class="example-break">
    579. 

  579.     	</div>
    580. 

  580.     	
    581. 

  581.     	
    582. 

  582.     </div>
    583. 

  583. 	
    584. 

  584. 	
    585. 

  585. </div></body></html>
    586.