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

Interface TdfInformation

  • All Superinterfaces:
    Cloneable, DiameterAvp, GroupedAvp
    public interface TdfInformation
extends GroupedAvp
    Defines an interface representing the TDF-Information grouped AVP type. From the Diameter Gx Reference Point Protocol Details (3GPP TS 29.212 V11.9.0) specification: 
     5.3.78  TDF-Information
     The TDF-Information AVP (AVP code 1087) is of type Grouped and may be sent from the PCEF to the PCRF in a Gx CCR with
     CC-Request-Type set to INITIAL-REQUEST. This AVP contains the information about the TDF that shall handle the application
     detection and reporting for that IP-CAN Session. The PCRF shall create the TDF session with that TDF.
 
     The TDF-Information AVP shall include either the TDF-Destination-Realm and TDF-Destination-Host AVP, or the TDF-IP-Address AVP.
 
     NOTE:  The TDF-Information AVP may also be pre-provisioned in the PCRF. In case the TDF-Information AVP pre-provisioned at
     the PCRF and not received from the PCEF, it is being handled e.g. by configuration that PCEF routes the traffic to the same
     TDF. In case the TDF-Information is pre-provisioned in the PCRF and also the value is received in CC-Request from the PCEF,
     the value received in CC-Request takes precedence over pre-provisioned value.
 
     AVP Format:
 
     TDF-Information ::= < AVP Header: 1087 >
                         [ TDF-Destination-Realm ] 
                         [ TDF-Destination-Host ]
                         [ TDF-IP-Address ]
    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

      • hasTdfDestinationRealm

        boolean hasTdfDestinationRealm()
        Returns true if the TDF-Destination-Realm AVP is present in the TDF-Information AVP.

      • getTdfDestinationRealm

        DiameterIdentity getTdfDestinationRealm()
        Returns the value of the TDF-Destination-Realm AVP, of type DiameterIdentity.
        Returns:
        the value of the TDF-Destination-Realm AVP, or null if it has not been set.

      • setTdfDestinationRealm

        void setTdfDestinationRealm​(DiameterIdentity tdfDestinationRealm)
        Sets the value of the TDF-Destination-Realm AVP, of type DiameterIdentity.
        Throws:
        NullPointerException - if tdfDestinationRealm is null.

      • removeTdfDestinationRealm

        void removeTdfDestinationRealm()
        Removes the TDF-Destination-Realm AVP from the TDF-Information AVP. If the TDF-Destination-Realm AVP is not present, this method returns silently.

      • hasTdfDestinationHost

        boolean hasTdfDestinationHost()
        Returns true if the TDF-Destination-Host AVP is present in the TDF-Information AVP.

      • getTdfDestinationHost

        DiameterIdentity getTdfDestinationHost()
        Returns the value of the TDF-Destination-Host AVP, of type DiameterIdentity.
        Returns:
        the value of the TDF-Destination-Host AVP, or null if it has not been set.

      • setTdfDestinationHost

        void setTdfDestinationHost​(DiameterIdentity tdfDestinationHost)
        Sets the value of the TDF-Destination-Host AVP, of type DiameterIdentity.
        Throws:
        NullPointerException - if tdfDestinationHost is null.

      • removeTdfDestinationHost

        void removeTdfDestinationHost()
        Removes the TDF-Destination-Host AVP from the TDF-Information AVP. If the TDF-Destination-Host AVP is not present, this method returns silently.

      • hasTdfIpAddress

        boolean hasTdfIpAddress()
        Returns true if the TDF-IP-Address AVP is present in the TDF-Information AVP.

      • getTdfIpAddress

        DiameterIdentity getTdfIpAddress()
        Returns the value of the TDF-IP-Address AVP, of type DiameterIdentity.
        Returns:
        the value of the TDF-IP-Address AVP, or null if it has not been set.

      • setTdfIpAddress

        void setTdfIpAddress​(DiameterIdentity tdfIpAddress)
        Sets the value of the TDF-IP-Address AVP, of type DiameterIdentity.
        Throws:
        NullPointerException - if tdfIpAddress is null.

      • removeTdfIpAddress

        void removeTdfIpAddress()
        Removes the TDF-IP-Address AVP from the TDF-Information AVP. If the TDF-IP-Address 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 TDF-Information 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 TDF-Information 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 TDF-Information AVP. If no extension AVPs are present, this method returns silently.