Package com.sun.identity.saml2.protocol.impl

Class IDPEntryImpl

java.lang.Object

com.sun.identity.saml2.protocol.impl.IDPEntryImpl

All Implemented Interfaces:

IDPEntry

public class IDPEntryImpl
extends Object
implements IDPEntry

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

Constructor Summary

Constructors

Constructor	Description
IDPEntryImpl()	Constructor to create IDPEntry Object.
IDPEntryImpl(String xmlString)	Constructor to create IDPEntry Object.
IDPEntryImpl(Element element)	Constructor to create IDPEntry Object.

Method Summary

Modifier and Type	Method	Description
String	getLoc()	Return the value of Loc attribute.
String	getName()	Returns the value of Name attribute.
String	getProviderID()	Returns the value of ProviderID attribute.
boolean	isMutable()	Returns true if object is mutable.
void	makeImmutable()	Makes this object immutable.
void	setLoc(String locationURI)	Sets the value of Loc attribute.
void	setName(String name)	Sets the value of Name attribute.
void	setProviderID(String uri)	Sets the value of ProviderID attribute.
String	toXMLString()	Returns a String representation of this Object.
String	toXMLString(boolean includeNSPrefix, boolean declareNS)	Returns a String representation of this Object.

Methods inherited from class java.lang.Object

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

Constructor Detail

IDPEntryImpl

public IDPEntryImpl()

Constructor to create IDPEntry Object.

IDPEntryImpl

public IDPEntryImpl(Element element)
             throws SAML2Exception

Constructor to create IDPEntry Object.

Parameters:

element - Document Element of IDPEntry object.

Throws:

SAML2Exception - if IDPEntry cannot be created.

IDPEntryImpl

public IDPEntryImpl(String xmlString)
             throws SAML2Exception

Constructor to create IDPEntry Object.

Parameters:

xmlString - XML Representation of the IDPEntry object.

Throws:

SAML2Exception - if IDPEntry cannot be created.

Method Detail

getProviderID

public String getProviderID()

Returns the value of ProviderID attribute.

Specified by:

getProviderID in interface IDPEntry

Returns:

value of the ProviderID attribute.

See Also:

setProviderID(String)

setProviderID

public void setProviderID(String uri)
                   throws SAML2Exception

Sets the value of ProviderID attribute.

Specified by:

setProviderID in interface IDPEntry

Parameters:

uri - new value of ProviderID attribute.

Throws:

SAML2Exception - if the object is immutable.

See Also:

getProviderID()

getName

public String getName()

Returns the value of Name attribute.

Specified by:

getName in interface IDPEntry

Returns:

value of the Name attribute.

See Also:

setName(String)

setName

public void setName(String name)
             throws SAML2Exception

Sets the value of Name attribute.

Specified by:

setName in interface IDPEntry

Parameters:

name - new value of Name attribute.

Throws:

SAML2Exception - if the object is immutable.

See Also:

getName()

getLoc

public String getLoc()

Return the value of Loc attribute.

Specified by:

getLoc in interface IDPEntry

Returns:

value of Loc attribute.

See Also:

setLoc(String)

setLoc

public void setLoc(String locationURI)
            throws SAML2Exception

Sets the value of Loc attribute.

Specified by:

setLoc in interface IDPEntry

Parameters:

locationURI - value of Loc attribute.

Throws:

SAML2Exception - if the object is immutable.

See Also:

getLoc()

toXMLString

public String toXMLString()
                   throws SAML2Exception

Returns a String representation of this Object.

Specified by:

toXMLString in interface IDPEntry

Returns:

a String representation of this Object.

Throws:

SAML2Exception - if cannot create String object.

toXMLString

public String toXMLString(boolean includeNSPrefix,
                          boolean declareNS)
                   throws SAML2Exception

Returns a String representation of this Object.

Specified by:

toXMLString in interface IDPEntry

Parameters:

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

the String representation of this Object.

Throws:

SAML2Exception - if cannot create String object.

makeImmutable

public void makeImmutable()

Makes this object immutable.

Specified by:

makeImmutable in interface IDPEntry

isMutable

public boolean isMutable()

Returns true if object is mutable.

Specified by:

isMutable in interface IDPEntry

Returns:

true if object is mutable.