com.sun.identity.saml2.protocol
インタフェース Scoping

public interface Scoping

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

メソッドの概要

IDPList	getIDPList() Returns the IDPList Object.
Integer	getProxyCount() Returns the value of ProxyCount attribute.
List	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 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.

メソッドの詳細

getIDPList

IDPList getIDPList()

Returns the IDPList Object.

戻り値:

the IDPList object.

関連項目:

Scoping.setIDPList(IDPList)

setIDPList

void setIDPList(IDPList idpList)
                throws SAML2Exception

Sets the IDPList Object.

パラメータ:

idpList - the new IDPList object.

例外:

SAML2Exception - if the object is immutable.

関連項目:

Scoping.getIDPList()

getRequesterIDs

List getRequesterIDs()

Returns a list of RequesterID Objects..

戻り値:

list of RequesterID objects.

関連項目:

Scoping.setRequesterIDs(List)

setRequesterIDs

void setRequesterIDs(List requesterIDList)
                     throws SAML2Exception

Sets a list of RequesterID Objects.

パラメータ:

requesterIDList - the list of RequesterID object.

例外:

SAML2Exception - if the object is immutable.

関連項目:

Scoping.getRequesterIDs()

getProxyCount

Integer getProxyCount()

Returns the value of ProxyCount attribute.

戻り値:

the value of ProxyCount attribute.

関連項目:

Scoping.setProxyCount(Integer)

setProxyCount

void setProxyCount(Integer proxyCount)
                   throws SAML2Exception

Sets the value of ProxyCount attribute.

パラメータ:

proxyCount - new value of ProxyCount attribute.

例外:

SAML2Exception - if the object is immutable.

関連項目:

Scoping.getProxyCount()

toXMLString

String toXMLString()
                   throws SAML2Exception

Returns a String representation of this Object.

戻り値:

a String representation of this Object.

例外:

SAML2Exception - if cannot create String object

toXMLString

String toXMLString(boolean includeNSPrefix,
                   boolean declareNS)
                   throws SAML2Exception

Returns a String representation of this Object.

パラメータ:

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.

戻り値:

the String representation of this Object.

例外:

SAML2Exception - if String object cannot be created.

makeImmutable

void makeImmutable()

Makes this object immutable.

isMutable

boolean isMutable()

Returns true if object is mutable.

戻り値:

true if object is mutable.