/servers/jain-slee/resources/diameter-base/common/ratype/src/main/java/net/java/slee/resource/diameter/base/DiameterAvpFactory.java

http://mobicents.googlecode.com/ · Java · 395 lines · 49 code · 41 blank · 305 comment · 0 complexity · 30d3681d6f6fa109e3300e85c07634ad MD5 · raw file 

    

  1. /*

    2. 

  2.  * JBoss, Home of Professional Open Source

    3. 

  3.  * Copyright 2011, Red Hat, Inc. and individual contributors

    4. 

  4.  * by the @authors tag. See the copyright.txt in the distribution for a

    5. 

  5.  * full listing of individual contributors.

    6. 

  6.  *

    7. 

  7.  * This is free software; you can redistribute it and/or modify it

    8. 

  8.  * under the terms of the GNU Lesser General Public License as

    9. 

  9.  * published by the Free Software Foundation; either version 2.1 of

    10. 

  10.  * the License, or (at your option) any later version.

    11. 

  11.  *

    12. 

  12.  * This software is distributed in the hope that it will be useful,

    13. 

  13.  * but WITHOUT ANY WARRANTY; without even the implied warranty of

    14. 

  14.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU

    15. 

  15.  * Lesser General Public License for more details.

    16. 

  16.  *

    17. 

  17.  * You should have received a copy of the GNU Lesser General Public

    18. 

  18.  * License along with this software; if not, write to the Free

    19. 

  19.  * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA

    20. 

  20.  * 02110-1301 USA, or see the FSF site: http://www.fsf.org.

    21. 

  21.  */

    22. 

  22. 

    23. 

  23. package net.java.slee.resource.diameter.base;

    24. 

  24. 

    25. 

  25. import java.util.Date;

    26. 

  26. 

    27. 

  27. import net.java.slee.resource.diameter.base.events.DiameterCommand;

    28. 

  28. import net.java.slee.resource.diameter.base.events.avp.AvpNotAllowedException;

    29. 

  29. import net.java.slee.resource.diameter.base.events.avp.DiameterAvp;

    30. 

  30. import net.java.slee.resource.diameter.base.events.avp.DiameterAvpType;

    31. 

  31. import net.java.slee.resource.diameter.base.events.avp.DiameterIdentity;

    32. 

  32. import net.java.slee.resource.diameter.base.events.avp.ExperimentalResultAvp;

    33. 

  33. import net.java.slee.resource.diameter.base.events.avp.FailedAvp;

    34. 

  34. import net.java.slee.resource.diameter.base.events.avp.ProxyInfoAvp;

    35. 

  35. import net.java.slee.resource.diameter.base.events.avp.VendorSpecificApplicationIdAvp;

    36. 

  36. 

    37. 

  37. /**

    38. 

  38.  * 

    39. 

  39.  * Factory to create instances of {@link DiameterAvp}.

    40. 

  40.  * <p/>

    41. 

  41.  * An implementation of this class should be returned by the

    42. 

  42.  * {@link DiameterProvider#getDiameterAvpFactory()} method.

    43. 

  43.  *

    44. 

  44.  * @author <a href="mailto:brainslog@gmail.com"> Alexandre Mendonca </a>

    45. 

  45.  * @author <a href="mailto:baranowb@gmail.com"> Bartosz Baranowski </a>

    46. 

  46.  */

    47. 

  47. public interface DiameterAvpFactory {

    48. 

  48. 

    49. 

  49.   /**

    50. 

  50.    * Create a value for a Grouped AVP.  Type will always be

    51. 

  51.    * {@link DiameterAvpType#GROUPED}

    52. 

  52.    *

    53. 

  53.    * @param avpCode the code for the AVP

    54. 

  54.    * @param avps an array of DiameterAvp objects

    55. 

  55.    * @return an implementation of the DiameterAvp interface

    56. 

  56.    */

    57. 

  57.   DiameterAvp createAvp(int avpCode, DiameterAvp[] avps) throws NoSuchAvpException, AvpNotAllowedException;

    58. 

  58. 

    59. 

  59.   /**

    60. 

  60.    * Create a value for a vendor-specific Grouped AVP.  Type will always be

    61. 

  61.    * {@link DiameterAvpType#GROUPED}

    62. 

  62.    *

    63. 

  63.    * @param vendorID the IANA-assigned enterprise number of the vendor that specified the AVP (eg. 10415 for 3GPP).

    64. 

  64.    * @param avpCode the code for the AVP

    65. 

  65.    * @param avps an array of DiameterAvp objects

    66. 

  66.    * @return an implementation of the DiameterAvp interface

    67. 

  67.    */

    68. 

  68.   DiameterAvp createAvp(int vendorID, int avpCode, DiameterAvp[] avps) throws NoSuchAvpException, AvpNotAllowedException;

    69. 

  69. 

    70. 

  70.   /**

    71. 

  71.    * Create an AVP containing a DiameterAvpValue from the byte[] value provided.  The

    72. 

  72.    * AVP type will be determined from the AVP code.

    73. 

  73.    *

    74. 

  74.    * @param avpCode the code for the AVP

    75. 

  75.    * @param value the value itself

    76. 

  76.    * @return an implementation of the DiameterAvp interface

    77. 

  77.    */

    78. 

  78.   DiameterAvp createAvp(int avpCode, byte[] value) throws NoSuchAvpException;

    79. 

  79. 

    80. 

  80.   /**

    81. 

  81.    * Create a vendor-specific AVP containing a DiameterAvpValue from the byte[] value provided.

    82. 

  82.    * The AVP type will be determined from the AVP code.

    83. 

  83.    *

    84. 

  84.    * @param vendorID the IANA-assigned enterprise number of the vendor that specified the AVP (eg. 10415 for 3GPP).

    85. 

  85.    * @param avpCode the code for the AVP

    86. 

  86.    * @param value the value itself

    87. 

  87.    * @return an implementation of the DiameterAvp interface

    88. 

  88.    */

    89. 

  89.   DiameterAvp createAvp(int vendorID, int avpCode, byte[] value) throws NoSuchAvpException;

    90. 

  90. 

    91. 

  91.   /**

    92. 

  92.    * Create an AVP containing a DiameterAvpValue from the int value provided.  The

    93. 

  93.    * AVP type will be determined from the AVP code.

    94. 

  94.    *

    95. 

  95.    * @param avpCode the code for the AVP

    96. 

  96.    * @param value the value itself

    97. 

  97.    * @return an implementation of the DiameterAvp interface

    98. 

  98.    */

    99. 

  99.   DiameterAvp createAvp(int avpCode, int value) throws NoSuchAvpException;

    100. 

  100. 

    101. 

  101.   /**

    102. 

  102.    * Create a vendor-specific AVP containing a DiameterAvpValue from the int value provided.

    103. 

  103.    * The AVP type will be determined from the AVP code.

    104. 

  104.    *

    105. 

  105.    * @param vendorID the IANA-assigned enterprise number of the vendor that specified the AVP (eg. 10415 for 3GPP).

    106. 

  106.    * @param avpCode the code for the AVP

    107. 

  107.    * @param value the value itself

    108. 

  108.    * @return an implementation of the DiameterAvp interface

    109. 

  109.    */

    110. 

  110.   DiameterAvp createAvp(int vendorID, int avpCode, int value) throws NoSuchAvpException;

    111. 

  111. 

    112. 

  112.   /**

    113. 

  113.    * Create an AVP containing a DiameterAvpValue from the long value provided.  The

    114. 

  114.    * AVP type will be determined from the AVP code.

    115. 

  115.    *

    116. 

  116.    * @param avpCode the code for the AVP

    117. 

  117.    * @param value the value itself

    118. 

  118.    * @return an implementation of the DiameterAvp interface

    119. 

  119.    */

    120. 

  120.   DiameterAvp createAvp(int avpCode, long value) throws NoSuchAvpException;

    121. 

  121. 

    122. 

  122.   /**

    123. 

  123.    * Create a vendor-specific AVP containing a DiameterAvpValue from the long value provided.

    124. 

  124.    * The AVP type will be determined from the AVP code.

    125. 

  125.    *

    126. 

  126.    * @param vendorID the IANA-assigned enterprise number of the vendor that specified the AVP (eg. 10415 for 3GPP).

    127. 

  127.    * @param avpCode the code for the AVP

    128. 

  128.    * @param value the value itself

    129. 

  129.    * @return an implementation of the DiameterAvp interface

    130. 

  130.    */

    131. 

  131.   DiameterAvp createAvp(int vendorID, int avpCode, long value) throws NoSuchAvpException;

    132. 

  132. 

    133. 

  133.   /**

    134. 

  134.    * Create an AVP containing a DiameterAvpValue from the float value provided.  The

    135. 

  135.    * AVP type will be determined from the AVP code.

    136. 

  136.    *

    137. 

  137.    * @param avpCode the code for the AVP

    138. 

  138.    * @param value the value itself

    139. 

  139.    * @return an implementation of the DiameterAvp interface

    140. 

  140.    */

    141. 

  141.   DiameterAvp createAvp(int avpCode, float value) throws NoSuchAvpException;

    142. 

  142. 

    143. 

  143.   /**

    144. 

  144.    * Create a vendor-specific AVP containing a DiameterAvpValue from the float value provided.

    145. 

  145.    * The AVP type will be determined from the AVP code.

    146. 

  146.    *

    147. 

  147.    * @param vendorID the IANA-assigned enterprise number of the vendor that specified the AVP (eg. 10415 for 3GPP).

    148. 

  148.    * @param avpCode the code for the AVP

    149. 

  149.    * @param value the value itself

    150. 

  150.    * @return an implementation of the DiameterAvp interface

    151. 

  151.    */

    152. 

  152.   DiameterAvp createAvp(int vendorID, int avpCode, float value) throws NoSuchAvpException;

    153. 

  153. 

    154. 

  154.   /**

    155. 

  155.    * Create an AVP containing a DiameterAvpValue from the double value provided.  The

    156. 

  156.    * AVP type will be determined from the AVP code.

    157. 

  157.    *

    158. 

  158.    * @param avpCode the code for the AVP

    159. 

  159.    * @param value the value itself

    160. 

  160.    * @return an implementation of the DiameterAvp interface

    161. 

  161.    */

    162. 

  162.   DiameterAvp createAvp(int avpCode, double value) throws NoSuchAvpException;

    163. 

  163. 

    164. 

  164.   /**

    165. 

  165.    * Create a vendor-specific AVP containing a DiameterAvpValue from the double value provided.

    166. 

  166.    * The AVP type will be determined from the AVP code.

    167. 

  167.    *

    168. 

  168.    * @param vendorID the IANA-assigned enterprise number of the vendor that specified the AVP (eg. 10415 for 3GPP).

    169. 

  169.    * @param avpCode the code for the AVP

    170. 

  170.    * @param value the value itself

    171. 

  171.    * @return an implementation of the DiameterAvp interface

    172. 

  172.    */

    173. 

  173.   DiameterAvp createAvp(int vendorID, int avpCode, double value) throws NoSuchAvpException;

    174. 

  174. 

    175. 

  175.   /**

    176. 

  176.    * Create an AVP containing a DiameterAvpValue from the java.net.InetAddress value provided.  The

    177. 

  177.    * AVP type will be determined from the AVP code.

    178. 

  178.    *

    179. 

  179.    * @param avpCode the code for the AVP

    180. 

  180.    * @param value the value itself

    181. 

  181.    * @return an implementation of the DiameterAvp interface

    182. 

  182.    */

    183. 

  183.   DiameterAvp createAvp(int avpCode, java.net.InetAddress value) throws NoSuchAvpException;

    184. 

  184. 

    185. 

  185.   /**

    186. 

  186.    * Create a vendor-specific AVP containing a DiameterAvpValue from the java.net.InetAddress value provided.

    187. 

  187.    * The AVP type will be determined from the AVP code.

    188. 

  188.    *

    189. 

  189.    * @param vendorID the IANA-assigned enterprise number of the vendor that specified the AVP (eg. 10415 for 3GPP).

    190. 

  190.    * @param avpCode the code for the AVP

    191. 

  191.    * @param value the value itself

    192. 

  192.    * @return an implementation of the DiameterAvp interface

    193. 

  193.    */

    194. 

  194.   DiameterAvp createAvp(int vendorID, int avpCode, java.net.InetAddress value) throws NoSuchAvpException;

    195. 

  195. 

    196. 

  196.   /**

    197. 

  197.    * Create an AVP containing a DiameterAvpValue from the Date value provided.  The

    198. 

  198.    * AVP type will be determined from the AVP code.

    199. 

  199.    *

    200. 

  200.    * @param avpCode the code for the AVP

    201. 

  201.    * @param value the value itself

    202. 

  202.    * @return an implementation of the DiameterAvp interface

    203. 

  203.    */

    204. 

  204.   DiameterAvp createAvp(int avpCode, Date value) throws NoSuchAvpException;

    205. 

  205. 

    206. 

  206.   /**

    207. 

  207.    * Create a vendor-specific AVP containing a DiameterAvpValue from the Date value provided.

    208. 

  208.    * The AVP type will be determined from the AVP code.

    209. 

  209.    *

    210. 

  210.    * @param vendorID the IANA-assigned enterprise number of the vendor that specified the AVP (eg. 10415 for 3GPP).

    211. 

  211.    * @param avpCode the code for the AVP

    212. 

  212.    * @param value the value itself

    213. 

  213.    * @return an implementation of the DiameterAvp interface

    214. 

  214.    */

    215. 

  215.   DiameterAvp createAvp(int vendorID, int avpCode, Date value) throws NoSuchAvpException;

    216. 

  216. 

    217. 

  217.   /**

    218. 

  218.    * Create an AVP containing a DiameterAvpValue from the java.lang.String value provided.  The

    219. 

  219.    * AVP type will be determined from the AVP code.

    220. 

  220.    *

    221. 

  221.    * @param avpCode the code for the AVP

    222. 

  222.    * @param value the value itself

    223. 

  223.    * @return an implementation of the DiameterAvp interface

    224. 

  224.    */

    225. 

  225.   DiameterAvp createAvp(int avpCode, java.lang.String value) throws NoSuchAvpException;

    226. 

  226. 

    227. 

  227.   /**

    228. 

  228.    * Create a vendor-specific AVP containing a DiameterAvpValue from the java.lang.String value provided.

    229. 

  229.    * The AVP type will be determined from the AVP code.

    230. 

  230.    *

    231. 

  231.    * @param vendorID the IANA-assigned enterprise number of the vendor that specified the AVP (eg. 10415 for 3GPP).

    232. 

  232.    * @param avpCode the code for the AVP

    233. 

  233.    * @param value the value itself

    234. 

  234.    * @return an implementation of the DiameterAvp interface

    235. 

  235.    */

    236. 

  236.   DiameterAvp createAvp(int vendorID, int avpCode, java.lang.String value) throws NoSuchAvpException;

    237. 

  237. 

    238. 

  238.   /**

    239. 

  239.    * Create an AVP containing a DiameterAvpValue from the net.java.slee.resource.diameter.base.types.Enumerated value provided.  The

    240. 

  240.    * AVP type will be determined from the AVP code.

    241. 

  241.    *

    242. 

  242.    * @param avpCode the code for the AVP

    243. 

  243.    * @param value the value itself

    244. 

  244.    * @return an implementation of the DiameterAvp interface

    245. 

  245.    */

    246. 

  246.   DiameterAvp createAvp(int avpCode, net.java.slee.resource.diameter.base.events.avp.Enumerated value) throws NoSuchAvpException;

    247. 

  247. 

    248. 

  248.   /**

    249. 

  249.    * Create a vendor-specific AVP containing a DiameterAvpValue from the net.java.slee.resource.diameter.base.types.Enumerated value provided.

    250. 

  250.    * The AVP type will be determined from the AVP code.

    251. 

  251.    *

    252. 

  252.    * @param vendorID the IANA-assigned enterprise number of the vendor that specified the AVP (eg. 10415 for 3GPP).

    253. 

  253.    * @param avpCode the code for the AVP

    254. 

  254.    * @param value the value itself

    255. 

  255.    * @return an implementation of the DiameterAvp interface

    256. 

  256.    */

    257. 

  257.   DiameterAvp createAvp(int vendorID, int avpCode, net.java.slee.resource.diameter.base.events.avp.Enumerated value) throws NoSuchAvpException;

    258. 

  258. 

    259. 

  259.   /**

    260. 

  260.    * Create an instance of a DiameterCommand concrete implementation using

    261. 

  261.    * the given arguments.

    262. 

  262.    *

    263. 

  263.    * @param commandCode the command code of the command

    264. 

  264.    * @param applicationId the application ID of the command

    265. 

  265.    * @param shortName   the short name of the command, e.g., "CER"

    266. 

  266.    * @param longName    the long name of the command, e.g., "Capabilities-Exchange-Request"

    267. 

  267.    * @param isRequest   true if this command represents a request (not answer)

    268. 

  268.    * @param isProxiable true if this command may be proxied

    269. 

  269.    * @return a complete and correct DiameterCommand object to be passed to

    270. 

  270.    *         {@link #createMessage(DiameterCommand, DiameterAvp[] avps)}.

    271. 

  271.    */

    272. 

  272.   DiameterCommand createCommand(int commandCode, int applicationId, String shortName, String longName, boolean isRequest, boolean isProxiable);

    273. 

  273. 

    274. 

  274.   /**

    275. 

  275.    * Create a ProxyInfo (Grouped AVP) instance using required AVP values.

    276. 

  276.    * 

    277. 

  277.    * @param proxyHost

    278. 

  278.    * @param proxyState

    279. 

  279.    * @return

    280. 

  280.    */

    281. 

  281.   ProxyInfoAvp createProxyInfo(DiameterIdentity proxyHost, byte[] proxyState);

    282. 

  282. 

    283. 

  283.   /**

    284. 

  284.    * Create an empty ProxyInfo (Grouped AVP) instance.

    285. 

  285.    * 

    286. 

  286.    * @return

    287. 

  287.    */

    288. 

  288.   ProxyInfoAvp createProxyInfo();

    289. 

  289. 

    290. 

  290.   /**

    291. 

  291.    * Create a ProxyInfo (Grouped AVP) instance, populating one AVP.

    292. 

  292.    * 

    293. 

  293.    * @param avp

    294. 

  294.    * @return

    295. 

  295.    */

    296. 

  296.   ProxyInfoAvp createProxyInfo(DiameterAvp avp);

    297. 

  297. 

    298. 

  298.   /**

    299. 

  299.    * Create a ProxyInfo (Grouped AVP) instance using the given array to populate the AVPs.

    300. 

  300.    * 

    301. 

  301.    * @param avps

    302. 

  302.    * @return

    303. 

  303.    */

    304. 

  304.   ProxyInfoAvp createProxyInfo(DiameterAvp[] avps);

    305. 

  305. 

    306. 

  306.   /**

    307. 

  307.    * Create a VendorSpecificApplicationId (Grouped AVP) instance using required AVP values.

    308. 

  308.    * 

    309. 

  309.    * @param vendorId

    310. 

  310.    * @return

    311. 

  311.    */

    312. 

  312.   VendorSpecificApplicationIdAvp createVendorSpecificApplicationId(long vendorId);

    313. 

  313. 

    314. 

  314.   /**

    315. 

  315.    * Create an empty VendorSpecificApplicationId (Grouped AVP) instance.

    316. 

  316.    * 

    317. 

  317.    * @return

    318. 

  318.    */

    319. 

  319.   VendorSpecificApplicationIdAvp createVendorSpecificApplicationId();

    320. 

  320. 

    321. 

  321.   /**

    322. 

  322.    * Create a VendorSpecificApplicationId (Grouped AVP) instance, populating one AVP.

    323. 

  323.    * 

    324. 

  324.    * @param avp

    325. 

  325.    * @return

    326. 

  326.    * @throws AvpNotAllowedException

    327. 

  327.    */

    328. 

  328.   VendorSpecificApplicationIdAvp createVendorSpecificApplicationId(DiameterAvp avp) throws AvpNotAllowedException;

    329. 

  329. 

    330. 

  330.   /**

    331. 

  331.    * Create a VendorSpecificApplicationId (Grouped AVP) instance using the given array to populate the AVPs.

    332. 

  332.    * 

    333. 

  333.    * @param avps

    334. 

  334.    * @return

    335. 

  335.    * @throws AvpNotAllowedException

    336. 

  336.    */

    337. 

  337.   VendorSpecificApplicationIdAvp createVendorSpecificApplicationId(DiameterAvp[] avps) throws AvpNotAllowedException;

    338. 

  338. 

    339. 

  339.   /**

    340. 

  340.    * Create an empty FailedAvp (Grouped AVP) instance.

    341. 

  341.    * 

    342. 

  342.    * @return

    343. 

  343.    */

    344. 

  344.   FailedAvp createFailedAvp();

    345. 

  345. 

    346. 

  346.   /**

    347. 

  347.    * Create a FailedAvp (Grouped AVP) instance, populating one AVP.

    348. 

  348.    * 

    349. 

  349.    * @param avp

    350. 

  350.    * @return

    351. 

  351.    */

    352. 

  352.   FailedAvp createFailedAvp(DiameterAvp avp);

    353. 

  353. 

    354. 

  354.   /**

    355. 

  355.    * Create a FailedAvp (Grouped AVP) instance using the given array to populate the AVPs.

    356. 

  356.    * 

    357. 

  357.    * @param avps

    358. 

  358.    * @return

    359. 

  359.    */

    360. 

  360.   FailedAvp createFailedAvp(DiameterAvp[] avps);

    361. 

  361. 

    362. 

  362.   /**

    363. 

  363.    * Create a ExperimentalResult (Grouped AVP) instance using required AVP values.

    364. 

  364.    * @param vendorId

    365. 

  365.    * @param experimentalResultCode

    366. 

  366.    * @return

    367. 

  367.    */

    368. 

  368.   ExperimentalResultAvp createExperimentalResult(long vendorId, long experimentalResultCode);

    369. 

  369. 

    370. 

  370.   /**

    371. 

  371.    * Create an empty ExperimentalResult (Grouped AVP) instance.

    372. 

  372.    * 

    373. 

  373.    * @return

    374. 

  374.    */

    375. 

  375.   ExperimentalResultAvp createExperimentalResult();

    376. 

  376. 

    377. 

  377.   /**

    378. 

  378.    * Create a ExperimentalResult (Grouped AVP) instance, populating one AVP.

    379. 

  379.    * 

    380. 

  380.    * @param avp

    381. 

  381.    * @return

    382. 

  382.    * @throws AvpNotAllowedException

    383. 

  383.    */

    384. 

  384.   ExperimentalResultAvp createExperimentalResult(DiameterAvp avp) throws AvpNotAllowedException;

    385. 

  385. 

    386. 

  386.   /**

    387. 

  387.    * Create a ExperimentalResult (Grouped AVP) instance using the given array to populate the AVPs.

    388. 

  388.    * 

    389. 

  389.    * @param avps

    390. 

  390.    * @return

    391. 

  391.    * @throws AvpNotAllowedException

    392. 

  392.    */

    393. 

  393.   ExperimentalResultAvp createExperimentalResult(DiameterAvp[] avps) throws AvpNotAllowedException;

    394. 

  394. 

    395. 

  395. }
    396.