|
|||||||||
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
public class FSAuthnRequestEnvelope
This class defines methods for setting and retrieving attributes and elements associated with a Liberty Authentication Request.
Constructor Summary | |
---|---|
FSAuthnRequestEnvelope()
Default Constructor. |
|
FSAuthnRequestEnvelope(Element root)
Constructs a new FSAuthnRequestEnvelope object
from a Document Element. |
|
FSAuthnRequestEnvelope(FSAuthnRequest authnRequest,
String providerID,
String providerName,
String assertionConsumerServiceURL,
FSIDPList idpList,
boolean isPassive)
Constructs a new FSAuthnRequestEnvelope object. |
Method Summary | |
---|---|
String |
getAssertionConsumerServiceURL()
Returns the value of AssertionConsumerServiceURL attribute. |
FSAuthnRequest |
getAuthnRequest()
Returns the FSAuthnRequest object. |
FSIDPList |
getIDPList()
Returns the FSIDPList object. |
int |
getMinorVersion()
Returns the value of MinorVersion property. |
List |
getOtherElements()
Returns a list of elements. |
static FSAuthnRequestEnvelope |
parseBASE64EncodedString(String encodedReq)
Returns FSAuthnRequestEnvelope object. |
static FSAuthnRequestEnvelope |
parseXML(String xml)
Returns the FSAuthnRequestEnvelope object. |
void |
setAssertionConsumerServiceURL(String assertionConsumerURL)
Sets the value of AssertionConsumerServiceURL attribute. |
void |
setAuthnRequest(FSAuthnRequest authnRequest)
Sets the FSAuthnRequest object. |
void |
setIDPList(FSIDPList idpList)
Sets the FSIDPList object. |
void |
setMinorVersion(int minorVersion)
Sets the value of MinorVersion property. |
void |
setOtherElements(List otherElements)
Sets a list of elements. |
String |
toBASE64EncodedString()
Returns a Base64 Encoded Authentication Request String. |
String |
toXMLString()
Returns the request as an XML Document String based on the Liberty Request schema. |
String |
toXMLString(boolean includeNS,
boolean declareNS)
Creates a String representation of the <lib:AuthnRequest> element. |
String |
toXMLString(boolean includeNS,
boolean declareNS,
boolean includeHeader)
Creates a String representation of the <lib:AuthnRequest> element. |
Constructor Detail |
---|
public FSAuthnRequestEnvelope()
public FSAuthnRequestEnvelope(FSAuthnRequest authnRequest, String providerID, String providerName, String assertionConsumerServiceURL, FSIDPList idpList, boolean isPassive)
FSAuthnRequestEnvelope
object.
authnRequest
- the authentication requestproviderID
- the provider's identifierproviderName
- name of the providerassertionConsumerServiceURL
- absolute url of the assertion
consumer serviceidpList
- list of identity providersisPassive
- true if identity provider must not interact
with the Principal
.public FSAuthnRequestEnvelope(Element root) throws FSMsgException
FSAuthnRequestEnvelope
object
from a Document Element.
root
- the Document Element .
FSMsgException
- if there is an error
creating this object.Method Detail |
---|
public int getMinorVersion()
MinorVersion
property.
MinorVersion
property.public void setMinorVersion(int minorVersion)
MinorVersion
property.
minorVersion
- the value of MinorVersion
property.FSAuthnRequestEnvelope.setMinorVersion(int)
public String toXMLString() throws FSMsgException
FSMsgException
- if there is an error.
FSMsgException
public String toXMLString(boolean includeNS, boolean declareNS) throws FSMsgException
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 there is an error.public String toXMLString(boolean includeNS, boolean declareNS, boolean includeHeader) throws FSMsgException
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 there is an error.
FSMsgException
public static FSAuthnRequestEnvelope parseXML(String xml) throws FSMsgException
FSAuthnRequestEnvelope
object.
xml
- the XML string to create this object from
FSAuthnRequestEnvelope
object.
FSMsgException
- if there is
error creating the object.public String getAssertionConsumerServiceURL()
AssertionConsumerServiceURL
attribute.
AssertionConsumerServiceURL
attribute.FSAuthnRequestEnvelope.setAssertionConsumerServiceURL(String)
public void setAssertionConsumerServiceURL(String assertionConsumerURL)
AssertionConsumerServiceURL
attribute.
assertionConsumerURL
- the value of
AssertionConsumerServiceURL
attribute.FSAuthnRequestEnvelope.getAssertionConsumerServiceURL()
public FSAuthnRequest getAuthnRequest()
FSAuthnRequest
object.
FSAuthnRequest
object.FSAuthnRequestEnvelope.setAuthnRequest(FSAuthnRequest)
public void setAuthnRequest(FSAuthnRequest authnRequest)
FSAuthnRequest
object.
authnRequest
- the FSAuthnRequest
object.FSAuthnRequestEnvelope.getAuthnRequest()
public FSIDPList getIDPList()
FSIDPList
object.
return the FSIDPList
object.
FSAuthnRequestEnvelope.setIDPList(FSIDPList)
public void setIDPList(FSIDPList idpList)
FSIDPList
object.
idpList
- the FSIDPList
object.FSAuthnRequestEnvelope.getIDPList()
public List getOtherElements()
FSAuthnRequestEnvelope.setOtherElements(List)
public void setOtherElements(List otherElements)
otherElements
- a list of elements.FSAuthnRequestEnvelope.getOtherElements()
public static FSAuthnRequestEnvelope parseBASE64EncodedString(String encodedReq) throws FSMsgException
FSAuthnRequestEnvelope
object. The object
is created by parsing an Base64 encode authentication
request String.
encodedReq
- the encoded string.
FSMsgException
- if there is an error
creating FSAuthnRequestEnvelope
object.
FSMsgException
public String toBASE64EncodedString() throws FSMsgException
FSMsgException
- if there is an error encoding
the string.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |