Package org.jainslee.resources.diameter.base

Interface DiameterHeader

  • All Superinterfaces:
    Cloneable
    public interface DiameterHeader
extends Cloneable
    Interface to allow applications to retrieve Diameter header fields should they need to.
    Author:
    Open Cloud

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      Object clone()
      Creates and returns a deep copy of this diameter header instance.
      int getApplicationId()
      Return application ID from this Diameter header.
      int getCommandCode()
      Return the command code stored in this Diameter header.
      int getEndToEndId()
      Return End-to-End ID from this Diameter header.
      int getHopByHopId()
      Return Hop-by-Hop ID from this Diameter header.
      int getMessageLength()
      Return the message length stored in this Diameter header.
      short getVersion()
      Return the Diameter version ID from this Diameter header.
      boolean isError()
      Return true if the error flag is set in this header.
      boolean isPotentiallyRetransmitted()
      Return true if the potentially retransmitted flag is set in this header.
      boolean isProxiable()
      Return true if the proxiable flag is set in this header.
      boolean isRequest()
      Return true if the request flag is set in this header.
      void setPotentiallyRetransmitted​(boolean isPotentiallyRetransmitted)
      Sets the state of potentially retransmitted flag in this header.

    • Method Detail

      • isRequest

        boolean isRequest()
        Return true if the request flag is set in this header.
        Returns:
        request flag

      • isProxiable

        boolean isProxiable()
        Return true if the proxiable flag is set in this header.
        Returns:
        proxiable flag

      • isError

        boolean isError()
        Return true if the error flag is set in this header.
        Returns:
        error flag

      • isPotentiallyRetransmitted

        boolean isPotentiallyRetransmitted()
        Return true if the potentially retransmitted flag is set in this header.
        Returns:
        potentially retransmitted flag

      • setPotentiallyRetransmitted

        void setPotentiallyRetransmitted​(boolean isPotentiallyRetransmitted)
                          throws IllegalArgumentException
        Sets the state of potentially retransmitted flag in this header.
        Parameters:
        isPotentiallyRetransmitted - true if message is a possible duplicate, false otherwise.
        Throws:
        IllegalArgumentException - if isPotentiallyRetransmitted value is set to true for an answer (that is isRequest() is false). This flag MUST NOT be set in answer messages.

      • getApplicationId

        int getApplicationId()
        Return application ID from this Diameter header.
        Returns:
        the application ID

      • getHopByHopId

        int getHopByHopId()
        Return Hop-by-Hop ID from this Diameter header.
        Returns:
        the hop-by-hop id

      • getEndToEndId

        int getEndToEndId()
        Return End-to-End ID from this Diameter header.
        Returns:
        the end-to-end id

      • getVersion

        short getVersion()
        Return the Diameter version ID from this Diameter header.
        Returns:
        the value 1

      • getMessageLength

        int getMessageLength()
        Return the message length stored in this Diameter header. Note that for outgoing messages, the correct length may not be known until the message is encoded for transmission.
        Returns:
        the message length

      • getCommandCode

        int getCommandCode()
        Return the command code stored in this Diameter header.
        Returns:
        the command code

      • clone

        Object clone()
        Creates and returns a deep copy of this diameter header instance.
        Returns:
        a deep copy of this header.