Interface DcdInformation

  • All Superinterfaces:
    Cloneable, DiameterAvp, GroupedAvp

    public interface DcdInformation
    extends GroupedAvp
    Defines an interface representing the DCD-Information grouped AVP type. From the Diameter Ro Reference Point Protocol Details (3GPP TS 32.299 V9.6.0) specification:
     7.2.34 A    DCD-Information AVP
     The DCD-Information AVP (AVP code 2115) is of type Grouped. Its purpose is to allow the transmission of service information elements
     used for DCD services.  The AVP is defined in OMA-DDS-Charging_DataThe DCD-Information AVP (AVP code 2115) is of type Grouped.
     Its purpose is to allow the transmission of service information elements used for DCD services. 
     
         DCD-Information ::= < AVP Header: 2115 >
                             [ Content-ID]
                             [ Content-Provider-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

      • hasContentId

        boolean hasContentId()
        Returns true if the Content-ID AVP is present in the DCD-Information AVP.
      • getContentId

        String getContentId()
        Returns the value of the Content-ID AVP, of type UTF8String.
        Returns:
        the value of the Content-ID AVP, or null if it has not been set.
      • setContentId

        void setContentId​(String contentId)
        Sets the value of the Content-ID AVP, of type UTF8String.
        Throws:
        NullPointerException - if contentId is null.
      • removeContentId

        void removeContentId()
        Removes the Content-ID AVP from the DCD-Information AVP. If the Content-ID AVP is not present, this method returns silently.
      • hasContentProviderId

        boolean hasContentProviderId()
        Returns true if the Content-Provider-ID AVP is present in the DCD-Information AVP.
      • getContentProviderId

        String getContentProviderId()
        Returns the value of the Content-Provider-ID AVP, of type UTF8String.
        Returns:
        the value of the Content-Provider-ID AVP, or null if it has not been set.
      • setContentProviderId

        void setContentProviderId​(String contentProviderId)
        Sets the value of the Content-Provider-ID AVP, of type UTF8String.
        Throws:
        NullPointerException - if contentProviderId is null.
      • removeContentProviderId

        void removeContentProviderId()
        Removes the Content-Provider-ID AVP from the DCD-Information AVP. If the Content-Provider-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 DCD-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 DCD-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 DCD-Information AVP. If no extension AVPs are present, this method returns silently.