Interface ProseInformation

  • All Superinterfaces:
    Cloneable, DiameterAvp, GroupedAvp

    public interface ProseInformation
    extends GroupedAvp
    Defines an interface representing the ProSe-Information grouped AVP type. From the Diameter Ro Reference Point Protocol Details (3GPP TS 32.299 V12.11.0) specification:
     7.2.154 I        ProSe-Information AVP
     
     The ProSe-Information AVP (AVP code 3447) is of type Grouped. Its purpose is to allow the transmission of additional ProSe service specific information elements. 
     It has the following ABNF grammar:
     
         ProSe-Information ::=  < AVP Header: 3447>
                                     [ Announcing-UE-HPLMN-Identifier ]
                                     [ Announcing-UE-VPLMN-Identifier ]
                                     [ Monitoring-UE-HPLMN-Identifier ]
                                     [ Monitoring-UE-VPLMN-Identifier ]
                                     [ Monitored-PLMN-Identifier ]
                                     [ Role-Of-ProSe-Function ]
                                     [ ProSe-App-Id ]
                                     [ ProSe-3rd-Party-Application-ID ]
                                     [ Application-Specific-Data ]
                                     [ ProSe-Event-Type ]
                                     [ ProSe-Direct-Discovery-Model ]
                                     [ ProSe-Function-IP-Address ]
                                     [ ProSe-Function-ID ]
                                     [ ProSe-Validity-Timer ]
                                     [ ProSe-Role-Of-UE ]
                                     [ ProSe-Request-Timestamp ]
                                     [ PC3-Control-Protocol-Cause ]
                                     [ Monitoring-UE-Identifier ]
                                     [ ProSe-Function-PLMN-Identifier ]
                                     [ Requestor-PLMN-Identifier ]
                                     [ Origin-App-Layer-User-Id ]
                                     [ WLAN-Link-Layer-Id ]
                                     [ Requesting-EPUID ]
                                     [ Target-App-Layer-User-Id ]
                                     [ Requested-PLMN-Identifier ]
                                     [ Time-Window ]
                                     [ ProSe-Range-Class ]
                                     [ Proximity-Alert-Indication ]
                                     [ Proximity-Alert-Timestamp ]
                                     [ Proximity-Cancellation-Timestamp ]
                                     [ ProSe-Reason-For-Cancellation ]
                                     [ PC3-EPC-Control-Protocol-Cause ]
                                     [ ProSe-UE-ID ]
                                     [ ProSe-Source-IP-Address ]
                                     [ Layer-2-Group-ID ]
                                     [ ProSe-Group-IP-Multicast-Address ]
                                   * [ Coverage-Info ]
                                   * [ Radio-Parameter-Set-Info ]
                                   * [ Transmitter-Info ]
                                     [ Time-First-Transmission ]
                                     [ Time-First-Reception ]
                                   * [ ProSe-Direct-Communication-Transmission-Data-Container ]
                                   * [ ProSe-Direct-Communication-Reception-Data-Container ]
     
    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

      • hasAnnouncingUeHplmnIdentifier

        boolean hasAnnouncingUeHplmnIdentifier()
        Returns true if the Announcing-UE-HPLMN-Identifier AVP is present in the ProSe-Information AVP.
      • getAnnouncingUeHplmnIdentifier

        String getAnnouncingUeHplmnIdentifier()
        Returns the value of the Announcing-UE-HPLMN-Identifier AVP, of type UTF8String.
        Returns:
        the value of the Announcing-UE-HPLMN-Identifier AVP, or null if it has not been set.
      • setAnnouncingUeHplmnIdentifier

        void setAnnouncingUeHplmnIdentifier​(String announcingUeHplmnIdentifier)
        Sets the value of the Announcing-UE-HPLMN-Identifier AVP, of type UTF8String.
        Throws:
        NullPointerException - if announcingUeHplmnIdentifier is null.
      • removeAnnouncingUeHplmnIdentifier

        void removeAnnouncingUeHplmnIdentifier()
        Removes the Announcing-UE-HPLMN-Identifier AVP from the ProSe-Information AVP. If the Announcing-UE-HPLMN-Identifier AVP is not present, this method returns silently.
      • hasAnnouncingUeVplmnIdentifier

        boolean hasAnnouncingUeVplmnIdentifier()
        Returns true if the Announcing-UE-VPLMN-Identifier AVP is present in the ProSe-Information AVP.
      • getAnnouncingUeVplmnIdentifier

        String getAnnouncingUeVplmnIdentifier()
        Returns the value of the Announcing-UE-VPLMN-Identifier AVP, of type UTF8String.
        Returns:
        the value of the Announcing-UE-VPLMN-Identifier AVP, or null if it has not been set.
      • setAnnouncingUeVplmnIdentifier

        void setAnnouncingUeVplmnIdentifier​(String announcingUeVplmnIdentifier)
        Sets the value of the Announcing-UE-VPLMN-Identifier AVP, of type UTF8String.
        Throws:
        NullPointerException - if announcingUeVplmnIdentifier is null.
      • removeAnnouncingUeVplmnIdentifier

        void removeAnnouncingUeVplmnIdentifier()
        Removes the Announcing-UE-VPLMN-Identifier AVP from the ProSe-Information AVP. If the Announcing-UE-VPLMN-Identifier AVP is not present, this method returns silently.
      • hasMonitoringUeHplmnIdentifier

        boolean hasMonitoringUeHplmnIdentifier()
        Returns true if the Monitoring-UE-HPLMN-Identifier AVP is present in the ProSe-Information AVP.
      • getMonitoringUeHplmnIdentifier

        String getMonitoringUeHplmnIdentifier()
        Returns the value of the Monitoring-UE-HPLMN-Identifier AVP, of type UTF8String.
        Returns:
        the value of the Monitoring-UE-HPLMN-Identifier AVP, or null if it has not been set.
      • setMonitoringUeHplmnIdentifier

        void setMonitoringUeHplmnIdentifier​(String monitoringUeHplmnIdentifier)
        Sets the value of the Monitoring-UE-HPLMN-Identifier AVP, of type UTF8String.
        Throws:
        NullPointerException - if monitoringUeHplmnIdentifier is null.
      • removeMonitoringUeHplmnIdentifier

        void removeMonitoringUeHplmnIdentifier()
        Removes the Monitoring-UE-HPLMN-Identifier AVP from the ProSe-Information AVP. If the Monitoring-UE-HPLMN-Identifier AVP is not present, this method returns silently.
      • hasMonitoringUeVplmnIdentifier

        boolean hasMonitoringUeVplmnIdentifier()
        Returns true if the Monitoring-UE-VPLMN-Identifier AVP is present in the ProSe-Information AVP.
      • getMonitoringUeVplmnIdentifier

        String getMonitoringUeVplmnIdentifier()
        Returns the value of the Monitoring-UE-VPLMN-Identifier AVP, of type UTF8String.
        Returns:
        the value of the Monitoring-UE-VPLMN-Identifier AVP, or null if it has not been set.
      • setMonitoringUeVplmnIdentifier

        void setMonitoringUeVplmnIdentifier​(String monitoringUeVplmnIdentifier)
        Sets the value of the Monitoring-UE-VPLMN-Identifier AVP, of type UTF8String.
        Throws:
        NullPointerException - if monitoringUeVplmnIdentifier is null.
      • removeMonitoringUeVplmnIdentifier

        void removeMonitoringUeVplmnIdentifier()
        Removes the Monitoring-UE-VPLMN-Identifier AVP from the ProSe-Information AVP. If the Monitoring-UE-VPLMN-Identifier AVP is not present, this method returns silently.
      • hasMonitoredPlmnIdentifier

        boolean hasMonitoredPlmnIdentifier()
        Returns true if the Monitored-PLMN-Identifier AVP is present in the ProSe-Information AVP.
      • getMonitoredPlmnIdentifier

        String getMonitoredPlmnIdentifier()
        Returns the value of the Monitored-PLMN-Identifier AVP, of type UTF8String.
        Returns:
        the value of the Monitored-PLMN-Identifier AVP, or null if it has not been set.
      • setMonitoredPlmnIdentifier

        void setMonitoredPlmnIdentifier​(String monitoredPlmnIdentifier)
        Sets the value of the Monitored-PLMN-Identifier AVP, of type UTF8String.
        Throws:
        NullPointerException - if monitoredPlmnIdentifier is null.
      • removeMonitoredPlmnIdentifier

        void removeMonitoredPlmnIdentifier()
        Removes the Monitored-PLMN-Identifier AVP from the ProSe-Information AVP. If the Monitored-PLMN-Identifier AVP is not present, this method returns silently.
      • hasRoleOfProseFunction

        boolean hasRoleOfProseFunction()
        Returns true if the Role-Of-ProSe-Function AVP is present in the ProSe-Information AVP.
      • getRoleOfProseFunction

        RoleOfProseFunction getRoleOfProseFunction()
        Returns the value of the Role-Of-ProSe-Function AVP, of type Enumerated.
        Returns:
        the value of the Role-Of-ProSe-Function AVP, or null if it has not been set.
      • setRoleOfProseFunction

        void setRoleOfProseFunction​(RoleOfProseFunction roleOfProseFunction)
        Sets the value of the Role-Of-ProSe-Function AVP, of type Enumerated.
        Throws:
        NullPointerException - if roleOfProseFunction is null.
      • removeRoleOfProseFunction

        void removeRoleOfProseFunction()
        Removes the Role-Of-ProSe-Function AVP from the ProSe-Information AVP. If the Role-Of-ProSe-Function AVP is not present, this method returns silently.
      • hasProseAppId

        boolean hasProseAppId()
        Returns true if the ProSe-App-Id AVP is present in the ProSe-Information AVP.
      • getProseAppId

        String getProseAppId()
        Returns the value of the ProSe-App-Id AVP, of type UTF8String.
        Returns:
        the value of the ProSe-App-Id AVP, or null if it has not been set.
      • setProseAppId

        void setProseAppId​(String proseAppId)
        Sets the value of the ProSe-App-Id AVP, of type UTF8String.
        Throws:
        NullPointerException - if proseAppId is null.
      • removeProseAppId

        void removeProseAppId()
        Removes the ProSe-App-Id AVP from the ProSe-Information AVP. If the ProSe-App-Id AVP is not present, this method returns silently.
      • hasProse3rdPartyApplicationId

        boolean hasProse3rdPartyApplicationId()
        Returns true if the ProSe-3rd-Party-Application-ID AVP is present in the ProSe-Information AVP.
      • getProse3rdPartyApplicationId

        String getProse3rdPartyApplicationId()
        Returns the value of the ProSe-3rd-Party-Application-ID AVP, of type UTF8String.
        Returns:
        the value of the ProSe-3rd-Party-Application-ID AVP, or null if it has not been set.
      • setProse3rdPartyApplicationId

        void setProse3rdPartyApplicationId​(String prose3rdPartyApplicationId)
        Sets the value of the ProSe-3rd-Party-Application-ID AVP, of type UTF8String.
        Throws:
        NullPointerException - if prose3rdPartyApplicationId is null.
      • removeProse3rdPartyApplicationId

        void removeProse3rdPartyApplicationId()
        Removes the ProSe-3rd-Party-Application-ID AVP from the ProSe-Information AVP. If the ProSe-3rd-Party-Application-ID AVP is not present, this method returns silently.
      • hasApplicationSpecificData

        boolean hasApplicationSpecificData()
        Returns true if the Application-Specific-Data AVP is present in the ProSe-Information AVP.
      • getApplicationSpecificData

        byte[] getApplicationSpecificData()
        Returns the value of the Application-Specific-Data AVP, of type OctetString.
        Returns:
        the value of the Application-Specific-Data AVP, or null if it has not been set.
      • setApplicationSpecificData

        void setApplicationSpecificData​(byte[] applicationSpecificData)
        Sets the value of the Application-Specific-Data AVP, of type OctetString.
        Throws:
        NullPointerException - if applicationSpecificData is null.
      • removeApplicationSpecificData

        void removeApplicationSpecificData()
        Removes the Application-Specific-Data AVP from the ProSe-Information AVP. If the Application-Specific-Data AVP is not present, this method returns silently.
      • hasProseEventType

        boolean hasProseEventType()
        Returns true if the ProSe-Event-Type AVP is present in the ProSe-Information AVP.
      • getProseEventType

        ProseEventType getProseEventType()
        Returns the value of the ProSe-Event-Type AVP, of type Enumerated.
        Returns:
        the value of the ProSe-Event-Type AVP, or null if it has not been set.
      • setProseEventType

        void setProseEventType​(ProseEventType proseEventType)
        Sets the value of the ProSe-Event-Type AVP, of type Enumerated.
        Throws:
        NullPointerException - if proseEventType is null.
      • removeProseEventType

        void removeProseEventType()
        Removes the ProSe-Event-Type AVP from the ProSe-Information AVP. If the ProSe-Event-Type AVP is not present, this method returns silently.
      • hasProseDirectDiscoveryModel

        boolean hasProseDirectDiscoveryModel()
        Returns true if the ProSe-Direct-Discovery-Model AVP is present in the ProSe-Information AVP.
      • getProseDirectDiscoveryModel

        ProseDirectDiscoveryModel getProseDirectDiscoveryModel()
        Returns the value of the ProSe-Direct-Discovery-Model AVP, of type Enumerated.
        Returns:
        the value of the ProSe-Direct-Discovery-Model AVP, or null if it has not been set.
      • setProseDirectDiscoveryModel

        void setProseDirectDiscoveryModel​(ProseDirectDiscoveryModel proseDirectDiscoveryModel)
        Sets the value of the ProSe-Direct-Discovery-Model AVP, of type Enumerated.
        Throws:
        NullPointerException - if proseDirectDiscoveryModel is null.
      • removeProseDirectDiscoveryModel

        void removeProseDirectDiscoveryModel()
        Removes the ProSe-Direct-Discovery-Model AVP from the ProSe-Information AVP. If the ProSe-Direct-Discovery-Model AVP is not present, this method returns silently.
      • hasProseFunctionIpAddress

        boolean hasProseFunctionIpAddress()
        Returns true if the ProSe-Function-IP-Address AVP is present in the ProSe-Information AVP.
      • getProseFunctionIpAddress

        Address getProseFunctionIpAddress()
        Returns the value of the ProSe-Function-IP-Address AVP, of type Address.
        Returns:
        the value of the ProSe-Function-IP-Address AVP, or null if it has not been set.
      • setProseFunctionIpAddress

        void setProseFunctionIpAddress​(Address proseFunctionIpAddress)
        Sets the value of the ProSe-Function-IP-Address AVP, of type Address.
        Throws:
        NullPointerException - if proseFunctionIpAddress is null.
      • removeProseFunctionIpAddress

        void removeProseFunctionIpAddress()
        Removes the ProSe-Function-IP-Address AVP from the ProSe-Information AVP. If the ProSe-Function-IP-Address AVP is not present, this method returns silently.
      • hasProseFunctionId

        boolean hasProseFunctionId()
        Returns true if the ProSe-Function-ID AVP is present in the ProSe-Information AVP.
      • getProseFunctionId

        byte[] getProseFunctionId()
        Returns the value of the ProSe-Function-ID AVP, of type OctetString.
        Returns:
        the value of the ProSe-Function-ID AVP, or null if it has not been set.
      • setProseFunctionId

        void setProseFunctionId​(byte[] proseFunctionId)
        Sets the value of the ProSe-Function-ID AVP, of type OctetString.
        Throws:
        NullPointerException - if proseFunctionId is null.
      • removeProseFunctionId

        void removeProseFunctionId()
        Removes the ProSe-Function-ID AVP from the ProSe-Information AVP. If the ProSe-Function-ID AVP is not present, this method returns silently.
      • hasProseValidityTimer

        boolean hasProseValidityTimer()
        Returns true if the ProSe-Validity-Timer AVP is present in the ProSe-Information AVP.
      • getProseValidityTimer

        long getProseValidityTimer()
        Returns the value of the ProSe-Validity-Timer AVP, of type Unsigned32. Use hasProseValidityTimer() to check the existence of this AVP.
        Returns:
        the value of the ProSe-Validity-Timer AVP
        Throws:
        IllegalStateException - if the ProSe-Validity-Timer AVP has not been set.
      • setProseValidityTimer

        void setProseValidityTimer​(long proseValidityTimer)
        Sets the value of the ProSe-Validity-Timer AVP, of type Unsigned32.
      • removeProseValidityTimer

        void removeProseValidityTimer()
        Removes the ProSe-Validity-Timer AVP from the ProSe-Information AVP. If the ProSe-Validity-Timer AVP is not present, this method returns silently.
      • hasProseRoleOfUe

        boolean hasProseRoleOfUe()
        Returns true if the ProSe-Role-Of-UE AVP is present in the ProSe-Information AVP.
      • getProseRoleOfUe

        ProseRoleOfUe getProseRoleOfUe()
        Returns the value of the ProSe-Role-Of-UE AVP, of type Enumerated.
        Returns:
        the value of the ProSe-Role-Of-UE AVP, or null if it has not been set.
      • setProseRoleOfUe

        void setProseRoleOfUe​(ProseRoleOfUe proseRoleOfUe)
        Sets the value of the ProSe-Role-Of-UE AVP, of type Enumerated.
        Throws:
        NullPointerException - if proseRoleOfUe is null.
      • removeProseRoleOfUe

        void removeProseRoleOfUe()
        Removes the ProSe-Role-Of-UE AVP from the ProSe-Information AVP. If the ProSe-Role-Of-UE AVP is not present, this method returns silently.
      • hasProseRequestTimestamp

        boolean hasProseRequestTimestamp()
        Returns true if the ProSe-Request-Timestamp AVP is present in the ProSe-Information AVP.
      • getProseRequestTimestamp

        Date getProseRequestTimestamp()
        Returns the value of the ProSe-Request-Timestamp AVP, of type Time.
        Returns:
        the value of the ProSe-Request-Timestamp AVP, or null if it has not been set.
      • setProseRequestTimestamp

        void setProseRequestTimestamp​(Date proseRequestTimestamp)
        Sets the value of the ProSe-Request-Timestamp AVP, of type Time.
        Throws:
        NullPointerException - if proseRequestTimestamp is null.
      • removeProseRequestTimestamp

        void removeProseRequestTimestamp()
        Removes the ProSe-Request-Timestamp AVP from the ProSe-Information AVP. If the ProSe-Request-Timestamp AVP is not present, this method returns silently.
      • hasPc3ControlProtocolCause

        boolean hasPc3ControlProtocolCause()
        Returns true if the PC3-Control-Protocol-Cause AVP is present in the ProSe-Information AVP.
      • getPc3ControlProtocolCause

        int getPc3ControlProtocolCause()
        Returns the value of the PC3-Control-Protocol-Cause AVP, of type Integer32. Use hasPc3ControlProtocolCause() to check the existence of this AVP.
        Returns:
        the value of the PC3-Control-Protocol-Cause AVP
        Throws:
        IllegalStateException - if the PC3-Control-Protocol-Cause AVP has not been set.
      • setPc3ControlProtocolCause

        void setPc3ControlProtocolCause​(int pc3ControlProtocolCause)
        Sets the value of the PC3-Control-Protocol-Cause AVP, of type Integer32.
      • removePc3ControlProtocolCause

        void removePc3ControlProtocolCause()
        Removes the PC3-Control-Protocol-Cause AVP from the ProSe-Information AVP. If the PC3-Control-Protocol-Cause AVP is not present, this method returns silently.
      • hasMonitoringUeIdentifier

        boolean hasMonitoringUeIdentifier()
        Returns true if the Monitoring-UE-Identifier AVP is present in the ProSe-Information AVP.
      • getMonitoringUeIdentifier

        String getMonitoringUeIdentifier()
        Returns the value of the Monitoring-UE-Identifier AVP, of type UTF8String.
        Returns:
        the value of the Monitoring-UE-Identifier AVP, or null if it has not been set.
      • setMonitoringUeIdentifier

        void setMonitoringUeIdentifier​(String monitoringUeIdentifier)
        Sets the value of the Monitoring-UE-Identifier AVP, of type UTF8String.
        Throws:
        NullPointerException - if monitoringUeIdentifier is null.
      • removeMonitoringUeIdentifier

        void removeMonitoringUeIdentifier()
        Removes the Monitoring-UE-Identifier AVP from the ProSe-Information AVP. If the Monitoring-UE-Identifier AVP is not present, this method returns silently.
      • hasProseFunctionPlmnIdentifier

        boolean hasProseFunctionPlmnIdentifier()
        Returns true if the ProSe-Function-PLMN-Identifier AVP is present in the ProSe-Information AVP.
      • getProseFunctionPlmnIdentifier

        String getProseFunctionPlmnIdentifier()
        Returns the value of the ProSe-Function-PLMN-Identifier AVP, of type UTF8String.
        Returns:
        the value of the ProSe-Function-PLMN-Identifier AVP, or null if it has not been set.
      • setProseFunctionPlmnIdentifier

        void setProseFunctionPlmnIdentifier​(String proseFunctionPlmnIdentifier)
        Sets the value of the ProSe-Function-PLMN-Identifier AVP, of type UTF8String.
        Throws:
        NullPointerException - if proseFunctionPlmnIdentifier is null.
      • removeProseFunctionPlmnIdentifier

        void removeProseFunctionPlmnIdentifier()
        Removes the ProSe-Function-PLMN-Identifier AVP from the ProSe-Information AVP. If the ProSe-Function-PLMN-Identifier AVP is not present, this method returns silently.
      • hasRequestorPlmnIdentifier

        boolean hasRequestorPlmnIdentifier()
        Returns true if the Requestor-PLMN-Identifier AVP is present in the ProSe-Information AVP.
      • getRequestorPlmnIdentifier

        String getRequestorPlmnIdentifier()
        Returns the value of the Requestor-PLMN-Identifier AVP, of type UTF8String.
        Returns:
        the value of the Requestor-PLMN-Identifier AVP, or null if it has not been set.
      • setRequestorPlmnIdentifier

        void setRequestorPlmnIdentifier​(String requestorPlmnIdentifier)
        Sets the value of the Requestor-PLMN-Identifier AVP, of type UTF8String.
        Throws:
        NullPointerException - if requestorPlmnIdentifier is null.
      • removeRequestorPlmnIdentifier

        void removeRequestorPlmnIdentifier()
        Removes the Requestor-PLMN-Identifier AVP from the ProSe-Information AVP. If the Requestor-PLMN-Identifier AVP is not present, this method returns silently.
      • hasOriginAppLayerUserId

        boolean hasOriginAppLayerUserId()
        Returns true if the Origin-App-Layer-User-Id AVP is present in the ProSe-Information AVP.
      • getOriginAppLayerUserId

        String getOriginAppLayerUserId()
        Returns the value of the Origin-App-Layer-User-Id AVP, of type UTF8String.
        Returns:
        the value of the Origin-App-Layer-User-Id AVP, or null if it has not been set.
      • setOriginAppLayerUserId

        void setOriginAppLayerUserId​(String originAppLayerUserId)
        Sets the value of the Origin-App-Layer-User-Id AVP, of type UTF8String.
        Throws:
        NullPointerException - if originAppLayerUserId is null.
      • removeOriginAppLayerUserId

        void removeOriginAppLayerUserId()
        Removes the Origin-App-Layer-User-Id AVP from the ProSe-Information AVP. If the Origin-App-Layer-User-Id AVP is not present, this method returns silently.
      • hasWlanLinkLayerId

        boolean hasWlanLinkLayerId()
        Returns true if the WLAN-Link-Layer-Id AVP is present in the ProSe-Information AVP.
      • getWlanLinkLayerId

        byte[] getWlanLinkLayerId()
        Returns the value of the WLAN-Link-Layer-Id AVP, of type OctetString.
        Returns:
        the value of the WLAN-Link-Layer-Id AVP, or null if it has not been set.
      • setWlanLinkLayerId

        void setWlanLinkLayerId​(byte[] wlanLinkLayerId)
        Sets the value of the WLAN-Link-Layer-Id AVP, of type OctetString.
        Throws:
        NullPointerException - if wlanLinkLayerId is null.
      • removeWlanLinkLayerId

        void removeWlanLinkLayerId()
        Removes the WLAN-Link-Layer-Id AVP from the ProSe-Information AVP. If the WLAN-Link-Layer-Id AVP is not present, this method returns silently.
      • hasRequestingEpuid

        boolean hasRequestingEpuid()
        Returns true if the Requesting-EPUID AVP is present in the ProSe-Information AVP.
      • getRequestingEpuid

        String getRequestingEpuid()
        Returns the value of the Requesting-EPUID AVP, of type UTF8String.
        Returns:
        the value of the Requesting-EPUID AVP, or null if it has not been set.
      • setRequestingEpuid

        void setRequestingEpuid​(String requestingEpuid)
        Sets the value of the Requesting-EPUID AVP, of type UTF8String.
        Throws:
        NullPointerException - if requestingEpuid is null.
      • removeRequestingEpuid

        void removeRequestingEpuid()
        Removes the Requesting-EPUID AVP from the ProSe-Information AVP. If the Requesting-EPUID AVP is not present, this method returns silently.
      • hasTargetAppLayerUserId

        boolean hasTargetAppLayerUserId()
        Returns true if the Target-App-Layer-User-Id AVP is present in the ProSe-Information AVP.
      • getTargetAppLayerUserId

        String getTargetAppLayerUserId()
        Returns the value of the Target-App-Layer-User-Id AVP, of type UTF8String.
        Returns:
        the value of the Target-App-Layer-User-Id AVP, or null if it has not been set.
      • setTargetAppLayerUserId

        void setTargetAppLayerUserId​(String targetAppLayerUserId)
        Sets the value of the Target-App-Layer-User-Id AVP, of type UTF8String.
        Throws:
        NullPointerException - if targetAppLayerUserId is null.
      • removeTargetAppLayerUserId

        void removeTargetAppLayerUserId()
        Removes the Target-App-Layer-User-Id AVP from the ProSe-Information AVP. If the Target-App-Layer-User-Id AVP is not present, this method returns silently.
      • hasRequestedPlmnIdentifier

        boolean hasRequestedPlmnIdentifier()
        Returns true if the Requested-PLMN-Identifier AVP is present in the ProSe-Information AVP.
      • getRequestedPlmnIdentifier

        String getRequestedPlmnIdentifier()
        Returns the value of the Requested-PLMN-Identifier AVP, of type UTF8String.
        Returns:
        the value of the Requested-PLMN-Identifier AVP, or null if it has not been set.
      • setRequestedPlmnIdentifier

        void setRequestedPlmnIdentifier​(String requestedPlmnIdentifier)
        Sets the value of the Requested-PLMN-Identifier AVP, of type UTF8String.
        Throws:
        NullPointerException - if requestedPlmnIdentifier is null.
      • removeRequestedPlmnIdentifier

        void removeRequestedPlmnIdentifier()
        Removes the Requested-PLMN-Identifier AVP from the ProSe-Information AVP. If the Requested-PLMN-Identifier AVP is not present, this method returns silently.
      • hasTimeWindow

        boolean hasTimeWindow()
        Returns true if the Time-Window AVP is present in the ProSe-Information AVP.
      • getTimeWindow

        long getTimeWindow()
        Returns the value of the Time-Window AVP, of type Unsigned32. Use hasTimeWindow() to check the existence of this AVP.
        Returns:
        the value of the Time-Window AVP
        Throws:
        IllegalStateException - if the Time-Window AVP has not been set.
      • setTimeWindow

        void setTimeWindow​(long timeWindow)
        Sets the value of the Time-Window AVP, of type Unsigned32.
      • removeTimeWindow

        void removeTimeWindow()
        Removes the Time-Window AVP from the ProSe-Information AVP. If the Time-Window AVP is not present, this method returns silently.
      • hasProseRangeClass

        boolean hasProseRangeClass()
        Returns true if the ProSe-Range-Class AVP is present in the ProSe-Information AVP.
      • getProseRangeClass

        ProseRangeClass getProseRangeClass()
        Returns the value of the ProSe-Range-Class AVP, of type Enumerated.
        Returns:
        the value of the ProSe-Range-Class AVP, or null if it has not been set.
      • setProseRangeClass

        void setProseRangeClass​(ProseRangeClass proseRangeClass)
        Sets the value of the ProSe-Range-Class AVP, of type Enumerated.
        Throws:
        NullPointerException - if proseRangeClass is null.
      • removeProseRangeClass

        void removeProseRangeClass()
        Removes the ProSe-Range-Class AVP from the ProSe-Information AVP. If the ProSe-Range-Class AVP is not present, this method returns silently.
      • hasProximityAlertIndication

        boolean hasProximityAlertIndication()
        Returns true if the Proximity-Alert-Indication AVP is present in the ProSe-Information AVP.
      • getProximityAlertIndication

        ProximityAlertIndication getProximityAlertIndication()
        Returns the value of the Proximity-Alert-Indication AVP, of type Enumerated.
        Returns:
        the value of the Proximity-Alert-Indication AVP, or null if it has not been set.
      • setProximityAlertIndication

        void setProximityAlertIndication​(ProximityAlertIndication proximityAlertIndication)
        Sets the value of the Proximity-Alert-Indication AVP, of type Enumerated.
        Throws:
        NullPointerException - if proximityAlertIndication is null.
      • removeProximityAlertIndication

        void removeProximityAlertIndication()
        Removes the Proximity-Alert-Indication AVP from the ProSe-Information AVP. If the Proximity-Alert-Indication AVP is not present, this method returns silently.
      • hasProximityAlertTimestamp

        boolean hasProximityAlertTimestamp()
        Returns true if the Proximity-Alert-Timestamp AVP is present in the ProSe-Information AVP.
      • getProximityAlertTimestamp

        Date getProximityAlertTimestamp()
        Returns the value of the Proximity-Alert-Timestamp AVP, of type Time.
        Returns:
        the value of the Proximity-Alert-Timestamp AVP, or null if it has not been set.
      • setProximityAlertTimestamp

        void setProximityAlertTimestamp​(Date proximityAlertTimestamp)
        Sets the value of the Proximity-Alert-Timestamp AVP, of type Time.
        Throws:
        NullPointerException - if proximityAlertTimestamp is null.
      • removeProximityAlertTimestamp

        void removeProximityAlertTimestamp()
        Removes the Proximity-Alert-Timestamp AVP from the ProSe-Information AVP. If the Proximity-Alert-Timestamp AVP is not present, this method returns silently.
      • hasProximityCancellationTimestamp

        boolean hasProximityCancellationTimestamp()
        Returns true if the Proximity-Cancellation-Timestamp AVP is present in the ProSe-Information AVP.
      • getProximityCancellationTimestamp

        Date getProximityCancellationTimestamp()
        Returns the value of the Proximity-Cancellation-Timestamp AVP, of type Time.
        Returns:
        the value of the Proximity-Cancellation-Timestamp AVP, or null if it has not been set.
      • setProximityCancellationTimestamp

        void setProximityCancellationTimestamp​(Date proximityCancellationTimestamp)
        Sets the value of the Proximity-Cancellation-Timestamp AVP, of type Time.
        Throws:
        NullPointerException - if proximityCancellationTimestamp is null.
      • removeProximityCancellationTimestamp

        void removeProximityCancellationTimestamp()
        Removes the Proximity-Cancellation-Timestamp AVP from the ProSe-Information AVP. If the Proximity-Cancellation-Timestamp AVP is not present, this method returns silently.
      • hasProseReasonForCancellation

        boolean hasProseReasonForCancellation()
        Returns true if the ProSe-Reason-For-Cancellation AVP is present in the ProSe-Information AVP.
      • getProseReasonForCancellation

        ProseReasonForCancellation getProseReasonForCancellation()
        Returns the value of the ProSe-Reason-For-Cancellation AVP, of type Enumerated.
        Returns:
        the value of the ProSe-Reason-For-Cancellation AVP, or null if it has not been set.
      • setProseReasonForCancellation

        void setProseReasonForCancellation​(ProseReasonForCancellation proseReasonForCancellation)
        Sets the value of the ProSe-Reason-For-Cancellation AVP, of type Enumerated.
        Throws:
        NullPointerException - if proseReasonForCancellation is null.
      • removeProseReasonForCancellation

        void removeProseReasonForCancellation()
        Removes the ProSe-Reason-For-Cancellation AVP from the ProSe-Information AVP. If the ProSe-Reason-For-Cancellation AVP is not present, this method returns silently.
      • hasPc3EpcControlProtocolCause

        boolean hasPc3EpcControlProtocolCause()
        Returns true if the PC3-EPC-Control-Protocol-Cause AVP is present in the ProSe-Information AVP.
      • getPc3EpcControlProtocolCause

        int getPc3EpcControlProtocolCause()
        Returns the value of the PC3-EPC-Control-Protocol-Cause AVP, of type Integer32. Use hasPc3EpcControlProtocolCause() to check the existence of this AVP.
        Returns:
        the value of the PC3-EPC-Control-Protocol-Cause AVP
        Throws:
        IllegalStateException - if the PC3-EPC-Control-Protocol-Cause AVP has not been set.
      • setPc3EpcControlProtocolCause

        void setPc3EpcControlProtocolCause​(int pc3EpcControlProtocolCause)
        Sets the value of the PC3-EPC-Control-Protocol-Cause AVP, of type Integer32.
      • removePc3EpcControlProtocolCause

        void removePc3EpcControlProtocolCause()
        Removes the PC3-EPC-Control-Protocol-Cause AVP from the ProSe-Information AVP. If the PC3-EPC-Control-Protocol-Cause AVP is not present, this method returns silently.
      • hasProseUeId

        boolean hasProseUeId()
        Returns true if the ProSe-UE-ID AVP is present in the ProSe-Information AVP.
      • getProseUeId

        byte[] getProseUeId()
        Returns the value of the ProSe-UE-ID AVP, of type OctetString.
        Returns:
        the value of the ProSe-UE-ID AVP, or null if it has not been set.
      • setProseUeId

        void setProseUeId​(byte[] proseUeId)
        Sets the value of the ProSe-UE-ID AVP, of type OctetString.
        Throws:
        NullPointerException - if proseUeId is null.
      • removeProseUeId

        void removeProseUeId()
        Removes the ProSe-UE-ID AVP from the ProSe-Information AVP. If the ProSe-UE-ID AVP is not present, this method returns silently.
      • hasProseSourceIpAddress

        boolean hasProseSourceIpAddress()
        Returns true if the ProSe-Source-IP-Address AVP is present in the ProSe-Information AVP.
      • getProseSourceIpAddress

        Address getProseSourceIpAddress()
        Returns the value of the ProSe-Source-IP-Address AVP, of type Address.
        Returns:
        the value of the ProSe-Source-IP-Address AVP, or null if it has not been set.
      • setProseSourceIpAddress

        void setProseSourceIpAddress​(Address proseSourceIpAddress)
        Sets the value of the ProSe-Source-IP-Address AVP, of type Address.
        Throws:
        NullPointerException - if proseSourceIpAddress is null.
      • removeProseSourceIpAddress

        void removeProseSourceIpAddress()
        Removes the ProSe-Source-IP-Address AVP from the ProSe-Information AVP. If the ProSe-Source-IP-Address AVP is not present, this method returns silently.
      • hasLayer2GroupId

        boolean hasLayer2GroupId()
        Returns true if the Layer-2-Group-ID AVP is present in the ProSe-Information AVP.
      • getLayer2GroupId

        byte[] getLayer2GroupId()
        Returns the value of the Layer-2-Group-ID AVP, of type OctetString.
        Returns:
        the value of the Layer-2-Group-ID AVP, or null if it has not been set.
      • setLayer2GroupId

        void setLayer2GroupId​(byte[] layer2GroupId)
        Sets the value of the Layer-2-Group-ID AVP, of type OctetString.
        Throws:
        NullPointerException - if layer2GroupId is null.
      • removeLayer2GroupId

        void removeLayer2GroupId()
        Removes the Layer-2-Group-ID AVP from the ProSe-Information AVP. If the Layer-2-Group-ID AVP is not present, this method returns silently.
      • hasProseGroupIpMulticastAddress

        boolean hasProseGroupIpMulticastAddress()
        Returns true if the ProSe-Group-IP-Multicast-Address AVP is present in the ProSe-Information AVP.
      • getProseGroupIpMulticastAddress

        Address getProseGroupIpMulticastAddress()
        Returns the value of the ProSe-Group-IP-Multicast-Address AVP, of type Address.
        Returns:
        the value of the ProSe-Group-IP-Multicast-Address AVP, or null if it has not been set.
      • setProseGroupIpMulticastAddress

        void setProseGroupIpMulticastAddress​(Address proseGroupIpMulticastAddress)
        Sets the value of the ProSe-Group-IP-Multicast-Address AVP, of type Address.
        Throws:
        NullPointerException - if proseGroupIpMulticastAddress is null.
      • removeProseGroupIpMulticastAddress

        void removeProseGroupIpMulticastAddress()
        Removes the ProSe-Group-IP-Multicast-Address AVP from the ProSe-Information AVP. If the ProSe-Group-IP-Multicast-Address AVP is not present, this method returns silently.
      • getCoverageInfos

        CoverageInfo[] getCoverageInfos()
        Returns the set of Coverage-Info AVPs. The returned array contains the AVPs in the order they appear in the ProSe-Information AVP. A return value of null implies that no Coverage-Info AVPs have been set. The elements in the given array are CoverageInfo objects.
      • setCoverageInfo

        void setCoverageInfo​(CoverageInfo coverageInfo)
        Sets a single Coverage-Info AVP in the ProSe-Information AVP, of type Grouped.
        Throws:
        NullPointerException - if coverageInfo is null.
      • setCoverageInfos

        void setCoverageInfos​(CoverageInfo[] coverageInfos)
        Sets the set of Coverage-Info AVPs, with all the values in the given array. The AVPs will be added to the ProSe-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 getCoverageInfos() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
        Throws:
        NullPointerException - if coverageInfos is null.
      • removeCoverageInfos

        void removeCoverageInfos()
        Removes all Coverage-Info AVPs from the ProSe-Information AVP. If no Coverage-Info AVPs are present, this method returns silently.
      • getRadioParameterSetInfos

        RadioParameterSetInfo[] getRadioParameterSetInfos()
        Returns the set of Radio-Parameter-Set-Info AVPs. The returned array contains the AVPs in the order they appear in the ProSe-Information AVP. A return value of null implies that no Radio-Parameter-Set-Info AVPs have been set. The elements in the given array are RadioParameterSetInfo objects.
      • setRadioParameterSetInfo

        void setRadioParameterSetInfo​(RadioParameterSetInfo radioParameterSetInfo)
        Sets a single Radio-Parameter-Set-Info AVP in the ProSe-Information AVP, of type Grouped.
        Throws:
        NullPointerException - if radioParameterSetInfo is null.
      • setRadioParameterSetInfos

        void setRadioParameterSetInfos​(RadioParameterSetInfo[] radioParameterSetInfos)
        Sets the set of Radio-Parameter-Set-Info AVPs, with all the values in the given array. The AVPs will be added to the ProSe-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 getRadioParameterSetInfos() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
        Throws:
        NullPointerException - if radioParameterSetInfos is null.
      • removeRadioParameterSetInfos

        void removeRadioParameterSetInfos()
        Removes all Radio-Parameter-Set-Info AVPs from the ProSe-Information AVP. If no Radio-Parameter-Set-Info AVPs are present, this method returns silently.
      • getTransmitterInfos

        TransmitterInfo[] getTransmitterInfos()
        Returns the set of Transmitter-Info AVPs. The returned array contains the AVPs in the order they appear in the ProSe-Information AVP. A return value of null implies that no Transmitter-Info AVPs have been set. The elements in the given array are TransmitterInfo objects.
      • setTransmitterInfo

        void setTransmitterInfo​(TransmitterInfo transmitterInfo)
        Sets a single Transmitter-Info AVP in the ProSe-Information AVP, of type Grouped.
        Throws:
        NullPointerException - if transmitterInfo is null.
      • setTransmitterInfos

        void setTransmitterInfos​(TransmitterInfo[] transmitterInfos)
        Sets the set of Transmitter-Info AVPs, with all the values in the given array. The AVPs will be added to the ProSe-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 getTransmitterInfos() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
        Throws:
        NullPointerException - if transmitterInfos is null.
      • removeTransmitterInfos

        void removeTransmitterInfos()
        Removes all Transmitter-Info AVPs from the ProSe-Information AVP. If no Transmitter-Info AVPs are present, this method returns silently.
      • hasTimeFirstTransmission

        boolean hasTimeFirstTransmission()
        Returns true if the Time-First-Transmission AVP is present in the ProSe-Information AVP.
      • getTimeFirstTransmission

        Date getTimeFirstTransmission()
        Returns the value of the Time-First-Transmission AVP, of type Time.
        Returns:
        the value of the Time-First-Transmission AVP, or null if it has not been set.
      • setTimeFirstTransmission

        void setTimeFirstTransmission​(Date timeFirstTransmission)
        Sets the value of the Time-First-Transmission AVP, of type Time.
        Throws:
        NullPointerException - if timeFirstTransmission is null.
      • removeTimeFirstTransmission

        void removeTimeFirstTransmission()
        Removes the Time-First-Transmission AVP from the ProSe-Information AVP. If the Time-First-Transmission AVP is not present, this method returns silently.
      • hasTimeFirstReception

        boolean hasTimeFirstReception()
        Returns true if the Time-First-Reception AVP is present in the ProSe-Information AVP.
      • getTimeFirstReception

        Date getTimeFirstReception()
        Returns the value of the Time-First-Reception AVP, of type Time.
        Returns:
        the value of the Time-First-Reception AVP, or null if it has not been set.
      • setTimeFirstReception

        void setTimeFirstReception​(Date timeFirstReception)
        Sets the value of the Time-First-Reception AVP, of type Time.
        Throws:
        NullPointerException - if timeFirstReception is null.
      • removeTimeFirstReception

        void removeTimeFirstReception()
        Removes the Time-First-Reception AVP from the ProSe-Information AVP. If the Time-First-Reception AVP is not present, this method returns silently.
      • getProseDirectCommunicationTransmissionDataContainers

        ProseDirectCommunicationTransmissionDataContainer[] getProseDirectCommunicationTransmissionDataContainers()
        Returns the set of ProSe-Direct-Communication-Transmission-Data-Container AVPs. The returned array contains the AVPs in the order they appear in the ProSe-Information AVP. A return value of null implies that no ProSe-Direct-Communication-Transmission-Data-Container AVPs have been set. The elements in the given array are ProseDirectCommunicationTransmissionDataContainer objects.
      • setProseDirectCommunicationTransmissionDataContainer

        void setProseDirectCommunicationTransmissionDataContainer​(ProseDirectCommunicationTransmissionDataContainer proseDirectCommunicationTransmissionDataContainer)
        Sets a single ProSe-Direct-Communication-Transmission-Data-Container AVP in the ProSe-Information AVP, of type Grouped.
        Throws:
        NullPointerException - if proseDirectCommunicationTransmissionDataContainer is null.
      • setProseDirectCommunicationTransmissionDataContainers

        void setProseDirectCommunicationTransmissionDataContainers​(ProseDirectCommunicationTransmissionDataContainer[] proseDirectCommunicationTransmissionDataContainers)
        Sets the set of ProSe-Direct-Communication-Transmission-Data-Container AVPs, with all the values in the given array. The AVPs will be added to the ProSe-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 getProseDirectCommunicationTransmissionDataContainers() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
        Throws:
        NullPointerException - if proseDirectCommunicationTransmissionDataContainers is null.
      • removeProseDirectCommunicationTransmissionDataContainers

        void removeProseDirectCommunicationTransmissionDataContainers()
        Removes all ProSe-Direct-Communication-Transmission-Data-Container AVPs from the ProSe-Information AVP. If no ProSe-Direct-Communication-Transmission-Data-Container AVPs are present, this method returns silently.
      • getProseDirectCommunicationReceptionDataContainers

        ProseDirectCommunicationReceptionDataContainer[] getProseDirectCommunicationReceptionDataContainers()
        Returns the set of ProSe-Direct-Communication-Reception-Data-Container AVPs. The returned array contains the AVPs in the order they appear in the ProSe-Information AVP. A return value of null implies that no ProSe-Direct-Communication-Reception-Data-Container AVPs have been set. The elements in the given array are ProseDirectCommunicationReceptionDataContainer objects.
      • setProseDirectCommunicationReceptionDataContainer

        void setProseDirectCommunicationReceptionDataContainer​(ProseDirectCommunicationReceptionDataContainer proseDirectCommunicationReceptionDataContainer)
        Sets a single ProSe-Direct-Communication-Reception-Data-Container AVP in the ProSe-Information AVP, of type Grouped.
        Throws:
        NullPointerException - if proseDirectCommunicationReceptionDataContainer is null.
      • setProseDirectCommunicationReceptionDataContainers

        void setProseDirectCommunicationReceptionDataContainers​(ProseDirectCommunicationReceptionDataContainer[] proseDirectCommunicationReceptionDataContainers)
        Sets the set of ProSe-Direct-Communication-Reception-Data-Container AVPs, with all the values in the given array. The AVPs will be added to the ProSe-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 getProseDirectCommunicationReceptionDataContainers() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
        Throws:
        NullPointerException - if proseDirectCommunicationReceptionDataContainers is null.
      • removeProseDirectCommunicationReceptionDataContainers

        void removeProseDirectCommunicationReceptionDataContainers()
        Removes all ProSe-Direct-Communication-Reception-Data-Container AVPs from the ProSe-Information AVP. If no ProSe-Direct-Communication-Reception-Data-Container 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 ProSe-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 ProSe-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 ProSe-Information AVP. If no extension AVPs are present, this method returns silently.