com.sun.identity.federation.message.common
Class 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.

Field Summary

static int	LIB_TYPE_BROKER
static int	LIB_TYPE_IDP

Constructor Summary

IDPEntry()
Default Constructor.

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

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

Method Summary

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.

Field Detail

LIB_TYPE_IDP

public static final int LIB_TYPE_IDP

See Also:

Constant Field Values

LIB_TYPE_BROKER

public static final int LIB_TYPE_BROKER

See Also:

Constant Field Values

Constructor Detail

IDPEntry

public IDPEntry()

Default Constructor.

IDPEntry

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

Constructor creates IDPEntry object.

Parameters:

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.

Parameters:

root - Document Element of IDPEntry object.

Throws:

FSMsgException - if IDPEntry cannot be created.

Method Detail

getProviderID

public String getProviderID()

Returns the value of ProviderID attribute.

Returns:

the value of ProviderID attribute.

See Also:

IDPEntry.setProviderID(String)

setProviderID

public void setProviderID(String providerID)

Sets the value of ProviderID attribute.

Parameters:

providerID - the value of ProviderID attribute.

See Also:

IDPEntry.getProviderID()

getProviderName

public String getProviderName()

Returns the Identity Provider Name.

Returns:

the Identity Provider Name.

See Also:

IDPEntry.setProviderName(String)

setProviderName

public void setProviderName(String providerName)

Sets the Identity Provider Name.

Parameters:

providerName - the Identity Provider Name.

See Also:

IDPEntry.getProviderName()

getLocation

public String getLocation()

Returns the location URI of the Identity Provider.

Returns:

the location URI of the Identity Provider.

See Also:

IDPEntry.setLocation(String)

setLocation

public void setLocation(String location)

Sets the location URI of the Identity Provider.

Parameters:

location - the location URI of the Identity Provider.

See Also:

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.

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.