com.sun.identity.saml2.protocol

Interface IDPList

public interface IDPList

This interface specifies the identity providers trusted by the requester to authenticate the presenter.

Method Summary

Modifier and Type	Method and Description
GetComplete	getGetComplete() Returns the GetComplete Object.
List<IDPEntry>	getIDPEntries() Returns the list of IDPEntry Objects.
boolean	isMutable() Returns true if object is mutable.
void	makeImmutable() Makes this object immutable.
void	setGetComplete(GetComplete getComplete) Sets the GetComplete Object.
void	setIDPEntries(List<IDPEntry> idpEntryList) Sets the IDPEntry Object.
String	toXMLString() Returns a String representation of this Object.
String	toXMLString(boolean includeNSPrefix, boolean declareNS) Returns a String representation of this Object.

Method Detail

getIDPEntries

List<IDPEntry> getIDPEntries()

Returns the list of IDPEntry Objects.

Returns:

the list IDPEntry objects.

See Also:

IDPList.setIDPEntries(List)

setIDPEntries

void setIDPEntries(List<IDPEntry> idpEntryList)
            throws SAML2Exception

Sets the IDPEntry Object.

Parameters:

idpEntryList - the list of IDPEntry objects.

Throws:

SAML2Exception - if the object is immutable.

See Also:

IDPList.getIDPEntries()

getGetComplete

GetComplete getGetComplete()

Returns the GetComplete Object.

Returns:

the GetComplete object.

See Also:

IDPList.setGetComplete(GetComplete)

setGetComplete

void setGetComplete(GetComplete getComplete)
             throws SAML2Exception

Sets the GetComplete Object.

Parameters:

getComplete - the new GetComplete object.

Throws:

SAML2Exception - if the object is immutable.

See Also:

IDPList.getGetComplete()

toXMLString

String toXMLString()
            throws SAML2Exception

Returns a String representation of this Object.

Returns:

a String representation of this Object.

Throws:

SAML2Exception - 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 - cannot create String object.

makeImmutable

void makeImmutable()

Makes this object immutable.

isMutable

boolean isMutable()

Returns true if object is mutable.

Returns:

true if the object is mutable.