.diameter.diameter-core-docs-sources-asciidoc.1.7.0.137.source-code.Section-JDiameter-Validator-Source_Overview.adoc 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-asciidoc

There is a newer version: 1.7.0.201


[[_jdiameter_validator_source_overview]]
= Validator Source Overview

The Validator	API defines methods to access its database of AVPs and check if the AVP and message have the proper structure.

The Validator is currently message oriented.
This means that it declares methods that center on message consistency checks.
The class containing all validation logic is [class]`org.jdiameter.common.impl.validation.DiameterMessageValidator`.
It exposes the following methods:

public boolean isOn();::
  Simple method to determine if the `Validator` is enabled.

public ValidatorLevel getSendLevel();::
  Returns the validation level of outgoing messages.
  It can have one of the following values: `OFF`, `MESSAGE`, `ALL`.

public ValidatorLevel getReceiveLevel()::
  Returns the validation level of incoming messages.
  It can have one of the following values: `OFF`, `MESSAGE`, `ALL`.

public void validate(Message msg, boolean incoming) throws JAvpNotAllowedException::
  Performs validation on a message.
  Based on the [parameter]`incoming` flag, the correct validation level is applied.
  If validation fails, an exception with details is thrown.

public void validate(Message msg, ValidatorLevel validatorLevel) throws JAvpNotAllowedException::
  Performs validation on messages with a specified level.
  It is a programatical way to allow different levels of validation from those configured.
  If validation fails, a [class]`JAvpNotAllowedException` with details is thrown.

NOTE: The current implementation provides more methods, however those are out of scope for this documentation.

A simple example of a Validator use case is shown below:

.Validator Message Check Example
====
The example below is pseudo-code.

[source,java]
----

...
boolean isRequest = true;
boolean isIncoming = false;

DiameterMessageValidator messageValidator = DiameterMessageValidator.getInstance();
Message message = createMessage(UserDataRequest.MESSAGE_CODE, isRequest,
	applicationId);

//add AVPs
...
//perform check
try{
	messageValidator.validate(message, isIncoming);
}
catch(JAvpNotAllowedException e) {
	System.err.println("Failed to validate ..., avp code: " + e.getAvpCode() + " avp vendor:" + e.getVendorId() + ", message:" + e.getMessage());
}
----
====