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

Interface RoutingRuleRemove

  • All Superinterfaces:
    Cloneable, DiameterAvp, GroupedAvp
    public interface RoutingRuleRemove
extends GroupedAvp
    Defines an interface representing the Routing-Rule-Remove grouped AVP type. From the Diameter Gx Reference Point Protocol Details (3GPP TS 29.212 V10.1.0) specification: 
     5.3.69 Routing-Rule-Remove AVP
 
     The Routing-Rule-Remove AVP (AVP code 1075) is of type Grouped, and it is used to remove IP flow mobility
     routing rules for an IP CAN session from the PCRF.
 
     Routing-Rule-Identifier AVP is a reference for a specific IP flow mobility routing rule at the PCRF to be removed.
 
     AVP Format:
 
     Routing-Rule-Remove ::= < AVP Header: 1075 >
                             *[ Routing-Rule-Identifier ]
                             *[ AVP ]

    • Method Detail

      • getRoutingRuleIdentifiers

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

      • setRoutingRuleIdentifier

        void setRoutingRuleIdentifier​(byte[] routingRuleIdentifier)
        Sets a single Routing-Rule-Identifier AVP in the Routing-Rule-Remove AVP, of type OctetString.
        Throws:
        NullPointerException - if routingRuleIdentifier is null.

      • setRoutingRuleIdentifiers

        void setRoutingRuleIdentifiers​(byte[][] routingRuleIdentifiers)
        Sets the set of Routing-Rule-Identifier AVPs, with all the values in the given array. The AVPs will be added to the Routing-Rule-Remove 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 getRoutingRuleIdentifiers() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
        Throws:
        NullPointerException - if routingRuleIdentifiers is null.

      • removeRoutingRuleIdentifiers

        void removeRoutingRuleIdentifiers()
        Removes all Routing-Rule-Identifier AVPs from the Routing-Rule-Remove AVP. If no Routing-Rule-Identifier 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 Routing-Rule-Remove 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 Routing-Rule-Remove 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 Routing-Rule-Remove AVP. If no extension AVPs are present, this method returns silently.