Package at.gv.egovernment.moa.id.auth.data

Interface InfoboxValidationResult

All Known Implementing Classes:

InfoboxValidationResultImpl

public interface InfoboxValidationResult

Includes the result of an extended infobox validation. If validation succeeds, an array of ExtendedSAMLAttributes maybe provided. Each of these SAML-Attributes will be either appended to the final SAML-Assertion passed to the online application or to the AUTH-Block, or to both.
If validation fails the implementing class has to provide a short error message.

Method Summary

Modifier and Type	Method	Description
String	getErrorMessage()	A short error description that should be displayed by MOA-ID if validation of the InfoBoxReadResponse fails.
at.gv.egovernment.moa.id.commons.api.data.ExtendedSAMLAttribute[]	getExtendedSamlAttributes()	Returns an array of ExtendedSAMLAttributes that should be added to the SAML-Assertion provided to the online application.
boolean	isValid()	The method returns true if validation succeeds.

Method Detail

isValid

boolean isValid()

The method returns true if validation succeeds. In that case method getExtendedSamlAttributes() may provide an array of ExtendedSAMLAttributes that should be appended to the final SAML-Assertion or the AUTH-Block or to both.
The method returns false if validation fails. In that case method getErrorMessage() has to provide a short error description.

Returns:

True if validation succeeds, otherwise false.

getExtendedSamlAttributes

at.gv.egovernment.moa.id.commons.api.data.ExtendedSAMLAttribute[] getExtendedSamlAttributes()

Returns an array of ExtendedSAMLAttributes that should be added to the SAML-Assertion provided to the online application. The SAML-Attributes in that array will be added to the final SAML-Assertion, the AUTH-Block, or both, exactly in the order as they are arranged in the array this method returns.

Returns:

An array of ExtendedSAMLAttributes that should be added to the SAML-Assertion provided to the online application, the AUTH-Block, or both. If no attributes should be added this array maybe null or empty.

getErrorMessage

String getErrorMessage()

A short error description that should be displayed by MOA-ID if validation of the InfoBoxReadResponse fails.

Returns:

An short error message if validation fails.