com.sun.identity.federation.message
Class FSScoping

java.lang.Object
  com.sun.identity.federation.message.FSScoping

public class FSScoping
extends Object

This class FSScoping creates scoping element for the authentication request.

Constructor Summary

FSScoping()
Default constructor

FSScoping(Element root)
Constructor creates FSScoping object from the Document Element.

FSScoping(FSIDPList idpList, int proxyCount)
Constructor creates FSScoping object.

Method Summary

FSIDPList	getIDPList() Returns the preferred IDPs list in an authentication request.
int	getProxyCount() Returns the proxy count.
static FSScoping	parseURLEncodedRequest(HttpServletRequest request) Returns FSScoping object.
void	setIDPList(FSIDPList idpList) Sets preferred ordered List of IDPs that is known to SP for proxying.
void	setProxyCount(int count) Sets the proxy count.
String	toURLEncodedQueryString() Returns an URL Encoded String.
String	toXMLString() Returns a XML string representation of this object.
String	toXMLString(boolean includeNS, boolean declareNS) Creates a String representation of this object.

Constructor Detail

FSScoping

public FSScoping()

Default constructor

FSScoping

public FSScoping(FSIDPList idpList,
                 int proxyCount)

Constructor creates FSScoping object.

Parameters:

idpList - the FSIDPList object.

proxyCount - the number of proxies

FSScoping

public FSScoping(Element root)
          throws FSMsgException

Constructor creates FSScoping object from the Document Element.

Parameters:

root - the Document Element .

Throws:

FSMsgException - if there is a failure creating this object.

Method Detail

setProxyCount

public void setProxyCount(int count)

Sets the proxy count.

Parameters:

count - number of proxies

getProxyCount

public int getProxyCount()

Returns the proxy count.

Returns:

number of proxies.

setIDPList

public void setIDPList(FSIDPList idpList)

Sets preferred ordered List of IDPs that is known to SP for proxying.

Parameters:

idpList - the FSIDPList object.

getIDPList

public FSIDPList getIDPList()

Returns the preferred IDPs list in an authentication request.

Returns:

the FSIDPList object.

toXMLString

public String toXMLString()
                   throws FSMsgException

Returns a XML string representation of this object.

Returns:

XML String representing this object.

Throws:

FSMsgException - if there is an error creating the XML string or if the required elements to create the string do not conform to the schema.

toXMLString

public String toXMLString(boolean includeNS,
                          boolean declareNS)
                   throws FSMsgException

Creates a String representation of this object.

Parameters:

includeNS - : 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:

string containing the valid XML for this element.

Throws:

FSMsgException - if there is an error.

toURLEncodedQueryString

public String toURLEncodedQueryString()
                               throws FSMsgException

Returns an URL Encoded String.

Returns:

a url encoded query string.

Throws:

FSMsgException - if there is an error.

parseURLEncodedRequest

public static FSScoping parseURLEncodedRequest(HttpServletRequest request)

Returns FSScoping object. The object is creating by parsing the HttpServletRequest object.

Parameters:

request - the HttpServletRequest object.

Throws:

FSMsgException - if there is an error creating this object.