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

Interface ServingNode

  • All Superinterfaces:
    Cloneable, DiameterAvp, GroupedAvp
    public interface ServingNode
extends GroupedAvp
    Defines an interface representing the Serving-Node grouped AVP type. From the Diameter Ro Reference Point Protocol Details (3GPP TS 32.299 V12.11.0) specification: 
     6.3.3 Serving-Node
 
 The Serving-Node AVP is of type Grouped and it shall contain the name/number of the serving node to be used for T4-triggering. It is originally defined in 3GPP TS 29.173 [8].  
 
     Serving-Node ::=    <AVP Header: 2401 >
                         [ SGSN-Name ]
                         [ SGSN-Realm ]
                         [ SGSN-Number ]
                         [ MME-Name ] 
                         [ MME-Realm ]
                         [ MME-Number-for-MT-SMS ]
                         [ MSC-Number ]
                         [ IP-SM-GW-Number ]
                         [ IP-SM-GW-Name ]
                         [ IP-SM-GW-Realm ]
                         *[AVP] 
 The following combinations are allowed:
     a) SGSN-Number
     b) SGSN-Name & SGSN-Realm & SGSN-Number
     c) MME-Name & MME-Realm & MME-Number-for-MT-SMS
     d) MSC-Number
     e) MSC-Number & MME-Name & MME-Realm
     f) IP-SM-GW-Number
     g) IP-SM-GW-Number & IP-SM-GW-Name & IP-SM-GW-Realm

    • Method Detail

      • hasSgsnName

        boolean hasSgsnName()
        Returns true if the SGSN-Name AVP is present in the Serving-Node AVP.

      • getSgsnName

        DiameterIdentity getSgsnName()
        Returns the value of the SGSN-Name AVP, of type DiameterIdentity.
        Returns:
        the value of the SGSN-Name AVP, or null if it has not been set.

      • removeSgsnName

        void removeSgsnName()
        Removes the SGSN-Name AVP from the Serving-Node AVP. If the SGSN-Name AVP is not present, this method returns silently.

      • hasSgsnRealm

        boolean hasSgsnRealm()
        Returns true if the SGSN-Realm AVP is present in the Serving-Node AVP.

      • getSgsnRealm

        DiameterIdentity getSgsnRealm()
        Returns the value of the SGSN-Realm AVP, of type DiameterIdentity.
        Returns:
        the value of the SGSN-Realm AVP, or null if it has not been set.

      • setSgsnRealm

        void setSgsnRealm​(DiameterIdentity sgsnRealm)
        Sets the value of the SGSN-Realm AVP, of type DiameterIdentity.
        Throws:
        NullPointerException - if sgsnRealm is null.

      • removeSgsnRealm

        void removeSgsnRealm()
        Removes the SGSN-Realm AVP from the Serving-Node AVP. If the SGSN-Realm AVP is not present, this method returns silently.

      • hasSgsnNumber

        boolean hasSgsnNumber()
        Returns true if the SGSN-Number AVP is present in the Serving-Node AVP.

      • getSgsnNumber

        byte[] getSgsnNumber()
        Returns the value of the SGSN-Number AVP, of type OctetString.
        Returns:
        the value of the SGSN-Number AVP, or null if it has not been set.

      • setSgsnNumber

        void setSgsnNumber​(byte[] sgsnNumber)
        Sets the value of the SGSN-Number AVP, of type OctetString.
        Throws:
        NullPointerException - if sgsnNumber is null.

      • removeSgsnNumber

        void removeSgsnNumber()
        Removes the SGSN-Number AVP from the Serving-Node AVP. If the SGSN-Number AVP is not present, this method returns silently.

      • hasMmeName

        boolean hasMmeName()
        Returns true if the MME-Name AVP is present in the Serving-Node 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 Serving-Node 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 Serving-Node 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 Serving-Node AVP. If the MME-Realm 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 Serving-Node 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 Serving-Node AVP. If the MME-Number-for-MT-SMS AVP is not present, this method returns silently.

      • hasMscNumber

        boolean hasMscNumber()
        Returns true if the MSC-Number AVP is present in the Serving-Node AVP.

      • getMscNumber

        byte[] getMscNumber()
        Returns the value of the MSC-Number AVP, of type OctetString.
        Returns:
        the value of the MSC-Number AVP, or null if it has not been set.

      • setMscNumber

        void setMscNumber​(byte[] mscNumber)
        Sets the value of the MSC-Number AVP, of type OctetString.
        Throws:
        NullPointerException - if mscNumber is null.

      • removeMscNumber

        void removeMscNumber()
        Removes the MSC-Number AVP from the Serving-Node AVP. If the MSC-Number AVP is not present, this method returns silently.

      • hasIpSmGwNumber

        boolean hasIpSmGwNumber()
        Returns true if the IP-SM-GW-Number AVP is present in the Serving-Node AVP.

      • getIpSmGwNumber

        byte[] getIpSmGwNumber()
        Returns the value of the IP-SM-GW-Number AVP, of type OctetString.
        Returns:
        the value of the IP-SM-GW-Number AVP, or null if it has not been set.

      • setIpSmGwNumber

        void setIpSmGwNumber​(byte[] ipSmGwNumber)
        Sets the value of the IP-SM-GW-Number AVP, of type OctetString.
        Throws:
        NullPointerException - if ipSmGwNumber is null.

      • removeIpSmGwNumber

        void removeIpSmGwNumber()
        Removes the IP-SM-GW-Number AVP from the Serving-Node AVP. If the IP-SM-GW-Number AVP is not present, this method returns silently.

      • hasIpSmGwName

        boolean hasIpSmGwName()
        Returns true if the IP-SM-GW-Name AVP is present in the Serving-Node AVP.

      • getIpSmGwName

        DiameterIdentity getIpSmGwName()
        Returns the value of the IP-SM-GW-Name AVP, of type DiameterIdentity.
        Returns:
        the value of the IP-SM-GW-Name AVP, or null if it has not been set.

      • setIpSmGwName

        void setIpSmGwName​(DiameterIdentity ipSmGwName)
        Sets the value of the IP-SM-GW-Name AVP, of type DiameterIdentity.
        Throws:
        NullPointerException - if ipSmGwName is null.

      • removeIpSmGwName

        void removeIpSmGwName()
        Removes the IP-SM-GW-Name AVP from the Serving-Node AVP. If the IP-SM-GW-Name AVP is not present, this method returns silently.

      • hasIpSmGwRealm

        boolean hasIpSmGwRealm()
        Returns true if the IP-SM-GW-Realm AVP is present in the Serving-Node AVP.

      • getIpSmGwRealm

        DiameterIdentity getIpSmGwRealm()
        Returns the value of the IP-SM-GW-Realm AVP, of type DiameterIdentity.
        Returns:
        the value of the IP-SM-GW-Realm AVP, or null if it has not been set.

      • setIpSmGwRealm

        void setIpSmGwRealm​(DiameterIdentity ipSmGwRealm)
        Sets the value of the IP-SM-GW-Realm AVP, of type DiameterIdentity.
        Throws:
        NullPointerException - if ipSmGwRealm is null.

      • removeIpSmGwRealm

        void removeIpSmGwRealm()
        Removes the IP-SM-GW-Realm AVP from the Serving-Node AVP. If the IP-SM-GW-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 Serving-Node 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 Serving-Node 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 Serving-Node AVP. If no extension AVPs are present, this method returns silently.