Package org.jainslee.resources.diameter.gx.types.va10

Interface AccessNetworkChargingIdentifierGx

  • All Superinterfaces:
    Cloneable, DiameterAvp, GroupedAvp
    public interface AccessNetworkChargingIdentifierGx
extends GroupedAvp
    Defines an interface representing the Access-Network-Charging-Identifier-Gx grouped AVP type. From the Diameter Gx Reference Point Protocol Details (3GPP TS 29.212 V10.1.0) specification: 
     5.3.22  Access-Network-Charging-Identifier-Gx
 
     The Access-Network-Charging-Identifier-Gx AVP (AVP code 1022) is of type Grouped. It contains a charging identifier (e.g. GCID) within the Access-Network-Charging-Identifier-Value AVP and the related PCC rule name(s) within the Charging-Rule-Name AVP(s) and/or within the Charging-Rule-Base-Name AVP(s). If the IP CAN session contains only a single IP CAN bearer, no Charging-Rule-Name AVPs or Charging-Rule-Base-Name AVPs need to be provided. Otherwise, all the Charging-Rule-Name AVPs or Charging-Rule-Base-Name AVPs corresponding to PCC rules activated or installed within the IP CAN bearer corresponding to the provided Access-Network-Charging-Identifier-Value shall be included.
     The Access-Network-Charging-Identifier-Gx AVP can be sent from the PCEF to the PCRF. The PCRF may use this information for charging correlation towards the AF.
 
     It has the following ABNF grammar:
 
     Access-Network-Charging-Identifier-Gx ::=   < AVP Header: 1022 >
                                                  { Access-Network-Charging-Identifier-Value}
                                                 *[ Charging-Rule-Base-Name ]
                                                 *[ Charging-Rule-Name ]
    Note:
    The support for extension AVPs is present even thou the ABNF grammar for this AVP does not contain the "* [ AVP ]" line. Be aware that adding any extension AVPs may result in interoperability problems with products that strongly validate the incoming diameter message for it's adherence to the specification.

    • Method Detail

      • hasAccessNetworkChargingIdentifierValue

        boolean hasAccessNetworkChargingIdentifierValue()
        Returns true if the Access-Network-Charging-Identifier-Value AVP is present in the Access-Network-Charging-Identifier-Gx AVP.

      • getAccessNetworkChargingIdentifierValue

        byte[] getAccessNetworkChargingIdentifierValue()
        Returns the value of the Access-Network-Charging-Identifier-Value AVP, of type OctetString.
        Returns:
        the value of the Access-Network-Charging-Identifier-Value AVP, or null if it has not been set.

      • setAccessNetworkChargingIdentifierValue

        void setAccessNetworkChargingIdentifierValue​(byte[] accessNetworkChargingIdentifierValue)
        Sets the value of the Access-Network-Charging-Identifier-Value AVP, of type OctetString.
        Throws:
        NullPointerException - if accessNetworkChargingIdentifierValue is null.

      • removeAccessNetworkChargingIdentifierValue

        void removeAccessNetworkChargingIdentifierValue()
        Removes the Access-Network-Charging-Identifier-Value AVP from the Access-Network-Charging-Identifier-Gx AVP. If the Access-Network-Charging-Identifier-Value AVP is not present, this method returns silently.

      • getChargingRuleBaseNames

        String[] getChargingRuleBaseNames()
        Returns the set of Charging-Rule-Base-Name AVPs. The returned array contains the AVPs in the order they appear in the Access-Network-Charging-Identifier-Gx AVP. A return value of null implies that no Charging-Rule-Base-Name AVPs have been set. The elements in the given array are String objects.

      • setChargingRuleBaseName

        void setChargingRuleBaseName​(String chargingRuleBaseName)
        Sets a single Charging-Rule-Base-Name AVP in the Access-Network-Charging-Identifier-Gx AVP, of type UTF8String.
        Throws:
        NullPointerException - if chargingRuleBaseName is null.

      • setChargingRuleBaseNames

        void setChargingRuleBaseNames​(String[] chargingRuleBaseNames)
        Sets the set of Charging-Rule-Base-Name AVPs, with all the values in the given array. The AVPs will be added to the Access-Network-Charging-Identifier-Gx AVP in the order in which they appear in the array. Note: the array must not be altered by the caller following this call, and getChargingRuleBaseNames() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
        Throws:
        NullPointerException - if chargingRuleBaseNames is null.

      • removeChargingRuleBaseNames

        void removeChargingRuleBaseNames()
        Removes all Charging-Rule-Base-Name AVPs from the Access-Network-Charging-Identifier-Gx AVP. If no Charging-Rule-Base-Name AVPs are present, this method returns silently.

      • getChargingRuleNames

        byte[][] getChargingRuleNames()
        Returns the set of Charging-Rule-Name AVPs. The returned array contains the AVPs in the order they appear in the Access-Network-Charging-Identifier-Gx AVP. A return value of null implies that no Charging-Rule-Name AVPs have been set. The elements in the given array are byte[] objects.

      • setChargingRuleName

        void setChargingRuleName​(byte[] chargingRuleName)
        Sets a single Charging-Rule-Name AVP in the Access-Network-Charging-Identifier-Gx AVP, of type OctetString.
        Throws:
        NullPointerException - if chargingRuleName is null.

      • setChargingRuleNames

        void setChargingRuleNames​(byte[][] chargingRuleNames)
        Sets the set of Charging-Rule-Name AVPs, with all the values in the given array. The AVPs will be added to the Access-Network-Charging-Identifier-Gx AVP in the order in which they appear in the array. Note: the array must not be altered by the caller following this call, and getChargingRuleNames() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
        Throws:
        NullPointerException - if chargingRuleNames is null.

      • removeChargingRuleNames

        void removeChargingRuleNames()
        Removes all Charging-Rule-Name AVPs from the Access-Network-Charging-Identifier-Gx AVP. If no Charging-Rule-Name AVPs are present, this method returns silently.

      • getExtensionAvps

        DiameterAvp[] getExtensionAvps()
        Returns the set of extension AVPs. The returned array contains the extension AVPs in the order they appear in the Access-Network-Charging-Identifier-Gx AVP. A return value of null implies that no extensions AVPs have been set.

      • setExtensionAvps

        void setExtensionAvps​(DiameterAvp[] avps)
               throws AvpNotAllowedException
        Sets the set of extension AVPs with all the values in the given array. The AVPs will be added to Access-Network-Charging-Identifier-Gx AVP in the order in which they appear in the array. Note: the array must not be altered by the caller following this call, and getExtensionAvps() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
        Throws:
        AvpNotAllowedException - if an AVP is encountered of a type already known to this class (i.e. an AVP for which get/set methods already appear in this class)
        NullPointerException - if avps is null.

      • removeExtensionAvps

        void removeExtensionAvps()
        Removes all extension AVPs from the Access-Network-Charging-Identifier-Gx AVP. If no extension AVPs are present, this method returns silently.