com.netegrity.llsdk6.imsapi.exception
Class AttributeValidationException

java.lang.Object
  SmApiException
      com.netegrity.llsdk6.imsapi.exception.AttributeValidationException

public class AttributeValidationException
extends SmApiException

The exception class for attribute validation errors.

This exception class is used with the following types of attribute validation rules:

• Task-level validation. See TaskValidator.
• Directory-level validation. See IAttributeValidator or AttributeValidator.

AttributeValidationException is thrown if a validation rule cannot validate an attribute value supplied through a task screen field or programmatically. The exception contains messages that are displayed to the user, allowing the user to correct the entry and resubmit the task.

Messages displayed through AttributeValidationException have the same format as messages displayed through IMSException. For information on message format, including variables you can use in messages, see IMSException.

AttributeValidationException messages are stored in the pre-defined resource bundle IMSExceptions.properties or in a custom resource bundle. Resource bundes are typically located within the IdentityMinder EAR directory on the application server, as follows:

     custom\resourceBundles

You can retrieve messages from a custom resource bundle through Localizer.

Since:

IdentityMinder 6.0

Constructor Summary

AttributeValidationException(java.lang.String message)
Creates an attribute validation exception object containing a message to display to the user.

AttributeValidationException(java.lang.String attrName, java.lang.String attrValue, java.lang.String messageid, java.lang.String message)
Creates an attribute validation exception object containing the attribute name, value, ID of the message to display for the exception, and an additional message.

Method Summary

java.lang.String	getAdditionalMessage() Retrieves the text of an additional message to display for this exception.
java.lang.String	getAttributeName() Retrieves the name of the attribute being validated.
java.lang.String	getAttributeValue() Retrieves the value of the attribute being validated.
java.lang.String	getMessageId() Retrieves the ID associated with the message to display for this exception.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AttributeValidationException

public AttributeValidationException(java.lang.String message)

Creates an attribute validation exception object containing a message to display to the user.

Parameters:

message - The error message to display.

AttributeValidationException

public AttributeValidationException(java.lang.String attrName,
                                    java.lang.String attrValue,
                                    java.lang.String messageid,
                                    java.lang.String message)

Creates an attribute validation exception object containing the attribute name, value, ID of the message to display for the exception, and an additional message.

Parameters:

attrName - The name of the managed object attribute being validated.

attrValue - The value to validate.

messageid - Corresponds to a custom message in the resource bundle IMSExceptions.properties.

message - An additional message that can be displayed to the user. This gives you an opportunity to display a more specific message than the one in the resource bundle, or a message from a custom resource bundle retrieved through Localizer.

Method Detail

getAttributeName

public java.lang.String getAttributeName()

Retrieves the name of the attribute being validated.

getAttributeValue

public java.lang.String getAttributeValue()

Retrieves the value of the attribute being validated.

getMessageId

public java.lang.String getMessageId()

Retrieves the ID associated with the message to display for this exception.

getAdditionalMessage

public java.lang.String getAdditionalMessage()

Retrieves the text of an additional message to display for this exception.