en-US.Section-JDiameter-Validator.xml Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of diameter-core-docs-sources Show documentation

There is a newer version: 1.7.0.93

Show newest version

<?xml version='1.0'?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "Diameter_User_Guide.ent">
%BOOK_ENTITIES;
]>

<section id="jdiameter-validator">

	<title>Diameter Stack Validator</title>

	<para>Validator is one of the Stack features. The primary purpose of the Validator is to detect malformed messages, such as an Answer message containing a Destination-Host Attribute Value Pair (AVP).</para>

	<para>The Validator is capable of validating multi-leveled, grouped AVPs, excluding the following content types:</para>
	<itemizedlist>
		<listitem>
			<para>URI, or Identifier types.</para>
		</listitem>
		<listitem>
			<para>Enumerated types against defined values.</para>
		</listitem>
	</itemizedlist>
	<para>The Validator is only capable of checking structural integrity, not the content of the message.</para>
	<para>The Validator performs the following checks:</para>
	<variablelist>
		<varlistentry>
			<term>Index</term>
			<listitem><para>Checks that the AVPs are in the correct place. For example, <literal>Session-Id</literal> must always be encoded before any other AVP.</para></listitem>
		</varlistentry>
		<varlistentry>
			<term>Multiplicity</term>
			<listitem><para>Checks that the message AVPs occur the proper number of times. For example, the Session-ID should only be present once.</para></listitem>
		</varlistentry>
		<!-- TODO: add more checks :) -->
	</variablelist>
	<para>The <literal>Validator</literal> is called by the stack implementation. It is invoked after the message is received, but before it is dispatched to a remote peer.</para>
  <note>
    <para>
    This means that if the peer does not exist in the local peer table, the validator is not called, as the stack fails before calling it.
    </para>
  </note>  
	<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
		href="Section-JDiameter-Validator-Configuration.xml" encoding="UTF-8" />
	<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
		href="Section-JDiameter-Validator-Source_Overview.xml" encoding="UTF-8" />

</section>