|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.sun.identity.federation.message.FSAuthnRequestEnvelope
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 |
public FSAuthnRequestEnvelope()
public FSAuthnRequestEnvelope(FSAuthnRequest authnRequest, java.lang.String providerID, java.lang.String providerName, java.lang.String assertionConsumerServiceURL, FSIDPList idpList, boolean isPassive)
authnRequest
- FSAuthnRequest
objectproviderID
- provider IDproviderName
- provider nameassertionConsumerServiceURL
- assertion consumer service URLidpList
- IDPListisPassive
- true if IsPassive
attribute is true,
false otherwisepublic FSAuthnRequestEnvelope(org.w3c.dom.Element root) throws FSMsgException
root
- XML element
FSMsgException
- if error occurs during parsingMethod Detail |
public int getMinorVersion()
public void setMinorVersion(int minorVersion)
minorVersion
- minor version to be setpublic java.lang.String toXMLString() throws FSMsgException
AuthnRequestEnvelop
element.
FSMsgException
- if error occurs.public java.lang.String toXMLString(boolean includeNS, boolean declareNS) throws FSMsgException
AuthnRequestEnvelope
element.
includeNS
- Determines whether or not the namespace qualifier
is prepended to the Element when converteddeclareNS
- Determines whether or not the namespace is declared
within the Element.
FSMsgException
- if error occurs.public java.lang.String toXMLString(boolean includeNS, boolean declareNS, boolean includeHeader) throws FSMsgException
AuthnRequestEnvelope
element.
includeNS
- Determines whether or not the namespace qualifier
is prepended to the Element when converteddeclareNS
- Determines whether or not the namespace is declared
within the Element.includeHeader
- Determines whether the output include the xml
declaration header.
FSMsgException
- if error occurs.public static FSAuthnRequestEnvelope parseXML(java.lang.String xml) throws FSMsgException
xml
- XML String
FSMsgException
- if unable to parse the XML string.public java.lang.String getAssertionConsumerServiceURL()
AssertionConsumerServiceURL
parameter.
public void setAssertionConsumerServiceURL(java.lang.String assertionConsumerUrl)
AssertionConsumerServiceURL
parameter.
assertionConsumerUrl
- assertion consumer service URL to be set.public FSAuthnRequest getAuthnRequest()
AuthnRequest
object
AuthnRequest
objectpublic void setAuthnRequest(FSAuthnRequest authnRequest)
AuthnRequest
object
authnRequest
- AuthnRequest
object to be setpublic FSIDPList getIDPList()
IDPList
object
IDPList
public void setIDPList(FSIDPList idpList)
IDPList
object
idpList
- IDPList
to be set.public java.util.List getOtherElements()
public void setOtherElements(java.util.List otherElements)
otherElements
- List of Other Elements to be set.public static FSAuthnRequestEnvelope parseBASE64EncodedString(java.lang.String encodedReq) throws FSMsgException
FSAuthnRequestEnvelope
from the BASE64 encoded format.
encodedReq
- FSAuthnRequestEnvelope
in BASE64
encoded string.
FSAuthnRequestEnvelope
object.
FSMsgException
- if unable to construct the object.public java.lang.String toBASE64EncodedString() throws FSMsgException
FSMsgException
- if unable to get the BASE 64 encoded format.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |