com.sun.identity.federation.message
クラス FSAuthnResponseEnvelope

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

public class FSAuthnResponseEnvelope
extends Object

This class defines methods for setting and retrieving attributes and elements associated with a Liberty Response .

コンストラクタの概要

FSAuthnResponseEnvelope()
Default Constructor.

FSAuthnResponseEnvelope(Element root)
Constructor create FSAuthnResponseEnvelope object.

FSAuthnResponseEnvelope(FSAuthnResponse authnResponse)
Constructor create FSAuthnResponseEnvelope object.

メソッドの概要

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 attribute.
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 object.
String	toXMLString(boolean includeNS, boolean declareNS, boolean includeHeader) Creates a String representation of the Response object.

コンストラクタの詳細

FSAuthnResponseEnvelope

public FSAuthnResponseEnvelope()

Default Constructor.

FSAuthnResponseEnvelope

public FSAuthnResponseEnvelope(FSAuthnResponse authnResponse)

Constructor create FSAuthnResponseEnvelope object.

パラメータ:

authnResponse - the FSAuthnResponse object.

FSAuthnResponseEnvelope

public FSAuthnResponseEnvelope(Element root)
                        throws FSMsgException,
                               SAMLException

Constructor create FSAuthnResponseEnvelope object.

パラメータ:

root - the Document element .

例外:

FSMsgException - if there is an error creating the object.

SAMLException - if there is an error creating the object.

メソッドの詳細

getMinorVersion

public int getMinorVersion()

Returns the value of MinorVersion attribute.

戻り値:

the value of MinorVersion attribute.

関連項目:

FSAuthnResponseEnvelope.setMinorVersion(int)

setMinorVersion

public void setMinorVersion(int minorVersion)

Sets the value of MinorVersion attribute.

パラメータ:

minorVersion - the MinorVersion attribute.

getOtherElements

public List getOtherElements()

Returns a list of elements.

戻り値:

list of elements.

関連項目:

FSAuthnResponseEnvelope.setOtherElements(List)

setOtherElements

public void setOtherElements(List otherElement)

Sets a list of elements.

パラメータ:

otherElement - a list of elements.

関連項目:

FSAuthnResponseEnvelope.getOtherElements()

getAuthnResponse

public FSAuthnResponse getAuthnResponse()

Returns the FSAuthnResponse object.

戻り値:

the FSAuthnResponse object.

関連項目:

FSAuthnResponseEnvelope.setAuthnResponse(FSAuthnResponse)

setAuthnResponse

public void setAuthnResponse(FSAuthnResponse authnResponse)

Sets the FSAuthnResponse object.

パラメータ:

authnResponse - the FSAuthnResponse object.

関連項目:

FSAuthnResponseEnvelope.getAuthnResponse()

getAssertionConsumerServiceURL

public String getAssertionConsumerServiceURL()

Returns the Assertion Consumer Service URL.

戻り値:

the Assertion Consumer Service URL.

関連項目:

FSAuthnResponseEnvelope.setAssertionConsumerServiceURL(String)

setAssertionConsumerServiceURL

public void setAssertionConsumerServiceURL(String assertionConsumerUrl)

Sets the Assertion Consumer Service URL.

パラメータ:

assertionConsumerUrl - the Assertion Consumer Service Identifier.

関連項目:

FSAuthnResponseEnvelope.getAssertionConsumerServiceURL()

parseXML

public static FSAuthnResponseEnvelope parseXML(String xml)
                                        throws FSMsgException

Returns the FSAuthnResponseEnvelope object.

パラメータ:

xml - the XML string to create this object from

戻り値:

FSAuthnResponseEnvelope object.

例外:

FSMsgException - if there is error creating the object.

toXMLString

public String toXMLString()
                   throws FSMsgException

Returns XML document String for this object based on the Response Schema.

戻り値:

XML String representing the Response

例外:

FSMsgException - if there is an error.

toXMLString

public String toXMLString(boolean includeNS,
                          boolean declareNS)
                   throws FSMsgException

Creates a String representation of the Response object.

パラメータ:

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.

戻り値:

A string containing the valid XML for this element.

例外:

FSMsgException - if there is an error.

toXMLString

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

Creates a String representation of the Response object.

パラメータ:

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.

戻り値:

a string containing the valid XML for this object.

例外:

FSMsgException - if there is an error.

toBASE64EncodedString

public String toBASE64EncodedString()
                             throws FSMsgException

Returns a Base64 Encoded String.

戻り値:

a Base64 Encoded String.

例外:

FSMsgException - if there is an error encoding the string.

parseBASE64EncodedString

public static FSAuthnResponseEnvelope parseBASE64EncodedString(String encodedReq)
                                                        throws FSMsgException

Returns 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.