Package org.jainslee.resources.diameter.ro.types.v820

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 Ro Reference Point Protocol Details (3GPP TS 32.299 V8.2.0) specification: 
     7.2.124     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 ]
                           [ TGPP-PDP-Type ]
                           [ PDP-Address ]
                           [ TGPP-GPRS-Negotiated-QoS-Profile ]
                           [ SGSN-Address ]
                           [ GGSN-Address ]
                           [ CG-Address ]
                           [ TGPP-IMSI-MCC-MNC ]
                           [ TGPP-GGSN-MCC-MNC ]
                           [ TGPP-NSAPI ]
                           [ Called-Station-Id ]
                           [ TGPP-Session-Stop-Indicator ]
                           [ TGPP-Selection-Mode ]
                           [ TGPP-Charging-Characteristics ]
                           [ TGPP-SGSN-MCC-MNC ]
                           [ TGPP-MS-TimeZone ]
                         * [ Charging-Rule-Base-Name ]
                           [ TGPP-User-Location-Info ]
                           [ TGPP-RAT-Type ]
                           [ PS-Furnish-Charging-Information ]
                           [ PDP-Context-Type ]
                           [ Offline-Charging ]
                         * [ AVP ]

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

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

      • hasPdpAddress

        boolean hasPdpAddress()
        Returns true if the PDP-Address AVP is present in the PS-Information AVP.

      • getPdpAddress

        Address getPdpAddress()
        Returns the value of the PDP-Address AVP, of type Address.
        Returns:
        the value of the PDP-Address AVP, or null if it has not been set.

      • setPdpAddress

        void setPdpAddress​(Address pdpAddress)
        Sets the value of the PDP-Address AVP, of type Address.
        Throws:
        NullPointerException - if pdpAddress is null.

      • removePdpAddress

        void removePdpAddress()
        Removes the PDP-Address AVP from the PS-Information AVP. If the PDP-Address AVP is not present, this method returns silently.

      • hasTgppGprsNegotiatedQosProfile

        boolean hasTgppGprsNegotiatedQosProfile()
        Returns true if the TGPP-GPRS-Negotiated-QoS-Profile AVP is present in the PS-Information AVP.

      • getTgppGprsNegotiatedQosProfile

        String getTgppGprsNegotiatedQosProfile()
        Returns the value of the TGPP-GPRS-Negotiated-QoS-Profile AVP, of type UTF8String.
        Returns:
        the value of the TGPP-GPRS-Negotiated-QoS-Profile AVP, or null if it has not been set.

      • setTgppGprsNegotiatedQosProfile

        void setTgppGprsNegotiatedQosProfile​(String tgppGprsNegotiatedQosProfile)
        Sets the value of the TGPP-GPRS-Negotiated-QoS-Profile AVP, of type UTF8String.
        Throws:
        NullPointerException - if tgppGprsNegotiatedQosProfile is null.

      • removeTgppGprsNegotiatedQosProfile

        void removeTgppGprsNegotiatedQosProfile()
        Removes the TGPP-GPRS-Negotiated-QoS-Profile AVP from the PS-Information AVP. If the TGPP-GPRS-Negotiated-QoS-Profile 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.

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

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

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

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

      • getChargingRuleBaseNames

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

      • setChargingRuleBaseName

        void setChargingRuleBaseName​(byte[] chargingRuleBaseName)
        Sets a single Charging-Rule-Base-Name AVP in the PS-Information AVP, of type OctetString.
        Throws:
        NullPointerException - if chargingRuleBaseName is null.

      • setChargingRuleBaseNames

        void setChargingRuleBaseNames​(byte[][] chargingRuleBaseNames)
        Sets the set of Charging-Rule-Base-Name 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 getChargingRuleBaseNames() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
        Throws:
        NullPointerException - if chargingRuleBaseNames is null.

      • removeChargingRuleBaseNames

        void removeChargingRuleBaseNames()
        Removes all Charging-Rule-Base-Name AVPs from the PS-Information AVP. If no Charging-Rule-Base-Name AVPs are 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.

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

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