at.gv.egiz.moodle.eidconnector.auth.data
Class SubjectAttributes

java.lang.Object
  extended by at.gv.egiz.moodle.eidconnector.auth.data.SubjectAttributes

public class SubjectAttributes
extends Object

Author:
AT-TUG (Thomas Knall)

Field Summary
static String ACADEMIC_TITLE
          Deprecated. Use TITLE instead.
static String ADOPTED_FAMILY_NAME
           
static String AGE
           
static String[] ALL_STORK_ATTRIBUTES
           
static String CANONICAL_RESIDIENCE_ADDRESS
           
static String CITIZEN_QAA_LEVEL
           
static String CITIZEN_X509CERTIFICATE
           
static String COUNTRY_OF_BIRTH
           
static String DATE_OF_BIRTH
           
static String EIDENTIFIER
           
static String EMAIL_ADDRESS
           
static String EQUALIFIER
          The eQualifier can be used in order to give further information on the eIdentifier.
static String GENDER
           
static String GIVEN_NAME
           
static String INHERITATED_FAMILY_NAME
           
static String IS_AGE_OVER
           
static String MARITAL_STATUS
           
static String NATIONALITY
           
static String PSEUDONYM
           
static String QAA_LEVEL
          Deprecated. Use CITIZEN_QAA_LEVEL instead.
static String RESIDIENCE_PERMIT
           
static String SIGNED_DOC
           
static String SURNAME
           
static String TEXT_RESIDIENCE_ADDRESS
           
static String TITLE
           
 
Constructor Summary
SubjectAttributes()
           
 
Method Summary
 void addIsAgeOver(at.iaik.commons.xmlschema.saml.AgeOverData ageOverData)
           
 boolean equals(Object obj)
           
 String get(String key)
           
 String getAge()
           
 int getAgeValue()
           
 String getDateOfBirth()
           
 Date getDateOfBirthValue()
           
 String getEIdentifier()
           
 String getGivenName()
           
 at.iaik.commons.xmlschema.saml.AgeOverData[] getIsAgeOver()
           
 Set<String> getKeySet()
           
 String getQAALevel()
           
 Integer getQAALevelValue()
           
 String getSurName()
           
protected  Date getTimeStamp()
           
 Date getValidAt()
          The date the attributes encapsulated in this class are assured to be valid.
 int hashCode()
           
 boolean isAlreadyLogged()
          Returns true if statistical logging has already been done so that no further logging is required.
 String set(String key, String value)
           
 void setAge(String age)
           
 void setAgeValue(int age)
           
 void setAlreadyLogged(boolean alreadyLogged)
          Should be set to true if statistical logging has already been performed by the respective authentication implementation, false (which is the default value) if not.
 void setDateOfBirth(String dateOfBirth)
           
 void setDateOfBirthValue(Date dateOfBirth)
           
 void setEIdentifier(String eIdentifier)
           
 void setGivenName(String givenName)
           
 void setQAALevel(String qaaLevel)
           
 void setQAALevelValue(int qaaLevel)
           
 void setSurName(String surName)
           
protected  void setTimeStamp(Date timeStamp)
           
 void setValidAt(Date validAt)
          Sets the date the attributes are guaranteed to be valid.
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

EIDENTIFIER

public static final String EIDENTIFIER
See Also:
Constant Field Values

GIVEN_NAME

public static final String GIVEN_NAME
See Also:
Constant Field Values

SURNAME

public static final String SURNAME
See Also:
Constant Field Values

INHERITATED_FAMILY_NAME

public static final String INHERITATED_FAMILY_NAME
See Also:
Constant Field Values

ADOPTED_FAMILY_NAME

public static final String ADOPTED_FAMILY_NAME
See Also:
Constant Field Values

GENDER

public static final String GENDER
See Also:
Constant Field Values

DATE_OF_BIRTH

public static final String DATE_OF_BIRTH
See Also:
Constant Field Values

COUNTRY_OF_BIRTH

public static final String COUNTRY_OF_BIRTH
See Also:
Constant Field Values

NATIONALITY

public static final String NATIONALITY
See Also:
Constant Field Values

MARITAL_STATUS

public static final String MARITAL_STATUS
See Also:
Constant Field Values

TEXT_RESIDIENCE_ADDRESS

public static final String TEXT_RESIDIENCE_ADDRESS
See Also:
Constant Field Values

CANONICAL_RESIDIENCE_ADDRESS

public static final String CANONICAL_RESIDIENCE_ADDRESS
See Also:
Constant Field Values

EMAIL_ADDRESS

public static final String EMAIL_ADDRESS
See Also:
Constant Field Values

TITLE

public static final String TITLE
See Also:
Constant Field Values

RESIDIENCE_PERMIT

public static final String RESIDIENCE_PERMIT
See Also:
Constant Field Values

PSEUDONYM

public static final String PSEUDONYM
See Also:
Constant Field Values

AGE

public static final String AGE
See Also:
Constant Field Values

IS_AGE_OVER

public static final String IS_AGE_OVER
See Also:
Constant Field Values

SIGNED_DOC

public static final String SIGNED_DOC
See Also:
Constant Field Values

CITIZEN_X509CERTIFICATE

public static final String CITIZEN_X509CERTIFICATE
See Also:
Constant Field Values

CITIZEN_QAA_LEVEL

public static final String CITIZEN_QAA_LEVEL
See Also:
Constant Field Values

ACADEMIC_TITLE

public static final String ACADEMIC_TITLE
Deprecated. Use TITLE instead.
See Also:
Constant Field Values

QAA_LEVEL

public static final String QAA_LEVEL
Deprecated. Use CITIZEN_QAA_LEVEL instead.
See Also:
Constant Field Values

EQUALIFIER

public static final String EQUALIFIER
The eQualifier can be used in order to give further information on the eIdentifier.

See Also:
Constant Field Values

ALL_STORK_ATTRIBUTES

public static final String[] ALL_STORK_ATTRIBUTES
Constructor Detail

SubjectAttributes

public SubjectAttributes()
Method Detail

getKeySet

public Set<String> getKeySet()

getTimeStamp

protected Date getTimeStamp()

setTimeStamp

protected void setTimeStamp(Date timeStamp)

get

public String get(String key)

set

public String set(String key,
                  String value)

isAlreadyLogged

public boolean isAlreadyLogged()
Returns true if statistical logging has already been done so that no further logging is required.

Returns:
true if statistical logging has already been done, false if not.

setAlreadyLogged

public void setAlreadyLogged(boolean alreadyLogged)
Should be set to true if statistical logging has already been performed by the respective authentication implementation, false (which is the default value) if not.

Parameters:
alreadyLogged - true if logging has already been performed.

getValidAt

public Date getValidAt()
The date the attributes encapsulated in this class are assured to be valid. May be needed since there may be a delay in time between issuing of this attributes and retrieval by underlying client application (e.g. Moodle). If set, this date will be used for age calculation if needed, not not set (null) the current date will be used.

Returns:
The point in time the attributes are regarded valid, or null if the current date is to be used.

setValidAt

public void setValidAt(Date validAt)
Sets the date the attributes are guaranteed to be valid. Theoretically this date equals to the current date, but in praxis some time may elapse until the attributes are retrieved by the client application (some seconds up to the time frame the attributes are automaticalle removed from the store). If not date is set the current date is taken for age calculation (if needed).

Parameters:
validAt - The date the attributes are guaranteed to be valid.

toString

public String toString()
Overrides:
toString in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object

equals

public boolean equals(Object obj)
Overrides:
equals in class Object

getEIdentifier

public String getEIdentifier()

setEIdentifier

public void setEIdentifier(String eIdentifier)

getDateOfBirth

public String getDateOfBirth()

setDateOfBirth

public void setDateOfBirth(String dateOfBirth)

getDateOfBirthValue

public Date getDateOfBirthValue()
                         throws EIDConnectorException
Throws:
EIDConnectorException

setDateOfBirthValue

public void setDateOfBirthValue(Date dateOfBirth)

getQAALevel

public String getQAALevel()

setQAALevel

public void setQAALevel(String qaaLevel)

getQAALevelValue

public Integer getQAALevelValue()
                         throws EIDConnectorException
Throws:
EIDConnectorException

setQAALevelValue

public void setQAALevelValue(int qaaLevel)

getAge

public String getAge()

setAge

public void setAge(String age)

getAgeValue

public int getAgeValue()
                throws EIDConnectorException
Throws:
EIDConnectorException

setAgeValue

public void setAgeValue(int age)

getGivenName

public String getGivenName()

setGivenName

public void setGivenName(String givenName)

addIsAgeOver

public void addIsAgeOver(at.iaik.commons.xmlschema.saml.AgeOverData ageOverData)

getIsAgeOver

public at.iaik.commons.xmlschema.saml.AgeOverData[] getIsAgeOver()

getSurName

public String getSurName()

setSurName

public void setSurName(String surName)


Copyright 2009 EGIZ. All Rights Reserved.