Package org.jainslee.resources.diameter.gx.types.va10

Interface TraceData

  • All Superinterfaces:
    Cloneable, DiameterAvp, GroupedAvp
    public interface TraceData
extends GroupedAvp
    Defines an interface representing the Trace-Data grouped AVP type. From the Diameter Gx Reference Point Protocol Details (3GPP TS 29.212 V10.1.0) specification: 
     7.3.63  Trace-Data
 
     The Trace-Data AVP is of type Grouped. This AVP shall contain the information related to trace function.
 
     AVP format:
 
     Trace-Data ::= < AVP Header: 1458 10415 >
                     {Trace-Reference}
                     {Trace-Depth}
                     {Trace-NE-Type-List}
                     [Trace-Interface-List]
                     {Trace-Event-List}
                     [OMC-Id]
                     {Trace-Collection-Entity}
                     [MDT-Configuration]
                    *[AVP]

    • Method Detail

      • hasTraceReference

        boolean hasTraceReference()
        Returns true if the Trace-Reference AVP is present in the Trace-Data AVP.

      • getTraceReference

        byte[] getTraceReference()
        Returns the value of the Trace-Reference AVP, of type OctetString.
        Returns:
        the value of the Trace-Reference AVP, or null if it has not been set.

      • setTraceReference

        void setTraceReference​(byte[] traceReference)
        Sets the value of the Trace-Reference AVP, of type OctetString.
        Throws:
        NullPointerException - if traceReference is null.

      • removeTraceReference

        void removeTraceReference()
        Removes the Trace-Reference AVP from the Trace-Data AVP. If the Trace-Reference AVP is not present, this method returns silently.

      • hasTraceDepth

        boolean hasTraceDepth()
        Returns true if the Trace-Depth AVP is present in the Trace-Data AVP.

      • getTraceDepth

        TraceDepth getTraceDepth()
        Returns the value of the Trace-Depth AVP, of type Enumerated.
        Returns:
        the value of the Trace-Depth AVP, or null if it has not been set.

      • setTraceDepth

        void setTraceDepth​(TraceDepth traceDepth)
        Sets the value of the Trace-Depth AVP, of type Enumerated.
        Throws:
        NullPointerException - if traceDepth is null.

      • removeTraceDepth

        void removeTraceDepth()
        Removes the Trace-Depth AVP from the Trace-Data AVP. If the Trace-Depth AVP is not present, this method returns silently.

      • hasTraceNeTypeList

        boolean hasTraceNeTypeList()
        Returns true if the Trace-NE-Type-List AVP is present in the Trace-Data AVP.

      • getTraceNeTypeList

        byte[] getTraceNeTypeList()
        Returns the value of the Trace-NE-Type-List AVP, of type OctetString.
        Returns:
        the value of the Trace-NE-Type-List AVP, or null if it has not been set.

      • setTraceNeTypeList

        void setTraceNeTypeList​(byte[] traceNeTypeList)
        Sets the value of the Trace-NE-Type-List AVP, of type OctetString.
        Throws:
        NullPointerException - if traceNeTypeList is null.

      • removeTraceNeTypeList

        void removeTraceNeTypeList()
        Removes the Trace-NE-Type-List AVP from the Trace-Data AVP. If the Trace-NE-Type-List AVP is not present, this method returns silently.

      • hasTraceInterfaceList

        boolean hasTraceInterfaceList()
        Returns true if the Trace-Interface-List AVP is present in the Trace-Data AVP.

      • getTraceInterfaceList

        byte[] getTraceInterfaceList()
        Returns the value of the Trace-Interface-List AVP, of type OctetString.
        Returns:
        the value of the Trace-Interface-List AVP, or null if it has not been set.

      • setTraceInterfaceList

        void setTraceInterfaceList​(byte[] traceInterfaceList)
        Sets the value of the Trace-Interface-List AVP, of type OctetString.
        Throws:
        NullPointerException - if traceInterfaceList is null.

      • removeTraceInterfaceList

        void removeTraceInterfaceList()
        Removes the Trace-Interface-List AVP from the Trace-Data AVP. If the Trace-Interface-List AVP is not present, this method returns silently.

      • hasTraceEventList

        boolean hasTraceEventList()
        Returns true if the Trace-Event-List AVP is present in the Trace-Data AVP.

      • getTraceEventList

        byte[] getTraceEventList()
        Returns the value of the Trace-Event-List AVP, of type OctetString.
        Returns:
        the value of the Trace-Event-List AVP, or null if it has not been set.

      • setTraceEventList

        void setTraceEventList​(byte[] traceEventList)
        Sets the value of the Trace-Event-List AVP, of type OctetString.
        Throws:
        NullPointerException - if traceEventList is null.

      • removeTraceEventList

        void removeTraceEventList()
        Removes the Trace-Event-List AVP from the Trace-Data AVP. If the Trace-Event-List AVP is not present, this method returns silently.

      • hasOmcId

        boolean hasOmcId()
        Returns true if the OMC-Id AVP is present in the Trace-Data AVP.

      • getOmcId

        byte[] getOmcId()
        Returns the value of the OMC-Id AVP, of type OctetString.
        Returns:
        the value of the OMC-Id AVP, or null if it has not been set.

      • setOmcId

        void setOmcId​(byte[] omcId)
        Sets the value of the OMC-Id AVP, of type OctetString.
        Throws:
        NullPointerException - if omcId is null.

      • removeOmcId

        void removeOmcId()
        Removes the OMC-Id AVP from the Trace-Data AVP. If the OMC-Id AVP is not present, this method returns silently.

      • hasTraceCollectionEntity

        boolean hasTraceCollectionEntity()
        Returns true if the Trace-Collection-Entity AVP is present in the Trace-Data AVP.

      • getTraceCollectionEntity

        Address getTraceCollectionEntity()
        Returns the value of the Trace-Collection-Entity AVP, of type Address.
        Returns:
        the value of the Trace-Collection-Entity AVP, or null if it has not been set.

      • setTraceCollectionEntity

        void setTraceCollectionEntity​(Address traceCollectionEntity)
        Sets the value of the Trace-Collection-Entity AVP, of type Address.
        Throws:
        NullPointerException - if traceCollectionEntity is null.

      • removeTraceCollectionEntity

        void removeTraceCollectionEntity()
        Removes the Trace-Collection-Entity AVP from the Trace-Data AVP. If the Trace-Collection-Entity AVP is not present, this method returns silently.

      • hasMdtConfiguration

        boolean hasMdtConfiguration()
        Returns true if the MDT-Configuration AVP is present in the Trace-Data AVP.

      • getMdtConfiguration

        MdtConfiguration getMdtConfiguration()
        Returns the value of the MDT-Configuration AVP, of type Grouped.
        Returns:
        the value of the MDT-Configuration AVP, or null if it has not been set.

      • setMdtConfiguration

        void setMdtConfiguration​(MdtConfiguration mdtConfiguration)
        Sets the value of the MDT-Configuration AVP, of type Grouped.
        Throws:
        NullPointerException - if mdtConfiguration is null.

      • removeMdtConfiguration

        void removeMdtConfiguration()
        Removes the MDT-Configuration AVP from the Trace-Data AVP. If the MDT-Configuration 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 Trace-Data 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 Trace-Data 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 - if avps is null.

      • removeExtensionAvps

        void removeExtensionAvps()
        Removes all extension AVPs from the Trace-Data AVP. If no extension AVPs are present, this method returns silently.