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

Class ScopingImpl

java.lang.Object

com.sun.identity.saml2.protocol.impl.ScopingImpl

All Implemented Interfaces:

Scoping

public class ScopingImpl
extends Object
implements Scoping

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

Constructor Summary

Constructors

Constructor	Description
ScopingImpl()	Constructor to create Scoping object.
ScopingImpl(String xmlString)	Constructor to create the Scoping Object.
ScopingImpl(Element element)	Constructor to create the Scoping Object.

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> value)	Sets the RequesterID Object.
String	toXMLString()	Returns a String representation of this Object.
String	toXMLString(boolean includeNSPrefix, boolean declareNS)	Returns a String representation

Methods inherited from class java.lang.Object

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

Constructor Detail

ScopingImpl

public ScopingImpl()

Constructor to create Scoping object.

ScopingImpl

public ScopingImpl(Element element)
            throws SAML2Exception

Constructor to create the Scoping Object.

Parameters:

element - Document Element of Scoping Object.

Throws:

SAML2Exception - if Scoping cannot be created.

ScopingImpl

public ScopingImpl(String xmlString)
            throws SAML2Exception

Constructor to create the Scoping Object.

Parameters:

xmlString - XML String Representation of Scoping Object.

Throws:

SAML2Exception - if Scoping cannot be created.

Method Detail

getIDPList

public IDPList getIDPList()

Returns the IDPList Object.

Specified by:

getIDPList in interface Scoping

Returns:

the IDPList object.

See Also:

setIDPList(IDPList)

setIDPList

public void setIDPList(IDPList idpList)
                throws SAML2Exception

Sets the IDPList Object.

Specified by:

setIDPList in interface Scoping

Parameters:

idpList - the new IDPList object.

Throws:

SAML2Exception - if the object is immutable.

See Also:

getIDPList()

getRequesterIDs

public List<RequesterID> getRequesterIDs()

Returns a list of RequesterID Objects.

Specified by:

getRequesterIDs in interface Scoping

Returns:

list of RequesterID objects.

See Also:

setRequesterIDs(List)

setRequesterIDs

public void setRequesterIDs(List<RequesterID> value)
                     throws SAML2Exception

Sets the RequesterID Object.

Specified by:

setRequesterIDs in interface Scoping

Parameters:

value - list of RequesterID objects.

Throws:

SAML2Exception - if the object is immutable.

See Also:

getRequesterIDs()

getProxyCount

public Integer getProxyCount()

Returns the value of ProxyCount attribute.

Specified by:

getProxyCount in interface Scoping

Returns:

the value of ProxyCount attribute value.

See Also:

Scoping.setProxyCount(Integer)

setProxyCount

public void setProxyCount(Integer proxyCount)
                   throws SAML2Exception

Sets the value of ProxyCount attribute.

Specified by:

setProxyCount in interface Scoping

Parameters:

proxyCount - new value of ProxyCount attribute.

Throws:

SAML2Exception - if the object is immutable.

See Also:

Scoping.getProxyCount()

toXMLString

public String toXMLString()
                   throws SAML2Exception

Returns a String representation of this Object.

Specified by:

toXMLString in interface Scoping

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

Specified by:

toXMLString in interface Scoping

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

public void makeImmutable()

Makes this object immutable.

Specified by:

makeImmutable in interface Scoping

isMutable

public boolean isMutable()

Returns true if object is mutable.

Specified by:

isMutable in interface Scoping

Returns:

true if object is mutable.