Interface SdpTimestamps
-
- All Superinterfaces:
Cloneable
,DiameterAvp
,GroupedAvp
public interface SdpTimestamps extends GroupedAvp
Defines an interface representing the SDP-TimeStamps grouped AVP type. From the Diameter Rf Reference Point Protocol Details (3GPP TS 32.299 V12.11.0) specification:7.2.185 SDP-TimeStamps AVP The SDP-TimeStamps AVP (AVP code 1273) is of type Grouped and holds the time of the SDP offer and the SDP answer. It has the following ABNF grammar: SDP-TimeStamps ::= < AVP Header: 1273 > [ SDP-Offer-Timestamp ] [ SDP-Answer-Timestamp ]
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.
-
-
Field Summary
-
Fields inherited from interface org.jainslee.resources.diameter.base.DiameterAvp
FLAG_RULE_MAY, FLAG_RULE_MUST, FLAG_RULE_MUSTNOT
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description DiameterAvp[]
getExtensionAvps()
Returns the set of extension AVPs.Date
getSdpAnswerTimestamp()
Returns the value of the SDP-Answer-Timestamp AVP, of type Time.Date
getSdpOfferTimestamp()
Returns the value of the SDP-Offer-Timestamp AVP, of type Time.boolean
hasSdpAnswerTimestamp()
Returns true if the SDP-Answer-Timestamp AVP is present in the SDP-TimeStamps AVP.boolean
hasSdpOfferTimestamp()
Returns true if the SDP-Offer-Timestamp AVP is present in the SDP-TimeStamps AVP.void
removeExtensionAvps()
Removes all extension AVPs from the SDP-TimeStamps AVP.void
removeSdpAnswerTimestamp()
Removes the SDP-Answer-Timestamp AVP from the SDP-TimeStamps AVP.void
removeSdpOfferTimestamp()
Removes the SDP-Offer-Timestamp AVP from the SDP-TimeStamps AVP.void
setExtensionAvps(DiameterAvp[] avps)
Sets the set of extension AVPs with all the values in the given array.void
setSdpAnswerTimestamp(Date sdpAnswerTimestamp)
Sets the value of the SDP-Answer-Timestamp AVP, of type Time.void
setSdpOfferTimestamp(Date sdpOfferTimestamp)
Sets the value of the SDP-Offer-Timestamp AVP, of type Time.-
Methods inherited from interface org.jainslee.resources.diameter.base.DiameterAvp
byteArrayValue, clone, doubleValue, floatValue, getCode, getMandatoryRule, getName, getProtectedRule, getType, getVendorID, groupedAvpValue, intValue, longValue, stringValue
-
-
-
-
Method Detail
-
hasSdpOfferTimestamp
boolean hasSdpOfferTimestamp()
Returns true if the SDP-Offer-Timestamp AVP is present in the SDP-TimeStamps AVP.
-
getSdpOfferTimestamp
Date getSdpOfferTimestamp()
Returns the value of the SDP-Offer-Timestamp AVP, of type Time.- Returns:
- the value of the SDP-Offer-Timestamp AVP, or null if it has not been set.
-
setSdpOfferTimestamp
void setSdpOfferTimestamp(Date sdpOfferTimestamp)
Sets the value of the SDP-Offer-Timestamp AVP, of type Time.- Throws:
NullPointerException
- ifsdpOfferTimestamp
isnull
.
-
removeSdpOfferTimestamp
void removeSdpOfferTimestamp()
Removes the SDP-Offer-Timestamp AVP from the SDP-TimeStamps AVP. If the SDP-Offer-Timestamp AVP is not present, this method returns silently.
-
hasSdpAnswerTimestamp
boolean hasSdpAnswerTimestamp()
Returns true if the SDP-Answer-Timestamp AVP is present in the SDP-TimeStamps AVP.
-
getSdpAnswerTimestamp
Date getSdpAnswerTimestamp()
Returns the value of the SDP-Answer-Timestamp AVP, of type Time.- Returns:
- the value of the SDP-Answer-Timestamp AVP, or null if it has not been set.
-
setSdpAnswerTimestamp
void setSdpAnswerTimestamp(Date sdpAnswerTimestamp)
Sets the value of the SDP-Answer-Timestamp AVP, of type Time.- Throws:
NullPointerException
- ifsdpAnswerTimestamp
isnull
.
-
removeSdpAnswerTimestamp
void removeSdpAnswerTimestamp()
Removes the SDP-Answer-Timestamp AVP from the SDP-TimeStamps AVP. If the SDP-Answer-Timestamp 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-TimeStamps 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-TimeStamps 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
- ifavps
isnull
.
-
removeExtensionAvps
void removeExtensionAvps()
Removes all extension AVPs from the SDP-TimeStamps AVP. If no extension AVPs are present, this method returns silently.
-
-