com.sun.identity.federation.message.common
Class IDPEntries

java.lang.Object
  com.sun.identity.federation.message.common.IDPEntries

public class IDPEntries
extends Object

This class defines methods to set/retrieve multiple Identity Providers.

Constructor Summary

IDPEntries()
Default Constructor.

IDPEntries(Element root)
Constructor creates IDPEntries object from a Document Element.

IDPEntries(List idpEntries)
Constructor creates IDPEntries object.

Method Summary

List	getIDPEntryList() Returns the list of Identity Providers.
void	setIDPEntryList(List idpEntryList) Sets the list of Identity Providers.
String	toXMLString() Returns the string representation of this object.
String	toXMLString(boolean includeNS, boolean declareNS) Returns a String representation of this object.
String	toXMLString(boolean includeNS, boolean declareNS, boolean includeHeader) Returns a String representation of this object.

Constructor Detail

IDPEntries

public IDPEntries()

Default Constructor.

IDPEntries

public IDPEntries(List idpEntries)

Constructor creates IDPEntries object.

Parameters:

idpEntries - list of identity providers.

IDPEntries

public IDPEntries(Element root)
           throws FSMsgException

Constructor creates IDPEntries object from a Document Element.

Parameters:

root - the Document Element object.

Throws:

FSMsgException - on error.

Method Detail

getIDPEntryList

public List getIDPEntryList()

Returns the list of Identity Providers.

Returns:

list of Identity Providers.

See Also:

IDPEntries.setIDPEntryList(List)

setIDPEntryList

public void setIDPEntryList(List idpEntryList)

Sets the list of Identity Providers.

Parameters:

idpEntryList - the list of Identity Providers.

See Also:

IDPEntries.getIDPEntryList()

toXMLString

public String toXMLString()
                   throws FSMsgException

Returns the string representation of this object. This method translates the response to an XML document string.

Returns:

An XML String representing the response. NOTE: this is a complete SAML response xml string with ResponseID, MajorVersion, etc.

Throws:

FSMsgException

toXMLString

public String toXMLString(boolean includeNS,
                          boolean declareNS)
                   throws FSMsgException

Returns a String representation of this object.

Parameters:

includeNS - : Determines whether or not the namespace qualifier is prepended to the Element when converted

declareNS - : Determines whether or not the namespace is declared within the Element.

Returns:

a string containing the valid XML for this element

Throws:

FSMsgException - if there is an error converting this object ot a string.

toXMLString

public String toXMLString(boolean includeNS,
                          boolean declareNS,
                          boolean includeHeader)
                   throws FSMsgException

Returns a String representation of this object.

Parameters:

includeNS - Determines whether or not the namespace qualifier is prepended to the Element when converted

declareNS - Determines whether or not the namespace is declared within the Element.

includeHeader - Determines whether the output include the xml declaration header.

Returns:

a string containing the valid XML for this element

Throws:

FSMsgException - if there is an error converting this object ot a string.