PageRenderTime 76ms CodeModel.GetById 0ms RepoModel.GetById 1ms app.codeStats 0ms

/servers/jain-slee/resources/diameter-gx/events/src/main/java/net/java/slee/resource/diameter/gx/events/GxReAuthMessage.java

http://mobicents.googlecode.com/
Java | 89 lines | 11 code | 11 blank | 67 comment | 0 complexity | 2a4e7550cafeb93ac77572a089668ea3 MD5 | raw file
Possible License(s): LGPL-3.0, GPL-3.0, LGPL-2.1, GPL-2.0, CC-BY-SA-3.0, CC0-1.0, Apache-2.0, BSD-3-Clause 
    

  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. package net.java.slee.resource.diameter.gx.events;
    24. 

  24. 

  25. import net.java.slee.resource.diameter.base.events.DiameterMessage;
    26. 

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

  27. 

  28. 

  29. /**
    30. 

  30.  * Base interface for RoReAuthMessage
    31. 

  31.  *
    32. 

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

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

  34.  * @author <a href="mailto:carl-magnus.bjorkell@emblacom.com"> Carl-Magnus Bj??rkell </a>
    35. 

  35.  */
    36. 

  36. public interface GxReAuthMessage extends DiameterMessage {
    37. 

  37. 

  38.   /**
    39. 

  39.    * Returns the value of the Auth-Application-Id AVP, of type Unsigned32.
    40. 

  40.    *
    41. 

  41.    * @return
    42. 

  42.    */
    43. 

  43.   long getAuthApplicationId();
    44. 

  44. 

  45.   /**
    46. 

  46.    * Sets the value of the Auth-Application-Id AVP, of type Unsigned32.
    47. 

  47.    *
    48. 

  48.    * @param authApplicationId
    49. 

  49.    * @throws IllegalStateException
    50. 

  50.    */
    51. 

  51.   void setAuthApplicationId(long authApplicationId) throws IllegalStateException;
    52. 

  52. 

  53.   /**
    54. 

  54.    * Returns true if the Auth-Application-Id AVP is present in the message.
    55. 

  55.    *
    56. 

  56.    * @return
    57. 

  57.    */
    58. 

  58.   boolean hasAuthApplicationId();
    59. 

  59. 

  60.   /**
    61. 

  61.    * Returns the value of the CC-Request-Number AVP, of type Unsigned32.
    62. 

  62.    *
    63. 

  63.    * @return
    64. 

  64.    */
    65. 

  65.   
    66. 

  66.   /**
    67. 

  67.    * Returns the set of Route-Record AVPs.
    68. 

  68.    *
    69. 

  69.    * @return
    70. 

  70.    */
    71. 

  71.   DiameterIdentity[] getRouteRecords();
    72. 

  72. 

  73.   /**
    74. 

  74.    * Sets a single Route-Record AVP in the message, of type DiameterIdentity.
    75. 

  75.    *
    76. 

  76.    * @param routeRecord
    77. 

  77.    * @throws IllegalStateException
    78. 

  78.    */
    79. 

  79.   void setRouteRecord(DiameterIdentity routeRecord) throws IllegalStateException;
    80. 

  80. 

  81.   /**
    82. 

  82.    * Sets the set of Route-Record AVPs, with all the values in the given
    83. 

  83.    * array.
    84. 

  84.    *
    85. 

  85.    * @param routeRecords
    86. 

  86.    * @throws IllegalStateException
    87. 

  87.    */
    88. 

  88.   void setRouteRecords(DiameterIdentity[] routeRecords) throws IllegalStateException;
    89. 

  89. }
    90. 

  90.