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

Interface AccessTransferInformation

  • All Superinterfaces:
    Cloneable, DiameterAvp, GroupedAvp
    public interface AccessTransferInformation
extends GroupedAvp
    Defines an interface representing the Access-Transfer-Information grouped AVP type. From the Diameter Rf Reference Point Protocol Details (3GPP TS 32.299 V12.11.0) specification: 
     7.2.1 A    Access-Transfer-Information AVP
 
 The Access-Transfer-Information AVP (AVP code 2709) is of type Grouped and provides information on access transfer for IMS service continuity.
 It has the following ABNF grammar:
 
             Access-Transfer-Information ::=  < AVP Header: 2709>
                                                [ Access-Transfer-Type ]
                                              * [ Access-Network-Information ]
    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

      • hasAccessTransferType

        boolean hasAccessTransferType()
        Returns true if the Access-Transfer-Type AVP is present in the Access-Transfer-Information AVP.

      • getAccessTransferType

        AccessTransferType getAccessTransferType()
        Returns the value of the Access-Transfer-Type AVP, of type Enumerated.
        Returns:
        the value of the Access-Transfer-Type AVP, or null if it has not been set.

      • setAccessTransferType

        void setAccessTransferType​(AccessTransferType accessTransferType)
        Sets the value of the Access-Transfer-Type AVP, of type Enumerated.
        Throws:
        NullPointerException - if accessTransferType is null.

      • removeAccessTransferType

        void removeAccessTransferType()
        Removes the Access-Transfer-Type AVP from the Access-Transfer-Information AVP. If the Access-Transfer-Type AVP is not present, this method returns silently.

      • getAccessNetworkInformations

        byte[][] getAccessNetworkInformations()
        Returns the set of Access-Network-Information AVPs. The returned array contains the AVPs in the order they appear in the Access-Transfer-Information AVP. A return value of null implies that no Access-Network-Information AVPs have been set. The elements in the given array are byte[] objects.

      • setAccessNetworkInformation

        void setAccessNetworkInformation​(byte[] accessNetworkInformation)
        Sets a single Access-Network-Information AVP in the Access-Transfer-Information AVP, of type OctetString.
        Throws:
        NullPointerException - if accessNetworkInformation is null.

      • setAccessNetworkInformations

        void setAccessNetworkInformations​(byte[][] accessNetworkInformations)
        Sets the set of Access-Network-Information AVPs, with all the values in the given array. The AVPs will be added to the Access-Transfer-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 getAccessNetworkInformations() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
        Throws:
        NullPointerException - if accessNetworkInformations is null.

      • removeAccessNetworkInformations

        void removeAccessNetworkInformations()
        Removes all Access-Network-Information AVPs from the Access-Transfer-Information AVP. If no Access-Network-Information 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 Access-Transfer-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 Access-Transfer-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 Access-Transfer-Information AVP. If no extension AVPs are present, this method returns silently.