Interface UserCsgInformation
-
- All Superinterfaces:
Cloneable
,DiameterAvp
,GroupedAvp
public interface UserCsgInformation extends GroupedAvp
Defines an interface representing the User-CSG-Information grouped AVP type. From the Diameter Rf Reference Point Protocol Details (3GPP TS 32.299 V10.0.0) specification:7.2.240 A User-CSG-Information AVP The User-CSG-Information AVP (AVP code 2319) is of type Grouped and holds the user “Closed Subscriber Group” Information associated to CSG cell access: it comprises CSG ID within the PLMN, Access mode and indication on CSG membership for the user when hybrid access applies, as defined in TS 29.060 [225] for GPRS case, and in TS 29.274 [226] for EPC case. It has the following ABNF grammar: User-CSG-Information ::= < AVP Header: 2319> { CSG-Id } { CSG-Access-Mode } [ CSG-Membership-Indication ]
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 CsgAccessMode
getCsgAccessMode()
Returns the value of the CSG-Access-Mode AVP, of type Enumerated.long
getCsgId()
Returns the value of the CSG-Id AVP, of type Unsigned32.CsgMembershipIndication
getCsgMembershipIndication()
Returns the value of the CSG-Membership-Indication AVP, of type Enumerated.DiameterAvp[]
getExtensionAvps()
Returns the set of extension AVPs.boolean
hasCsgAccessMode()
Returns true if the CSG-Access-Mode AVP is present in the User-CSG-Information AVP.boolean
hasCsgId()
Returns true if the CSG-Id AVP is present in the User-CSG-Information AVP.boolean
hasCsgMembershipIndication()
Returns true if the CSG-Membership-Indication AVP is present in the User-CSG-Information AVP.void
removeCsgAccessMode()
Removes the CSG-Access-Mode AVP from the User-CSG-Information AVP.void
removeCsgId()
Removes the CSG-Id AVP from the User-CSG-Information AVP.void
removeCsgMembershipIndication()
Removes the CSG-Membership-Indication AVP from the User-CSG-Information AVP.void
removeExtensionAvps()
Removes all extension AVPs from the User-CSG-Information AVP.void
setCsgAccessMode(CsgAccessMode csgAccessMode)
Sets the value of the CSG-Access-Mode AVP, of type Enumerated.void
setCsgId(long csgId)
Sets the value of the CSG-Id AVP, of type Unsigned32.void
setCsgMembershipIndication(CsgMembershipIndication csgMembershipIndication)
Sets the value of the CSG-Membership-Indication AVP, of type Enumerated.void
setExtensionAvps(DiameterAvp[] avps)
Sets the set of extension AVPs with all the values in the given array.-
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
-
hasCsgId
boolean hasCsgId()
Returns true if the CSG-Id AVP is present in the User-CSG-Information AVP.
-
getCsgId
long getCsgId()
Returns the value of the CSG-Id AVP, of type Unsigned32. UsehasCsgId()
to check the existence of this AVP.- Returns:
- the value of the CSG-Id AVP
- Throws:
IllegalStateException
- if the CSG-Id AVP has not been set.
-
setCsgId
void setCsgId(long csgId)
Sets the value of the CSG-Id AVP, of type Unsigned32.
-
removeCsgId
void removeCsgId()
Removes the CSG-Id AVP from the User-CSG-Information AVP. If the CSG-Id AVP is not present, this method returns silently.
-
hasCsgAccessMode
boolean hasCsgAccessMode()
Returns true if the CSG-Access-Mode AVP is present in the User-CSG-Information AVP.
-
getCsgAccessMode
CsgAccessMode getCsgAccessMode()
Returns the value of the CSG-Access-Mode AVP, of type Enumerated.- Returns:
- the value of the CSG-Access-Mode AVP, or null if it has not been set.
-
setCsgAccessMode
void setCsgAccessMode(CsgAccessMode csgAccessMode)
Sets the value of the CSG-Access-Mode AVP, of type Enumerated.- Throws:
NullPointerException
- ifcsgAccessMode
isnull
.
-
removeCsgAccessMode
void removeCsgAccessMode()
Removes the CSG-Access-Mode AVP from the User-CSG-Information AVP. If the CSG-Access-Mode AVP is not present, this method returns silently.
-
hasCsgMembershipIndication
boolean hasCsgMembershipIndication()
Returns true if the CSG-Membership-Indication AVP is present in the User-CSG-Information AVP.
-
getCsgMembershipIndication
CsgMembershipIndication getCsgMembershipIndication()
Returns the value of the CSG-Membership-Indication AVP, of type Enumerated.- Returns:
- the value of the CSG-Membership-Indication AVP, or null if it has not been set.
-
setCsgMembershipIndication
void setCsgMembershipIndication(CsgMembershipIndication csgMembershipIndication)
Sets the value of the CSG-Membership-Indication AVP, of type Enumerated.- Throws:
NullPointerException
- ifcsgMembershipIndication
isnull
.
-
removeCsgMembershipIndication
void removeCsgMembershipIndication()
Removes the CSG-Membership-Indication AVP from the User-CSG-Information AVP. If the CSG-Membership-Indication 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 User-CSG-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 User-CSG-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
- ifavps
isnull
.
-
removeExtensionAvps
void removeExtensionAvps()
Removes all extension AVPs from the User-CSG-Information AVP. If no extension AVPs are present, this method returns silently.
-
-