User Console Design Guide › Validation Rules › How to Implement Custom Validation Rules › Java Implementation › Java Interface for Directory-Level Validation

Java Interface for Directory-Level Validation

The definition of the Java interface for directory-level validation is as follows:

Syntax

public interface IAttributeValidator {
public class StringRef {
   public String reference = new String();
   public String toString(){return reference;}
public boolean validate(
   Object attributeValue,
   StringRef changedValue,
   StringRef errorMessage
   ) throws AttributeValidationException;
}

Parameters

attributeValue

Input parameter

Specifies the value of the attribute being validated.

changedValue

Output parameter

Provides an optional transformation value that replaces the user-supplied value being validated. When no transformation is necessary, pass back null.

errorMessage

Output parameter

If validation fails, it displays a message to the user.

Comments

If the validation operation requires managed objects from the directory, use AttributeValidator. This abstract class implements the IAttributeValidator interface, and includes a method for retrieving the managed object providers.

Returns

• True—the implementation considers the value in attributeValue to be valid, or it passes back a transformed value in changedValue.
• False—the implementation considers attributeValue to be invalid.

Throws

AttributeValidationException.