com.sun.identity.federation.message
Class FSAuthnRequestEnvelope

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

public class FSAuthnRequestEnvelope

extends java.lang.Object

This class FSAuthnRequestEnvelope is used to create and/or parse authentication request envelop.

Constructor Summary

FSAuthnRequestEnvelope()
Default AuthnRequest constructor

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

FSAuthnRequestEnvelope(FSAuthnRequest authnRequest, java.lang.String providerID, java.lang.String providerName, java.lang.String assertionConsumerServiceURL, FSIDPList idpList, boolean isPassive)
Constructor

Method Summary

java.lang.String	getAssertionConsumerServiceURL() Gets AssertionConsumerServiceURL parameter.
FSAuthnRequest	getAuthnRequest() Gets AuthnRequest object
FSIDPList	getIDPList() Gets IDPList object
int	getMinorVersion() Gets minor version
java.util.List	getOtherElements() Gets Other element
static FSAuthnRequestEnvelope	parseBASE64EncodedString(java.lang.String encodedReq) Gets the FSAuthnRequestEnvelope from the BASE64 encoded format.
static FSAuthnRequestEnvelope	parseXML(java.lang.String xml) Parse the XML and creates an XML RequestEnvelope
void	setAssertionConsumerServiceURL(java.lang.String assertionConsumerUrl) Sets AssertionConsumerServiceURL parameter.
void	setAuthnRequest(FSAuthnRequest authnRequest) Sets AuthnRequest object
void	setIDPList(FSIDPList idpList) Sets IDPList object
void	setMinorVersion(int minorVersion) Sets minor version
void	setOtherElements(java.util.List otherElements) Sets Other element
java.lang.String	toBASE64EncodedString() Gets the BASE 64 encoded format of the object
java.lang.String	toXMLString() Creates a String representation of the AuthnRequestEnvelop element.
java.lang.String	toXMLString(boolean includeNS, boolean declareNS) Creates a String representation of the AuthnRequestEnvelope element.
java.lang.String	toXMLString(boolean includeNS, boolean declareNS, boolean includeHeader) Creates a String representation of the AuthnRequestEnvelope element.

Methods inherited from class java.lang.Object

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

Constructor Detail

FSAuthnRequestEnvelope

public FSAuthnRequestEnvelope()

Default AuthnRequest constructor

FSAuthnRequestEnvelope

public FSAuthnRequestEnvelope(FSAuthnRequest authnRequest,
                              java.lang.String providerID,
                              java.lang.String providerName,
                              java.lang.String assertionConsumerServiceURL,
                              FSIDPList idpList,
                              boolean isPassive)

Constructor

Parameters:

authnRequest - FSAuthnRequest object

providerID - provider ID

providerName - provider name

assertionConsumerServiceURL - assertion consumer service URL

idpList - IDPList

isPassive - true if IsPassive attribute is true, false otherwise

FSAuthnRequestEnvelope

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

Constructor

Parameters:

root - XML element

Throws:

FSMsgException - if error occurs during parsing

Method Detail

getMinorVersion

public int getMinorVersion()

Gets minor version

Returns:

minor version

setMinorVersion

public void setMinorVersion(int minorVersion)

Sets minor version

Parameters:

minorVersion - minor version to be set

toXMLString

public java.lang.String toXMLString()
                             throws FSMsgException

Creates a String representation of the AuthnRequestEnvelop element.

Returns:

XML String representing the request.

Throws:

FSMsgException - if error occurs.

toXMLString

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

Creates a String representation of the AuthnRequestEnvelope element.

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:

XML String representing the request.

Throws:

FSMsgException - if error occurs.

toXMLString

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

Creates a String representation of the AuthnRequestEnvelope element.

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.

includeHeader - Determines whether the output include the xml declaration header.

Returns:

A string containing the valid XML for this element

Throws:

FSMsgException - if error occurs.

parseXML

public static FSAuthnRequestEnvelope parseXML(java.lang.String xml)
                                       throws FSMsgException

Parse the XML and creates an XML RequestEnvelope

Parameters:

xml - XML String

Returns:

FSAuthnRequestEnvelope object

Throws:

FSMsgException - if unable to parse the XML string.

getAssertionConsumerServiceURL

public java.lang.String getAssertionConsumerServiceURL()

Gets AssertionConsumerServiceURL parameter.

Returns:

assertion consumer service URL

setAssertionConsumerServiceURL

public void setAssertionConsumerServiceURL(java.lang.String assertionConsumerUrl)

Sets AssertionConsumerServiceURL parameter.

Parameters:

assertionConsumerUrl - assertion consumer service URL to be set.

getAuthnRequest

public FSAuthnRequest getAuthnRequest()

Gets AuthnRequest object

Returns:

AuthnRequest object

setAuthnRequest

public void setAuthnRequest(FSAuthnRequest authnRequest)

Sets AuthnRequest object

Parameters:

authnRequest - AuthnRequest object to be set

getIDPList

public FSIDPList getIDPList()

Gets IDPList object

Returns:

IDPList

setIDPList

public void setIDPList(FSIDPList idpList)

Sets IDPList object

Parameters:

idpList - IDPList to be set.

getOtherElements

public java.util.List getOtherElements()

Gets Other element

Returns:

List of Other Elements as String.

setOtherElements

public void setOtherElements(java.util.List otherElements)

Sets Other element

Parameters:

otherElements - List of Other Elements to be set.

parseBASE64EncodedString

public static FSAuthnRequestEnvelope parseBASE64EncodedString(java.lang.String encodedReq)
                                                       throws FSMsgException

Gets the FSAuthnRequestEnvelope from the BASE64 encoded format.

Parameters:

encodedReq - FSAuthnRequestEnvelope in BASE64 encoded string.

Returns:

the FSAuthnRequestEnvelope object.

Throws:

FSMsgException - if unable to construct the object.

toBASE64EncodedString

public java.lang.String toBASE64EncodedString()
                                       throws FSMsgException

Gets the BASE 64 encoded format of the object

Returns:

BASE 64 encoded string of the object

Throws:

FSMsgException - if unable to get the BASE 64 encoded format.