net.java.slee.resource.diameter.cca.events.avp
Interface FinalUnitIndicationAvp

All Superinterfaces:

java.lang.Cloneable, net.java.slee.resource.diameter.base.events.avp.DiameterAvp, net.java.slee.resource.diameter.base.events.avp.GroupedAvp

All Known Implementing Classes:

FinalUnitIndicationAvpImpl

public interface FinalUnitIndicationAvp
extends net.java.slee.resource.diameter.base.events.avp.GroupedAvp

  <b>8.34. Final-Unit-Indication AVP</b>
 
 
   The Final-Unit-Indication AVP (AVP Code 430) is of type Grouped and
   indicates that the Granted-Service-Unit AVP in the Credit-Control-
   Answer, or in the AA answer, contains the final units for the
   service.  After these units have expired, the Diameter credit-control
   client is responsible for executing the action indicated in the
   Final-Unit-Action AVP (see section 5.6).
 
   If more than one unit type is received in the Credit-Control-Answer,
   the unit type that first expired SHOULD cause the credit-control
   client to execute the specified action.
 
   In the first interrogation, the Final-Unit-Indication AVP with
   Final-Unit-Action REDIRECT or RESTRICT_ACCESS can also be present
   with no Granted-Service-Unit AVP in the Credit-Control-Answer or in
   the AA answer.  This indicates to the Diameter credit-control client
   to execute the specified action immediately.  If the home service
   provider policy is to terminate the service, naturally, the server
   SHOULD return the appropriate transient failure (see section 9.1) in
   order to implement the policy-defined action.
 
   The Final-Unit-Action AVP defines the behavior of the service element
   when the user's account cannot cover the cost of the service and MUST
   always be present if the Final-Unit-Indication AVP is included in a
   command.
 
   If the Final-Unit-Action AVP is set to TERMINATE, no other AVPs MUST
   be present.
 
   If the Final-Unit-Action AVP is set to REDIRECT at least the
   Redirect-Server AVP MUST be present.  The Restriction-Filter-Rule AVP
   or the Filter-Id AVP MAY be present in the Credit-Control-Answer
   message if the user is also allowed to access other services that are
   not accessible through the address given in the Redirect-Server AVP.
 
   If the Final-Unit-Action AVP is set to RESTRICT_ACCESS, either the
   Restriction-Filter-Rule AVP or the Filter-Id AVP SHOULD be present.
   The Filter-Id AVP is defined in [NASREQ].  The Filter-Id AVP can be
   used to reference an IP filter list installed in the access device by
   means other than the Diameter credit-control application, e.g.,
   locally configured or configured by another entity.
 
   The Final-Unit-Indication AVP is defined as follows (per the
   grouped-avp-def of RFC 3588 [DIAMBASE]):
 
      Final-Unit-Indication ::= < AVP Header: 430 >
                                { Final-Unit-Action }
                               *[ Restriction-Filter-Rule ]
                               *[ Filter-Id ]
                                [ Redirect-Server ]
 

Author:

Bartosz Baranowski , Alexandre Mendonca

Field Summary

Fields inherited from interface net.java.slee.resource.diameter.base.events.avp.DiameterAvp

FLAG_RULE_MAY, FLAG_RULE_MUST, FLAG_RULE_MUSTNOT

Method Summary

java.lang.String[]	getFilterIds() Returns the set of Filter-Id AVPs.
FinalUnitActionType	getFinalUnitAction() Returns the value of the Final-Unit-Action AVP, of type Enumerated.
RedirectServerAvp	getRedirectServer() Returns the value of the Redirect-Server AVP, of type Grouped.
net.java.slee.resource.diameter.base.events.avp.IPFilterRule[]	getRestrictionFilterRules() Returns the set of Restriction-Filter-Rule AVPs.
boolean	hasFinalUnitAction() Returns true if the Final-Unit-Action AVP is present in the message.
boolean	hasRedirectServer() Returns true if the Redirect-Server AVP is present in the message.
void	setFilterId(java.lang.String filterId) Sets a single Filter-Id AVP in the message, of type UTF8String.
void	setFilterIds(java.lang.String[] filterIds) Sets the set of Filter-Id AVPs, with all the values in the given array.
void	setFinalUnitAction(FinalUnitActionType finalUnitAction) Sets the value of the Final-Unit-Action AVP, of type Enumerated.
void	setRedirectServer(RedirectServerAvp redirectServer) Sets the value of the Redirect-Server AVP, of type Grouped.
void	setRestrictionFilterRule(net.java.slee.resource.diameter.base.events.avp.IPFilterRule restrictionFilterRule) Sets the set of Restriction-Filter-Rule AVPs, with all the values in the given array.
void	setRestrictionFilterRules(net.java.slee.resource.diameter.base.events.avp.IPFilterRule[] restrictionFilterRules) Sets the set of Restriction-Filter-Rule AVPs, with all the values in the given array.

Methods inherited from interface net.java.slee.resource.diameter.base.events.avp.GroupedAvp

getExtensionAvps, setExtensionAvps

Methods inherited from interface net.java.slee.resource.diameter.base.events.avp.DiameterAvp

byteArrayValue, clone, doubleValue, floatValue, getCode, getMandatoryRule, getName, getProtectedRule, getType, getVendorId, intValue, longValue, octetStringValue, stringValue

Method Detail

getFilterIds

java.lang.String[] getFilterIds()

Returns the set of Filter-Id AVPs. The returned array contains the AVPs in the order they appear in the message. A return value of null implies that no Filter-Id AVPs have been set. The elements in the given array are String objects (Filter-Id is of type UTF8String).

Returns:

getFinalUnitAction

FinalUnitActionType getFinalUnitAction()

Returns the value of the Final-Unit-Action AVP, of type Enumerated. Return value of null indicates that this avp has not been set. See: FinalUnitActionType

Returns:

getRedirectServer

RedirectServerAvp getRedirectServer()

Returns the value of the Redirect-Server AVP, of type Grouped. Return value of null indicates that this avp has not been set. See: RedirectServerAvp

Returns:

getRestrictionFilterRules

net.java.slee.resource.diameter.base.events.avp.IPFilterRule[] getRestrictionFilterRules()

Returns the set of Restriction-Filter-Rule AVPs. Null value implies that value has not been set. See: IPFilterRule

Returns:

hasFinalUnitAction

boolean hasFinalUnitAction()

Returns true if the Final-Unit-Action AVP is present in the message.

Returns:

hasRedirectServer

boolean hasRedirectServer()

Returns true if the Redirect-Server AVP is present in the message.

Returns:

setFilterId

void setFilterId(java.lang.String filterId)

Sets a single Filter-Id AVP in the message, of type UTF8String.

Parameters:

filterId -

setFilterIds

void setFilterIds(java.lang.String[] filterIds)

Sets the set of Filter-Id AVPs, with all the values in the given array.

Parameters:

filterIds -

setFinalUnitAction

void setFinalUnitAction(FinalUnitActionType finalUnitAction)

Sets the value of the Final-Unit-Action AVP, of type Enumerated. See: FinalUnitActionType

Parameters:

finalUnitAction -

setRedirectServer

void setRedirectServer(RedirectServerAvp redirectServer)

Sets the value of the Redirect-Server AVP, of type Grouped. See: RedirectServerAvp

Parameters:

redirectServer -

setRestrictionFilterRule

void setRestrictionFilterRule(net.java.slee.resource.diameter.base.events.avp.IPFilterRule restrictionFilterRule)

Sets the set of Restriction-Filter-Rule AVPs, with all the values in the given array. The AVPs will be added to message in the order in which they appear in the array. Note: the array must not be altered by the caller following this call, and getRestrictionFilterRules() is not guaranteed to return the same array instance, e.g. an "==" check would fail. See: IPFilterRule

Parameters:

restrictionFilterRule -

setRestrictionFilterRules

void setRestrictionFilterRules(net.java.slee.resource.diameter.base.events.avp.IPFilterRule[] restrictionFilterRules)

Sets the set of Restriction-Filter-Rule AVPs, with all the values in the given array. See: IPFilterRule

Parameters:

restrictionFilterRules -