com.sun.identity.federation.message.common
クラス 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.

コンストラクタの概要

IDPEntries()
Default Constructor.

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

IDPEntries(List idpEntries)
Constructor creates IDPEntries object.

メソッドの概要

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.

コンストラクタの詳細

IDPEntries

public IDPEntries()

Default Constructor.

IDPEntries

public IDPEntries(List idpEntries)

Constructor creates IDPEntries object.

パラメータ:

idpEntries - list of identity providers.

IDPEntries

public IDPEntries(Element root)
           throws FSMsgException

Constructor creates IDPEntries object from a Document Element.

パラメータ:

root - the Document Element object.

例外:

FSMsgException - on error.

メソッドの詳細

getIDPEntryList

public List getIDPEntryList()

Returns the list of Identity Providers.

戻り値:

list of Identity Providers.

関連項目:

IDPEntries.setIDPEntryList(List)

setIDPEntryList

public void setIDPEntryList(List idpEntryList)

Sets the list of Identity Providers.

パラメータ:

idpEntryList - the list of Identity Providers.

関連項目:

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.

戻り値:

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

例外:

FSMsgException

toXMLString

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

Returns a String representation of this object.

パラメータ:

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.

戻り値:

a string containing the valid XML for this element

例外:

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.

パラメータ:

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.

戻り値:

a string containing the valid XML for this element

例外:

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