Package com.sun.identity.saml2.protocol

Interface Scoping

All Known Implementing Classes:

ScopingImpl

public interface Scoping

This interface defines methods to retrieve Identity Providers and context/limitations related to proxying of the request message.

Method Summary

Modifier and Type	Method	Description
IDPList	getIDPList()	Returns the IDPList Object.
Integer	getProxyCount()	Returns the value of ProxyCount attribute.
List<RequesterID>	getRequesterIDs()	Returns a list of RequesterID Objects..
boolean	isMutable()	Returns true if object is mutable.
void	makeImmutable()	Makes this object immutable.
void	setIDPList(IDPList idpList)	Sets the IDPList Object.
void	setProxyCount(Integer proxyCount)	Sets the value of ProxyCount attribute.
void	setRequesterIDs(List<RequesterID> requesterIDList)	Sets a list of RequesterID Objects.
String	toXMLString()	Returns a String representation of this Object.
String	toXMLString(boolean includeNSPrefix, boolean declareNS)	Returns a String representation of this Object.

Method Detail

getIDPList

IDPList getIDPList()

Returns the IDPList Object.

Returns:

the IDPList object.

See Also:

setIDPList(IDPList)

setIDPList

void setIDPList(IDPList idpList)
         throws SAML2Exception

Sets the IDPList Object.

Parameters:

idpList - the new IDPList object.

Throws:

SAML2Exception - if the object is immutable.

See Also:

getIDPList()

getRequesterIDs

List<RequesterID> getRequesterIDs()

Returns a list of RequesterID Objects..

Returns:

list of RequesterID objects.

See Also:

setRequesterIDs(List)

setRequesterIDs

void setRequesterIDs(List<RequesterID> requesterIDList)
              throws SAML2Exception

Sets a list of RequesterID Objects.

Parameters:

requesterIDList - the list of RequesterID object.

Throws:

SAML2Exception - if the object is immutable.

See Also:

getRequesterIDs()

getProxyCount

Integer getProxyCount()

Returns the value of ProxyCount attribute.

Returns:

the value of ProxyCount attribute.

See Also:

setProxyCount(Integer)

setProxyCount

void setProxyCount(Integer proxyCount)
            throws SAML2Exception

Sets the value of ProxyCount attribute.

Parameters:

proxyCount - new value of ProxyCount attribute.

Throws:

SAML2Exception - if the object is immutable.

See Also:

getProxyCount()

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 String object cannot be created.

makeImmutable

void makeImmutable()

Makes this object immutable.

isMutable

boolean isMutable()

Returns true if object is mutable.

Returns:

true if object is mutable.