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

Interface CreditControlAnswer

  • All Superinterfaces:
    Cloneable, CreditControlMessage, DiameterMessage
    public interface CreditControlAnswer
extends CreditControlMessage
    Defines an interface representing the Credit-Control-Answer command. From the Diameter Gx Reference Point Protocol Details (3GPP TS 29.212 V10.1.0) specification: 
     5.6.3   Credit-Control-Answer (CCA) Command
 
     The CCA command, indicated by the Command-Code field set to 272 and the 'R' bit cleared
     in the Command Flags field, is sent by the PCRF to the PCEF in response to the CCR command.
     It is used to provision PCC rules and event triggers for the bearer/session and to provide
     the selected bearer control mode for the IP-CAN session. If the PCRF performs the bearer binding,
     PCC rules will be provisioned at bearer level. The primary and secondary CCF and/or primary and
     secondary OCS addresses may be included in the initial provisioning.
 
     Message Format:
 
     <Credit-Control-Answer> ::=  < Diameter Header: 272, PXY >
                      < Session-Id >
                      { Auth-Application-Id }
                      { Origin-Host }
                      { Origin-Realm }
                      [ Result-Code ]
                      [ Experimental-Result ]
                      { CC-Request-Type }
                      { CC-Request-Number }
                     *[ Supported-Features ]
                      [ Bearer-Control-Mode ]
                     *[ Event-Trigger ]
                      [ Origin-State-Id ]
                     *[ Redirect-Host ]
                      [ Redirect-Host-Usage ]
                      [ Redirect-Max-Cache-Time ]
                     *[ Charging-Rule-Remove ]
                     *[ Charging-Rule-Install ]
                      [ Charging-Information ]
                      [ Online ]
                      [ Offline ]
                     *[ QoS-Information ]
                      [ Revalidation-Time ]
                      [ Default-EPS-Bearer-QoS ]
                      [ Bearer-Usage ]
                      [ TGPP-User-Location-Info]
                     *[ Usage-Monitoring-Information ]
                     *[ CSG-Information-Reporting ]
                      [ User-CSG-Information ]
                      [ Error-Message ]
                      [ Error-Reporting-Host ]
                     *[ Failed-AVP ]
                     *[ 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.

      • hasResultCode

        boolean hasResultCode()
        Returns true if the Result-Code AVP is present in the message.

      • getResultCode

        long getResultCode()
        Returns the value of the Result-Code AVP, of type Unsigned32. Use hasResultCode() to check the existence of this AVP.
        Returns:
        the value of the Result-Code AVP
        Throws:
        IllegalStateException - if the Result-Code AVP has not been set on this message

      • setResultCode

        void setResultCode​(long resultCode)
        Sets the value of the Result-Code AVP, of type Unsigned32.

      • removeResultCode

        void removeResultCode()
        Removes the Result-Code AVP from the message. If the Result-Code AVP is not present, this method returns silently.

      • hasExperimentalResult

        boolean hasExperimentalResult()
        Returns true if the Experimental-Result AVP is present in the message.

      • getExperimentalResult

        ExperimentalResult getExperimentalResult()
        Returns the value of the Experimental-Result AVP, of type Grouped.
        Returns:
        the value of the Experimental-Result AVP or null if it has not been set on this message

      • setExperimentalResult

        void setExperimentalResult​(ExperimentalResult experimentalResult)
        Sets the value of the Experimental-Result AVP, of type Grouped.
        Throws:
        NullPointerException - if experimentalResult is null.

      • removeExperimentalResult

        void removeExperimentalResult()
        Removes the Experimental-Result AVP from the message. If the Experimental-Result 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.

      • 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.

      • hasBearerControlMode

        boolean hasBearerControlMode()
        Returns true if the Bearer-Control-Mode AVP is present in the message.

      • getBearerControlMode

        BearerControlMode getBearerControlMode()
        Returns the value of the Bearer-Control-Mode AVP, of type Enumerated.
        Returns:
        the value of the Bearer-Control-Mode AVP or null if it has not been set on this message

      • setBearerControlMode

        void setBearerControlMode​(BearerControlMode bearerControlMode)
        Sets the value of the Bearer-Control-Mode AVP, of type Enumerated.
        Throws:
        NullPointerException - if bearerControlMode is null.

      • removeBearerControlMode

        void removeBearerControlMode()
        Removes the Bearer-Control-Mode AVP from the message. If the Bearer-Control-Mode AVP is not 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.

      • 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.

      • getRedirectHosts

        DiameterURI[] getRedirectHosts()
        Returns the set of Redirect-Host AVPs. The returned array contains the AVPs in the order they appear in the message. A return value of null implies that no Redirect-Host AVPs have been set. The elements in the given array are DiameterURI objects.

      • setRedirectHost

        void setRedirectHost​(DiameterURI redirectHost)
        Sets a single Redirect-Host AVP in the message, of type DiameterURI.
        Throws:
        NullPointerException - if redirectHost is null.

      • setRedirectHosts

        void setRedirectHosts​(DiameterURI[] redirectHosts)
        Sets the set of Redirect-Host 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 getRedirectHosts() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
        Throws:
        NullPointerException - if redirectHosts is null.

      • removeRedirectHosts

        void removeRedirectHosts()
        Removes all Redirect-Host AVPs from the message. If no Redirect-Host AVPs are present, this method returns silently.

      • hasRedirectHostUsage

        boolean hasRedirectHostUsage()
        Returns true if the Redirect-Host-Usage AVP is present in the message.

      • getRedirectHostUsage

        RedirectHostUsage getRedirectHostUsage()
        Returns the value of the Redirect-Host-Usage AVP, of type Enumerated.
        Returns:
        the value of the Redirect-Host-Usage AVP or null if it has not been set on this message

      • setRedirectHostUsage

        void setRedirectHostUsage​(RedirectHostUsage redirectHostUsage)
        Sets the value of the Redirect-Host-Usage AVP, of type Enumerated.
        Throws:
        NullPointerException - if redirectHostUsage is null.

      • removeRedirectHostUsage

        void removeRedirectHostUsage()
        Removes the Redirect-Host-Usage AVP from the message. If the Redirect-Host-Usage AVP is not present, this method returns silently.

      • hasRedirectMaxCacheTime

        boolean hasRedirectMaxCacheTime()
        Returns true if the Redirect-Max-Cache-Time AVP is present in the message.

      • getRedirectMaxCacheTime

        long getRedirectMaxCacheTime()
        Returns the value of the Redirect-Max-Cache-Time AVP, of type Unsigned32. Use hasRedirectMaxCacheTime() to check the existence of this AVP.
        Returns:
        the value of the Redirect-Max-Cache-Time AVP
        Throws:
        IllegalStateException - if the Redirect-Max-Cache-Time AVP has not been set on this message

      • setRedirectMaxCacheTime

        void setRedirectMaxCacheTime​(long redirectMaxCacheTime)
        Sets the value of the Redirect-Max-Cache-Time AVP, of type Unsigned32.

      • removeRedirectMaxCacheTime

        void removeRedirectMaxCacheTime()
        Removes the Redirect-Max-Cache-Time AVP from the message. If the Redirect-Max-Cache-Time AVP is not present, this method returns silently.

      • getChargingRuleRemoves

        ChargingRuleRemove[] getChargingRuleRemoves()
        Returns the set of Charging-Rule-Remove 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-Remove AVPs have been set. The elements in the given array are ChargingRuleRemove objects.

      • setChargingRuleRemove

        void setChargingRuleRemove​(ChargingRuleRemove chargingRuleRemove)
        Sets a single Charging-Rule-Remove AVP in the message, of type Grouped.
        Throws:
        NullPointerException - if chargingRuleRemove is null.

      • setChargingRuleRemoves

        void setChargingRuleRemoves​(ChargingRuleRemove[] chargingRuleRemoves)
        Sets the set of Charging-Rule-Remove 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 getChargingRuleRemoves() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
        Throws:
        NullPointerException - if chargingRuleRemoves is null.

      • removeChargingRuleRemoves

        void removeChargingRuleRemoves()
        Removes all Charging-Rule-Remove AVPs from the message. If no Charging-Rule-Remove AVPs are present, this method returns silently.

      • getChargingRuleInstalls

        ChargingRuleInstall[] getChargingRuleInstalls()
        Returns the set of Charging-Rule-Install 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-Install AVPs have been set. The elements in the given array are ChargingRuleInstall objects.

      • setChargingRuleInstall

        void setChargingRuleInstall​(ChargingRuleInstall chargingRuleInstall)
        Sets a single Charging-Rule-Install AVP in the message, of type Grouped.
        Throws:
        NullPointerException - if chargingRuleInstall is null.

      • setChargingRuleInstalls

        void setChargingRuleInstalls​(ChargingRuleInstall[] chargingRuleInstalls)
        Sets the set of Charging-Rule-Install 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 getChargingRuleInstalls() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
        Throws:
        NullPointerException - if chargingRuleInstalls is null.

      • removeChargingRuleInstalls

        void removeChargingRuleInstalls()
        Removes all Charging-Rule-Install AVPs from the message. If no Charging-Rule-Install AVPs are present, this method returns silently.

      • hasChargingInformation

        boolean hasChargingInformation()
        Returns true if the Charging-Information AVP is present in the message.

      • getChargingInformation

        ChargingInformation getChargingInformation()
        Returns the value of the Charging-Information AVP, of type Grouped.
        Returns:
        the value of the Charging-Information AVP or null if it has not been set on this message

      • setChargingInformation

        void setChargingInformation​(ChargingInformation chargingInformation)
        Sets the value of the Charging-Information AVP, of type Grouped.
        Throws:
        NullPointerException - if chargingInformation is null.

      • removeChargingInformation

        void removeChargingInformation()
        Removes the Charging-Information AVP from the message. If the Charging-Information 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.

      • getQosInformations

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

      • setQosInformation

        void setQosInformation​(QosInformation qosInformation)
        Sets a single QoS-Information AVP in the message, of type Grouped.
        Throws:
        NullPointerException - if qosInformation is null.

      • setQosInformations

        void setQosInformations​(QosInformation[] qosInformations)
        Sets the set of QoS-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 getQosInformations() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
        Throws:
        NullPointerException - if qosInformations is null.

      • removeQosInformations

        void removeQosInformations()
        Removes all QoS-Information AVPs from the message. If no QoS-Information AVPs are present, this method returns silently.

      • hasRevalidationTime

        boolean hasRevalidationTime()
        Returns true if the Revalidation-Time AVP is present in the message.

      • getRevalidationTime

        Date getRevalidationTime()
        Returns the value of the Revalidation-Time AVP, of type Time.
        Returns:
        the value of the Revalidation-Time AVP or null if it has not been set on this message

      • setRevalidationTime

        void setRevalidationTime​(Date revalidationTime)
        Sets the value of the Revalidation-Time AVP, of type Time.
        Throws:
        NullPointerException - if revalidationTime is null.

      • removeRevalidationTime

        void removeRevalidationTime()
        Removes the Revalidation-Time AVP from the message. If the Revalidation-Time 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.

      • 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.

      • 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.

      • 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.

      • getCsgInformationReportings

        CsgInformationReporting[] getCsgInformationReportings()
        Returns the set of CSG-Information-Reporting AVPs. The returned array contains the AVPs in the order they appear in the message. A return value of null implies that no CSG-Information-Reporting AVPs have been set. The elements in the given array are CsgInformationReporting objects.

      • setCsgInformationReporting

        void setCsgInformationReporting​(CsgInformationReporting csgInformationReporting)
        Sets a single CSG-Information-Reporting AVP in the message, of type Enumerated.
        Throws:
        NullPointerException - if csgInformationReporting is null.

      • setCsgInformationReportings

        void setCsgInformationReportings​(CsgInformationReporting[] csgInformationReportings)
        Sets the set of CSG-Information-Reporting 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 getCsgInformationReportings() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
        Throws:
        NullPointerException - if csgInformationReportings is null.

      • removeCsgInformationReportings

        void removeCsgInformationReportings()
        Removes all CSG-Information-Reporting AVPs from the message. If no CSG-Information-Reporting AVPs are present, this method returns silently.

      • hasUserCsgInformation

        boolean hasUserCsgInformation()
        Returns true if the User-CSG-Information AVP is present in the message.

      • getUserCsgInformation

        UserCsgInformation getUserCsgInformation()
        Returns the value of the User-CSG-Information AVP, of type Grouped.
        Returns:
        the value of the User-CSG-Information AVP or null if it has not been set on this message

      • setUserCsgInformation

        void setUserCsgInformation​(UserCsgInformation userCsgInformation)
        Sets the value of the User-CSG-Information AVP, of type Grouped.
        Throws:
        NullPointerException - if userCsgInformation is null.

      • removeUserCsgInformation

        void removeUserCsgInformation()
        Removes the User-CSG-Information AVP from the message. If the User-CSG-Information AVP is not present, this method returns silently.

      • hasErrorMessage

        boolean hasErrorMessage()
        Returns true if the Error-Message AVP is present in the message.

      • getErrorMessage

        String getErrorMessage()
        Returns the value of the Error-Message AVP, of type UTF8String.
        Returns:
        the value of the Error-Message AVP or null if it has not been set on this message

      • setErrorMessage

        void setErrorMessage​(String errorMessage)
        Sets the value of the Error-Message AVP, of type UTF8String.
        Throws:
        NullPointerException - if errorMessage is null.

      • removeErrorMessage

        void removeErrorMessage()
        Removes the Error-Message AVP from the message. If the Error-Message AVP is not present, this method returns silently.

      • hasErrorReportingHost

        boolean hasErrorReportingHost()
        Returns true if the Error-Reporting-Host AVP is present in the message.

      • getErrorReportingHost

        DiameterIdentity getErrorReportingHost()
        Returns the value of the Error-Reporting-Host AVP, of type DiameterIdentity.
        Returns:
        the value of the Error-Reporting-Host AVP or null if it has not been set on this message

      • setErrorReportingHost

        void setErrorReportingHost​(DiameterIdentity errorReportingHost)
        Sets the value of the Error-Reporting-Host AVP, of type DiameterIdentity.
        Throws:
        NullPointerException - if errorReportingHost is null.

      • removeErrorReportingHost

        void removeErrorReportingHost()
        Removes the Error-Reporting-Host AVP from the message. If the Error-Reporting-Host AVP is not present, this method returns silently.

      • getFailedAvps

        FailedAvp[] getFailedAvps()
        Returns the set of Failed-AVP AVPs. The returned array contains the AVPs in the order they appear in the message. A return value of null implies that no Failed-AVP AVPs have been set. The elements in the given array are FailedAvp objects.

      • setFailedAvp

        void setFailedAvp​(FailedAvp failedAvp)
        Sets a single Failed-AVP AVP in the message, of type Grouped.
        Throws:
        NullPointerException - if failedAvp is null.

      • setFailedAvps

        void setFailedAvps​(FailedAvp[] failedAvps)
        Sets the set of Failed-AVP 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 getFailedAvps() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
        Throws:
        NullPointerException - if failedAvps is null.

      • removeFailedAvps

        void removeFailedAvps()
        Removes all Failed-AVP AVPs from the message. If no Failed-AVP AVPs are 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.