Interface PsInformation

  • All Superinterfaces:
    Cloneable, DiameterAvp, GroupedAvp

    public interface PsInformation
    extends GroupedAvp
    Defines an interface representing the PS-Information grouped AVP type. From the Diameter Rf Reference Point Protocol Details (3GPP TS 32.299 V10.0.0) specification:
     7.2.158     PS-Information AVP
     
     The PS-Information AVP (AVP code 874) is of type Grouped. Its purpose is to
     allow the transmission of additional PS service specific information
     elements.
     It has the following ABNF grammar:
     
         PS-Information ::=   < AVP Header: 874>
                                [ TGPP-Charging-Id ]
                                [ PDN-Connection-Charging-ID ]
                                [ Node-Id ]
                                [ TGPP-PDP-Type ]
                              * [ PDP-Address ]
                                [ PDP-Address-Prefix-Length ]
                                [ Dynamic-Address-Flag ]
                                [ Dynamic-Address-Flag-Extension ]
                                [ QoS-Information ]
                                [ SGSN-Address ]
                                [ GGSN-Address ]
                                [ SGW-Address ]
                                [ CG-Address ]
                                [ Serving-Node-Type ]
                                [ SGW-Change ]
                                [ TGPP-IMSI-MCC-MNC ]
                                [ IMSI-Unauthenticated-Flag ]
                                [ TGPP-GGSN-MCC-MNC ]
                                [ TGPP-NSAPI ]
                                [ Called-Station-Id ]
                                [ TGPP-Session-Stop-Indicator ]
                                [ TGPP-Selection-Mode ]
                                [ TGPP-Charging-Characteristics ]
                                [ Charging-Characteristics-Selection-Mode ]
                                [ TGPP-SGSN-MCC-MNC ]
                                [ TGPP-MS-TimeZone ]
                                [ Charging-Rule-Base-Name ] 
                                [ TGPP-User-Location-Info ]
                                [ User-CSG-Information ]
                                [ TGPP2-BSID ]
                                [ TWAN-User-Location-Info ]
                                [ TGPP-RAT-Type ]
                                [ PS-Furnish-Charging-Information ]
                                [ PDP-Context-Type ]
                                [ Offline-Charging ]
                              * [ Traffic-Data-Volumes ]
                              * [ Service-Data-Container ]
                                [ User-Equipment-Info ]
                                [ Terminal-Information ]
                                [ Start-Time ]
                                [ Stop-Time ]
                                [ Change-Condition ]
                                [ Diagnostics ]
                                [ Low-Priority-Indicator ]
                                [ MME-Number-for-MT-SMS ]
                                [ MME-Name ]
                                [ MME-Realm ]
     
    Note:
    The support for extension AVPs is present even thou the ABNF grammar for this AVP does not contain the "* [ AVP ]" line. Be aware that adding any extension AVPs may result in interoperability problems with products that strongly validate the incoming diameter message for it's adherence to the specification.
    • Method Detail

      • hasTgppChargingId

        boolean hasTgppChargingId()
        Returns true if the TGPP-Charging-Id AVP is present in the PS-Information AVP.
      • getTgppChargingId

        byte[] getTgppChargingId()
        Returns the value of the TGPP-Charging-Id AVP, of type OctetString.
        Returns:
        the value of the TGPP-Charging-Id AVP, or null if it has not been set.
      • setTgppChargingId

        void setTgppChargingId​(byte[] tgppChargingId)
        Sets the value of the TGPP-Charging-Id AVP, of type OctetString.
        Throws:
        NullPointerException - if tgppChargingId is null.
      • removeTgppChargingId

        void removeTgppChargingId()
        Removes the TGPP-Charging-Id AVP from the PS-Information AVP. If the TGPP-Charging-Id AVP is not present, this method returns silently.
      • hasPdnConnectionChargingId

        boolean hasPdnConnectionChargingId()
        Returns true if the PDN-Connection-Charging-ID AVP is present in the PS-Information AVP.
      • getPdnConnectionChargingId

        long getPdnConnectionChargingId()
        Returns the value of the PDN-Connection-Charging-ID AVP, of type Unsigned32. Use hasPdnConnectionChargingId() to check the existence of this AVP.
        Returns:
        the value of the PDN-Connection-Charging-ID AVP
        Throws:
        IllegalStateException - if the PDN-Connection-Charging-ID AVP has not been set.
      • setPdnConnectionChargingId

        void setPdnConnectionChargingId​(long pdnConnectionChargingId)
        Sets the value of the PDN-Connection-Charging-ID AVP, of type Unsigned32.
      • removePdnConnectionChargingId

        void removePdnConnectionChargingId()
        Removes the PDN-Connection-Charging-ID AVP from the PS-Information AVP. If the PDN-Connection-Charging-ID AVP is not present, this method returns silently.
      • hasNodeId

        boolean hasNodeId()
        Returns true if the Node-Id AVP is present in the PS-Information AVP.
      • getNodeId

        String getNodeId()
        Returns the value of the Node-Id AVP, of type UTF8String.
        Returns:
        the value of the Node-Id AVP, or null if it has not been set.
      • setNodeId

        void setNodeId​(String nodeId)
        Sets the value of the Node-Id AVP, of type UTF8String.
        Throws:
        NullPointerException - if nodeId is null.
      • removeNodeId

        void removeNodeId()
        Removes the Node-Id AVP from the PS-Information AVP. If the Node-Id AVP is not present, this method returns silently.
      • hasTgppPdpType

        boolean hasTgppPdpType()
        Returns true if the TGPP-PDP-Type AVP is present in the PS-Information AVP.
      • getTgppPdpType

        int getTgppPdpType()
        Returns the value of the TGPP-PDP-Type AVP, of type Integer32. Use hasTgppPdpType() to check the existence of this AVP.
        Returns:
        the value of the TGPP-PDP-Type AVP
        Throws:
        IllegalStateException - if the TGPP-PDP-Type AVP has not been set.
      • setTgppPdpType

        void setTgppPdpType​(int tgppPdpType)
        Sets the value of the TGPP-PDP-Type AVP, of type Integer32.
      • removeTgppPdpType

        void removeTgppPdpType()
        Removes the TGPP-PDP-Type AVP from the PS-Information AVP. If the TGPP-PDP-Type AVP is not present, this method returns silently.
      • getPdpAddresses

        Address[] getPdpAddresses()
        Returns the set of PDP-Address AVPs. The returned array contains the AVPs in the order they appear in the PS-Information AVP. A return value of null implies that no PDP-Address AVPs have been set. The elements in the given array are Address objects.
      • setPdpAddress

        void setPdpAddress​(Address pdpAddress)
        Sets a single PDP-Address AVP in the PS-Information AVP, of type Address.
        Throws:
        NullPointerException - if pdpAddress is null.
      • setPdpAddresses

        void setPdpAddresses​(Address[] pdpAddresses)
        Sets the set of PDP-Address AVPs, with all the values in the given array. The AVPs will be added to the PS-Information AVP in the order in which they appear in the array. Note: the array must not be altered by the caller following this call, and getPdpAddresses() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
        Throws:
        NullPointerException - if pdpAddresses is null.
      • removePdpAddresses

        void removePdpAddresses()
        Removes all PDP-Address AVPs from the PS-Information AVP. If no PDP-Address AVPs are present, this method returns silently.
      • hasPdpAddressPrefixLength

        boolean hasPdpAddressPrefixLength()
        Returns true if the PDP-Address-Prefix-Length AVP is present in the PS-Information AVP.
      • getPdpAddressPrefixLength

        long getPdpAddressPrefixLength()
        Returns the value of the PDP-Address-Prefix-Length AVP, of type Unsigned32. Use hasPdpAddressPrefixLength() to check the existence of this AVP.
        Returns:
        the value of the PDP-Address-Prefix-Length AVP
        Throws:
        IllegalStateException - if the PDP-Address-Prefix-Length AVP has not been set.
      • setPdpAddressPrefixLength

        void setPdpAddressPrefixLength​(long pdpAddressPrefixLength)
        Sets the value of the PDP-Address-Prefix-Length AVP, of type Unsigned32.
      • removePdpAddressPrefixLength

        void removePdpAddressPrefixLength()
        Removes the PDP-Address-Prefix-Length AVP from the PS-Information AVP. If the PDP-Address-Prefix-Length AVP is not present, this method returns silently.
      • hasDynamicAddressFlag

        boolean hasDynamicAddressFlag()
        Returns true if the Dynamic-Address-Flag AVP is present in the PS-Information AVP.
      • getDynamicAddressFlag

        DynamicAddressFlag getDynamicAddressFlag()
        Returns the value of the Dynamic-Address-Flag AVP, of type Enumerated.
        Returns:
        the value of the Dynamic-Address-Flag AVP, or null if it has not been set.
      • setDynamicAddressFlag

        void setDynamicAddressFlag​(DynamicAddressFlag dynamicAddressFlag)
        Sets the value of the Dynamic-Address-Flag AVP, of type Enumerated.
        Throws:
        NullPointerException - if dynamicAddressFlag is null.
      • removeDynamicAddressFlag

        void removeDynamicAddressFlag()
        Removes the Dynamic-Address-Flag AVP from the PS-Information AVP. If the Dynamic-Address-Flag AVP is not present, this method returns silently.
      • hasDynamicAddressFlagExtension

        boolean hasDynamicAddressFlagExtension()
        Returns true if the Dynamic-Address-Flag-Extension AVP is present in the PS-Information AVP.
      • getDynamicAddressFlagExtension

        DynamicAddressFlagExtension getDynamicAddressFlagExtension()
        Returns the value of the Dynamic-Address-Flag-Extension AVP, of type Enumerated.
        Returns:
        the value of the Dynamic-Address-Flag-Extension AVP, or null if it has not been set.
      • setDynamicAddressFlagExtension

        void setDynamicAddressFlagExtension​(DynamicAddressFlagExtension dynamicAddressFlagExtension)
        Sets the value of the Dynamic-Address-Flag-Extension AVP, of type Enumerated.
        Throws:
        NullPointerException - if dynamicAddressFlagExtension is null.
      • removeDynamicAddressFlagExtension

        void removeDynamicAddressFlagExtension()
        Removes the Dynamic-Address-Flag-Extension AVP from the PS-Information AVP. If the Dynamic-Address-Flag-Extension AVP is not present, this method returns silently.
      • hasQosInformation

        boolean hasQosInformation()
        Returns true if the QoS-Information AVP is present in the PS-Information AVP.
      • 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.
      • 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 PS-Information AVP. If the QoS-Information AVP is not present, this method returns silently.
      • hasSgsnAddress

        boolean hasSgsnAddress()
        Returns true if the SGSN-Address AVP is present in the PS-Information AVP.
      • getSgsnAddress

        Address getSgsnAddress()
        Returns the value of the SGSN-Address AVP, of type Address.
        Returns:
        the value of the SGSN-Address AVP, or null if it has not been set.
      • setSgsnAddress

        void setSgsnAddress​(Address sgsnAddress)
        Sets the value of the SGSN-Address AVP, of type Address.
        Throws:
        NullPointerException - if sgsnAddress is null.
      • removeSgsnAddress

        void removeSgsnAddress()
        Removes the SGSN-Address AVP from the PS-Information AVP. If the SGSN-Address AVP is not present, this method returns silently.
      • hasGgsnAddress

        boolean hasGgsnAddress()
        Returns true if the GGSN-Address AVP is present in the PS-Information AVP.
      • getGgsnAddress

        Address getGgsnAddress()
        Returns the value of the GGSN-Address AVP, of type Address.
        Returns:
        the value of the GGSN-Address AVP, or null if it has not been set.
      • setGgsnAddress

        void setGgsnAddress​(Address ggsnAddress)
        Sets the value of the GGSN-Address AVP, of type Address.
        Throws:
        NullPointerException - if ggsnAddress is null.
      • removeGgsnAddress

        void removeGgsnAddress()
        Removes the GGSN-Address AVP from the PS-Information AVP. If the GGSN-Address AVP is not present, this method returns silently.
      • hasSgwAddress

        boolean hasSgwAddress()
        Returns true if the SGW-Address AVP is present in the PS-Information AVP.
      • getSgwAddress

        Address getSgwAddress()
        Returns the value of the SGW-Address AVP, of type Address.
        Returns:
        the value of the SGW-Address AVP, or null if it has not been set.
      • setSgwAddress

        void setSgwAddress​(Address sgwAddress)
        Sets the value of the SGW-Address AVP, of type Address.
        Throws:
        NullPointerException - if sgwAddress is null.
      • removeSgwAddress

        void removeSgwAddress()
        Removes the SGW-Address AVP from the PS-Information AVP. If the SGW-Address AVP is not present, this method returns silently.
      • hasCgAddress

        boolean hasCgAddress()
        Returns true if the CG-Address AVP is present in the PS-Information AVP.
      • getCgAddress

        Address getCgAddress()
        Returns the value of the CG-Address AVP, of type Address.
        Returns:
        the value of the CG-Address AVP, or null if it has not been set.
      • setCgAddress

        void setCgAddress​(Address cgAddress)
        Sets the value of the CG-Address AVP, of type Address.
        Throws:
        NullPointerException - if cgAddress is null.
      • removeCgAddress

        void removeCgAddress()
        Removes the CG-Address AVP from the PS-Information AVP. If the CG-Address AVP is not present, this method returns silently.
      • hasServingNodeType

        boolean hasServingNodeType()
        Returns true if the Serving-Node-Type AVP is present in the PS-Information AVP.
      • getServingNodeType

        ServingNodeType getServingNodeType()
        Returns the value of the Serving-Node-Type AVP, of type Enumerated.
        Returns:
        the value of the Serving-Node-Type AVP, or null if it has not been set.
      • setServingNodeType

        void setServingNodeType​(ServingNodeType servingNodeType)
        Sets the value of the Serving-Node-Type AVP, of type Enumerated.
        Throws:
        NullPointerException - if servingNodeType is null.
      • removeServingNodeType

        void removeServingNodeType()
        Removes the Serving-Node-Type AVP from the PS-Information AVP. If the Serving-Node-Type AVP is not present, this method returns silently.
      • hasSgwChange

        boolean hasSgwChange()
        Returns true if the SGW-Change AVP is present in the PS-Information AVP.
      • getSgwChange

        SgwChange getSgwChange()
        Returns the value of the SGW-Change AVP, of type Enumerated.
        Returns:
        the value of the SGW-Change AVP, or null if it has not been set.
      • setSgwChange

        void setSgwChange​(SgwChange sgwChange)
        Sets the value of the SGW-Change AVP, of type Enumerated.
        Throws:
        NullPointerException - if sgwChange is null.
      • removeSgwChange

        void removeSgwChange()
        Removes the SGW-Change AVP from the PS-Information AVP. If the SGW-Change AVP is not present, this method returns silently.
      • hasTgppImsiMccMnc

        boolean hasTgppImsiMccMnc()
        Returns true if the TGPP-IMSI-MCC-MNC AVP is present in the PS-Information AVP.
      • getTgppImsiMccMnc

        String getTgppImsiMccMnc()
        Returns the value of the TGPP-IMSI-MCC-MNC AVP, of type UTF8String.
        Returns:
        the value of the TGPP-IMSI-MCC-MNC AVP, or null if it has not been set.
      • setTgppImsiMccMnc

        void setTgppImsiMccMnc​(String tgppImsiMccMnc)
        Sets the value of the TGPP-IMSI-MCC-MNC AVP, of type UTF8String.
        Throws:
        NullPointerException - if tgppImsiMccMnc is null.
      • removeTgppImsiMccMnc

        void removeTgppImsiMccMnc()
        Removes the TGPP-IMSI-MCC-MNC AVP from the PS-Information AVP. If the TGPP-IMSI-MCC-MNC AVP is not present, this method returns silently.
      • hasImsiUnauthenticatedFlag

        boolean hasImsiUnauthenticatedFlag()
        Returns true if the IMSI-Unauthenticated-Flag AVP is present in the PS-Information AVP.
      • getImsiUnauthenticatedFlag

        ImsiUnauthenticatedFlag getImsiUnauthenticatedFlag()
        Returns the value of the IMSI-Unauthenticated-Flag AVP, of type Enumerated.
        Returns:
        the value of the IMSI-Unauthenticated-Flag AVP, or null if it has not been set.
      • setImsiUnauthenticatedFlag

        void setImsiUnauthenticatedFlag​(ImsiUnauthenticatedFlag imsiUnauthenticatedFlag)
        Sets the value of the IMSI-Unauthenticated-Flag AVP, of type Enumerated.
        Throws:
        NullPointerException - if imsiUnauthenticatedFlag is null.
      • removeImsiUnauthenticatedFlag

        void removeImsiUnauthenticatedFlag()
        Removes the IMSI-Unauthenticated-Flag AVP from the PS-Information AVP. If the IMSI-Unauthenticated-Flag AVP is not present, this method returns silently.
      • hasTgppGgsnMccMnc

        boolean hasTgppGgsnMccMnc()
        Returns true if the TGPP-GGSN-MCC-MNC AVP is present in the PS-Information AVP.
      • getTgppGgsnMccMnc

        String getTgppGgsnMccMnc()
        Returns the value of the TGPP-GGSN-MCC-MNC AVP, of type UTF8String.
        Returns:
        the value of the TGPP-GGSN-MCC-MNC AVP, or null if it has not been set.
      • setTgppGgsnMccMnc

        void setTgppGgsnMccMnc​(String tgppGgsnMccMnc)
        Sets the value of the TGPP-GGSN-MCC-MNC AVP, of type UTF8String.
        Throws:
        NullPointerException - if tgppGgsnMccMnc is null.
      • removeTgppGgsnMccMnc

        void removeTgppGgsnMccMnc()
        Removes the TGPP-GGSN-MCC-MNC AVP from the PS-Information AVP. If the TGPP-GGSN-MCC-MNC AVP is not present, this method returns silently.
      • hasTgppNsapi

        boolean hasTgppNsapi()
        Returns true if the TGPP-NSAPI AVP is present in the PS-Information AVP.
      • getTgppNsapi

        byte[] getTgppNsapi()
        Returns the value of the TGPP-NSAPI AVP, of type OctetString.
        Returns:
        the value of the TGPP-NSAPI AVP, or null if it has not been set.
      • setTgppNsapi

        void setTgppNsapi​(byte[] tgppNsapi)
        Sets the value of the TGPP-NSAPI AVP, of type OctetString.
        Throws:
        NullPointerException - if tgppNsapi is null.
      • removeTgppNsapi

        void removeTgppNsapi()
        Removes the TGPP-NSAPI AVP from the PS-Information AVP. If the TGPP-NSAPI AVP is not present, this method returns silently.
      • hasCalledStationId

        boolean hasCalledStationId()
        Returns true if the Called-Station-Id AVP is present in the PS-Information AVP.
      • 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.
      • 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 PS-Information AVP. If the Called-Station-Id AVP is not present, this method returns silently.
      • hasTgppSessionStopIndicator

        boolean hasTgppSessionStopIndicator()
        Returns true if the TGPP-Session-Stop-Indicator AVP is present in the PS-Information AVP.
      • getTgppSessionStopIndicator

        byte[] getTgppSessionStopIndicator()
        Returns the value of the TGPP-Session-Stop-Indicator AVP, of type OctetString.
        Returns:
        the value of the TGPP-Session-Stop-Indicator AVP, or null if it has not been set.
      • setTgppSessionStopIndicator

        void setTgppSessionStopIndicator​(byte[] tgppSessionStopIndicator)
        Sets the value of the TGPP-Session-Stop-Indicator AVP, of type OctetString.
        Throws:
        NullPointerException - if tgppSessionStopIndicator is null.
      • removeTgppSessionStopIndicator

        void removeTgppSessionStopIndicator()
        Removes the TGPP-Session-Stop-Indicator AVP from the PS-Information AVP. If the TGPP-Session-Stop-Indicator AVP is not present, this method returns silently.
      • hasTgppSelectionMode

        boolean hasTgppSelectionMode()
        Returns true if the TGPP-Selection-Mode AVP is present in the PS-Information AVP.
      • getTgppSelectionMode

        String getTgppSelectionMode()
        Returns the value of the TGPP-Selection-Mode AVP, of type UTF8String.
        Returns:
        the value of the TGPP-Selection-Mode AVP, or null if it has not been set.
      • setTgppSelectionMode

        void setTgppSelectionMode​(String tgppSelectionMode)
        Sets the value of the TGPP-Selection-Mode AVP, of type UTF8String.
        Throws:
        NullPointerException - if tgppSelectionMode is null.
      • removeTgppSelectionMode

        void removeTgppSelectionMode()
        Removes the TGPP-Selection-Mode AVP from the PS-Information AVP. If the TGPP-Selection-Mode AVP is not present, this method returns silently.
      • hasTgppChargingCharacteristics

        boolean hasTgppChargingCharacteristics()
        Returns true if the TGPP-Charging-Characteristics AVP is present in the PS-Information AVP.
      • getTgppChargingCharacteristics

        String getTgppChargingCharacteristics()
        Returns the value of the TGPP-Charging-Characteristics AVP, of type UTF8String.
        Returns:
        the value of the TGPP-Charging-Characteristics AVP, or null if it has not been set.
      • setTgppChargingCharacteristics

        void setTgppChargingCharacteristics​(String tgppChargingCharacteristics)
        Sets the value of the TGPP-Charging-Characteristics AVP, of type UTF8String.
        Throws:
        NullPointerException - if tgppChargingCharacteristics is null.
      • removeTgppChargingCharacteristics

        void removeTgppChargingCharacteristics()
        Removes the TGPP-Charging-Characteristics AVP from the PS-Information AVP. If the TGPP-Charging-Characteristics AVP is not present, this method returns silently.
      • hasChargingCharacteristicsSelectionMode

        boolean hasChargingCharacteristicsSelectionMode()
        Returns true if the Charging-Characteristics-Selection-Mode AVP is present in the PS-Information AVP.
      • getChargingCharacteristicsSelectionMode

        ChargingCharacteristicsSelectionMode getChargingCharacteristicsSelectionMode()
        Returns the value of the Charging-Characteristics-Selection-Mode AVP, of type Enumerated.
        Returns:
        the value of the Charging-Characteristics-Selection-Mode AVP, or null if it has not been set.
      • setChargingCharacteristicsSelectionMode

        void setChargingCharacteristicsSelectionMode​(ChargingCharacteristicsSelectionMode chargingCharacteristicsSelectionMode)
        Sets the value of the Charging-Characteristics-Selection-Mode AVP, of type Enumerated.
        Throws:
        NullPointerException - if chargingCharacteristicsSelectionMode is null.
      • removeChargingCharacteristicsSelectionMode

        void removeChargingCharacteristicsSelectionMode()
        Removes the Charging-Characteristics-Selection-Mode AVP from the PS-Information AVP. If the Charging-Characteristics-Selection-Mode AVP is not present, this method returns silently.
      • hasTgppSgsnMccMnc

        boolean hasTgppSgsnMccMnc()
        Returns true if the TGPP-SGSN-MCC-MNC AVP is present in the PS-Information AVP.
      • 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.
      • 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 PS-Information AVP. If the TGPP-SGSN-MCC-MNC AVP is not present, this method returns silently.
      • hasTgppMsTimezone

        boolean hasTgppMsTimezone()
        Returns true if the TGPP-MS-TimeZone AVP is present in the PS-Information AVP.
      • 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.
      • 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 PS-Information AVP. If the TGPP-MS-TimeZone AVP is not present, this method returns silently.
      • hasChargingRuleBaseName

        boolean hasChargingRuleBaseName()
        Returns true if the Charging-Rule-Base-Name AVP is present in the PS-Information AVP.
      • getChargingRuleBaseName

        byte[] getChargingRuleBaseName()
        Returns the value of the Charging-Rule-Base-Name AVP, of type OctetString.
        Returns:
        the value of the Charging-Rule-Base-Name AVP, or null if it has not been set.
      • setChargingRuleBaseName

        void setChargingRuleBaseName​(byte[] chargingRuleBaseName)
        Sets the value of the Charging-Rule-Base-Name AVP, of type OctetString.
        Throws:
        NullPointerException - if chargingRuleBaseName is null.
      • removeChargingRuleBaseName

        void removeChargingRuleBaseName()
        Removes the Charging-Rule-Base-Name AVP from the PS-Information AVP. If the Charging-Rule-Base-Name AVP is not present, this method returns silently.
      • hasTgppUserLocationInfo

        boolean hasTgppUserLocationInfo()
        Returns true if the TGPP-User-Location-Info AVP is present in the PS-Information AVP.
      • 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.
      • 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 PS-Information AVP. If the TGPP-User-Location-Info AVP is not present, this method returns silently.
      • hasUserCsgInformation

        boolean hasUserCsgInformation()
        Returns true if the User-CSG-Information AVP is present in the PS-Information AVP.
      • 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.
      • 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 PS-Information AVP. If the User-CSG-Information AVP is not present, this method returns silently.
      • hasTgpp2Bsid

        boolean hasTgpp2Bsid()
        Returns true if the TGPP2-BSID AVP is present in the PS-Information AVP.
      • getTgpp2Bsid

        String getTgpp2Bsid()
        Returns the value of the TGPP2-BSID AVP, of type UTF8String.
        Returns:
        the value of the TGPP2-BSID AVP, or null if it has not been set.
      • setTgpp2Bsid

        void setTgpp2Bsid​(String tgpp2Bsid)
        Sets the value of the TGPP2-BSID AVP, of type UTF8String.
        Throws:
        NullPointerException - if tgpp2Bsid is null.
      • removeTgpp2Bsid

        void removeTgpp2Bsid()
        Removes the TGPP2-BSID AVP from the PS-Information AVP. If the TGPP2-BSID AVP is not present, this method returns silently.
      • hasTwanUserLocationInfo

        boolean hasTwanUserLocationInfo()
        Returns true if the TWAN-User-Location-Info AVP is present in the PS-Information AVP.
      • getTwanUserLocationInfo

        TwanUserLocationInfo getTwanUserLocationInfo()
        Returns the value of the TWAN-User-Location-Info AVP, of type Grouped.
        Returns:
        the value of the TWAN-User-Location-Info AVP, or null if it has not been set.
      • setTwanUserLocationInfo

        void setTwanUserLocationInfo​(TwanUserLocationInfo twanUserLocationInfo)
        Sets the value of the TWAN-User-Location-Info AVP, of type Grouped.
        Throws:
        NullPointerException - if twanUserLocationInfo is null.
      • removeTwanUserLocationInfo

        void removeTwanUserLocationInfo()
        Removes the TWAN-User-Location-Info AVP from the PS-Information AVP. If the TWAN-User-Location-Info AVP is not present, this method returns silently.
      • hasTgppRatType

        boolean hasTgppRatType()
        Returns true if the TGPP-RAT-Type AVP is present in the PS-Information AVP.
      • 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.
      • 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 PS-Information AVP. If the TGPP-RAT-Type AVP is not present, this method returns silently.
      • hasPsFurnishChargingInformation

        boolean hasPsFurnishChargingInformation()
        Returns true if the PS-Furnish-Charging-Information AVP is present in the PS-Information AVP.
      • getPsFurnishChargingInformation

        PsFurnishChargingInformation getPsFurnishChargingInformation()
        Returns the value of the PS-Furnish-Charging-Information AVP, of type Grouped.
        Returns:
        the value of the PS-Furnish-Charging-Information AVP, or null if it has not been set.
      • setPsFurnishChargingInformation

        void setPsFurnishChargingInformation​(PsFurnishChargingInformation psFurnishChargingInformation)
        Sets the value of the PS-Furnish-Charging-Information AVP, of type Grouped.
        Throws:
        NullPointerException - if psFurnishChargingInformation is null.
      • removePsFurnishChargingInformation

        void removePsFurnishChargingInformation()
        Removes the PS-Furnish-Charging-Information AVP from the PS-Information AVP. If the PS-Furnish-Charging-Information AVP is not present, this method returns silently.
      • hasPdpContextType

        boolean hasPdpContextType()
        Returns true if the PDP-Context-Type AVP is present in the PS-Information AVP.
      • getPdpContextType

        PdpContextType getPdpContextType()
        Returns the value of the PDP-Context-Type AVP, of type Enumerated.
        Returns:
        the value of the PDP-Context-Type AVP, or null if it has not been set.
      • setPdpContextType

        void setPdpContextType​(PdpContextType pdpContextType)
        Sets the value of the PDP-Context-Type AVP, of type Enumerated.
        Throws:
        NullPointerException - if pdpContextType is null.
      • removePdpContextType

        void removePdpContextType()
        Removes the PDP-Context-Type AVP from the PS-Information AVP. If the PDP-Context-Type AVP is not present, this method returns silently.
      • hasOfflineCharging

        boolean hasOfflineCharging()
        Returns true if the Offline-Charging AVP is present in the PS-Information AVP.
      • getOfflineCharging

        OfflineCharging getOfflineCharging()
        Returns the value of the Offline-Charging AVP, of type Grouped.
        Returns:
        the value of the Offline-Charging AVP, or null if it has not been set.
      • setOfflineCharging

        void setOfflineCharging​(OfflineCharging offlineCharging)
        Sets the value of the Offline-Charging AVP, of type Grouped.
        Throws:
        NullPointerException - if offlineCharging is null.
      • removeOfflineCharging

        void removeOfflineCharging()
        Removes the Offline-Charging AVP from the PS-Information AVP. If the Offline-Charging AVP is not present, this method returns silently.
      • getTrafficDataVolumeses

        TrafficDataVolumes[] getTrafficDataVolumeses()
        Returns the set of Traffic-Data-Volumes AVPs. The returned array contains the AVPs in the order they appear in the PS-Information AVP. A return value of null implies that no Traffic-Data-Volumes AVPs have been set. The elements in the given array are TrafficDataVolumes objects.
      • setTrafficDataVolumes

        void setTrafficDataVolumes​(TrafficDataVolumes trafficDataVolumes)
        Sets a single Traffic-Data-Volumes AVP in the PS-Information AVP, of type Grouped.
        Throws:
        NullPointerException - if trafficDataVolumes is null.
      • setTrafficDataVolumeses

        void setTrafficDataVolumeses​(TrafficDataVolumes[] trafficDataVolumeses)
        Sets the set of Traffic-Data-Volumes AVPs, with all the values in the given array. The AVPs will be added to the PS-Information AVP in the order in which they appear in the array. Note: the array must not be altered by the caller following this call, and getTrafficDataVolumeses() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
        Throws:
        NullPointerException - if trafficDataVolumeses is null.
      • removeTrafficDataVolumeses

        void removeTrafficDataVolumeses()
        Removes all Traffic-Data-Volumes AVPs from the PS-Information AVP. If no Traffic-Data-Volumes AVPs are present, this method returns silently.
      • getServiceDataContainers

        ServiceDataContainer[] getServiceDataContainers()
        Returns the set of Service-Data-Container AVPs. The returned array contains the AVPs in the order they appear in the PS-Information AVP. A return value of null implies that no Service-Data-Container AVPs have been set. The elements in the given array are ServiceDataContainer objects.
      • setServiceDataContainer

        void setServiceDataContainer​(ServiceDataContainer serviceDataContainer)
        Sets a single Service-Data-Container AVP in the PS-Information AVP, of type Grouped.
        Throws:
        NullPointerException - if serviceDataContainer is null.
      • setServiceDataContainers

        void setServiceDataContainers​(ServiceDataContainer[] serviceDataContainers)
        Sets the set of Service-Data-Container AVPs, with all the values in the given array. The AVPs will be added to the PS-Information AVP in the order in which they appear in the array. Note: the array must not be altered by the caller following this call, and getServiceDataContainers() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
        Throws:
        NullPointerException - if serviceDataContainers is null.
      • removeServiceDataContainers

        void removeServiceDataContainers()
        Removes all Service-Data-Container AVPs from the PS-Information AVP. If no Service-Data-Container AVPs are present, this method returns silently.
      • hasUserEquipmentInfo

        boolean hasUserEquipmentInfo()
        Returns true if the User-Equipment-Info AVP is present in the PS-Information AVP.
      • 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.
      • 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 PS-Information AVP. If the User-Equipment-Info AVP is not present, this method returns silently.
      • hasTerminalInformation

        boolean hasTerminalInformation()
        Returns true if the Terminal-Information AVP is present in the PS-Information AVP.
      • getTerminalInformation

        TerminalInformation getTerminalInformation()
        Returns the value of the Terminal-Information AVP, of type Grouped.
        Returns:
        the value of the Terminal-Information AVP, or null if it has not been set.
      • setTerminalInformation

        void setTerminalInformation​(TerminalInformation terminalInformation)
        Sets the value of the Terminal-Information AVP, of type Grouped.
        Throws:
        NullPointerException - if terminalInformation is null.
      • removeTerminalInformation

        void removeTerminalInformation()
        Removes the Terminal-Information AVP from the PS-Information AVP. If the Terminal-Information AVP is not present, this method returns silently.
      • hasStartTime

        boolean hasStartTime()
        Returns true if the Start-Time AVP is present in the PS-Information AVP.
      • getStartTime

        Date getStartTime()
        Returns the value of the Start-Time AVP, of type Time.
        Returns:
        the value of the Start-Time AVP, or null if it has not been set.
      • setStartTime

        void setStartTime​(Date startTime)
        Sets the value of the Start-Time AVP, of type Time.
        Throws:
        NullPointerException - if startTime is null.
      • removeStartTime

        void removeStartTime()
        Removes the Start-Time AVP from the PS-Information AVP. If the Start-Time AVP is not present, this method returns silently.
      • hasStopTime

        boolean hasStopTime()
        Returns true if the Stop-Time AVP is present in the PS-Information AVP.
      • getStopTime

        Date getStopTime()
        Returns the value of the Stop-Time AVP, of type Time.
        Returns:
        the value of the Stop-Time AVP, or null if it has not been set.
      • setStopTime

        void setStopTime​(Date stopTime)
        Sets the value of the Stop-Time AVP, of type Time.
        Throws:
        NullPointerException - if stopTime is null.
      • removeStopTime

        void removeStopTime()
        Removes the Stop-Time AVP from the PS-Information AVP. If the Stop-Time AVP is not present, this method returns silently.
      • hasChangeCondition

        boolean hasChangeCondition()
        Returns true if the Change-Condition AVP is present in the PS-Information AVP.
      • getChangeCondition

        int getChangeCondition()
        Returns the value of the Change-Condition AVP, of type Integer32. Use hasChangeCondition() to check the existence of this AVP.
        Returns:
        the value of the Change-Condition AVP
        Throws:
        IllegalStateException - if the Change-Condition AVP has not been set.
      • setChangeCondition

        void setChangeCondition​(int changeCondition)
        Sets the value of the Change-Condition AVP, of type Integer32.
      • removeChangeCondition

        void removeChangeCondition()
        Removes the Change-Condition AVP from the PS-Information AVP. If the Change-Condition AVP is not present, this method returns silently.
      • hasDiagnostics

        boolean hasDiagnostics()
        Returns true if the Diagnostics AVP is present in the PS-Information AVP.
      • getDiagnostics

        int getDiagnostics()
        Returns the value of the Diagnostics AVP, of type Integer32. Use hasDiagnostics() to check the existence of this AVP.
        Returns:
        the value of the Diagnostics AVP
        Throws:
        IllegalStateException - if the Diagnostics AVP has not been set.
      • setDiagnostics

        void setDiagnostics​(int diagnostics)
        Sets the value of the Diagnostics AVP, of type Integer32.
      • removeDiagnostics

        void removeDiagnostics()
        Removes the Diagnostics AVP from the PS-Information AVP. If the Diagnostics AVP is not present, this method returns silently.
      • hasLowPriorityIndicator

        boolean hasLowPriorityIndicator()
        Returns true if the Low-Priority-Indicator AVP is present in the PS-Information AVP.
      • getLowPriorityIndicator

        LowPriorityIndicator getLowPriorityIndicator()
        Returns the value of the Low-Priority-Indicator AVP, of type Enumerated.
        Returns:
        the value of the Low-Priority-Indicator AVP, or null if it has not been set.
      • setLowPriorityIndicator

        void setLowPriorityIndicator​(LowPriorityIndicator lowPriorityIndicator)
        Sets the value of the Low-Priority-Indicator AVP, of type Enumerated.
        Throws:
        NullPointerException - if lowPriorityIndicator is null.
      • removeLowPriorityIndicator

        void removeLowPriorityIndicator()
        Removes the Low-Priority-Indicator AVP from the PS-Information AVP. If the Low-Priority-Indicator AVP is not present, this method returns silently.
      • hasMmeNumberForMtSms

        boolean hasMmeNumberForMtSms()
        Returns true if the MME-Number-for-MT-SMS AVP is present in the PS-Information AVP.
      • getMmeNumberForMtSms

        byte[] getMmeNumberForMtSms()
        Returns the value of the MME-Number-for-MT-SMS AVP, of type OctetString.
        Returns:
        the value of the MME-Number-for-MT-SMS AVP, or null if it has not been set.
      • setMmeNumberForMtSms

        void setMmeNumberForMtSms​(byte[] mmeNumberForMtSms)
        Sets the value of the MME-Number-for-MT-SMS AVP, of type OctetString.
        Throws:
        NullPointerException - if mmeNumberForMtSms is null.
      • removeMmeNumberForMtSms

        void removeMmeNumberForMtSms()
        Removes the MME-Number-for-MT-SMS AVP from the PS-Information AVP. If the MME-Number-for-MT-SMS AVP is not present, this method returns silently.
      • hasMmeName

        boolean hasMmeName()
        Returns true if the MME-Name AVP is present in the PS-Information AVP.
      • getMmeName

        DiameterIdentity getMmeName()
        Returns the value of the MME-Name AVP, of type DiameterIdentity.
        Returns:
        the value of the MME-Name AVP, or null if it has not been set.
      • removeMmeName

        void removeMmeName()
        Removes the MME-Name AVP from the PS-Information AVP. If the MME-Name AVP is not present, this method returns silently.
      • hasMmeRealm

        boolean hasMmeRealm()
        Returns true if the MME-Realm AVP is present in the PS-Information AVP.
      • getMmeRealm

        DiameterIdentity getMmeRealm()
        Returns the value of the MME-Realm AVP, of type DiameterIdentity.
        Returns:
        the value of the MME-Realm AVP, or null if it has not been set.
      • removeMmeRealm

        void removeMmeRealm()
        Removes the MME-Realm AVP from the PS-Information AVP. If the MME-Realm AVP is not present, this method returns silently.
      • getExtensionAvps

        DiameterAvp[] getExtensionAvps()
        Returns the set of extension AVPs. The returned array contains the extension AVPs in the order they appear in the PS-Information AVP. A return value of null implies that no extensions AVPs have been set.
      • setExtensionAvps

        void setExtensionAvps​(DiameterAvp[] avps)
                       throws AvpNotAllowedException
        Sets the set of extension AVPs with all the values in the given array. The AVPs will be added to PS-Information AVP in the order in which they appear in the array. Note: the array must not be altered by the caller following this call, and getExtensionAvps() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
        Throws:
        AvpNotAllowedException - if an AVP is encountered of a type already known to this class (i.e. an AVP for which get/set methods already appear in this class)
        NullPointerException - if avps is null.
      • removeExtensionAvps

        void removeExtensionAvps()
        Removes all extension AVPs from the PS-Information AVP. If no extension AVPs are present, this method returns silently.