com.sun.identity.federation.message
Class FSIDPList

java.lang.Object
  com.sun.identity.federation.message.FSIDPList

public class FSIDPList
extends Object

This class has methods to construct an object or message representing a list of trusted Identity Providers.

Field Summary

IDPEntries

idpEntries IDPEntries object.

Constructor Summary

FSIDPList()
Default Constructor.

FSIDPList(Element root)
Constructor creates FSIDPList object from Document Element.

FSIDPList(IDPEntries idpEntries, List getCompleteList)
Constructor creates FSIDPList from IDPEntries object and a list of GetComplete objects.

Method Summary

List	getGetCompleteList() Returns list of GetComplete objects.
IDPEntries	getIDPEntries() Returns IDPEntries object.
int	getMinorVersion() Returns the value of MinorVersion attribute.
void	setGetCompleteList(List getCompleteList) Sets list of GetComplete objects.
void	setIDPEntries(IDPEntries idpEntries) Sets IDPEntries object.
void	setMinorVersion(int minorVersion) Sets the value of MinorVersion attribute.
String	toXMLString() Returns a XML string representation of this object.
String	toXMLString(boolean includeNS, boolean declareNS) Creates a String representation of this object.
String	toXMLString(boolean includeNS, boolean declareNS, boolean includeHeader) Creates a String representation of this element.

Field Detail

idpEntries

public IDPEntries idpEntries

IDPEntries object.

Constructor Detail

FSIDPList

public FSIDPList()

Default Constructor.

FSIDPList

public FSIDPList(Element root)
          throws FSMsgException

Constructor creates FSIDPList object from Document Element.

Parameters:

root - the Document Element object.

Throws:

FSMsgException - if there is an error creating the object.

FSIDPList

public FSIDPList(IDPEntries idpEntries,
                 List getCompleteList)

Constructor creates FSIDPList from IDPEntries object and a list of GetComplete objects.

Parameters:

idpEntries - the IDPEntries object.

getCompleteList - list of GetComplete objects.

Method Detail

setMinorVersion

public void setMinorVersion(int minorVersion)

Sets the value of MinorVersion attribute.

Parameters:

minorVersion - the value of MinorVersion attribute in the assertion.

See Also:

FSIDPList.setMinorVersion(int)

getMinorVersion

public int getMinorVersion()

Returns the value of MinorVersion attribute.

Returns:

the value of MinorVersion attribute.

See Also:

FSIDPList.setMinorVersion(int)

getIDPEntries

public IDPEntries getIDPEntries()

Returns IDPEntries object.

Returns:

the IDPEntries object.

See Also:

FSIDPList.setIDPEntries(IDPEntries)

getGetCompleteList

public List getGetCompleteList()

Returns list of GetComplete objects.

Returns:

list of GetComplete objects.

See Also:

FSIDPList.setGetCompleteList(List)

setIDPEntries

public void setIDPEntries(IDPEntries idpEntries)

Sets IDPEntries object.

Parameters:

idpEntries - IDPEntries object.

See Also:

FSIDPList.getIDPEntries()

setGetCompleteList

public void setGetCompleteList(List getCompleteList)

Sets list of GetComplete objects.

Parameters:

getCompleteList - list of GetComplete objects.

See Also:

FSIDPList.setGetCompleteList(List)

toXMLString

public String toXMLString()
                   throws FSMsgException

Returns a XML string representation of this object.

Returns:

XML String representing this object.

Throws:

FSMsgException - if there is an error creating the XML string or if the required elements to create the string do not conform to the schema.

toXMLString

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

Creates 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:

string containing the valid XML for this element.

Throws:

FSMsgException - if there is an error.

toXMLString

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

Creates a String representation of this element.

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.