com.sun.identity.saml2.protocol
Interface IDPEntry

public interface IDPEntry

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

Method Summary

String	getLoc() Return the value of Loc attribute.
String	getName() Returns the value of Name attribute.
String	getProviderID() Returns the ProviderID attribute value.
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 ProviderID attribute value.
String	toXMLString() Returns a String representation of this Object.
String	toXMLString(boolean includeNSPrefix, boolean declareNS) Returns a String representation of this Object.

Method Detail

getProviderID

String getProviderID()

Returns the ProviderID attribute value.

Returns:

value of the ProviderID attribute.

See Also:

IDPEntry.setProviderID(String)

setProviderID

void setProviderID(String uri)
                   throws SAML2Exception

Sets the ProviderID attribute value.

Parameters:

uri - new value of ProviderID attribute.

Throws:

SAML2Exception - if the object is immutable.

See Also:

IDPEntry.getProviderID()

getName

String getName()

Returns the value of Name attribute.

Returns:

value of the Name attribute.

See Also:

IDPEntry.setName(String)

setName

void setName(String name)
             throws SAML2Exception

Sets the value of Name attribute.

Parameters:

name - new value of Name attribute.

Throws:

SAML2Exception - if the object is immutable.

See Also:

IDPEntry.getName()

getLoc

String getLoc()

Return the value of Loc attribute.

Returns:

value of Loc attribute.

See Also:

IDPEntry.setLoc(String)

setLoc

void setLoc(String locationURI)
            throws SAML2Exception

Sets the value of Loc attribute.

Parameters:

locationURI - value of Loc attribute.

Throws:

SAML2Exception - if the object is immutable.

See Also:

IDPEntry.getLoc()

toXMLString

String toXMLString()
                   throws SAML2Exception

Returns a String representation of this Object.

Returns:

a String representation of this Object.

Throws:

SAML2Exception - if cannot create String object.

toXMLString

String toXMLString(boolean includeNSPrefix,
                   boolean declareNS)
                   throws SAML2Exception

Returns a String representation of this Object.

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

void makeImmutable()

Makes this object immutable.

isMutable

boolean isMutable()

Returns true if object is mutable.

Returns:

true if object is mutable.