public interface RoutingRuleDefinition extends GroupedAvp
5.3.70 Routing-Rule-Definition The Routing-Rule-Definition AVP (AVP code 1076) is of type Grouped, and it defines the IP flow mobility routing rule sent by the PCEF to the PCRF. The Routing-Rule-Identifier AVP uniquely identifies the IP flow mobility routing rule and it is used to reference to a IP flow mobility routing rule in communication between the PCEF and the PCRF within one IP CAN session. The Routing-IP-Address AVP identifies the IP address to be used for transporting for service data flows matching the IP flow mobility routing rule. The IP address may be a care-of-address or the home address. The Routing-Filter AVP(s) contains detailed description of routing filter(s) for determining the service data flows that belong to the IP flow mobility routing rule. AVP Format: Routing-Rule-Definition ::= < AVP Header: 1076 > { Routing-Rule-Identifier } *[ Routing-Filter ] [ Precedence ] [ Routing-IP-Address ] *[ AVP ]
FLAG_RULE_MAY, FLAG_RULE_MUST, FLAG_RULE_MUSTNOT
Modifier and Type | Method and Description |
---|---|
DiameterAvp[] |
getExtensionAvps()
Returns the set of extension AVPs.
|
long |
getPrecedence()
Returns the value of the Precedence AVP, of type Unsigned32.
|
RoutingFilter[] |
getRoutingFilters()
Returns the set of Routing-Filter AVPs.
|
Address |
getRoutingIpAddress()
Returns the value of the Routing-IP-Address AVP, of type Address.
|
byte[] |
getRoutingRuleIdentifier()
Returns the value of the Routing-Rule-Identifier AVP, of type OctetString.
|
boolean |
hasPrecedence()
Returns true if the Precedence AVP is present in the Routing-Rule-Definition AVP.
|
boolean |
hasRoutingIpAddress()
Returns true if the Routing-IP-Address AVP is present in the Routing-Rule-Definition AVP.
|
boolean |
hasRoutingRuleIdentifier()
Returns true if the Routing-Rule-Identifier AVP is present in the Routing-Rule-Definition AVP.
|
void |
removeExtensionAvps()
Removes all extension AVPs from the Routing-Rule-Definition AVP.
|
void |
removePrecedence()
Removes the Precedence AVP from the Routing-Rule-Definition AVP.
|
void |
removeRoutingFilters()
Removes all Routing-Filter AVPs from the Routing-Rule-Definition AVP.
|
void |
removeRoutingIpAddress()
Removes the Routing-IP-Address AVP from the Routing-Rule-Definition AVP.
|
void |
removeRoutingRuleIdentifier()
Removes the Routing-Rule-Identifier AVP from the Routing-Rule-Definition AVP.
|
void |
setExtensionAvps(DiameterAvp[] avps)
Sets the set of extension AVPs with all the values in the given array.
|
void |
setPrecedence(long precedence)
Sets the value of the Precedence AVP, of type Unsigned32.
|
void |
setRoutingFilter(RoutingFilter routingFilter)
Sets a single Routing-Filter AVP in the Routing-Rule-Definition AVP, of type Grouped.
|
void |
setRoutingFilters(RoutingFilter[] routingFilters)
Sets the set of Routing-Filter AVPs, with all the values in the given array.
|
void |
setRoutingIpAddress(Address routingIpAddress)
Sets the value of the Routing-IP-Address AVP, of type Address.
|
void |
setRoutingRuleIdentifier(byte[] routingRuleIdentifier)
Sets the value of the Routing-Rule-Identifier AVP, of type OctetString.
|
byteArrayValue, clone, doubleValue, floatValue, getCode, getMandatoryRule, getName, getProtectedRule, getType, getVendorID, groupedAvpValue, intValue, longValue, stringValue
boolean hasRoutingRuleIdentifier()
byte[] getRoutingRuleIdentifier()
void setRoutingRuleIdentifier(byte[] routingRuleIdentifier)
java.lang.NullPointerException
- if routingRuleIdentifier
is null
.void removeRoutingRuleIdentifier()
RoutingFilter[] getRoutingFilters()
void setRoutingFilter(RoutingFilter routingFilter)
java.lang.NullPointerException
- if routingFilter
is null
.void setRoutingFilters(RoutingFilter[] routingFilters)
java.lang.NullPointerException
- if routingFilters
is null
.void removeRoutingFilters()
boolean hasPrecedence()
long getPrecedence()
hasPrecedence()
to check the existence of this AVP.java.lang.IllegalStateException
- if the Precedence AVP has not been set.void setPrecedence(long precedence)
void removePrecedence()
boolean hasRoutingIpAddress()
Address getRoutingIpAddress()
void setRoutingIpAddress(Address routingIpAddress)
java.lang.NullPointerException
- if routingIpAddress
is null
.void removeRoutingIpAddress()
DiameterAvp[] getExtensionAvps()
void setExtensionAvps(DiameterAvp[] avps) throws AvpNotAllowedException
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)java.lang.NullPointerException
- if avps
is null
.void removeExtensionAvps()