Interface TwanUserLocationInfo
-
- All Superinterfaces:
Cloneable
,DiameterAvp
,GroupedAvp
public interface TwanUserLocationInfo extends GroupedAvp
Defines an interface representing the TWAN-User-Location-Info grouped AVP type. From the Diameter Ro Reference Point Protocol Details (3GPP TS 32.299 V12.11.0) specification:7.2.237 C TWAN-User-Location-Info AVP The TWAN-User-Location-Info AVP (AVP code 2714) is of type Grouped and contains the UE location in a Trusted WLAN Access Network (TWAN): BSSID and SSID of the access point. It has the following ABNF grammar: TWAN-User-Location-Info ::= < AVP Header: 2714> { SSID } [BSSID ]
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 String
getBssid()
Returns the value of the BSSID AVP, of type UTF8String.DiameterAvp[]
getExtensionAvps()
Returns the set of extension AVPs.String
getSsid()
Returns the value of the SSID AVP, of type UTF8String.boolean
hasBssid()
Returns true if the BSSID AVP is present in the TWAN-User-Location-Info AVP.boolean
hasSsid()
Returns true if the SSID AVP is present in the TWAN-User-Location-Info AVP.void
removeBssid()
Removes the BSSID AVP from the TWAN-User-Location-Info AVP.void
removeExtensionAvps()
Removes all extension AVPs from the TWAN-User-Location-Info AVP.void
removeSsid()
Removes the SSID AVP from the TWAN-User-Location-Info AVP.void
setBssid(String bssid)
Sets the value of the BSSID AVP, of type UTF8String.void
setExtensionAvps(DiameterAvp[] avps)
Sets the set of extension AVPs with all the values in the given array.void
setSsid(String ssid)
Sets the value of the SSID AVP, of type UTF8String.-
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
-
hasSsid
boolean hasSsid()
Returns true if the SSID AVP is present in the TWAN-User-Location-Info AVP.
-
getSsid
String getSsid()
Returns the value of the SSID AVP, of type UTF8String.- Returns:
- the value of the SSID AVP, or null if it has not been set.
-
setSsid
void setSsid(String ssid)
Sets the value of the SSID AVP, of type UTF8String.- Throws:
NullPointerException
- ifssid
isnull
.
-
removeSsid
void removeSsid()
Removes the SSID AVP from the TWAN-User-Location-Info AVP. If the SSID AVP is not present, this method returns silently.
-
hasBssid
boolean hasBssid()
Returns true if the BSSID AVP is present in the TWAN-User-Location-Info AVP.
-
getBssid
String getBssid()
Returns the value of the BSSID AVP, of type UTF8String.- Returns:
- the value of the BSSID AVP, or null if it has not been set.
-
setBssid
void setBssid(String bssid)
Sets the value of the BSSID AVP, of type UTF8String.- Throws:
NullPointerException
- ifbssid
isnull
.
-
removeBssid
void removeBssid()
Removes the BSSID AVP from the TWAN-User-Location-Info AVP. If the BSSID 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 TWAN-User-Location-Info 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 TWAN-User-Location-Info 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 TWAN-User-Location-Info AVP. If no extension AVPs are present, this method returns silently.
-
-