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

Class InfoboxValidationResultImpl

java.lang.Object

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

All Implemented Interfaces:

InfoboxValidationResult

public class InfoboxValidationResultImpl
extends Object
implements InfoboxValidationResult

Default implementation of the InfoboxValidationResult interface.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	errorMessage_	The error message.
protected at.gv.egovernment.moa.id.commons.api.data.ExtendedSAMLAttribute[]	extendedSamlAttributes_	The SAML attributes returned by the infobox validator.
protected boolean	valid_	Indicates whether the validation was successful or not.

Constructor Summary

Constructors

Constructor	Description
InfoboxValidationResultImpl()	Empty constructor.
InfoboxValidationResultImpl(boolean valid, at.gv.egovernment.moa.id.commons.api.data.ExtendedSAMLAttribute[] extendedSamlAttributes, String errorMessage)	Constructor to set all values.

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.
void	setErrorMessage(String errorMessage)	Sets the error message if validation fails..
void	setExtendedSamlAttributes(at.gv.egovernment.moa.id.commons.api.data.ExtendedSAMLAttribute[] extendedSamlAttributes)	Sets the SAML attributes returned by the infobox validatior..
void	setValid(boolean valid)	Sets validation result..

Methods inherited from class java.lang.Object

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

Field Detail

valid_

protected boolean valid_

Indicates whether the validation was successful or not.

errorMessage_

protected String errorMessage_

The error message.

extendedSamlAttributes_

protected at.gv.egovernment.moa.id.commons.api.data.ExtendedSAMLAttribute[] extendedSamlAttributes_

The SAML attributes returned by the infobox validator.

Constructor Detail

InfoboxValidationResultImpl

public InfoboxValidationResultImpl()

Empty constructor.

InfoboxValidationResultImpl

public InfoboxValidationResultImpl(boolean valid,
                                   at.gv.egovernment.moa.id.commons.api.data.ExtendedSAMLAttribute[] extendedSamlAttributes,
                                   String errorMessage)

Constructor to set all values.

Parameters:

valid - Global validation result.

extendedSamlAttributes - SAML attributes that should be appended to the final SAML Assertion or to the AUTH Block or to both.

errorMessage - An error message if infobox validation fails.

Method Detail

getErrorMessage

public String getErrorMessage()

Description copied from interface: InfoboxValidationResult

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

Specified by:

getErrorMessage in interface InfoboxValidationResult

Returns:

An short error message if validation fails.

See Also:

InfoboxValidationResult.getErrorMessage()

getExtendedSamlAttributes

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

Description copied from interface: InfoboxValidationResult

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.

Specified by:

getExtendedSamlAttributes in interface InfoboxValidationResult

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.

See Also:

InfoboxValidationResult.getExtendedSamlAttributes()

isValid

public boolean isValid()

Description copied from interface: InfoboxValidationResult

The method returns true if validation succeeds. In that case method InfoboxValidationResult.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 InfoboxValidationResult.getErrorMessage() has to provide a short error description.

Specified by:

isValid in interface InfoboxValidationResult

Returns:

True if validation succeeds, otherwise false.

See Also:

InfoboxValidationResult.isValid()

setErrorMessage

public void setErrorMessage(String errorMessage)

Sets the error message if validation fails..

Parameters:

errorMessage - The error message to set.

setExtendedSamlAttributes

public void setExtendedSamlAttributes(at.gv.egovernment.moa.id.commons.api.data.ExtendedSAMLAttribute[] extendedSamlAttributes)

Sets the SAML attributes returned by the infobox validatior..

Parameters:

extendedSamlAttributes - The SAML attributes returned by the infobox validator.

setValid

public void setValid(boolean valid)

Sets validation result..

Parameters:

valid - True if the infobox could be validated successfully, otherwise false.