|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.sun.identity.federation.message.FSAuthnResponseEnvelope
public class FSAuthnResponseEnvelope
This class defines methods for setting and retrieving attributes and elements associated with a Liberty Response .
Constructor Summary | |
---|---|
FSAuthnResponseEnvelope()
Default Constructor. |
|
FSAuthnResponseEnvelope(Element root)
Constructor create FSAuthnResponseEnvelope object. |
|
FSAuthnResponseEnvelope(FSAuthnResponse authnResponse)
Constructor create FSAuthnResponseEnvelope object. |
Method Summary | |
---|---|
String |
getAssertionConsumerServiceURL()
Returns the Assertion Consumer Service URL. |
FSAuthnResponse |
getAuthnResponse()
Returns the FSAuthnResponse object. |
int |
getMinorVersion()
Returns the value of MinorVersion attribute. |
List |
getOtherElements()
Returns a list of elements. |
static FSAuthnResponseEnvelope |
parseBASE64EncodedString(String encodedReq)
Returns FSAuthnResponseEnvelope object. |
static FSAuthnResponseEnvelope |
parseXML(String xml)
Returns the FSAuthnResponseEnvelope object. |
void |
setAssertionConsumerServiceURL(String assertionConsumerUrl)
Sets the Assertion Consumer Service URL. |
void |
setAuthnResponse(FSAuthnResponse authnResponse)
Sets the FSAuthnResponse object. |
void |
setMinorVersion(int minorVersion)
Sets the value of MinorVersion |
void |
setOtherElements(List otherElement)
Sets a list of elements. |
String |
toBASE64EncodedString()
Returns a Base64 Encoded String. |
String |
toXMLString()
Returns XML document String for this object based on the Response Schema. |
String |
toXMLString(boolean includeNS,
boolean declareNS)
Creates a String representation of the Response |
String |
toXMLString(boolean includeNS,
boolean declareNS,
boolean includeHeader)
Creates a String representation of the Response object. |
Constructor Detail |
---|
public FSAuthnResponseEnvelope()
public FSAuthnResponseEnvelope(FSAuthnResponse authnResponse)
FSAuthnResponseEnvelope
object.
authnResponse
- the FSAuthnResponse
object.public FSAuthnResponseEnvelope(Element root) throws FSMsgException, SAMLException
FSAuthnResponseEnvelope
object.
root
- the Document element .
FSMsgException
- if there is an error creating the object.
SAMLException
- if there is an error creating the object.Method Detail |
---|
public int getMinorVersion()
MinorVersion
attribute.
MinorVersion
attribute.FSAuthnResponseEnvelope.setMinorVersion(int)
public void setMinorVersion(int minorVersion)
MinorVersion attribute.
- Parameters:
minorVersion
- the MinorVersion
attribute.
public List getOtherElements()
FSAuthnResponseEnvelope.setOtherElements(List)
public void setOtherElements(List otherElement)
otherElement
- a list of elements.FSAuthnResponseEnvelope.getOtherElements()
public FSAuthnResponse getAuthnResponse()
FSAuthnResponse
object.
FSAuthnResponse
object.FSAuthnResponseEnvelope.setAuthnResponse(FSAuthnResponse)
public void setAuthnResponse(FSAuthnResponse authnResponse)
FSAuthnResponse
object.
authnResponse
- the FSAuthnResponse
object.FSAuthnResponseEnvelope.getAuthnResponse()
public String getAssertionConsumerServiceURL()
FSAuthnResponseEnvelope.setAssertionConsumerServiceURL(String)
public void setAssertionConsumerServiceURL(String assertionConsumerUrl)
assertionConsumerUrl
- the Assertion Consumer Service Identifier.FSAuthnResponseEnvelope.getAssertionConsumerServiceURL()
public static FSAuthnResponseEnvelope parseXML(String xml) throws FSMsgException
FSAuthnResponseEnvelope
object.
xml
- the XML string to create this object from
FSAuthnResponseEnvelope
object.
FSMsgException
- if there is error creating the object.public String toXMLString() throws FSMsgException
Response
FSMsgException
- if there is an error.public String toXMLString(boolean includeNS, boolean declareNS) throws FSMsgException
Response object.
- Parameters:
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.
- Returns:
- A string containing the valid XML for this element.
- Throws:
FSMsgException
- if there is an error.
public String toXMLString(boolean includeNS, boolean declareNS, boolean includeHeader) throws FSMsgException
Response
object.
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.public String toBASE64EncodedString() throws FSMsgException
Base64
Encoded String.
Base64
Encoded String.
FSMsgException
- if there is an error encoding
the string.public static FSAuthnResponseEnvelope parseBASE64EncodedString(String encodedReq) throws FSMsgException
FSAuthnResponseEnvelope
object. The
object is creating by parsing the Base64
encoded XML
string.
encodedReq
- the Based64
encoded XML
string.
FSMsgException
- if there is an error
creating FSAuthnResponseEnvelope
object.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |