Interface CreditControlRequest

  • All Superinterfaces:
    Cloneable, CreditControlMessage, DiameterMessage

    public interface CreditControlRequest
    extends CreditControlMessage
    Defines an interface representing the Credit-Control-Request command. From the Diameter Gx Reference Point Protocol Details (3GPP TS 29.212 V10.1.0) specification:
     5.6.2   Credit-Control-Request (CCR) Command
     
        The Credit-Control-Request message (CCR) is indicated by the
        command-code field being set to 272 and the 'R' bit being set in the
        Command Flags field.  It is used between the Diameter credit-control
        client and the credit-control server to request credit authorization
        for a given service.
     
        The Auth-Application-Id MUST be set to the value 4, indicating the
        Diameter credit-control application.
     
        Message Format
     
         <Credit-Control-Request> ::= < Diameter Header: 272, REQ, PXY >
                          < Session-Id >
                          { Auth-Application-Id }
                          { Origin-Host }
                          { Origin-Realm }
                          { Destination-Realm }
                          { CC-Request-Type }
                          { CC-Request-Number }
                          [ Destination-Host ]
                          [ Origin-State-Id ]
                         *[ Subscription-Id ]
                         *[ Supported-Features ]
                          [ Network-Request-Support ]
                         *[ Packet-Filter-Information ]
                          [ Packet-Filter-Operation ]
                          [ Bearer-Identifier ]
                          [ Bearer-Operation ]
                          [ Framed-IP-Address ]
                          [ Framed-IPv6-Prefix ]
                          [ IP-CAN-Type ]
                          [ TGPP-RAT-Type ]
                          [ RAT-Type ]
                          [ Termination-Cause ]
                          [ User-Equipment-Info ]
                          [ QoS-Information ]
                          [ QoS-Negotiation ]
                          [ QoS-Upgrade ]
                          [ Default-EPS-Bearer-QoS ]
                       0*2[ AN-GW-Address ]
                          [ TGPP-SGSN-MCC-MNC ]
                          [ TGPP-SGSN-Address ]
                          [ TGPP-SGSN-IPv6-Address ]
                          [ RAI ]
                          [ TGPP-User-Location-Info]
                          [ TGPP-MS-TimeZone ]
                          [ Called-Station-Id ]
                          [ PDN-Connection-ID ]
                          [ Bearer-Usage ]
                          [ Online ]
                          [ Offline ]
                         *[ TFT-Packet-Filter-Information ]
                         *[ Charging-Rule-Report]
                         *[ Event-Trigger]
                          [ Event-Report-Indication]
                          [ Access-Network-Charging-Address ]
                         *[ Access-Network-Charging-Identifier-Gx ]
                         *[ CoA-Information ]
                         *[ Usage-Monitoring-Information ]
                          [ Routing-Rule-Install ]
                          [ Routing-Rule-Remove ]
                         *[ Proxy-Info ]
                         *[ Route-Record ]
                         *[ AVP ]
     
    • Method Detail

      • hasSessionId

        boolean hasSessionId()
        Returns true if the Session-Id AVP is present in the message.
        Specified by:
        hasSessionId in interface CreditControlMessage
      • removeSessionId

        void removeSessionId()
        Removes the Session-Id AVP from the message. If the Session-Id AVP is not present, this method returns silently.
      • setAuthApplicationId

        void setAuthApplicationId​(long authApplicationId)
        Sets the value of the Auth-Application-Id AVP, of type Unsigned32.
        Specified by:
        setAuthApplicationId in interface CreditControlMessage
      • removeAuthApplicationId

        void removeAuthApplicationId()
        Removes the Auth-Application-Id AVP from the message. If the Auth-Application-Id AVP is not present, this method returns silently.
      • hasOriginHost

        boolean hasOriginHost()
        Returns true if the Origin-Host AVP is present in the message.
        Specified by:
        hasOriginHost in interface CreditControlMessage
      • removeOriginHost

        void removeOriginHost()
        Removes the Origin-Host AVP from the message. If the Origin-Host AVP is not present, this method returns silently.
      • hasOriginRealm

        boolean hasOriginRealm()
        Returns true if the Origin-Realm AVP is present in the message.
        Specified by:
        hasOriginRealm in interface CreditControlMessage
      • removeOriginRealm

        void removeOriginRealm()
        Removes the Origin-Realm AVP from the message. If the Origin-Realm AVP is not present, this method returns silently.
      • hasDestinationRealm

        boolean hasDestinationRealm()
        Returns true if the Destination-Realm AVP is present in the message.
      • getDestinationRealm

        DiameterIdentity getDestinationRealm()
        Returns the value of the Destination-Realm AVP, of type DiameterIdentity.
        Specified by:
        getDestinationRealm in interface DiameterMessage
        Returns:
        the value of the Destination-Realm AVP or null if it has not been set on this message
      • removeDestinationRealm

        void removeDestinationRealm()
        Removes the Destination-Realm AVP from the message. If the Destination-Realm AVP is not present, this method returns silently.
      • hasCcRequestType

        boolean hasCcRequestType()
        Returns true if the CC-Request-Type AVP is present in the message.
        Specified by:
        hasCcRequestType in interface CreditControlMessage
      • getCcRequestType

        CcRequestType getCcRequestType()
        Returns the value of the CC-Request-Type AVP, of type Enumerated.
        Specified by:
        getCcRequestType in interface CreditControlMessage
        Returns:
        the value of the CC-Request-Type AVP or null if it has not been set on this message
      • removeCcRequestType

        void removeCcRequestType()
        Removes the CC-Request-Type AVP from the message. If the CC-Request-Type AVP is not present, this method returns silently.
      • setCcRequestNumber

        void setCcRequestNumber​(long ccRequestNumber)
        Sets the value of the CC-Request-Number AVP, of type Unsigned32.
        Specified by:
        setCcRequestNumber in interface CreditControlMessage
      • removeCcRequestNumber

        void removeCcRequestNumber()
        Removes the CC-Request-Number AVP from the message. If the CC-Request-Number AVP is not present, this method returns silently.
      • hasDestinationHost

        boolean hasDestinationHost()
        Returns true if the Destination-Host AVP is present in the message.
      • getDestinationHost

        DiameterIdentity getDestinationHost()
        Returns the value of the Destination-Host AVP, of type DiameterIdentity.
        Specified by:
        getDestinationHost in interface DiameterMessage
        Returns:
        the value of the Destination-Host AVP or null if it has not been set on this message
      • removeDestinationHost

        void removeDestinationHost()
        Removes the Destination-Host AVP from the message. If the Destination-Host AVP is not present, this method returns silently.
      • hasOriginStateId

        boolean hasOriginStateId()
        Returns true if the Origin-State-Id AVP is present in the message.
      • getOriginStateId

        long getOriginStateId()
        Returns the value of the Origin-State-Id AVP, of type Unsigned32. Use hasOriginStateId() to check the existence of this AVP.
        Returns:
        the value of the Origin-State-Id AVP
        Throws:
        IllegalStateException - if the Origin-State-Id AVP has not been set on this message
      • setOriginStateId

        void setOriginStateId​(long originStateId)
        Sets the value of the Origin-State-Id AVP, of type Unsigned32.
      • removeOriginStateId

        void removeOriginStateId()
        Removes the Origin-State-Id AVP from the message. If the Origin-State-Id AVP is not present, this method returns silently.
      • getSubscriptionIds

        SubscriptionId[] getSubscriptionIds()
        Returns the set of Subscription-Id AVPs. The returned array contains the AVPs in the order they appear in the message. A return value of null implies that no Subscription-Id AVPs have been set. The elements in the given array are SubscriptionId objects.
      • setSubscriptionId

        void setSubscriptionId​(SubscriptionId subscriptionId)
        Sets a single Subscription-Id AVP in the message, of type Grouped.
        Throws:
        NullPointerException - if subscriptionId is null.
      • setSubscriptionIds

        void setSubscriptionIds​(SubscriptionId[] subscriptionIds)
        Sets the set of Subscription-Id AVPs, with all the values in the given array. The AVPs will be added to message in the order in which they appear in the array. Note: the array must not be altered by the caller following this call, and getSubscriptionIds() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
        Throws:
        NullPointerException - if subscriptionIds is null.
      • removeSubscriptionIds

        void removeSubscriptionIds()
        Removes all Subscription-Id AVPs from the message. If no Subscription-Id AVPs are present, this method returns silently.
      • getSupportedFeatureses

        SupportedFeatures[] getSupportedFeatureses()
        Returns the set of Supported-Features AVPs. The returned array contains the AVPs in the order they appear in the message. A return value of null implies that no Supported-Features AVPs have been set. The elements in the given array are SupportedFeatures objects.
      • setSupportedFeatures

        void setSupportedFeatures​(SupportedFeatures supportedFeatures)
        Sets a single Supported-Features AVP in the message, of type Grouped.
        Throws:
        NullPointerException - if supportedFeatures is null.
      • setSupportedFeatureses

        void setSupportedFeatureses​(SupportedFeatures[] supportedFeatureses)
        Sets the set of Supported-Features AVPs, with all the values in the given array. The AVPs will be added to message in the order in which they appear in the array. Note: the array must not be altered by the caller following this call, and getSupportedFeatureses() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
        Throws:
        NullPointerException - if supportedFeatureses is null.
      • removeSupportedFeatureses

        void removeSupportedFeatureses()
        Removes all Supported-Features AVPs from the message. If no Supported-Features AVPs are present, this method returns silently.
      • hasNetworkRequestSupport

        boolean hasNetworkRequestSupport()
        Returns true if the Network-Request-Support AVP is present in the message.
      • getNetworkRequestSupport

        NetworkRequestSupport getNetworkRequestSupport()
        Returns the value of the Network-Request-Support AVP, of type Enumerated.
        Returns:
        the value of the Network-Request-Support AVP or null if it has not been set on this message
      • setNetworkRequestSupport

        void setNetworkRequestSupport​(NetworkRequestSupport networkRequestSupport)
        Sets the value of the Network-Request-Support AVP, of type Enumerated.
        Throws:
        NullPointerException - if networkRequestSupport is null.
      • removeNetworkRequestSupport

        void removeNetworkRequestSupport()
        Removes the Network-Request-Support AVP from the message. If the Network-Request-Support AVP is not present, this method returns silently.
      • getPacketFilterInformations

        PacketFilterInformation[] getPacketFilterInformations()
        Returns the set of Packet-Filter-Information AVPs. The returned array contains the AVPs in the order they appear in the message. A return value of null implies that no Packet-Filter-Information AVPs have been set. The elements in the given array are PacketFilterInformation objects.
      • setPacketFilterInformation

        void setPacketFilterInformation​(PacketFilterInformation packetFilterInformation)
        Sets a single Packet-Filter-Information AVP in the message, of type Grouped.
        Throws:
        NullPointerException - if packetFilterInformation is null.
      • setPacketFilterInformations

        void setPacketFilterInformations​(PacketFilterInformation[] packetFilterInformations)
        Sets the set of Packet-Filter-Information AVPs, with all the values in the given array. The AVPs will be added to message in the order in which they appear in the array. Note: the array must not be altered by the caller following this call, and getPacketFilterInformations() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
        Throws:
        NullPointerException - if packetFilterInformations is null.
      • removePacketFilterInformations

        void removePacketFilterInformations()
        Removes all Packet-Filter-Information AVPs from the message. If no Packet-Filter-Information AVPs are present, this method returns silently.
      • hasPacketFilterOperation

        boolean hasPacketFilterOperation()
        Returns true if the Packet-Filter-Operation AVP is present in the message.
      • getPacketFilterOperation

        PacketFilterOperation getPacketFilterOperation()
        Returns the value of the Packet-Filter-Operation AVP, of type Enumerated.
        Returns:
        the value of the Packet-Filter-Operation AVP or null if it has not been set on this message
      • setPacketFilterOperation

        void setPacketFilterOperation​(PacketFilterOperation packetFilterOperation)
        Sets the value of the Packet-Filter-Operation AVP, of type Enumerated.
        Throws:
        NullPointerException - if packetFilterOperation is null.
      • removePacketFilterOperation

        void removePacketFilterOperation()
        Removes the Packet-Filter-Operation AVP from the message. If the Packet-Filter-Operation AVP is not present, this method returns silently.
      • hasBearerIdentifier

        boolean hasBearerIdentifier()
        Returns true if the Bearer-Identifier AVP is present in the message.
      • getBearerIdentifier

        byte[] getBearerIdentifier()
        Returns the value of the Bearer-Identifier AVP, of type OctetString.
        Returns:
        the value of the Bearer-Identifier AVP or null if it has not been set on this message
      • setBearerIdentifier

        void setBearerIdentifier​(byte[] bearerIdentifier)
        Sets the value of the Bearer-Identifier AVP, of type OctetString.
        Throws:
        NullPointerException - if bearerIdentifier is null.
      • removeBearerIdentifier

        void removeBearerIdentifier()
        Removes the Bearer-Identifier AVP from the message. If the Bearer-Identifier AVP is not present, this method returns silently.
      • hasBearerOperation

        boolean hasBearerOperation()
        Returns true if the Bearer-Operation AVP is present in the message.
      • getBearerOperation

        BearerOperation getBearerOperation()
        Returns the value of the Bearer-Operation AVP, of type Enumerated.
        Returns:
        the value of the Bearer-Operation AVP or null if it has not been set on this message
      • setBearerOperation

        void setBearerOperation​(BearerOperation bearerOperation)
        Sets the value of the Bearer-Operation AVP, of type Enumerated.
        Throws:
        NullPointerException - if bearerOperation is null.
      • removeBearerOperation

        void removeBearerOperation()
        Removes the Bearer-Operation AVP from the message. If the Bearer-Operation AVP is not present, this method returns silently.
      • hasFramedIpAddress

        boolean hasFramedIpAddress()
        Returns true if the Framed-IP-Address AVP is present in the message.
      • getFramedIpAddress

        byte[] getFramedIpAddress()
        Returns the value of the Framed-IP-Address AVP, of type OctetString.
        Returns:
        the value of the Framed-IP-Address AVP or null if it has not been set on this message
      • setFramedIpAddress

        void setFramedIpAddress​(byte[] framedIpAddress)
        Sets the value of the Framed-IP-Address AVP, of type OctetString.
        Throws:
        NullPointerException - if framedIpAddress is null.
      • removeFramedIpAddress

        void removeFramedIpAddress()
        Removes the Framed-IP-Address AVP from the message. If the Framed-IP-Address AVP is not present, this method returns silently.
      • hasFramedIpv6Prefix

        boolean hasFramedIpv6Prefix()
        Returns true if the Framed-IPv6-Prefix AVP is present in the message.
      • getFramedIpv6Prefix

        byte[] getFramedIpv6Prefix()
        Returns the value of the Framed-IPv6-Prefix AVP, of type OctetString.
        Returns:
        the value of the Framed-IPv6-Prefix AVP or null if it has not been set on this message
      • setFramedIpv6Prefix

        void setFramedIpv6Prefix​(byte[] framedIpv6Prefix)
        Sets the value of the Framed-IPv6-Prefix AVP, of type OctetString.
        Throws:
        NullPointerException - if framedIpv6Prefix is null.
      • removeFramedIpv6Prefix

        void removeFramedIpv6Prefix()
        Removes the Framed-IPv6-Prefix AVP from the message. If the Framed-IPv6-Prefix AVP is not present, this method returns silently.
      • hasIpCanType

        boolean hasIpCanType()
        Returns true if the IP-CAN-Type AVP is present in the message.
      • getIpCanType

        IpCanType getIpCanType()
        Returns the value of the IP-CAN-Type AVP, of type Enumerated.
        Returns:
        the value of the IP-CAN-Type AVP or null if it has not been set on this message
      • setIpCanType

        void setIpCanType​(IpCanType ipCanType)
        Sets the value of the IP-CAN-Type AVP, of type Enumerated.
        Throws:
        NullPointerException - if ipCanType is null.
      • removeIpCanType

        void removeIpCanType()
        Removes the IP-CAN-Type AVP from the message. If the IP-CAN-Type AVP is not present, this method returns silently.
      • hasTgppRatType

        boolean hasTgppRatType()
        Returns true if the TGPP-RAT-Type AVP is present in the message.
      • getTgppRatType

        byte[] getTgppRatType()
        Returns the value of the TGPP-RAT-Type AVP, of type OctetString.
        Returns:
        the value of the TGPP-RAT-Type AVP or null if it has not been set on this message
      • setTgppRatType

        void setTgppRatType​(byte[] tgppRatType)
        Sets the value of the TGPP-RAT-Type AVP, of type OctetString.
        Throws:
        NullPointerException - if tgppRatType is null.
      • removeTgppRatType

        void removeTgppRatType()
        Removes the TGPP-RAT-Type AVP from the message. If the TGPP-RAT-Type AVP is not present, this method returns silently.
      • hasRatType

        boolean hasRatType()
        Returns true if the RAT-Type AVP is present in the message.
      • getRatType

        RatType getRatType()
        Returns the value of the RAT-Type AVP, of type Enumerated.
        Returns:
        the value of the RAT-Type AVP or null if it has not been set on this message
      • setRatType

        void setRatType​(RatType ratType)
        Sets the value of the RAT-Type AVP, of type Enumerated.
        Throws:
        NullPointerException - if ratType is null.
      • removeRatType

        void removeRatType()
        Removes the RAT-Type AVP from the message. If the RAT-Type AVP is not present, this method returns silently.
      • hasTerminationCause

        boolean hasTerminationCause()
        Returns true if the Termination-Cause AVP is present in the message.
      • getTerminationCause

        TerminationCause getTerminationCause()
        Returns the value of the Termination-Cause AVP, of type Enumerated.
        Returns:
        the value of the Termination-Cause AVP or null if it has not been set on this message
      • setTerminationCause

        void setTerminationCause​(TerminationCause terminationCause)
        Sets the value of the Termination-Cause AVP, of type Enumerated.
        Throws:
        NullPointerException - if terminationCause is null.
      • removeTerminationCause

        void removeTerminationCause()
        Removes the Termination-Cause AVP from the message. If the Termination-Cause AVP is not present, this method returns silently.
      • hasUserEquipmentInfo

        boolean hasUserEquipmentInfo()
        Returns true if the User-Equipment-Info AVP is present in the message.
      • getUserEquipmentInfo

        UserEquipmentInfo getUserEquipmentInfo()
        Returns the value of the User-Equipment-Info AVP, of type Grouped.
        Returns:
        the value of the User-Equipment-Info AVP or null if it has not been set on this message
      • setUserEquipmentInfo

        void setUserEquipmentInfo​(UserEquipmentInfo userEquipmentInfo)
        Sets the value of the User-Equipment-Info AVP, of type Grouped.
        Throws:
        NullPointerException - if userEquipmentInfo is null.
      • removeUserEquipmentInfo

        void removeUserEquipmentInfo()
        Removes the User-Equipment-Info AVP from the message. If the User-Equipment-Info AVP is not present, this method returns silently.
      • hasQosInformation

        boolean hasQosInformation()
        Returns true if the QoS-Information AVP is present in the message.
      • getQosInformation

        QosInformation getQosInformation()
        Returns the value of the QoS-Information AVP, of type Grouped.
        Returns:
        the value of the QoS-Information AVP or null if it has not been set on this message
      • setQosInformation

        void setQosInformation​(QosInformation qosInformation)
        Sets the value of the QoS-Information AVP, of type Grouped.
        Throws:
        NullPointerException - if qosInformation is null.
      • removeQosInformation

        void removeQosInformation()
        Removes the QoS-Information AVP from the message. If the QoS-Information AVP is not present, this method returns silently.
      • hasQosNegotiation

        boolean hasQosNegotiation()
        Returns true if the QoS-Negotiation AVP is present in the message.
      • getQosNegotiation

        QosNegotiation getQosNegotiation()
        Returns the value of the QoS-Negotiation AVP, of type Enumerated.
        Returns:
        the value of the QoS-Negotiation AVP or null if it has not been set on this message
      • setQosNegotiation

        void setQosNegotiation​(QosNegotiation qosNegotiation)
        Sets the value of the QoS-Negotiation AVP, of type Enumerated.
        Throws:
        NullPointerException - if qosNegotiation is null.
      • removeQosNegotiation

        void removeQosNegotiation()
        Removes the QoS-Negotiation AVP from the message. If the QoS-Negotiation AVP is not present, this method returns silently.
      • hasQosUpgrade

        boolean hasQosUpgrade()
        Returns true if the QoS-Upgrade AVP is present in the message.
      • getQosUpgrade

        QosUpgrade getQosUpgrade()
        Returns the value of the QoS-Upgrade AVP, of type Enumerated.
        Returns:
        the value of the QoS-Upgrade AVP or null if it has not been set on this message
      • setQosUpgrade

        void setQosUpgrade​(QosUpgrade qosUpgrade)
        Sets the value of the QoS-Upgrade AVP, of type Enumerated.
        Throws:
        NullPointerException - if qosUpgrade is null.
      • removeQosUpgrade

        void removeQosUpgrade()
        Removes the QoS-Upgrade AVP from the message. If the QoS-Upgrade AVP is not present, this method returns silently.
      • hasDefaultEpsBearerQos

        boolean hasDefaultEpsBearerQos()
        Returns true if the Default-EPS-Bearer-QoS AVP is present in the message.
      • getDefaultEpsBearerQos

        DefaultEpsBearerQos getDefaultEpsBearerQos()
        Returns the value of the Default-EPS-Bearer-QoS AVP, of type Grouped.
        Returns:
        the value of the Default-EPS-Bearer-QoS AVP or null if it has not been set on this message
      • setDefaultEpsBearerQos

        void setDefaultEpsBearerQos​(DefaultEpsBearerQos defaultEpsBearerQos)
        Sets the value of the Default-EPS-Bearer-QoS AVP, of type Grouped.
        Throws:
        NullPointerException - if defaultEpsBearerQos is null.
      • removeDefaultEpsBearerQos

        void removeDefaultEpsBearerQos()
        Removes the Default-EPS-Bearer-QoS AVP from the message. If the Default-EPS-Bearer-QoS AVP is not present, this method returns silently.
      • getAnGwAddresses

        Address[] getAnGwAddresses()
        Returns the set of AN-GW-Address AVPs. The returned array contains the AVPs in the order they appear in the message. A return value of null implies that no AN-GW-Address AVPs have been set. The elements in the given array are Address objects.
      • setAnGwAddress

        void setAnGwAddress​(Address anGwAddress)
        Sets a single AN-GW-Address AVP in the message, of type Address.
        Throws:
        NullPointerException - if anGwAddress is null.
      • setAnGwAddresses

        void setAnGwAddresses​(Address[] anGwAddresses)
        Sets the set of AN-GW-Address AVPs, with all the values in the given array. The AVPs will be added to message in the order in which they appear in the array. Note: the array must not be altered by the caller following this call, and getAnGwAddresses() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
        Throws:
        NullPointerException - if anGwAddresses is null.
      • removeAnGwAddresses

        void removeAnGwAddresses()
        Removes all AN-GW-Address AVPs from the message. If no AN-GW-Address AVPs are present, this method returns silently.
      • hasTgppSgsnMccMnc

        boolean hasTgppSgsnMccMnc()
        Returns true if the TGPP-SGSN-MCC-MNC AVP is present in the message.
      • getTgppSgsnMccMnc

        String getTgppSgsnMccMnc()
        Returns the value of the TGPP-SGSN-MCC-MNC AVP, of type UTF8String.
        Returns:
        the value of the TGPP-SGSN-MCC-MNC AVP or null if it has not been set on this message
      • setTgppSgsnMccMnc

        void setTgppSgsnMccMnc​(String tgppSgsnMccMnc)
        Sets the value of the TGPP-SGSN-MCC-MNC AVP, of type UTF8String.
        Throws:
        NullPointerException - if tgppSgsnMccMnc is null.
      • removeTgppSgsnMccMnc

        void removeTgppSgsnMccMnc()
        Removes the TGPP-SGSN-MCC-MNC AVP from the message. If the TGPP-SGSN-MCC-MNC AVP is not present, this method returns silently.
      • hasTgppSgsnAddress

        boolean hasTgppSgsnAddress()
        Returns true if the TGPP-SGSN-Address AVP is present in the message.
      • getTgppSgsnAddress

        byte[] getTgppSgsnAddress()
        Returns the value of the TGPP-SGSN-Address AVP, of type OctetString.
        Returns:
        the value of the TGPP-SGSN-Address AVP or null if it has not been set on this message
      • setTgppSgsnAddress

        void setTgppSgsnAddress​(byte[] tgppSgsnAddress)
        Sets the value of the TGPP-SGSN-Address AVP, of type OctetString.
        Throws:
        NullPointerException - if tgppSgsnAddress is null.
      • removeTgppSgsnAddress

        void removeTgppSgsnAddress()
        Removes the TGPP-SGSN-Address AVP from the message. If the TGPP-SGSN-Address AVP is not present, this method returns silently.
      • hasTgppSgsnIpv6Address

        boolean hasTgppSgsnIpv6Address()
        Returns true if the TGPP-SGSN-IPv6-Address AVP is present in the message.
      • getTgppSgsnIpv6Address

        byte[] getTgppSgsnIpv6Address()
        Returns the value of the TGPP-SGSN-IPv6-Address AVP, of type OctetString.
        Returns:
        the value of the TGPP-SGSN-IPv6-Address AVP or null if it has not been set on this message
      • setTgppSgsnIpv6Address

        void setTgppSgsnIpv6Address​(byte[] tgppSgsnIpv6Address)
        Sets the value of the TGPP-SGSN-IPv6-Address AVP, of type OctetString.
        Throws:
        NullPointerException - if tgppSgsnIpv6Address is null.
      • removeTgppSgsnIpv6Address

        void removeTgppSgsnIpv6Address()
        Removes the TGPP-SGSN-IPv6-Address AVP from the message. If the TGPP-SGSN-IPv6-Address AVP is not present, this method returns silently.
      • hasRai

        boolean hasRai()
        Returns true if the RAI AVP is present in the message.
      • getRai

        String getRai()
        Returns the value of the RAI AVP, of type UTF8String.
        Returns:
        the value of the RAI AVP or null if it has not been set on this message
      • setRai

        void setRai​(String rai)
        Sets the value of the RAI AVP, of type UTF8String.
        Throws:
        NullPointerException - if rai is null.
      • removeRai

        void removeRai()
        Removes the RAI AVP from the message. If the RAI AVP is not present, this method returns silently.
      • hasTgppUserLocationInfo

        boolean hasTgppUserLocationInfo()
        Returns true if the TGPP-User-Location-Info AVP is present in the message.
      • getTgppUserLocationInfo

        byte[] getTgppUserLocationInfo()
        Returns the value of the TGPP-User-Location-Info AVP, of type OctetString.
        Returns:
        the value of the TGPP-User-Location-Info AVP or null if it has not been set on this message
      • setTgppUserLocationInfo

        void setTgppUserLocationInfo​(byte[] tgppUserLocationInfo)
        Sets the value of the TGPP-User-Location-Info AVP, of type OctetString.
        Throws:
        NullPointerException - if tgppUserLocationInfo is null.
      • removeTgppUserLocationInfo

        void removeTgppUserLocationInfo()
        Removes the TGPP-User-Location-Info AVP from the message. If the TGPP-User-Location-Info AVP is not present, this method returns silently.
      • hasTgppMsTimezone

        boolean hasTgppMsTimezone()
        Returns true if the TGPP-MS-TimeZone AVP is present in the message.
      • getTgppMsTimezone

        byte[] getTgppMsTimezone()
        Returns the value of the TGPP-MS-TimeZone AVP, of type OctetString.
        Returns:
        the value of the TGPP-MS-TimeZone AVP or null if it has not been set on this message
      • setTgppMsTimezone

        void setTgppMsTimezone​(byte[] tgppMsTimezone)
        Sets the value of the TGPP-MS-TimeZone AVP, of type OctetString.
        Throws:
        NullPointerException - if tgppMsTimezone is null.
      • removeTgppMsTimezone

        void removeTgppMsTimezone()
        Removes the TGPP-MS-TimeZone AVP from the message. If the TGPP-MS-TimeZone AVP is not present, this method returns silently.
      • hasCalledStationId

        boolean hasCalledStationId()
        Returns true if the Called-Station-Id AVP is present in the message.
      • getCalledStationId

        String getCalledStationId()
        Returns the value of the Called-Station-Id AVP, of type UTF8String.
        Returns:
        the value of the Called-Station-Id AVP or null if it has not been set on this message
      • setCalledStationId

        void setCalledStationId​(String calledStationId)
        Sets the value of the Called-Station-Id AVP, of type UTF8String.
        Throws:
        NullPointerException - if calledStationId is null.
      • removeCalledStationId

        void removeCalledStationId()
        Removes the Called-Station-Id AVP from the message. If the Called-Station-Id AVP is not present, this method returns silently.
      • hasPdnConnectionId

        boolean hasPdnConnectionId()
        Returns true if the PDN-Connection-ID AVP is present in the message.
      • getPdnConnectionId

        byte[] getPdnConnectionId()
        Returns the value of the PDN-Connection-ID AVP, of type OctetString.
        Returns:
        the value of the PDN-Connection-ID AVP or null if it has not been set on this message
      • setPdnConnectionId

        void setPdnConnectionId​(byte[] pdnConnectionId)
        Sets the value of the PDN-Connection-ID AVP, of type OctetString.
        Throws:
        NullPointerException - if pdnConnectionId is null.
      • removePdnConnectionId

        void removePdnConnectionId()
        Removes the PDN-Connection-ID AVP from the message. If the PDN-Connection-ID AVP is not present, this method returns silently.
      • hasBearerUsage

        boolean hasBearerUsage()
        Returns true if the Bearer-Usage AVP is present in the message.
      • getBearerUsage

        BearerUsage getBearerUsage()
        Returns the value of the Bearer-Usage AVP, of type Enumerated.
        Returns:
        the value of the Bearer-Usage AVP or null if it has not been set on this message
      • setBearerUsage

        void setBearerUsage​(BearerUsage bearerUsage)
        Sets the value of the Bearer-Usage AVP, of type Enumerated.
        Throws:
        NullPointerException - if bearerUsage is null.
      • removeBearerUsage

        void removeBearerUsage()
        Removes the Bearer-Usage AVP from the message. If the Bearer-Usage AVP is not present, this method returns silently.
      • hasOnline

        boolean hasOnline()
        Returns true if the Online AVP is present in the message.
      • getOnline

        Online getOnline()
        Returns the value of the Online AVP, of type Enumerated.
        Returns:
        the value of the Online AVP or null if it has not been set on this message
      • setOnline

        void setOnline​(Online online)
        Sets the value of the Online AVP, of type Enumerated.
        Throws:
        NullPointerException - if online is null.
      • removeOnline

        void removeOnline()
        Removes the Online AVP from the message. If the Online AVP is not present, this method returns silently.
      • hasOffline

        boolean hasOffline()
        Returns true if the Offline AVP is present in the message.
      • getOffline

        Offline getOffline()
        Returns the value of the Offline AVP, of type Enumerated.
        Returns:
        the value of the Offline AVP or null if it has not been set on this message
      • setOffline

        void setOffline​(Offline offline)
        Sets the value of the Offline AVP, of type Enumerated.
        Throws:
        NullPointerException - if offline is null.
      • removeOffline

        void removeOffline()
        Removes the Offline AVP from the message. If the Offline AVP is not present, this method returns silently.
      • getTftPacketFilterInformations

        TftPacketFilterInformation[] getTftPacketFilterInformations()
        Returns the set of TFT-Packet-Filter-Information AVPs. The returned array contains the AVPs in the order they appear in the message. A return value of null implies that no TFT-Packet-Filter-Information AVPs have been set. The elements in the given array are TftPacketFilterInformation objects.
      • setTftPacketFilterInformation

        void setTftPacketFilterInformation​(TftPacketFilterInformation tftPacketFilterInformation)
        Sets a single TFT-Packet-Filter-Information AVP in the message, of type Grouped.
        Throws:
        NullPointerException - if tftPacketFilterInformation is null.
      • setTftPacketFilterInformations

        void setTftPacketFilterInformations​(TftPacketFilterInformation[] tftPacketFilterInformations)
        Sets the set of TFT-Packet-Filter-Information AVPs, with all the values in the given array. The AVPs will be added to message in the order in which they appear in the array. Note: the array must not be altered by the caller following this call, and getTftPacketFilterInformations() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
        Throws:
        NullPointerException - if tftPacketFilterInformations is null.
      • removeTftPacketFilterInformations

        void removeTftPacketFilterInformations()
        Removes all TFT-Packet-Filter-Information AVPs from the message. If no TFT-Packet-Filter-Information AVPs are present, this method returns silently.
      • getChargingRuleReports

        ChargingRuleReport[] getChargingRuleReports()
        Returns the set of Charging-Rule-Report AVPs. The returned array contains the AVPs in the order they appear in the message. A return value of null implies that no Charging-Rule-Report AVPs have been set. The elements in the given array are ChargingRuleReport objects.
      • setChargingRuleReport

        void setChargingRuleReport​(ChargingRuleReport chargingRuleReport)
        Sets a single Charging-Rule-Report AVP in the message, of type Grouped.
        Throws:
        NullPointerException - if chargingRuleReport is null.
      • setChargingRuleReports

        void setChargingRuleReports​(ChargingRuleReport[] chargingRuleReports)
        Sets the set of Charging-Rule-Report AVPs, with all the values in the given array. The AVPs will be added to message in the order in which they appear in the array. Note: the array must not be altered by the caller following this call, and getChargingRuleReports() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
        Throws:
        NullPointerException - if chargingRuleReports is null.
      • removeChargingRuleReports

        void removeChargingRuleReports()
        Removes all Charging-Rule-Report AVPs from the message. If no Charging-Rule-Report AVPs are present, this method returns silently.
      • getEventTriggers

        EventTrigger[] getEventTriggers()
        Returns the set of Event-Trigger AVPs. The returned array contains the AVPs in the order they appear in the message. A return value of null implies that no Event-Trigger AVPs have been set. The elements in the given array are EventTrigger objects.
      • setEventTrigger

        void setEventTrigger​(EventTrigger eventTrigger)
        Sets a single Event-Trigger AVP in the message, of type Enumerated.
        Throws:
        NullPointerException - if eventTrigger is null.
      • setEventTriggers

        void setEventTriggers​(EventTrigger[] eventTriggers)
        Sets the set of Event-Trigger AVPs, with all the values in the given array. The AVPs will be added to message in the order in which they appear in the array. Note: the array must not be altered by the caller following this call, and getEventTriggers() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
        Throws:
        NullPointerException - if eventTriggers is null.
      • removeEventTriggers

        void removeEventTriggers()
        Removes all Event-Trigger AVPs from the message. If no Event-Trigger AVPs are present, this method returns silently.
      • hasEventReportIndication

        boolean hasEventReportIndication()
        Returns true if the Event-Report-Indication AVP is present in the message.
      • getEventReportIndication

        EventReportIndication getEventReportIndication()
        Returns the value of the Event-Report-Indication AVP, of type Grouped.
        Returns:
        the value of the Event-Report-Indication AVP or null if it has not been set on this message
      • setEventReportIndication

        void setEventReportIndication​(EventReportIndication eventReportIndication)
        Sets the value of the Event-Report-Indication AVP, of type Grouped.
        Throws:
        NullPointerException - if eventReportIndication is null.
      • removeEventReportIndication

        void removeEventReportIndication()
        Removes the Event-Report-Indication AVP from the message. If the Event-Report-Indication AVP is not present, this method returns silently.
      • hasAccessNetworkChargingAddress

        boolean hasAccessNetworkChargingAddress()
        Returns true if the Access-Network-Charging-Address AVP is present in the message.
      • getAccessNetworkChargingAddress

        Address getAccessNetworkChargingAddress()
        Returns the value of the Access-Network-Charging-Address AVP, of type Address.
        Returns:
        the value of the Access-Network-Charging-Address AVP or null if it has not been set on this message
      • setAccessNetworkChargingAddress

        void setAccessNetworkChargingAddress​(Address accessNetworkChargingAddress)
        Sets the value of the Access-Network-Charging-Address AVP, of type Address.
        Throws:
        NullPointerException - if accessNetworkChargingAddress is null.
      • removeAccessNetworkChargingAddress

        void removeAccessNetworkChargingAddress()
        Removes the Access-Network-Charging-Address AVP from the message. If the Access-Network-Charging-Address AVP is not present, this method returns silently.
      • getAccessNetworkChargingIdentifierGxs

        AccessNetworkChargingIdentifierGx[] getAccessNetworkChargingIdentifierGxs()
        Returns the set of Access-Network-Charging-Identifier-Gx AVPs. The returned array contains the AVPs in the order they appear in the message. A return value of null implies that no Access-Network-Charging-Identifier-Gx AVPs have been set. The elements in the given array are AccessNetworkChargingIdentifierGx objects.
      • setAccessNetworkChargingIdentifierGx

        void setAccessNetworkChargingIdentifierGx​(AccessNetworkChargingIdentifierGx accessNetworkChargingIdentifierGx)
        Sets a single Access-Network-Charging-Identifier-Gx AVP in the message, of type Grouped.
        Throws:
        NullPointerException - if accessNetworkChargingIdentifierGx is null.
      • setAccessNetworkChargingIdentifierGxs

        void setAccessNetworkChargingIdentifierGxs​(AccessNetworkChargingIdentifierGx[] accessNetworkChargingIdentifierGxs)
        Sets the set of Access-Network-Charging-Identifier-Gx AVPs, with all the values in the given array. The AVPs will be added to message in the order in which they appear in the array. Note: the array must not be altered by the caller following this call, and getAccessNetworkChargingIdentifierGxs() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
        Throws:
        NullPointerException - if accessNetworkChargingIdentifierGxs is null.
      • removeAccessNetworkChargingIdentifierGxs

        void removeAccessNetworkChargingIdentifierGxs()
        Removes all Access-Network-Charging-Identifier-Gx AVPs from the message. If no Access-Network-Charging-Identifier-Gx AVPs are present, this method returns silently.
      • getCoaInformations

        CoaInformation[] getCoaInformations()
        Returns the set of CoA-Information AVPs. The returned array contains the AVPs in the order they appear in the message. A return value of null implies that no CoA-Information AVPs have been set. The elements in the given array are CoaInformation objects.
      • setCoaInformation

        void setCoaInformation​(CoaInformation coaInformation)
        Sets a single CoA-Information AVP in the message, of type Grouped.
        Throws:
        NullPointerException - if coaInformation is null.
      • setCoaInformations

        void setCoaInformations​(CoaInformation[] coaInformations)
        Sets the set of CoA-Information AVPs, with all the values in the given array. The AVPs will be added to message in the order in which they appear in the array. Note: the array must not be altered by the caller following this call, and getCoaInformations() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
        Throws:
        NullPointerException - if coaInformations is null.
      • removeCoaInformations

        void removeCoaInformations()
        Removes all CoA-Information AVPs from the message. If no CoA-Information AVPs are present, this method returns silently.
      • getUsageMonitoringInformations

        UsageMonitoringInformation[] getUsageMonitoringInformations()
        Returns the set of Usage-Monitoring-Information AVPs. The returned array contains the AVPs in the order they appear in the message. A return value of null implies that no Usage-Monitoring-Information AVPs have been set. The elements in the given array are UsageMonitoringInformation objects.
      • setUsageMonitoringInformation

        void setUsageMonitoringInformation​(UsageMonitoringInformation usageMonitoringInformation)
        Sets a single Usage-Monitoring-Information AVP in the message, of type Grouped.
        Throws:
        NullPointerException - if usageMonitoringInformation is null.
      • setUsageMonitoringInformations

        void setUsageMonitoringInformations​(UsageMonitoringInformation[] usageMonitoringInformations)
        Sets the set of Usage-Monitoring-Information AVPs, with all the values in the given array. The AVPs will be added to message in the order in which they appear in the array. Note: the array must not be altered by the caller following this call, and getUsageMonitoringInformations() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
        Throws:
        NullPointerException - if usageMonitoringInformations is null.
      • removeUsageMonitoringInformations

        void removeUsageMonitoringInformations()
        Removes all Usage-Monitoring-Information AVPs from the message. If no Usage-Monitoring-Information AVPs are present, this method returns silently.
      • hasRoutingRuleInstall

        boolean hasRoutingRuleInstall()
        Returns true if the Routing-Rule-Install AVP is present in the message.
      • getRoutingRuleInstall

        RoutingRuleInstall getRoutingRuleInstall()
        Returns the value of the Routing-Rule-Install AVP, of type Grouped.
        Returns:
        the value of the Routing-Rule-Install AVP or null if it has not been set on this message
      • setRoutingRuleInstall

        void setRoutingRuleInstall​(RoutingRuleInstall routingRuleInstall)
        Sets the value of the Routing-Rule-Install AVP, of type Grouped.
        Throws:
        NullPointerException - if routingRuleInstall is null.
      • removeRoutingRuleInstall

        void removeRoutingRuleInstall()
        Removes the Routing-Rule-Install AVP from the message. If the Routing-Rule-Install AVP is not present, this method returns silently.
      • hasRoutingRuleRemove

        boolean hasRoutingRuleRemove()
        Returns true if the Routing-Rule-Remove AVP is present in the message.
      • getRoutingRuleRemove

        RoutingRuleRemove getRoutingRuleRemove()
        Returns the value of the Routing-Rule-Remove AVP, of type Grouped.
        Returns:
        the value of the Routing-Rule-Remove AVP or null if it has not been set on this message
      • setRoutingRuleRemove

        void setRoutingRuleRemove​(RoutingRuleRemove routingRuleRemove)
        Sets the value of the Routing-Rule-Remove AVP, of type Grouped.
        Throws:
        NullPointerException - if routingRuleRemove is null.
      • removeRoutingRuleRemove

        void removeRoutingRuleRemove()
        Removes the Routing-Rule-Remove AVP from the message. If the Routing-Rule-Remove AVP is not present, this method returns silently.
      • getProxyInfos

        ProxyInfo[] getProxyInfos()
        Returns the set of Proxy-Info AVPs. The returned array contains the AVPs in the order they appear in the message. A return value of null implies that no Proxy-Info AVPs have been set. The elements in the given array are ProxyInfo objects.
        Specified by:
        getProxyInfos in interface CreditControlMessage
      • setProxyInfos

        void setProxyInfos​(ProxyInfo[] proxyInfos)
        Sets the set of Proxy-Info AVPs, with all the values in the given array. The AVPs will be added to message in the order in which they appear in the array. Note: the array must not be altered by the caller following this call, and getProxyInfos() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
        Specified by:
        setProxyInfos in interface CreditControlMessage
        Throws:
        NullPointerException - if proxyInfos is null.
      • removeProxyInfos

        void removeProxyInfos()
        Removes all Proxy-Info AVPs from the message. If no Proxy-Info AVPs are present, this method returns silently.
      • getRouteRecords

        DiameterIdentity[] getRouteRecords()
        Returns the set of Route-Record AVPs. The returned array contains the AVPs in the order they appear in the message. A return value of null implies that no Route-Record AVPs have been set. The elements in the given array are DiameterIdentity objects.
        Specified by:
        getRouteRecords in interface CreditControlMessage
      • setRouteRecords

        void setRouteRecords​(DiameterIdentity[] routeRecords)
        Sets the set of Route-Record AVPs, with all the values in the given array. The AVPs will be added to message in the order in which they appear in the array. Note: the array must not be altered by the caller following this call, and getRouteRecords() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
        Specified by:
        setRouteRecords in interface CreditControlMessage
        Throws:
        NullPointerException - if routeRecords is null.
      • removeRouteRecords

        void removeRouteRecords()
        Removes all Route-Record AVPs from the message. If no Route-Record AVPs are 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 message. 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 message 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 message. If no extension AVPs are present, this method returns silently.