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

Class InfoboxValidatorParamsImpl

java.lang.Object

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

All Implemented Interfaces:

InfoboxValidatorParams

public class InfoboxValidatorParamsImpl
extends Object
implements 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}.

Field Summary

Fields

Modifier and Type	Field	Description
protected Element	applicationSpecificParams_	Application specific parameters.
protected String	bkuURL_	The URL of the BKU.
protected boolean	businessApplication_	Specifies whether the current online application is a business or a public application.
protected String	dateOfBirth_	The date of birth from the identity link.
protected String	domainIdentifier_	The domain identifier (register and number in the register parameter).
protected String	familyName_	The family name from the identity link.
protected String	givenName_	The given name from the identity link.
protected boolean	hideStammzahl_	Indicates whether source pins (Stammzahlen) must be hidden or not.
protected String	identificationType_	The identification type.
protected String	identificationValue_	The date of identification value.
protected Element	identityLink_	The identity link.
protected List	infoboxTokenList_	A list of InfoboxToken objects.
protected PublicKey[]	publicKeys_	The public keys from the identity link.
protected List	schemaLocations_	The locations of schemas that maybe needed for validating infobox tokens.
protected String	target_	The target parameter.
protected String	trustProfileID_	The ID of the trust profile used for validating certificates.

Constructor Summary

Constructors

Constructor	Description
InfoboxValidatorParamsImpl()	Empty constructor.

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.
void	setApplicationSpecificParams(Element applicationSpecificParams)	Sets the application specific parameters.
void	setBkuURL(String bkuURL)	Sets the bku URL.
void	setBusinessApplication(boolean businessApplication)	Sets the business application parameter.
void	setDateOfBirth(String dateOfBirth)	Sets the date of birth.
void	setDomainIdentifier(String domainIdentifier)	Sets the domain identifier (register and number in the register parameter)
void	setFamilyName(String familyName)	Sets the family name.
void	setGivenName(String givenName)	Sets the given name.
void	setHideStammzahl(boolean hideStammzahl)	Sets the hideStammzahl_ parameter.
void	setIdentificationType(String identificationType)	Sets the identification type.
void	setIdentificationValue(String identificationValue)	Sets the identification value.
void	setIdentityLink(Element identityLink)	Sets the identity link.
void	setInfoboxTokenList(List infoboxTokenList)	Sets the infobox token to be validated.
void	setPublicKeys(PublicKey[] publicKeys)	Sets the public Keys.
void	setSchemaLocations(List schemaLocations)	Sets the schema locations.
void	setTarget(String target)	Sets the target.
void	setTrustProfileID(String trustProfileID)	Sets the ID of the trust profile used for validating certificates.

Methods inherited from class java.lang.Object

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

Field Detail

infoboxTokenList_

protected List infoboxTokenList_

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.

trustProfileID_

protected String trustProfileID_

The ID of the trust profile used for validating certificates.

schemaLocations_

protected List schemaLocations_

The locations of schemas that maybe needed for validating infobox tokens.

bkuURL_

protected String bkuURL_

The URL of the BKU.

businessApplication_

protected boolean businessApplication_

Specifies whether the current online application is a business or a public application.

target_

protected String target_

The target parameter.

domainIdentifier_

protected String domainIdentifier_

The domain identifier (register and number in the register parameter).

familyName_

protected String familyName_

The family name from the identity link.

givenName_

protected String givenName_

The given name from the identity link.

dateOfBirth_

protected String dateOfBirth_

The date of birth from the identity link.

identificationValue_

protected String identificationValue_

The date of identification value.

identificationType_

protected String identificationType_

The identification type.

publicKeys_

protected PublicKey[] publicKeys_

The public keys from the identity link.

identityLink_

protected Element identityLink_

The identity link.

hideStammzahl_

protected boolean hideStammzahl_

Indicates whether source pins (Stammzahlen) must be hidden or not.

applicationSpecificParams_

protected Element applicationSpecificParams_

Application specific parameters.

Constructor Detail

InfoboxValidatorParamsImpl

public InfoboxValidatorParamsImpl()

Empty constructor.

Method Detail

getInfoboxTokenList

public List getInfoboxTokenList()

Description copied from interface: InfoboxValidatorParams

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.

Specified by:

getInfoboxTokenList in interface InfoboxValidatorParams

Returns:

A list of InfoboxToken objects.

See Also:

InfoboxValidatorParams.getInfoboxTokenList()

getTrustProfileID

public String getTrustProfileID()

Description copied from interface: InfoboxValidatorParams

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.

Specified by:

getTrustProfileID in interface InfoboxValidatorParams

Returns:

The ID of a trust profile.

See Also:

InfoboxValidatorParams.getTrustProfileID()

getSchemaLocations

public List getSchemaLocations()

Description copied from interface: InfoboxValidatorParams

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.

Specified by:

getSchemaLocations in interface InfoboxValidatorParams

Returns:

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

See Also:

InfoboxValidatorParams.getSchemaLocations()

getBkuURL

public String getBkuURL()

Description copied from interface: InfoboxValidatorParams

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

Specified by:

getBkuURL in interface InfoboxValidatorParams

Returns:

The url of the BKU.

See Also:

InfoboxValidatorParams.getBkuURL()

getTarget

public String getTarget()

Description copied from interface: InfoboxValidatorParams

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

Specified by:

getTarget in interface InfoboxValidatorParams

Returns:

The target parameter.

See Also:

InfoboxValidatorParams.getTarget()

getDomainIdentifier

public String getDomainIdentifier()

Description copied from interface: InfoboxValidatorParams

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

Specified by:

getDomainIdentifier in interface InfoboxValidatorParams

Returns:

The register and number in the register parameter.

See Also:

InfoboxValidatorParams.getDomainIdentifier()

getBusinessApplication

public boolean getBusinessApplication()

Description copied from interface: InfoboxValidatorParams

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

Specified by:

getBusinessApplication in interface InfoboxValidatorParams

Returns:

True if the application is a business service, otherwise false

See Also:

InfoboxValidatorParams.getBusinessApplication()

getFamilyName

public String getFamilyName()

Description copied from interface: InfoboxValidatorParams

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

Specified by:

getFamilyName in interface InfoboxValidatorParams

Returns:

The family name from the identity link.

See Also:

InfoboxValidatorParams.getFamilyName()

getGivenName

public String getGivenName()

Description copied from interface: InfoboxValidatorParams

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

Specified by:

getGivenName in interface InfoboxValidatorParams

Returns:

The given name from the identity link.

See Also:

InfoboxValidatorParams.getGivenName()

getDateOfBirth

public String getDateOfBirth()

Description copied from interface: InfoboxValidatorParams

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.

Specified by:

getDateOfBirth in interface InfoboxValidatorParams

Returns:

The date of birth from the identity link.

See Also:

InfoboxValidatorParams.getDateOfBirth()

getIdentificationValue

public String getIdentificationValue()

Description copied from interface: InfoboxValidatorParams

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.

Specified by:

getIdentificationValue in interface InfoboxValidatorParams

Returns:

The identification value from the identity link.

See Also:

InfoboxValidatorParams.getIdentificationValue()

getIdentificationType

public String getIdentificationType()

Description copied from interface: InfoboxValidatorParams

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

Specified by:

getIdentificationType in interface InfoboxValidatorParams

Returns:

The type of the identification value from the identity link.

See Also:

InfoboxValidatorParams.getIdentificationType()

getPublicKeys

public PublicKey[] getPublicKeys()

Description copied from interface: InfoboxValidatorParams

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

Specified by:

getPublicKeys in interface InfoboxValidatorParams

Returns:

PublicKey[] The public keys from the identity link.

See Also:

InfoboxValidatorParams.getPublicKeys()

getIdentityLink

public Element getIdentityLink()

Description copied from interface: InfoboxValidatorParams

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.

Specified by:

getIdentityLink in interface InfoboxValidatorParams

Returns:

The identity link.

See Also:

InfoboxValidatorParams.getIdentityLink()

getHideStammzahl

public boolean getHideStammzahl()

Description copied from interface: InfoboxValidatorParams

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.

Specified by:

getHideStammzahl in interface InfoboxValidatorParams

Returns:

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

See Also:

InfoboxValidatorParams.getHideStammzahl()

getApplicationSpecificParams

public Element getApplicationSpecificParams()

Description copied from interface: InfoboxValidatorParams

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.

Specified by:

getApplicationSpecificParams in interface InfoboxValidatorParams

Returns:

Application specific parameters.

See Also:

InfoboxValidatorParams.getApplicationSpecificParams()

setApplicationSpecificParams

public void setApplicationSpecificParams(Element applicationSpecificParams)

Sets the application specific parameters.

Parameters:

applicationSpecificParams - The application specific parameters to set.

setBkuURL

public void setBkuURL(String bkuURL)

Sets the bku URL.

Parameters:

bkuURL - The bku URL to set.

setBusinessApplication

public void setBusinessApplication(boolean businessApplication)

Sets the business application parameter.

Parameters:

businessApplication - The business application parameter to set. (True if the application is a business application, otherwies false).

setDateOfBirth

public void setDateOfBirth(String dateOfBirth)

Sets the date of birth.

Parameters:

dateOfBirth - The date of birth.

setFamilyName

public void setFamilyName(String familyName)

Sets the family name.

Parameters:

familyName - The family name.

setGivenName

public void setGivenName(String givenName)

Sets the given name.

Parameters:

givenName - The given name.

setIdentificationType

public void setIdentificationType(String identificationType)

Sets the identification type.

Parameters:

identificationType - The identification type.

setIdentificationValue

public void setIdentificationValue(String identificationValue)

Sets the identification value.

Parameters:

identificationValue - The identification value.

setIdentityLink

public void setIdentityLink(Element identityLink)

Sets the identity link.

Parameters:

identityLink - The identity link.

setInfoboxTokenList

public void setInfoboxTokenList(List infoboxTokenList)

Sets the infobox token to be validated.

Parameters:

infoboxTokenList - A list InfoboxToken objects.

setPublicKeys

public void setPublicKeys(PublicKey[] publicKeys)

Sets the public Keys.

Parameters:

publicKeys - The public keys.

setSchemaLocations

public void setSchemaLocations(List schemaLocations)

Sets the schema locations.

Parameters:

schemaLocations - The schema locations. A list of Schema objects.

setTarget

public void setTarget(String target)

Sets the target.

Parameters:

target - The target.

setDomainIdentifier

public void setDomainIdentifier(String domainIdentifier)

Sets the domain identifier (register and number in the register parameter)

Parameters:

domainIdentifier - the domainIdentifier to set

setTrustProfileID

public void setTrustProfileID(String trustProfileID)

Sets the ID of the trust profile used for validating certificates.

Parameters:

trustProfileID - the ID of the trust profile used for validating certificates.

setHideStammzahl

public void setHideStammzahl(boolean hideStammzahl)

Sets the hideStammzahl_ parameter. This indicates whether source pins (Stammzahlen) must be hidden or not.

Parameters:

hideStammzahl - True if source pins (Stammzahlen) should be hidden, otherwise false.