com.sun.identity.federation.message.common
クラス IDPEntry

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

public class IDPEntry
extends Object

This class defines methods to set/retrieve single identity provider information trusted by the request issuer to authenticate the presenter.

フィールドの概要

static int	LIB_TYPE_BROKER
static int	LIB_TYPE_IDP

コンストラクタの概要

IDPEntry()
Default Constructor.

IDPEntry(Element root)
Constructor creates IDPEntry Object from Document Element.

IDPEntry(String providerID, String providerName, String location)
Constructor creates IDPEntry object.

メソッドの概要

String	getLocation() Returns the location URI of the Identity Provider.
String	getProviderID() Returns the value of ProviderID attribute.
String	getProviderName() Returns the Identity Provider Name.
void	setLocation(String location) Sets the location URI of the Identity Provider.
void	setProviderID(String providerID) Sets the value of ProviderID attribute.
void	setProviderName(String providerName) Sets the Identity Provider Name.
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.

フィールドの詳細

LIB_TYPE_IDP

public static final int LIB_TYPE_IDP

関連項目:

定数フィールド値

LIB_TYPE_BROKER

public static final int LIB_TYPE_BROKER

関連項目:

定数フィールド値

コンストラクタの詳細

IDPEntry

public IDPEntry()

Default Constructor.

IDPEntry

public IDPEntry(String providerID,
                String providerName,
                String location)

Constructor creates IDPEntry object.

パラメータ:

providerID - the Identity Provider identifier.

providerName - the Identity Provider name.

location -

IDPEntry

public IDPEntry(Element root)
         throws FSMsgException

Constructor creates IDPEntry Object from Document Element.

パラメータ:

root - Document Element of IDPEntry object.

例外:

FSMsgException - if IDPEntry cannot be created.

メソッドの詳細

getProviderID

public String getProviderID()

Returns the value of ProviderID attribute.

戻り値:

the value of ProviderID attribute.

関連項目:

IDPEntry.setProviderID(String)

setProviderID

public void setProviderID(String providerID)

Sets the value of ProviderID attribute.

パラメータ:

providerID - the value of ProviderID attribute.

関連項目:

IDPEntry.getProviderID()

getProviderName

public String getProviderName()

Returns the Identity Provider Name.

戻り値:

the Identity Provider Name.

関連項目:

IDPEntry.setProviderName(String)

setProviderName

public void setProviderName(String providerName)

Sets the Identity Provider Name.

パラメータ:

providerName - the Identity Provider Name.

関連項目:

IDPEntry.getProviderName()

getLocation

public String getLocation()

Returns the location URI of the Identity Provider.

戻り値:

the location URI of the Identity Provider.

関連項目:

IDPEntry.setLocation(String)

setLocation

public void setLocation(String location)

Sets the location URI of the Identity Provider.

パラメータ:

location - the location URI of the Identity Provider.

関連項目:

IDPEntry.getLocation()

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.