Interface PacketFilterInformation
-
- All Superinterfaces:
Cloneable
,DiameterAvp
,GroupedAvp
public interface PacketFilterInformation extends GroupedAvp
Defines an interface representing the Packet-Filter-Information grouped AVP type. From the Diameter Gx Reference Point Protocol Details (3GPP TS 29.212 V11.9.0) specification:5.3.56 Packet-Filter-Information The Packet-Filter-Information AVP (AVP code 1061) is of type Grouped, and it contains the information from a single packet filter sent from the PCEF to the PCRF. Depending on the Packet-Filter-Operation included within the CCR command it may include the packet filter identifier, evaluation precedence, filter value, filter direction, Type-of-Service/Traffic Class, the IPSec SPI, and the Flow Label. When the Packet-Filter-Operation AVP included within the CCR command indicates DELETION, only the Packet-Filter-Identifier AVP shall be provided. The Flow-Direction AVP shall be included unless no other AVPs other than Packet-Filter-Identifier AVP are included within the Packet-Filter-Information AVP. When the Packet-Filter-Operation AVP included within the CCR command indicates ADDITION and is linked to an existing packet filter, only the Packet-Filter-Identifier AVP shall be provided for the existing packet filter. See annex B.3.4 for E-UTRAN specific details. AVP Format: Packet-Filter-Information ::= < AVP Header: 1061 > [ Packet-Filter-Identifier ] [ Precedence ] [ Packet-Filter-Content ] [ ToS-Traffic-Class ] [ Security-Parameter-Index ] [ Flow-Label ] [ Flow-Direction ] *[ AVP ]
-
-
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.FlowDirection
getFlowDirection()
Returns the value of the Flow-Direction AVP, of type Enumerated.byte[]
getFlowLabel()
Returns the value of the Flow-Label AVP, of type OctetString.IPFilterRule
getPacketFilterContent()
Returns the value of the Packet-Filter-Content AVP, of type IPFilterRule.byte[]
getPacketFilterIdentifier()
Returns the value of the Packet-Filter-Identifier AVP, of type OctetString.long
getPrecedence()
Returns the value of the Precedence AVP, of type Unsigned32.byte[]
getSecurityParameterIndex()
Returns the value of the Security-Parameter-Index AVP, of type OctetString.byte[]
getTosTrafficClass()
Returns the value of the ToS-Traffic-Class AVP, of type OctetString.boolean
hasFlowDirection()
Returns true if the Flow-Direction AVP is present in the Packet-Filter-Information AVP.boolean
hasFlowLabel()
Returns true if the Flow-Label AVP is present in the Packet-Filter-Information AVP.boolean
hasPacketFilterContent()
Returns true if the Packet-Filter-Content AVP is present in the Packet-Filter-Information AVP.boolean
hasPacketFilterIdentifier()
Returns true if the Packet-Filter-Identifier AVP is present in the Packet-Filter-Information AVP.boolean
hasPrecedence()
Returns true if the Precedence AVP is present in the Packet-Filter-Information AVP.boolean
hasSecurityParameterIndex()
Returns true if the Security-Parameter-Index AVP is present in the Packet-Filter-Information AVP.boolean
hasTosTrafficClass()
Returns true if the ToS-Traffic-Class AVP is present in the Packet-Filter-Information AVP.void
removeExtensionAvps()
Removes all extension AVPs from the Packet-Filter-Information AVP.void
removeFlowDirection()
Removes the Flow-Direction AVP from the Packet-Filter-Information AVP.void
removeFlowLabel()
Removes the Flow-Label AVP from the Packet-Filter-Information AVP.void
removePacketFilterContent()
Removes the Packet-Filter-Content AVP from the Packet-Filter-Information AVP.void
removePacketFilterIdentifier()
Removes the Packet-Filter-Identifier AVP from the Packet-Filter-Information AVP.void
removePrecedence()
Removes the Precedence AVP from the Packet-Filter-Information AVP.void
removeSecurityParameterIndex()
Removes the Security-Parameter-Index AVP from the Packet-Filter-Information AVP.void
removeTosTrafficClass()
Removes the ToS-Traffic-Class AVP from the Packet-Filter-Information AVP.void
setExtensionAvps(DiameterAvp[] avps)
Sets the set of extension AVPs with all the values in the given array.void
setFlowDirection(FlowDirection flowDirection)
Sets the value of the Flow-Direction AVP, of type Enumerated.void
setFlowLabel(byte[] flowLabel)
Sets the value of the Flow-Label AVP, of type OctetString.void
setPacketFilterContent(IPFilterRule packetFilterContent)
Sets the value of the Packet-Filter-Content AVP, of type IPFilterRule.void
setPacketFilterIdentifier(byte[] packetFilterIdentifier)
Sets the value of the Packet-Filter-Identifier AVP, of type OctetString.void
setPrecedence(long precedence)
Sets the value of the Precedence AVP, of type Unsigned32.void
setSecurityParameterIndex(byte[] securityParameterIndex)
Sets the value of the Security-Parameter-Index AVP, of type OctetString.void
setTosTrafficClass(byte[] tosTrafficClass)
Sets the value of the ToS-Traffic-Class AVP, of type OctetString.-
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
-
hasPacketFilterIdentifier
boolean hasPacketFilterIdentifier()
Returns true if the Packet-Filter-Identifier AVP is present in the Packet-Filter-Information AVP.
-
getPacketFilterIdentifier
byte[] getPacketFilterIdentifier()
Returns the value of the Packet-Filter-Identifier AVP, of type OctetString.- Returns:
- the value of the Packet-Filter-Identifier AVP, or null if it has not been set.
-
setPacketFilterIdentifier
void setPacketFilterIdentifier(byte[] packetFilterIdentifier)
Sets the value of the Packet-Filter-Identifier AVP, of type OctetString.- Throws:
NullPointerException
- ifpacketFilterIdentifier
isnull
.
-
removePacketFilterIdentifier
void removePacketFilterIdentifier()
Removes the Packet-Filter-Identifier AVP from the Packet-Filter-Information AVP. If the Packet-Filter-Identifier AVP is not present, this method returns silently.
-
hasPrecedence
boolean hasPrecedence()
Returns true if the Precedence AVP is present in the Packet-Filter-Information AVP.
-
getPrecedence
long getPrecedence()
Returns the value of the Precedence AVP, of type Unsigned32. UsehasPrecedence()
to check the existence of this AVP.- Returns:
- the value of the Precedence AVP
- Throws:
IllegalStateException
- if the Precedence AVP has not been set.
-
setPrecedence
void setPrecedence(long precedence)
Sets the value of the Precedence AVP, of type Unsigned32.
-
removePrecedence
void removePrecedence()
Removes the Precedence AVP from the Packet-Filter-Information AVP. If the Precedence AVP is not present, this method returns silently.
-
hasPacketFilterContent
boolean hasPacketFilterContent()
Returns true if the Packet-Filter-Content AVP is present in the Packet-Filter-Information AVP.
-
getPacketFilterContent
IPFilterRule getPacketFilterContent()
Returns the value of the Packet-Filter-Content AVP, of type IPFilterRule.- Returns:
- the value of the Packet-Filter-Content AVP, or null if it has not been set.
-
setPacketFilterContent
void setPacketFilterContent(IPFilterRule packetFilterContent)
Sets the value of the Packet-Filter-Content AVP, of type IPFilterRule.- Throws:
NullPointerException
- ifpacketFilterContent
isnull
.
-
removePacketFilterContent
void removePacketFilterContent()
Removes the Packet-Filter-Content AVP from the Packet-Filter-Information AVP. If the Packet-Filter-Content AVP is not present, this method returns silently.
-
hasTosTrafficClass
boolean hasTosTrafficClass()
Returns true if the ToS-Traffic-Class AVP is present in the Packet-Filter-Information AVP.
-
getTosTrafficClass
byte[] getTosTrafficClass()
Returns the value of the ToS-Traffic-Class AVP, of type OctetString.- Returns:
- the value of the ToS-Traffic-Class AVP, or null if it has not been set.
-
setTosTrafficClass
void setTosTrafficClass(byte[] tosTrafficClass)
Sets the value of the ToS-Traffic-Class AVP, of type OctetString.- Throws:
NullPointerException
- iftosTrafficClass
isnull
.
-
removeTosTrafficClass
void removeTosTrafficClass()
Removes the ToS-Traffic-Class AVP from the Packet-Filter-Information AVP. If the ToS-Traffic-Class AVP is not present, this method returns silently.
-
hasSecurityParameterIndex
boolean hasSecurityParameterIndex()
Returns true if the Security-Parameter-Index AVP is present in the Packet-Filter-Information AVP.
-
getSecurityParameterIndex
byte[] getSecurityParameterIndex()
Returns the value of the Security-Parameter-Index AVP, of type OctetString.- Returns:
- the value of the Security-Parameter-Index AVP, or null if it has not been set.
-
setSecurityParameterIndex
void setSecurityParameterIndex(byte[] securityParameterIndex)
Sets the value of the Security-Parameter-Index AVP, of type OctetString.- Throws:
NullPointerException
- ifsecurityParameterIndex
isnull
.
-
removeSecurityParameterIndex
void removeSecurityParameterIndex()
Removes the Security-Parameter-Index AVP from the Packet-Filter-Information AVP. If the Security-Parameter-Index AVP is not present, this method returns silently.
-
hasFlowLabel
boolean hasFlowLabel()
Returns true if the Flow-Label AVP is present in the Packet-Filter-Information AVP.
-
getFlowLabel
byte[] getFlowLabel()
Returns the value of the Flow-Label AVP, of type OctetString.- Returns:
- the value of the Flow-Label AVP, or null if it has not been set.
-
setFlowLabel
void setFlowLabel(byte[] flowLabel)
Sets the value of the Flow-Label AVP, of type OctetString.- Throws:
NullPointerException
- ifflowLabel
isnull
.
-
removeFlowLabel
void removeFlowLabel()
Removes the Flow-Label AVP from the Packet-Filter-Information AVP. If the Flow-Label AVP is not present, this method returns silently.
-
hasFlowDirection
boolean hasFlowDirection()
Returns true if the Flow-Direction AVP is present in the Packet-Filter-Information AVP.
-
getFlowDirection
FlowDirection getFlowDirection()
Returns the value of the Flow-Direction AVP, of type Enumerated.- Returns:
- the value of the Flow-Direction AVP, or null if it has not been set.
-
setFlowDirection
void setFlowDirection(FlowDirection flowDirection)
Sets the value of the Flow-Direction AVP, of type Enumerated.- Throws:
NullPointerException
- ifflowDirection
isnull
.
-
removeFlowDirection
void removeFlowDirection()
Removes the Flow-Direction AVP from the Packet-Filter-Information AVP. If the Flow-Direction 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 Packet-Filter-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 Packet-Filter-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 Packet-Filter-Information AVP. If no extension AVPs are present, this method returns silently.
-
-