com.sun.identity.liberty.ws.idpp.container

Class IDPPBaseContainer

java.lang.Object

com.sun.identity.liberty.ws.idpp.container.IDPPBaseContainer

All Implemented Interfaces:

IDPPContainer

Direct Known Subclasses:

IDPPAddressCard, IDPPCommonName, IDPPDemographics, IDPPEmergencyContact, IDPPEmploymentIdentity, IDPPEncryptKey, IDPPExtensionContainer, IDPPFacade, IDPPInformalName, IDPPLegalIdentity, IDPPMsgContact, IDPPSignKey

public abstract class IDPPBaseContainer
extends Object
implements IDPPContainer

This class IDPPBaseContainer is base class for common funcionality for any IDPPContainer.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	userDN

Constructor Summary

Constructors

Constructor and Description
IDPPBaseContainer()

Method Summary

Modifier and Type	Method and Description
protected com.sun.identity.liberty.ws.idpp.jaxb.AnalyzedNameType	getAnalyzedName(Map userMap) Gets AnalyzedName JAXB Object.
protected Set	getAnalyzedNameAttributes() Creates required set of attributes.
protected Map	getAnalyzedNameMap(Object obj, Map map) Gets analzedname attributes in a hashmap.
protected Map	getAttributeMap(String attr, Object obj, Map map) Returns the caller map with updated attribute and the value from the given data object.
protected AttributeMapper	getAttributeMapper() Gets Attribute Mapper
abstract Set	getContainerAttributes() Gets container attributes.
abstract Set	getContainerAttributesForSelect(String select) Gets the container attributes for select.
abstract Object	getContainerObject(Map userMap) Gets the container Object.
abstract Map	getDataMapForSelect(String select, List data) Gets data map for select.
protected com.sun.identity.liberty.ws.idpp.jaxb.DSTDate	getDSTDate(String value) Gets a JAXB DSTDate object.
protected com.sun.identity.liberty.ws.idpp.jaxb.DSTInteger	getDSTInteger(String value) Gets a JAXB DSTInteger object.
protected com.sun.identity.liberty.ws.idpp.jaxb.DSTMonthDay	getDSTMonthDay(String value) Gets a JAXB DSTMonthDay object.
protected com.sun.identity.liberty.ws.idpp.jaxb.DSTString	getDSTString(String value) Gets a JAXB DSTString object.
protected com.sun.identity.liberty.ws.idpp.jaxb.DSTURI	getDSTURI(String value) Gets a JAXB DSTURI object.
protected Set	getExtensionContainerAttributes() Gets extension attribute
protected IDPPExtension	getExtensionContainerClass() Gets container extension
protected Set	getMapperAttributeSet(Set set) Gets the mapper attributes for a given IDPP attribute set.
void	setUserDN(String user) Sets user DN
Document	toXMLDocument(Map userMap) Converts into an XML document so that XPATH can be applied.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sun.identity.liberty.ws.idpp.plugin.IDPPContainer

hasBinaryAttributes

Field Detail

userDN

protected String userDN

Constructor Detail

IDPPBaseContainer

public IDPPBaseContainer()

Method Detail

getContainerObject

public abstract Object getContainerObject(Map userMap)
                                   throws IDPPException

Gets the container Object. Each container need to to implement this method.

Parameters:

userMap - the user Map

Throws:

IDPPException

getContainerAttributes

public abstract Set getContainerAttributes()

Gets container attributes. Each container need to implement this method.

Specified by:

getContainerAttributes in interface IDPPContainer

Returns:

Set set of supported container attributes.

getContainerAttributesForSelect

public abstract Set getContainerAttributesForSelect(String select)

Gets the container attributes for select. Each container need to implement this method.

Specified by:

getContainerAttributesForSelect in interface IDPPContainer

Parameters:

select - Select Expression

Returns:

Set set of container attributes for the given select.

getDataMapForSelect

public abstract Map getDataMapForSelect(String select,
                                        List data)
                                 throws IDPPException

Gets data map for select. Each container need to implement this method.

Specified by:

getDataMapForSelect in interface IDPPContainer

Parameters:

select - Select expression

data - a List

Returns:

Map Attribute value pair for the given select and data.

Throws:

IDPPException

getAttributeMap

protected Map getAttributeMap(String attr,
                              Object obj,
                              Map map)

Returns the caller map with updated attribute and the value from the given data object.

Parameters:

attr - IDPP attribute name.

obj - object

map - this map is passed by the caller to set the attribute and the data value from the given object.

Returns:

Map updated attribute value pair map for the caller map.

getMapperAttributeSet

protected Set getMapperAttributeSet(Set set)

Gets the mapper attributes for a given IDPP attribute set.

Parameters:

set - IDPP attribute set

Returns:

Set attribute set from the attribute mapper

getDSTString

protected com.sun.identity.liberty.ws.idpp.jaxb.DSTString getDSTString(String value)

Gets a JAXB DSTString object.

Parameters:

value - a String representing the value.

Returns:

DSTString JAXB object.

getDSTDate

protected com.sun.identity.liberty.ws.idpp.jaxb.DSTDate getDSTDate(String value)

Gets a JAXB DSTDate object.

Parameters:

value - a String representing the value.

Returns:

DSTDate JAXB object.

getDSTMonthDay

protected com.sun.identity.liberty.ws.idpp.jaxb.DSTMonthDay getDSTMonthDay(String value)

Gets a JAXB DSTMonthDay object.

Parameters:

value - a String representing the value.

Returns:

DSTMonthDay JAXB object.

getDSTURI

protected com.sun.identity.liberty.ws.idpp.jaxb.DSTURI getDSTURI(String value)

Gets a JAXB DSTURI object.

Parameters:

value - a String representing the value.

Returns:

DSTURI JAXB object.

getDSTInteger

protected com.sun.identity.liberty.ws.idpp.jaxb.DSTInteger getDSTInteger(String value)

Gets a JAXB DSTInteger object.

Parameters:

value - a String representing the value.

Returns:

DSTInteger JAXB object.

getAnalyzedName

protected com.sun.identity.liberty.ws.idpp.jaxb.AnalyzedNameType getAnalyzedName(Map userMap)
                                                                          throws IDPPException

Gets AnalyzedName JAXB Object.

Parameters:

userMap - user map

Returns:

AnalyzedNameType JAXB Object.

Throws:

IDPPException.

IDPPException

toXMLDocument

public Document toXMLDocument(Map userMap)
                       throws IDPPException

Converts into an XML document so that XPATH can be applied. This method is an implementation of IDPPContainer.

Specified by:

toXMLDocument in interface IDPPContainer

Parameters:

userMap - user map

Returns:

Document XML document representation of container.

Throws:

IDPPException

getAnalyzedNameAttributes

protected Set getAnalyzedNameAttributes()

Creates required set of attributes.

Returns:

set of required attributes.

getAnalyzedNameMap

protected Map getAnalyzedNameMap(Object obj,
                                 Map map)
                          throws IDPPException

Gets analzedname attributes in a hashmap.

Parameters:

obj - AnalyzedNameType JAXB object.

map - map that sets attribute/value pairs.

Returns:

Map required analyzed name hashmap.

Throws:

IDPPException

getAttributeMapper

protected AttributeMapper getAttributeMapper()

Gets Attribute Mapper

Returns:

Attribute Mapper instance

getExtensionContainerAttributes

protected Set getExtensionContainerAttributes()

Gets extension attribute

Returns:

extension attributes

getExtensionContainerClass

protected IDPPExtension getExtensionContainerClass()

Gets container extension

Returns:

IDDExtension object

setUserDN

public void setUserDN(String user)

Sets user DN

Specified by:

setUserDN in interface IDPPContainer

Parameters:

user - userDN