Class AvpException

All Implemented Interfaces:
Serializable

public class AvpException extends MessageException
Exception raised if an invalid AVP was encountered in a Diameter message.
Author:
Copyright (c) 2019, Oracle and/or its affiliates. All rights reserved.
See Also:
  • Constructor Details

    • AvpException

      public AvpException(ResultCode rc, Avp invalidAvp)
      Creates a new AvpException for the specified ResultCode and invalid AVP.
      Parameters:
      rc - the error ResultCode
      invalidAvp - the invalid (failed) AVP to be included
    • AvpException

      public AvpException(ResultCode rc, Avp[] invalidAvps)
      Creates a new AvpException for the specified ResultCode and invalid AVPs.
      Parameters:
      rc - the error ResultCode
      invalidAvps - the the list of invalid (failed) AVPs to be included
    • AvpException

      public AvpException(ResultCode rc, Attribute attr)
      Creates a new AvpException for the specified ResultCode and missing AVP.
      Parameters:
      rc - the error ResultCode
      attr - the Attribute for the missing AVP
  • Method Details

    • addInvalidAvp

      public void addInvalidAvp(Avp avp)
      Adds an additional AVP to the list of failed AVPs.
      Parameters:
      avp - the failed AVP to be added
    • addMissingAvp

      public void addMissingAvp(Attribute attr)
      Adds an additional missing AVP to the list of failed AVPs.
      Parameters:
      attr - the Attribute for the missing AVP
    • getFailedAvps

      public AvpList getFailedAvps()
      Returns the list of failed AVPs for this exception.
    • getFailedAvp

      public Avp getFailedAvp()
    • createAnswer

      public Answer createAnswer(Request req)
      Creates a new Answer message for a Request that contained invalid AVPs. The failed AVPs will be included in the answer as well as AVPs for the error result code and error message.
      Overrides:
      createAnswer in class MessageException
      Parameters:
      req - the Request that was invalid
      Returns:
      the Answer message indicating one or more invalid AVPs
    • avpOccursTooManyTimes

      public static AvpException avpOccursTooManyTimes(Avp avp)
      Convenience method to return an AvpException indicating that the specified AVP occurs too many times in the message.
    • missingAvp

      public static AvpException missingAvp(Attribute attr)
    • invalidAvpLength

      public static AvpException invalidAvpLength(Avp avp)
      Convenience method to return an AvpException indicating that the length of the specified AVP was invalid.
    • invalidAvpValue

      public static AvpException invalidAvpValue(Avp avp)
      Convenience method to return an AvpException indicating that the value of the specified AVP was invalid.
    • contradictingAvps

      public static AvpException contradictingAvps(Avp avp1, Avp avp2)
      Convenience method to return an AvpException indicating indicating contradicting AVPs in a message.