com.sun.identity.federation.message
Class FSScoping

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

public class FSScoping

extends java.lang.Object

This class FSScoping creates scoping element for the authentication request.

Constructor Summary

FSScoping()
Default constructor

FSScoping(org.w3c.dom.Element root)
Constructor

FSScoping(FSIDPList idpList, int proxyCount)
Constructor

Method Summary

FSIDPList	getIDPList() Gets the preferred IDPs list in an authentication request.
int	getProxyCount() Gets the proxy count.
static FSScoping	parseURLEncodedRequest(javax.servlet.http.HttpServletRequest request) Parses the http requests and creates a scoping 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.
java.lang.String	toURLEncodedQueryString() Converts into an url encoded query string.
java.lang.String	toXMLString() Converts into a xml string format.
java.lang.String	toXMLString(boolean includeNS, boolean declareNS) Converts into a xml string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

FSScoping

public FSScoping()

Default constructor

FSScoping

public FSScoping(FSIDPList idpList,
                 int proxyCount)

Constructor

Parameters:

idpList - IDPList

proxyCount - Number of proxies

FSScoping

public FSScoping(org.w3c.dom.Element root)
          throws FSMsgException

Constructor

Parameters:

root - Scoping DOMElement

Throws:

FSMsgException - if there is a failure in parsing.

Method Detail

setProxyCount

public void setProxyCount(int count)

Sets the proxy count.

Parameters:

count - number of proxies

getProxyCount

public int getProxyCount()

Gets the proxy count.

Returns:

number of proxies count

setIDPList

public void setIDPList(FSIDPList idpList)

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

Parameters:

idpList - IDPs List.

getIDPList

public FSIDPList getIDPList()

Gets the preferred IDPs list in an authentication request.

Returns:

FSIDPList IDP list.

toXMLString

public java.lang.String toXMLString()
                             throws FSMsgException

Converts into a xml string format.

Returns:

String XMLString

Throws:

FSMsgException - if any failure.

toXMLString

public java.lang.String toXMLString(boolean includeNS,
                                    boolean declareNS)
                             throws FSMsgException

Converts into a xml string format.

Parameters:

includeNS - include name space.

declareNS - declare name space.

Returns:

xml string format.

Throws:

FSMsgException - for any failures.

toURLEncodedQueryString

public java.lang.String toURLEncodedQueryString()
                                         throws FSMsgException

Converts into an url encoded query string.

Returns:

String url encoded query String.

Throws:

FSMsgException - if the proxy count is not defined.

parseURLEncodedRequest

public static FSScoping parseURLEncodedRequest(javax.servlet.http.HttpServletRequest request)

Parses the http requests and creates a scoping object.

Parameters:

request - HttpServletRequest to retrieve query parameters.

Returns:

FSScoping object.