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

Interface SdpMediaComponent

  • All Superinterfaces:
    Cloneable, DiameterAvp, GroupedAvp
    public interface SdpMediaComponent
extends GroupedAvp
    Defines an interface representing the SDP-Media-Component grouped AVP type. From the Diameter Ro Reference Point Protocol Details (3GPP TS 32.299 V10.0.0) specification: 
     7.2.180     SDP-Media-Component AVP
 
 The SDP-Media-Component AVP (AVP code 843) is of type Grouped and contains
 information about media used for a IMS session.
 It has the following ABNF grammar:
 
       SDP-Media-Component ::=  <AVP Header: 843 >
                                [ SDP-Media-Name ]
                              * [ SDP-Media-Description ]
                                [ Media-Initiator-Flag]
                                [ Media-Initiator-Party ]
                                [ Authorised-QoS ]
                                [ TGPP-Charging-Id ]
                                [ Access-Network-Charging-Identifier-Value ]
                                [ SDP-Type ]
    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

      • hasSdpMediaName

        boolean hasSdpMediaName()
        Returns true if the SDP-Media-Name AVP is present in the SDP-Media-Component AVP.

      • getSdpMediaName

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

      • setSdpMediaName

        void setSdpMediaName​(String sdpMediaName)
        Sets the value of the SDP-Media-Name AVP, of type UTF8String.
        Throws:
        NullPointerException - if sdpMediaName is null.

      • removeSdpMediaName

        void removeSdpMediaName()
        Removes the SDP-Media-Name AVP from the SDP-Media-Component AVP. If the SDP-Media-Name AVP is not present, this method returns silently.

      • getSdpMediaDescriptions

        String[] getSdpMediaDescriptions()
        Returns the set of SDP-Media-Description AVPs. The returned array contains the AVPs in the order they appear in the SDP-Media-Component AVP. A return value of null implies that no SDP-Media-Description AVPs have been set. The elements in the given array are String objects.

      • setSdpMediaDescription

        void setSdpMediaDescription​(String sdpMediaDescription)
        Sets a single SDP-Media-Description AVP in the SDP-Media-Component AVP, of type UTF8String.
        Throws:
        NullPointerException - if sdpMediaDescription is null.

      • setSdpMediaDescriptions

        void setSdpMediaDescriptions​(String[] sdpMediaDescriptions)
        Sets the set of SDP-Media-Description AVPs, with all the values in the given array. The AVPs will be added to the SDP-Media-Component 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 getSdpMediaDescriptions() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
        Throws:
        NullPointerException - if sdpMediaDescriptions is null.

      • removeSdpMediaDescriptions

        void removeSdpMediaDescriptions()
        Removes all SDP-Media-Description AVPs from the SDP-Media-Component AVP. If no SDP-Media-Description AVPs are present, this method returns silently.

      • hasMediaInitiatorFlag

        boolean hasMediaInitiatorFlag()
        Returns true if the Media-Initiator-Flag AVP is present in the SDP-Media-Component AVP.

      • getMediaInitiatorFlag

        MediaInitiatorFlag getMediaInitiatorFlag()
        Returns the value of the Media-Initiator-Flag AVP, of type Enumerated.
        Returns:
        the value of the Media-Initiator-Flag AVP, or null if it has not been set.

      • setMediaInitiatorFlag

        void setMediaInitiatorFlag​(MediaInitiatorFlag mediaInitiatorFlag)
        Sets the value of the Media-Initiator-Flag AVP, of type Enumerated.
        Throws:
        NullPointerException - if mediaInitiatorFlag is null.

      • removeMediaInitiatorFlag

        void removeMediaInitiatorFlag()
        Removes the Media-Initiator-Flag AVP from the SDP-Media-Component AVP. If the Media-Initiator-Flag AVP is not present, this method returns silently.

      • hasMediaInitiatorParty

        boolean hasMediaInitiatorParty()
        Returns true if the Media-Initiator-Party AVP is present in the SDP-Media-Component AVP.

      • getMediaInitiatorParty

        String getMediaInitiatorParty()
        Returns the value of the Media-Initiator-Party AVP, of type UTF8String.
        Returns:
        the value of the Media-Initiator-Party AVP, or null if it has not been set.

      • setMediaInitiatorParty

        void setMediaInitiatorParty​(String mediaInitiatorParty)
        Sets the value of the Media-Initiator-Party AVP, of type UTF8String.
        Throws:
        NullPointerException - if mediaInitiatorParty is null.

      • removeMediaInitiatorParty

        void removeMediaInitiatorParty()
        Removes the Media-Initiator-Party AVP from the SDP-Media-Component AVP. If the Media-Initiator-Party AVP is not present, this method returns silently.

      • hasAuthorisedQos

        boolean hasAuthorisedQos()
        Returns true if the Authorised-QoS AVP is present in the SDP-Media-Component AVP.

      • getAuthorisedQos

        String getAuthorisedQos()
        Returns the value of the Authorised-QoS AVP, of type UTF8String.
        Returns:
        the value of the Authorised-QoS AVP, or null if it has not been set.

      • setAuthorisedQos

        void setAuthorisedQos​(String authorisedQos)
        Sets the value of the Authorised-QoS AVP, of type UTF8String.
        Throws:
        NullPointerException - if authorisedQos is null.

      • removeAuthorisedQos

        void removeAuthorisedQos()
        Removes the Authorised-QoS AVP from the SDP-Media-Component AVP. If the Authorised-QoS AVP is not present, this method returns silently.

      • hasTgppChargingId

        boolean hasTgppChargingId()
        Returns true if the TGPP-Charging-Id AVP is present in the SDP-Media-Component 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 SDP-Media-Component AVP. If the TGPP-Charging-Id AVP is not present, this method returns silently.

      • hasAccessNetworkChargingIdentifierValue

        boolean hasAccessNetworkChargingIdentifierValue()
        Returns true if the Access-Network-Charging-Identifier-Value AVP is present in the SDP-Media-Component AVP.

      • getAccessNetworkChargingIdentifierValue

        byte[] getAccessNetworkChargingIdentifierValue()
        Returns the value of the Access-Network-Charging-Identifier-Value AVP, of type OctetString.
        Returns:
        the value of the Access-Network-Charging-Identifier-Value AVP, or null if it has not been set.

      • setAccessNetworkChargingIdentifierValue

        void setAccessNetworkChargingIdentifierValue​(byte[] accessNetworkChargingIdentifierValue)
        Sets the value of the Access-Network-Charging-Identifier-Value AVP, of type OctetString.
        Throws:
        NullPointerException - if accessNetworkChargingIdentifierValue is null.

      • removeAccessNetworkChargingIdentifierValue

        void removeAccessNetworkChargingIdentifierValue()
        Removes the Access-Network-Charging-Identifier-Value AVP from the SDP-Media-Component AVP. If the Access-Network-Charging-Identifier-Value AVP is not present, this method returns silently.

      • hasSdpType

        boolean hasSdpType()
        Returns true if the SDP-Type AVP is present in the SDP-Media-Component AVP.

      • getSdpType

        SdpType getSdpType()
        Returns the value of the SDP-Type AVP, of type Enumerated.
        Returns:
        the value of the SDP-Type AVP, or null if it has not been set.

      • setSdpType

        void setSdpType​(SdpType sdpType)
        Sets the value of the SDP-Type AVP, of type Enumerated.
        Throws:
        NullPointerException - if sdpType is null.

      • removeSdpType

        void removeSdpType()
        Removes the SDP-Type AVP from the SDP-Media-Component AVP. If the SDP-Type 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 SDP-Media-Component 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 SDP-Media-Component 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 SDP-Media-Component AVP. If no extension AVPs are present, this method returns silently.