Interface CallReferenceInfo

  • All Superinterfaces:
    Cloneable, DiameterAvp, GroupedAvp

    public interface CallReferenceInfo
    extends GroupedAvp
    Defines an interface representing the Call-Reference-Info grouped AVP type. From the Diameter Sh Reference Point Protocol Details (3GPP TS 29.329 V12.6.0) specification:
     6.3.29      Call-Reference-Info AVP
     
     The Call-Reference-Info AVP is of type Grouped. This AVP shall contain a Call-Reference-Number
     AVP and an AS-Number AVP.
     AVP format
     
     Call-Reference-Info  ::=  < AVP Header: 720 10415 >
                             { Call-Reference-Number }
                             { AS-Number }
                             *[ AVP ]
     
    • Method Detail

      • hasCallReferenceNumber

        boolean hasCallReferenceNumber()
        Returns true if the Call-Reference-Number AVP is present in the Call-Reference-Info AVP.
      • getCallReferenceNumber

        byte[] getCallReferenceNumber()
        Returns the value of the Call-Reference-Number AVP, of type OctetString.
        Returns:
        the value of the Call-Reference-Number AVP, or null if it has not been set.
      • setCallReferenceNumber

        void setCallReferenceNumber​(byte[] callReferenceNumber)
        Sets the value of the Call-Reference-Number AVP, of type OctetString.
        Throws:
        NullPointerException - if callReferenceNumber is null.
      • removeCallReferenceNumber

        void removeCallReferenceNumber()
        Removes the Call-Reference-Number AVP from the Call-Reference-Info AVP. If the Call-Reference-Number AVP is not present, this method returns silently.
      • hasAsNumber

        boolean hasAsNumber()
        Returns true if the AS-Number AVP is present in the Call-Reference-Info AVP.
      • getAsNumber

        byte[] getAsNumber()
        Returns the value of the AS-Number AVP, of type OctetString.
        Returns:
        the value of the AS-Number AVP, or null if it has not been set.
      • setAsNumber

        void setAsNumber​(byte[] asNumber)
        Sets the value of the AS-Number AVP, of type OctetString.
        Throws:
        NullPointerException - if asNumber is null.
      • removeAsNumber

        void removeAsNumber()
        Removes the AS-Number AVP from the Call-Reference-Info AVP. If the AS-Number 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 Call-Reference-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 Call-Reference-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 Call-Reference-Info AVP. If no extension AVPs are present, this method returns silently.