net.java.slee.resource.diameter.base.events.avp
Interface FailedAvp

All Superinterfaces:

java.lang.Cloneable, DiameterAvp, GroupedAvp

All Known Implementing Classes:

FailedAvpImpl

public interface FailedAvp
extends GroupedAvp

Defines an interface representing the Failed-AVP grouped AVP type. From the Diameter Base Protocol (rfc3588.txt) specification:

 7.5.  Failed-AVP AVP
 
    The Failed-AVP AVP (AVP Code 279) is of type Grouped and provides
    debugging information in cases where a request is rejected or not
    fully processed due to erroneous information in a specific AVP.  The
    value of the Result-Code AVP will provide information on the reason
    for the Failed-AVP AVP.
 
    The possible reasons for this AVP are the presence of an improperly
    constructed AVP, an unsupported or unrecognized AVP, an invalid AVP
    value, the omission of a required AVP, the presence of an explicitly
    excluded AVP (see tables in Section 10), or the presence of two or
    more occurrences of an AVP which is restricted to 0, 1, or 0-1
    occurrences.
 
    A Diameter message MAY contain one Failed-AVP AVP, containing the
    entire AVP that could not be processed successfully.  If the failure
    reason is omission of a required AVP, an AVP with the missing AVP
    code, the missing vendor id, and a zero filled payload of the minimum
    required length for the omitted AVP will be added.
 
    AVP Format
 
       <Failed-AVP> ::= < AVP Header: 279 >
                     1* {AVP}
 

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

DiameterAvp[]	getExtensionAvps() Returns the set of extension AVPs.
void	setExtensionAvps(DiameterAvp[] avps) Sets the set of extension AVPs with all the values in the given array.

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

hasExtensionAvps

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, stringValue

Method Detail

getExtensionAvps

DiameterAvp[] getExtensionAvps()

Returns the set of extension AVPs. The returned array contains the extension AVPs in the order they appear in the message. A return value of null implies that no extensions AVPs have been set.

Specified by:

getExtensionAvps in interface GroupedAvp

Returns:

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 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 getExtensionAvps() is not guaranteed to return the same array instance, e.g. an "==" check would fail.

Specified by:

setExtensionAvps in interface GroupedAvp

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)

java.lang.IllegalStateException - if setExtensionAvps has already been called