Interface PocUserRole
-
- All Superinterfaces:
Cloneable
,DiameterAvp
,GroupedAvp
public interface PocUserRole extends GroupedAvp
Defines an interface representing the PoC-User-Role grouped AVP type. From the Diameter Rf Reference Point Protocol Details (3GPP TS 32.299 V10.0.0) specification:7.2.149 PoC-User-Role AVP The PoC-User-Role AVP (AVP code 1252) is of type Grouped. It specifies the role(s) related information of the PoC User that participating in the PoC Session. It has the following grammar: PoC-User-Role ::= < AVP Header: 1252> [ PoC-User-Role-Ids ] [ PoC-User-Role-Info-Units ]
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.String
getPocUserRoleIds()
Returns the value of the PoC-User-Role-Ids AVP, of type UTF8String.PocUserRoleInfoUnits
getPocUserRoleInfoUnits()
Returns the value of the PoC-User-Role-Info-Units AVP, of type Enumerated.boolean
hasPocUserRoleIds()
Returns true if the PoC-User-Role-Ids AVP is present in the PoC-User-Role AVP.boolean
hasPocUserRoleInfoUnits()
Returns true if the PoC-User-Role-Info-Units AVP is present in the PoC-User-Role AVP.void
removeExtensionAvps()
Removes all extension AVPs from the PoC-User-Role AVP.void
removePocUserRoleIds()
Removes the PoC-User-Role-Ids AVP from the PoC-User-Role AVP.void
removePocUserRoleInfoUnits()
Removes the PoC-User-Role-Info-Units AVP from the PoC-User-Role AVP.void
setExtensionAvps(DiameterAvp[] avps)
Sets the set of extension AVPs with all the values in the given array.void
setPocUserRoleIds(String pocUserRoleIds)
Sets the value of the PoC-User-Role-Ids AVP, of type UTF8String.void
setPocUserRoleInfoUnits(PocUserRoleInfoUnits pocUserRoleInfoUnits)
Sets the value of the PoC-User-Role-Info-Units AVP, of type Enumerated.-
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
-
hasPocUserRoleIds
boolean hasPocUserRoleIds()
Returns true if the PoC-User-Role-Ids AVP is present in the PoC-User-Role AVP.
-
getPocUserRoleIds
String getPocUserRoleIds()
Returns the value of the PoC-User-Role-Ids AVP, of type UTF8String.- Returns:
- the value of the PoC-User-Role-Ids AVP, or null if it has not been set.
-
setPocUserRoleIds
void setPocUserRoleIds(String pocUserRoleIds)
Sets the value of the PoC-User-Role-Ids AVP, of type UTF8String.- Throws:
NullPointerException
- ifpocUserRoleIds
isnull
.
-
removePocUserRoleIds
void removePocUserRoleIds()
Removes the PoC-User-Role-Ids AVP from the PoC-User-Role AVP. If the PoC-User-Role-Ids AVP is not present, this method returns silently.
-
hasPocUserRoleInfoUnits
boolean hasPocUserRoleInfoUnits()
Returns true if the PoC-User-Role-Info-Units AVP is present in the PoC-User-Role AVP.
-
getPocUserRoleInfoUnits
PocUserRoleInfoUnits getPocUserRoleInfoUnits()
Returns the value of the PoC-User-Role-Info-Units AVP, of type Enumerated.- Returns:
- the value of the PoC-User-Role-Info-Units AVP, or null if it has not been set.
-
setPocUserRoleInfoUnits
void setPocUserRoleInfoUnits(PocUserRoleInfoUnits pocUserRoleInfoUnits)
Sets the value of the PoC-User-Role-Info-Units AVP, of type Enumerated.- Throws:
NullPointerException
- ifpocUserRoleInfoUnits
isnull
.
-
removePocUserRoleInfoUnits
void removePocUserRoleInfoUnits()
Removes the PoC-User-Role-Info-Units AVP from the PoC-User-Role AVP. If the PoC-User-Role-Info-Units 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 PoC-User-Role 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 PoC-User-Role 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 PoC-User-Role AVP. If no extension AVPs are present, this method returns silently.
-
-