se.litsec.eidas.opensaml2.ext.attributes

Interface CurrentAddressType

All Superinterfaces:

CurrentAddressStructuredType, XMLObject

All Known Implementing Classes:

CurrentAddressTypeImpl

public interface CurrentAddressType
extends CurrentAddressStructuredType

The eIDAS CurrentAddressType.

 
 <xsd:simpleType name="CurrentAddressType">
   <xsd:annotation>
     <xsd:documentation>
       Current address of the natural person as a base64 encoded string.
     </xsd:documentation>
   </xsd:annotation>
   <xsd:restriction base="xsd:string"/>
 </xsd:simpleType>
 

This attribute describes the current address for the natural person as registered with the MS authority.

Address data is structured by nature and is defined in the attribute schema as a structured XML sequence of xsd:string elements. Where appropriate this structure address data follows the Core ISA Vocabulary type CvAddressType although this has been simplified to a sequence of xsd:string elements.

To enable this data to be passed in a single attribute value this data MUST first be base64 encoded as described in section 2.2.3 Responding Attributes, of the eIDAS Message Format specification.

Example:

 
 <saml:Attribute
       FriendlyName="CurrentAddress"
       Name="http://eidas.europa.eu/attributes/naturalperson/CurrentAddress"
       NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:uri">
   <saml:AttributeValue xsi:type="eidas:CurrentAddressType">
     PGVpZGFzOkxvY2F0b3JEZXNpZ25hdG9yPjIyPC9laWRhczpMb2NhdG9yRGVzaWduYX
     Rvcj48ZWlkYXM6VGhvcm91Z2hmYXJlPkFyY2FjaWEgQXZlbnVlPC9laWRhczpUaG9y
     b3VnaGZhcmU+DQo8ZWlkYXM6UG9zdE5hbWU+TG9uZG9uPC9laWRhczpQb3N0TmFtZT
     4NCjxlaWRhczpQb3N0Q29kZT5TVzFBIDFBQTwvZWlkYXM6UG9zdENvZGU+
   </saml:AttributeValue>
 </saml:Attribute>
 

Author:

Martin Lindström (martin.lindstrom@litsec.se)

See Also:

CurrentAddressStructuredType

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE_LOCAL_NAME Local name of the XSI type.
static QName	TYPE_NAME QName of the XSI type.

Method Summary

Modifier and Type	Method and Description
String	toSwedishEidString() Within the Swedish eID Framework only string-valued attributes are released.

Methods inherited from interface se.litsec.eidas.opensaml2.ext.attributes.CurrentAddressStructuredType

getAdminunitFirstline, getAdminunitSecondline, getCvaddressArea, getLocatorDesignator, getLocatorName, getPoBox, getPostCode, getPostName, getThoroughfare, setAdminunitFirstline, setAdminunitSecondline, setCvaddressArea, setLocatorDesignator, setLocatorName, setPoBox, setPostCode, setPostName, setThoroughfare

Methods inherited from interface org.opensaml.xml.XMLObject

addNamespace, detach, getDOM, getElementQName, getIDIndex, getNamespaceManager, getNamespaces, getNoNamespaceSchemaLocation, getOrderedChildren, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, isNil, isNilXSBoolean, releaseChildrenDOM, releaseDOM, releaseParentDOM, removeNamespace, resolveID, resolveIDFromRoot, setDOM, setNil, setNil, setNoNamespaceSchemaLocation, setParent, setSchemaLocation

Field Detail

TYPE_LOCAL_NAME

static final String TYPE_LOCAL_NAME

Local name of the XSI type.

See Also:

Constant Field Values

TYPE_NAME

static final QName TYPE_NAME

QName of the XSI type.

Method Detail

toSwedishEidString

String toSwedishEidString()

Within the Swedish eID Framework only string-valued attributes are released. It would be possible to simply release the Base64-blob and let attribute consumers decode and parse it, but the "Attribute Specification for the Swedish eID Framework" is a little bit more helpful. It mandates that the eIDAS http://eidas.europa.eu/attributes/naturalperson/CurrentAddress attribute is converted into the the attribute eidasNaturalPersonAddress (urn:oid:1.2.752.201.3.9). This attribute holds a string value which contains URL-encoded key-value pairs separated by semicolons.

The XML-snippet below:

 
 <eidas:LocatorDesignator>22</eidas:LocatorDesignator>
 <eidas:Thoroughfare>Arcacia Avenue</eidas:Thoroughfare>
 <eidas:PostName>London</eidas:PostName>
 <eidas:PostCode>SW1A 1AA</eidas:Postcode>

will be represented as: "LocatorDesignator=22;Thoroughfare=Arcacia%20Avenue;PostName=London;PostCode=SW1A%201AA".

Returns:

the address represented as a name-value string