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

Interface ParticipantGroup

  • All Superinterfaces:
    Cloneable, DiameterAvp, GroupedAvp
    public interface ParticipantGroup
extends GroupedAvp
    Defines an interface representing the Participant-Group grouped AVP type. From the Diameter Rf Reference Point Protocol Details (3GPP TS 32.299 V8.13.0) specification: 
     7.2.101     Participant-Group AVP
 
 The Participant-Group AVP (AVP code 1260) is of type Grouped and holds detailed information, e.g. the address
 (Public User ID: SIP URI, TEL URI, MSISDN), the access priority parameters, etc, of the party who is involved into
 the PoC session.
 It has the following ABNF grammar:
 
     Participant-Group ::= < AVP Header: 1260>
                             [ Called-Party-Address ]
                             [ Participant-Access-Priority ]
                             [ User-Participating-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

      • hasCalledPartyAddress

        boolean hasCalledPartyAddress()
        Returns true if the Called-Party-Address AVP is present in the Participant-Group AVP.

      • getCalledPartyAddress

        String getCalledPartyAddress()
        Returns the value of the Called-Party-Address AVP, of type UTF8String.
        Returns:
        the value of the Called-Party-Address AVP, or null if it has not been set.

      • setCalledPartyAddress

        void setCalledPartyAddress​(String calledPartyAddress)
        Sets the value of the Called-Party-Address AVP, of type UTF8String.
        Throws:
        NullPointerException - if calledPartyAddress is null.

      • removeCalledPartyAddress

        void removeCalledPartyAddress()
        Removes the Called-Party-Address AVP from the Participant-Group AVP. If the Called-Party-Address AVP is not present, this method returns silently.

      • hasParticipantAccessPriority

        boolean hasParticipantAccessPriority()
        Returns true if the Participant-Access-Priority AVP is present in the Participant-Group AVP.

      • getParticipantAccessPriority

        ParticipantAccessPriority getParticipantAccessPriority()
        Returns the value of the Participant-Access-Priority AVP, of type Enumerated.
        Returns:
        the value of the Participant-Access-Priority AVP, or null if it has not been set.

      • setParticipantAccessPriority

        void setParticipantAccessPriority​(ParticipantAccessPriority participantAccessPriority)
        Sets the value of the Participant-Access-Priority AVP, of type Enumerated.
        Throws:
        NullPointerException - if participantAccessPriority is null.

      • removeParticipantAccessPriority

        void removeParticipantAccessPriority()
        Removes the Participant-Access-Priority AVP from the Participant-Group AVP. If the Participant-Access-Priority AVP is not present, this method returns silently.

      • hasUserParticipatingType

        boolean hasUserParticipatingType()
        Returns true if the User-Participating-Type AVP is present in the Participant-Group AVP.

      • getUserParticipatingType

        UserParticipatingType getUserParticipatingType()
        Returns the value of the User-Participating-Type AVP, of type Enumerated.
        Returns:
        the value of the User-Participating-Type AVP, or null if it has not been set.

      • setUserParticipatingType

        void setUserParticipatingType​(UserParticipatingType userParticipatingType)
        Sets the value of the User-Participating-Type AVP, of type Enumerated.
        Throws:
        NullPointerException - if userParticipatingType is null.

      • removeUserParticipatingType

        void removeUserParticipatingType()
        Removes the User-Participating-Type AVP from the Participant-Group AVP. If the User-Participating-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 Participant-Group 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 Participant-Group 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 Participant-Group AVP. If no extension AVPs are present, this method returns silently.