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

Interface InfoboxValidatorParams

All Known Implementing Classes:

InfoboxValidatorParamsImpl

public interface InfoboxValidatorParams

Parameters for validating an infobox. This interface is used by MOA-ID to provide parameters to an {link at.gv.egovernment.moa.id.auth.validator.InfoboxValidator InfoboxValidator}.

Method Summary

Modifier and Type	Method	Description
Element	getApplicationSpecificParams()	Returns application specific parameters.
String	getBkuURL()	Returns the URL of the BKU.
boolean	getBusinessApplication()	Returns true if the application is a business service, otherwise false.
String	getDateOfBirth()	The date of birth from the identity link.
String	getDomainIdentifier()	Returns the register and number in the register parameter.
String	getFamilyName()	Returns the family name from the identity link.
String	getGivenName()	Returns the given name from the identity link.
boolean	getHideStammzahl()	Indicates whether source pins (Stammzahlen) should be hidden or not.
String	getIdentificationType()	Returns the type of the identification value from the identity link.
String	getIdentificationValue()	Returns he identification value from the identity link.
Element	getIdentityLink()	Returns the identity link.
List	getInfoboxTokenList()	Returns a list of InfoboxToken objects.
PublicKey[]	getPublicKeys()	Returns the public keys from the identity link.
List	getSchemaLocations()	Returns schema location URIs that may be needed by the validator to parse infobox tokens.
String	getTarget()	Returns the target parameter.
String	getTrustProfileID()	Returns the ID of the trust profile to be used for validating certificates.

Method Detail

getInfoboxTokenList

List getInfoboxTokenList()

Returns a list of InfoboxToken objects. The first token in this list is the one to be validated. Each further token maybe needed to validate this first token.

Returns:

A list of InfoboxToken objects.

getTrustProfileID

String getTrustProfileID()

Returns the ID of the trust profile to be used for validating certificates. Maybe ignored by a validator, if no certificates has to be validated.

Returns:

The ID of a trust profile.

getSchemaLocations

List getSchemaLocations()

Returns schema location URIs that may be needed by the validator to parse infobox tokens. Each entry in the list is a Schema specifying the location of an XML schema.

Returns:

A list of Schema objects each of them specifying the location of an XML schema.

getBkuURL

String getBkuURL()

Returns the URL of the BKU. Maybe needed by a validator.

Returns:

The url of the BKU.

getTarget

String getTarget()

Returns the target parameter. null in the case of a business service.

Returns:

The target parameter.

getDomainIdentifier

String getDomainIdentifier()

Returns the register and number in the register parameter. null in the case of not a business service.

Returns:

The register and number in the register parameter.

getBusinessApplication

boolean getBusinessApplication()

Returns true if the application is a business service, otherwise false. This may be useful for the validating application.

Returns:

True if the application is a business service, otherwise false

getFamilyName

String getFamilyName()

Returns the family name from the identity link. Maybe needed by a validator.

Returns:

The family name from the identity link.

getGivenName

String getGivenName()

Returns the given name from the identity link. Maybe needed by a validator.

Returns:

The given name from the identity link.

getDateOfBirth

String getDateOfBirth()

The date of birth from the identity link. The method returns the value of the element from the identity link. Maybe needed by a validator.

Returns:

The date of birth from the identity link.

getIdentificationValue

String getIdentificationValue()

Returns he identification value from the identity link. This may be the Stammzahl in the case of a public application or the wbPK in the case of a business application. This parameter is only returned if specified within the config file.

Returns:

The identification value from the identity link.

getIdentificationType

String getIdentificationType()

Returns the type of the identification value from the identity link. This may be especially of interest for business applications.

Returns:

The type of the identification value from the identity link.

getPublicKeys

PublicKey[] getPublicKeys()

Returns the public keys from the identity link. Maybe needed by the application.

Returns:

PublicKey[] The public keys from the identity link.

getIdentityLink

Element getIdentityLink()

Returns the identity link. A validator may need other data from the identity link, than family name, given name, date of birth and identification value. The identity link element is only returned if specified within the config file.

Returns:

The identity link.

getHideStammzahl

boolean getHideStammzahl()

Indicates whether source pins (Stammzahlen) should be hidden or not. If an online application lying behind MOA-ID is not allowed to get source pins (Stammzahlen), any source pins within SAML attributes returned by the validator must suppressed:
If the parameter getHideStammzahl is true, then the validator MUST hide (replace by an empty string) any source pin (Stammzahl) that may be included in a SAML attribute returned by the validator.

Returns:

true if source pins (Stammzahlen) must be hidden, otherwise false.

getApplicationSpecificParams

Element getApplicationSpecificParams()

Returns application specific parameters. Each child element of this element contains a validating application specific parameter. The element is passed as specified within the config file and its up to the implementing class to parse and interprete its children.

Returns:

Application specific parameters.