Interface TransmitterInfo

  • All Superinterfaces:
    Cloneable, DiameterAvp, GroupedAvp

    public interface TransmitterInfo
    extends GroupedAvp
    Defines an interface representing the Transmitter-Info grouped AVP type. From the Diameter Ro Reference Point Protocol Details (3GPP TS 32.299 V12.11.0) specification:
     7.2.233 C    Transmitter-Info AVP
     
     The Transmitter-Info AVP (AVP code 3468) is of type Grouped and provides information on a transmitter detected for direct communication. Each transmitter is identified by a source IP address and ProSe UE ID.
     It has the following ABNF grammar:
     
         Transmitter-Info ::= < AVP Header: 3468>
                                 [ ProSe-Source-IP-Address ]
                                 [ ProSe-UE-ID ]
     
    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

      • hasProseSourceIpAddress

        boolean hasProseSourceIpAddress()
        Returns true if the ProSe-Source-IP-Address AVP is present in the Transmitter-Info AVP.
      • getProseSourceIpAddress

        Address getProseSourceIpAddress()
        Returns the value of the ProSe-Source-IP-Address AVP, of type Address.
        Returns:
        the value of the ProSe-Source-IP-Address AVP, or null if it has not been set.
      • setProseSourceIpAddress

        void setProseSourceIpAddress​(Address proseSourceIpAddress)
        Sets the value of the ProSe-Source-IP-Address AVP, of type Address.
        Throws:
        NullPointerException - if proseSourceIpAddress is null.
      • removeProseSourceIpAddress

        void removeProseSourceIpAddress()
        Removes the ProSe-Source-IP-Address AVP from the Transmitter-Info AVP. If the ProSe-Source-IP-Address AVP is not present, this method returns silently.
      • hasProseUeId

        boolean hasProseUeId()
        Returns true if the ProSe-UE-ID AVP is present in the Transmitter-Info AVP.
      • getProseUeId

        byte[] getProseUeId()
        Returns the value of the ProSe-UE-ID AVP, of type OctetString.
        Returns:
        the value of the ProSe-UE-ID AVP, or null if it has not been set.
      • setProseUeId

        void setProseUeId​(byte[] proseUeId)
        Sets the value of the ProSe-UE-ID AVP, of type OctetString.
        Throws:
        NullPointerException - if proseUeId is null.
      • removeProseUeId

        void removeProseUeId()
        Removes the ProSe-UE-ID AVP from the Transmitter-Info AVP. If the ProSe-UE-ID 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 Transmitter-Info 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 Transmitter-Info 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 Transmitter-Info AVP. If no extension AVPs are present, this method returns silently.