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

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

public class IDPEntry

extends java.lang.Object

This class IDPEntry represents the ID-FF Entry element.

Field Summary

static int	LIB_TYPE_BROKER
static int	LIB_TYPE_IDP

Constructor Summary

IDPEntry()
Default constructor

IDPEntry(org.w3c.dom.Element root)
Constructor

IDPEntry(java.lang.String providerID, java.lang.String providerName, java.lang.String location)
Constructor

Method Summary

java.lang.String	getLocation() Gets location
java.lang.String	getProviderID() Gets provider ID
java.lang.String	getProviderName() Gets provider name
void	setLocation(java.lang.String location) Sets location
void	setProviderID(java.lang.String providerID) Sets provider ID
void	setProviderName(java.lang.String providerName) Sets provider name
java.lang.String	toXMLString() Creates a String representation of the IDPEntry object
java.lang.String	toXMLString(boolean includeNS, boolean declareNS) Creates a String representation of the IDPEntry object
java.lang.String	toXMLString(boolean includeNS, boolean declareNS, boolean includeHeader) Creates a String representation of the IDPEntry object

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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(java.lang.String providerID,
                java.lang.String providerName,
                java.lang.String location)

Constructor

Parameters:

providerID - provider ID

providerName - provider name

location - location

IDPEntry

public IDPEntry(org.w3c.dom.Element root)
         throws FSMsgException

Constructor

Parameters:

root - DOM Element representing an IDPEntry object

Throws:

FSMsgException - if unable to create the object

Method Detail

getProviderID

public java.lang.String getProviderID()

Gets provider ID

Returns:

provider ID

setProviderID

public void setProviderID(java.lang.String providerID)

Sets provider ID

Parameters:

providerID - provider ID to be set

getProviderName

public java.lang.String getProviderName()

Gets provider name

Returns:

provider name

setProviderName

public void setProviderName(java.lang.String providerName)

Sets provider name

Parameters:

providerName - provider name to be set

getLocation

public java.lang.String getLocation()

Gets location

Returns:

provider location

setLocation

public void setLocation(java.lang.String location)

Sets location

Parameters:

location - location to be set

toXMLString

public java.lang.String toXMLString()
                             throws FSMsgException

Creates a String representation of the IDPEntry object

Returns:

A string containing the valid XML for this element

Throws:

FSMsgException - if unable to get XML string

toXMLString

public java.lang.String toXMLString(boolean includeNS,
                                    boolean declareNS)
                             throws FSMsgException

Creates a String representation of the IDPEntry 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 unable to get XML string

toXMLString

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

Creates a String representation of the IDPEntry 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 unable to get XML string