Package com.sun.identity.liberty.ws.idpp.plugin

Interface IDPPContainer

All Known Implementing Classes:

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

public interface IDPPContainer

The interface IDPPContainer provides a plugin for the IDPP containers. Each IDPP container needs to implement this interface for those containers that the Personal profile supports.

Method Summary

Modifier and Type	Method	Description
Set	getContainerAttributes()	Gets the supported container attributes.
Set	getContainerAttributesForSelect(String select)	Gets the container attributes for a select expression.
Map	getDataMapForSelect(String select, List data)	Gets the data map for a given select and the data.
boolean	hasBinaryAttributes()	Checks if the container has any binary attributes.
void	setUserDN(String userDN)	Sets the UserDN for the container that needs to be built by using this user attributes.
Document	toXMLDocument(Map userMap)	Converts all the supported container values into an XML document.

Method Detail

toXMLDocument

Document toXMLDocument(Map userMap)
                throws IDPPException

Converts all the supported container values into an XML document.

Parameters:

userMap - user data map

Returns:

Document XML representation of container.

Throws:

IDPPException

getContainerAttributes

Set getContainerAttributes()

Gets the supported container attributes.

Returns:

Set set of supported container attributes.

getContainerAttributesForSelect

Set getContainerAttributesForSelect(String select)

Gets the container attributes for a select expression.

Parameters:

select - select string.

Returns:

Set set of container attributes for the given select.

getDataMapForSelect

Map getDataMapForSelect(String select,
                        List data)
                 throws IDPPException

Gets the data map for a given select and the data.

Parameters:

select - select expression.

data - list of new data objects.

Returns:

Map Attribute value pair for the given select and data.

Throws:

IDPPException

hasBinaryAttributes

boolean hasBinaryAttributes()

Checks if the container has any binary attributes.

Returns:

true if any of the container attributes are binary.

setUserDN

void setUserDN(String userDN)

Sets the UserDN for the container that needs to be built by using this user attributes.

Parameters:

userDN - User's DN.