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

Interface AddressDomain

  • All Superinterfaces:
    Cloneable, DiameterAvp, GroupedAvp
    public interface AddressDomain
extends GroupedAvp
    Defines an interface representing the Address-Domain grouped AVP type. From the Diameter Rf Reference Point Protocol Details (3GPP TS 32.299 V12.11.0) specification: 
     7.2.8       Address-Domain AVP
 
 The Address-Domain AVP (AVP code 898) is of type Grouped and indicates the
 domain/network to which the associated address resides. If this AVP is
 present, at least one of the AVPs described within the grouping must be
 included.
 It has the following ABNF:
 
     Address-Domain ::=     < AVP Header: 898 >
                             [ Domain-Name ]
                             [ TGPP-IMSI-MCC-MNC ]
    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

      • hasDomainName

        boolean hasDomainName()
        Returns true if the Domain-Name AVP is present in the Address-Domain AVP.

      • getDomainName

        String getDomainName()
        Returns the value of the Domain-Name AVP, of type UTF8String.
        Returns:
        the value of the Domain-Name AVP, or null if it has not been set.

      • setDomainName

        void setDomainName​(String domainName)
        Sets the value of the Domain-Name AVP, of type UTF8String.
        Throws:
        NullPointerException - if domainName is null.

      • removeDomainName

        void removeDomainName()
        Removes the Domain-Name AVP from the Address-Domain AVP. If the Domain-Name AVP is not present, this method returns silently.

      • hasTgppImsiMccMnc

        boolean hasTgppImsiMccMnc()
        Returns true if the TGPP-IMSI-MCC-MNC AVP is present in the Address-Domain 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 Address-Domain AVP. If the TGPP-IMSI-MCC-MNC 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 Address-Domain 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 Address-Domain 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 Address-Domain AVP. If no extension AVPs are present, this method returns silently.