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

Interface ReAuthAnswer

  • All Superinterfaces:
    Cloneable, DiameterMessage
    public interface ReAuthAnswer
extends DiameterMessage
    Defines an interface representing the Re-Auth-Answer command. From the Diameter Gx Reference Point Protocol Details (TGPP TS 29.212 V12.12.0) specification: 
     5.6.5   Re-Auth-Answer (RAA) Command
 
     The RAA command, indicated by the Command-Code field set to 258 and the 'R' bit cleared in 
     the Command Flags field, is sent by the PCEF to the PCRF in response to the RAR command.
 
     Message Format:
     <Re-Auth-Answer> ::=  < Diameter Header: 258, PXY >
                     < Session-Id >
                     { Origin-Host }
                     { Origin-Realm }
                     [ Result-Code ]
                     [ Experimental-Result ]
                     [ Origin-State-Id ]
                     [ OC-Supported-Features ]
                     [ OC-OLR ]
                     [ IP-CAN-Type ]
                     [ RAT-Type ]
                     [ AN-Trusted ]
                  0*2[ AN-GW-Address ]
                     [ TGPP-SGSN-MCC-MNC ]
                     [ TGPP-SGSN-Address ]
                     [ TGPP-SGSN-IPv6-Address ]
                     [ RAI ]
                     [ TGPP-User-Location-Info ]
                     [ User-Location-Info-Time ]
                     [ NetLoc-Access-Support ]
                     [ User-CSG-Information ]
                     [ TGPP-MS-TimeZone ]
                     [ Default-QoS-Information ]
                    *[ Charging-Rule-Report]
                     [ Error-Message ]
                     [ Error-Reporting-Host ]
                    *[ Failed-AVP ]
                    *[ Proxy-Info ]
                    *[ AVP ]

    • Method Detail

      • hasSessionId

        boolean hasSessionId()
        Returns true if the Session-Id AVP is present in the message.

      • getSessionId

        String getSessionId()
        Returns the value of the Session-Id AVP, of type UTF8String.
        Specified by:
        getSessionId in interface DiameterMessage
        Returns:
        the value of the Session-Id AVP or null if it has not been set on this message

      • removeSessionId

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

      • hasOriginHost

        boolean hasOriginHost()
        Returns true if the Origin-Host AVP is present in the message.

      • getOriginHost

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

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

      • getOriginRealm

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

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

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

      • hasOcSupportedFeatures

        boolean hasOcSupportedFeatures()
        Returns true if the OC-Supported-Features AVP is present in the message.

      • getOcSupportedFeatures

        OcSupportedFeatures getOcSupportedFeatures()
        Returns the value of the OC-Supported-Features AVP, of type Grouped.
        Returns:
        the value of the OC-Supported-Features AVP or null if it has not been set on this message

      • setOcSupportedFeatures

        void setOcSupportedFeatures​(OcSupportedFeatures ocSupportedFeatures)
        Sets the value of the OC-Supported-Features AVP, of type Grouped.
        Throws:
        NullPointerException - if ocSupportedFeatures is null.

      • removeOcSupportedFeatures

        void removeOcSupportedFeatures()
        Removes the OC-Supported-Features AVP from the message. If the OC-Supported-Features AVP is not present, this method returns silently.

      • hasOcOlr

        boolean hasOcOlr()
        Returns true if the OC-OLR AVP is present in the message.

      • getOcOlr

        OcOlr getOcOlr()
        Returns the value of the OC-OLR AVP, of type Grouped.
        Returns:
        the value of the OC-OLR AVP or null if it has not been set on this message

      • setOcOlr

        void setOcOlr​(OcOlr ocOlr)
        Sets the value of the OC-OLR AVP, of type Grouped.
        Throws:
        NullPointerException - if ocOlr is null.

      • removeOcOlr

        void removeOcOlr()
        Removes the OC-OLR AVP from the message. If the OC-OLR 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.

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

      • hasAnTrusted

        boolean hasAnTrusted()
        Returns true if the AN-Trusted AVP is present in the message.

      • getAnTrusted

        AnTrusted getAnTrusted()
        Returns the value of the AN-Trusted AVP, of type Enumerated.
        Returns:
        the value of the AN-Trusted AVP or null if it has not been set on this message

      • setAnTrusted

        void setAnTrusted​(AnTrusted anTrusted)
        Sets the value of the AN-Trusted AVP, of type Enumerated.
        Throws:
        NullPointerException - if anTrusted is null.

      • removeAnTrusted

        void removeAnTrusted()
        Removes the AN-Trusted AVP from the message. If the AN-Trusted 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.

      • hasUserLocationInfoTime

        boolean hasUserLocationInfoTime()
        Returns true if the User-Location-Info-Time AVP is present in the message.

      • getUserLocationInfoTime

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

      • setUserLocationInfoTime

        void setUserLocationInfoTime​(Date userLocationInfoTime)
        Sets the value of the User-Location-Info-Time AVP, of type Time.
        Throws:
        NullPointerException - if userLocationInfoTime is null.

      • removeUserLocationInfoTime

        void removeUserLocationInfoTime()
        Removes the User-Location-Info-Time AVP from the message. If the User-Location-Info-Time AVP is not present, this method returns silently.

      • hasNetlocAccessSupport

        boolean hasNetlocAccessSupport()
        Returns true if the NetLoc-Access-Support AVP is present in the message.

      • getNetlocAccessSupport

        long getNetlocAccessSupport()
        Returns the value of the NetLoc-Access-Support AVP, of type Unsigned32. Use hasNetlocAccessSupport() to check the existence of this AVP.
        Returns:
        the value of the NetLoc-Access-Support AVP
        Throws:
        IllegalStateException - if the NetLoc-Access-Support AVP has not been set on this message

      • setNetlocAccessSupport

        void setNetlocAccessSupport​(long netlocAccessSupport)
        Sets the value of the NetLoc-Access-Support AVP, of type Unsigned32.

      • removeNetlocAccessSupport

        void removeNetlocAccessSupport()
        Removes the NetLoc-Access-Support AVP from the message. If the NetLoc-Access-Support AVP is not 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.

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

      • hasDefaultQosInformation

        boolean hasDefaultQosInformation()
        Returns true if the Default-QoS-Information AVP is present in the message.

      • getDefaultQosInformation

        DefaultQosInformation getDefaultQosInformation()
        Returns the value of the Default-QoS-Information AVP, of type Grouped.
        Returns:
        the value of the Default-QoS-Information AVP or null if it has not been set on this message

      • setDefaultQosInformation

        void setDefaultQosInformation​(DefaultQosInformation defaultQosInformation)
        Sets the value of the Default-QoS-Information AVP, of type Grouped.
        Throws:
        NullPointerException - if defaultQosInformation is null.

      • removeDefaultQosInformation

        void removeDefaultQosInformation()
        Removes the Default-QoS-Information AVP from the message. If the Default-QoS-Information AVP is not 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.

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

      • setProxyInfo

        void setProxyInfo​(ProxyInfo proxyInfo)
        Sets a single Proxy-Info AVP in the message, of type Grouped.
        Throws:
        NullPointerException - if proxyInfo is null.

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

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