Package org.jainslee.resources.diameter.gx.types.vcd0

Interface RedirectInformation

  • All Superinterfaces:
    Cloneable, DiameterAvp, GroupedAvp
    public interface RedirectInformation
extends GroupedAvp
    Defines an interface representing the Redirect-Information grouped AVP type. From the Diameter Gx Reference Point Protocol Details (3GPP TS 29.212 V11.9.0) specification: 
     5.3.82  Redirect-Information
 
     The Redirect-Information AVP (AVP code 1085) is of type Grouped. It indicates whether the detected application traffic should
     be redirected to another controlled address. The Redirect-Information AVP is sent from the PCRF as a part of Charging-Rule-
     Definition AVP. 
 
     If the Redirect-Information AVP includes the Redirect-Server-Address AVP, the Redirect-Address-Type AVP shall also be provided
     indicating the type of address given in the Redirect-Server-Address AVP.
 
     AVP Format:
 
     Redirect-Information ::= < AVP Header: 1085 >
                              [ Redirect-Support ]
                              [ Redirect-Address-Type ]
                              [ Redirect-Server-Address ]
                             *[ AVP ]

    • Method Detail

      • hasRedirectSupport

        boolean hasRedirectSupport()
        Returns true if the Redirect-Support AVP is present in the Redirect-Information AVP.

      • getRedirectSupport

        RedirectSupport getRedirectSupport()
        Returns the value of the Redirect-Support AVP, of type Enumerated.
        Returns:
        the value of the Redirect-Support AVP, or null if it has not been set.

      • setRedirectSupport

        void setRedirectSupport​(RedirectSupport redirectSupport)
        Sets the value of the Redirect-Support AVP, of type Enumerated.
        Throws:
        NullPointerException - if redirectSupport is null.

      • removeRedirectSupport

        void removeRedirectSupport()
        Removes the Redirect-Support AVP from the Redirect-Information AVP. If the Redirect-Support AVP is not present, this method returns silently.

      • hasRedirectAddressType

        boolean hasRedirectAddressType()
        Returns true if the Redirect-Address-Type AVP is present in the Redirect-Information AVP.

      • getRedirectAddressType

        RedirectAddressType getRedirectAddressType()
        Returns the value of the Redirect-Address-Type AVP, of type Enumerated.
        Returns:
        the value of the Redirect-Address-Type AVP, or null if it has not been set.

      • setRedirectAddressType

        void setRedirectAddressType​(RedirectAddressType redirectAddressType)
        Sets the value of the Redirect-Address-Type AVP, of type Enumerated.
        Throws:
        NullPointerException - if redirectAddressType is null.

      • removeRedirectAddressType

        void removeRedirectAddressType()
        Removes the Redirect-Address-Type AVP from the Redirect-Information AVP. If the Redirect-Address-Type AVP is not present, this method returns silently.

      • hasRedirectServerAddress

        boolean hasRedirectServerAddress()
        Returns true if the Redirect-Server-Address AVP is present in the Redirect-Information AVP.

      • getRedirectServerAddress

        String getRedirectServerAddress()
        Returns the value of the Redirect-Server-Address AVP, of type UTF8String.
        Returns:
        the value of the Redirect-Server-Address AVP, or null if it has not been set.

      • setRedirectServerAddress

        void setRedirectServerAddress​(String redirectServerAddress)
        Sets the value of the Redirect-Server-Address AVP, of type UTF8String.
        Throws:
        NullPointerException - if redirectServerAddress is null.

      • removeRedirectServerAddress

        void removeRedirectServerAddress()
        Removes the Redirect-Server-Address AVP from the Redirect-Information AVP. If the Redirect-Server-Address 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 Redirect-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 Redirect-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 Redirect-Information AVP. If no extension AVPs are present, this method returns silently.