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

Interface RoutingFilter

  • All Superinterfaces:
    Cloneable, DiameterAvp, GroupedAvp
    public interface RoutingFilter
extends GroupedAvp
    Defines an interface representing the Routing-Filter grouped AVP type. From the Diameter Gx Reference Point Protocol Details (3GPP TS 29.212 V10.1.0) specification: 
     5.3.72 Routing-Filter
 
     The Routing-Filter AVP (AVP code 1078) is of type Grouped and is sent from the PCEF to the PCRF. This AVP
     contains the information for a single routing filter.
 
     The Routing-Filter AVP shall include the Flow-Direction AVP with value set to "BIDIRECTIONAL". The direction
     information contained in the Flow-Description AVP shall be "out".
 
     The routing filter may be wild carded by omitting ToS-Traffice-Class AVP, Security-Parameter-Index AVP, and Flow-
     Label AVP, setting Flow-Direction AVP to the value "BIDIRECTIONAL", setting Flow-Description AVP to the value
     "permit out ip from any to any".
 
     The Routing-Filter AVP may also include the Type-of-Service/Traffic Class, the IPSec SPI, and the Flow Label. The
     values of these AVPs are obtained from the routing information provided to the PCEF.
 
     AVP Format:
 
     Routing-Filter ::= < AVP Header: 1078 >
                         { Flow-Description }
                         { Flow-Direction }
                         [ ToS-Traffic-Class ]
                         [ Security-Parameter-Index ]
                         [ Flow-Label ]
                        *[ AVP ]

    • Method Detail

      • hasFlowDescription

        boolean hasFlowDescription()
        Returns true if the Flow-Description AVP is present in the Routing-Filter AVP.

      • getFlowDescription

        IPFilterRule getFlowDescription()
        Returns the value of the Flow-Description AVP, of type IPFilterRule.
        Returns:
        the value of the Flow-Description AVP, or null if it has not been set.

      • setFlowDescription

        void setFlowDescription​(IPFilterRule flowDescription)
        Sets the value of the Flow-Description AVP, of type IPFilterRule.
        Throws:
        NullPointerException - if flowDescription is null.

      • removeFlowDescription

        void removeFlowDescription()
        Removes the Flow-Description AVP from the Routing-Filter AVP. If the Flow-Description AVP is not present, this method returns silently.

      • hasFlowDirection

        boolean hasFlowDirection()
        Returns true if the Flow-Direction AVP is present in the Routing-Filter AVP.

      • getFlowDirection

        FlowDirection getFlowDirection()
        Returns the value of the Flow-Direction AVP, of type Enumerated.
        Returns:
        the value of the Flow-Direction AVP, or null if it has not been set.

      • setFlowDirection

        void setFlowDirection​(FlowDirection flowDirection)
        Sets the value of the Flow-Direction AVP, of type Enumerated.
        Throws:
        NullPointerException - if flowDirection is null.

      • removeFlowDirection

        void removeFlowDirection()
        Removes the Flow-Direction AVP from the Routing-Filter AVP. If the Flow-Direction AVP is not present, this method returns silently.

      • hasTosTrafficClass

        boolean hasTosTrafficClass()
        Returns true if the ToS-Traffic-Class AVP is present in the Routing-Filter AVP.

      • getTosTrafficClass

        byte[] getTosTrafficClass()
        Returns the value of the ToS-Traffic-Class AVP, of type OctetString.
        Returns:
        the value of the ToS-Traffic-Class AVP, or null if it has not been set.

      • setTosTrafficClass

        void setTosTrafficClass​(byte[] tosTrafficClass)
        Sets the value of the ToS-Traffic-Class AVP, of type OctetString.
        Throws:
        NullPointerException - if tosTrafficClass is null.

      • removeTosTrafficClass

        void removeTosTrafficClass()
        Removes the ToS-Traffic-Class AVP from the Routing-Filter AVP. If the ToS-Traffic-Class AVP is not present, this method returns silently.

      • hasSecurityParameterIndex

        boolean hasSecurityParameterIndex()
        Returns true if the Security-Parameter-Index AVP is present in the Routing-Filter AVP.

      • getSecurityParameterIndex

        byte[] getSecurityParameterIndex()
        Returns the value of the Security-Parameter-Index AVP, of type OctetString.
        Returns:
        the value of the Security-Parameter-Index AVP, or null if it has not been set.

      • setSecurityParameterIndex

        void setSecurityParameterIndex​(byte[] securityParameterIndex)
        Sets the value of the Security-Parameter-Index AVP, of type OctetString.
        Throws:
        NullPointerException - if securityParameterIndex is null.

      • removeSecurityParameterIndex

        void removeSecurityParameterIndex()
        Removes the Security-Parameter-Index AVP from the Routing-Filter AVP. If the Security-Parameter-Index AVP is not present, this method returns silently.

      • hasFlowLabel

        boolean hasFlowLabel()
        Returns true if the Flow-Label AVP is present in the Routing-Filter AVP.

      • getFlowLabel

        byte[] getFlowLabel()
        Returns the value of the Flow-Label AVP, of type OctetString.
        Returns:
        the value of the Flow-Label AVP, or null if it has not been set.

      • setFlowLabel

        void setFlowLabel​(byte[] flowLabel)
        Sets the value of the Flow-Label AVP, of type OctetString.
        Throws:
        NullPointerException - if flowLabel is null.

      • removeFlowLabel

        void removeFlowLabel()
        Removes the Flow-Label AVP from the Routing-Filter AVP. If the Flow-Label AVP is not 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-Filter 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-Filter 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-Filter AVP. If no extension AVPs are present, this method returns silently.