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

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

public class FSAuthnRequestEnvelope
extends Object

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

コンストラクタの概要

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.

メソッドの概要

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.

コンストラクタの詳細

FSAuthnRequestEnvelope

public FSAuthnRequestEnvelope()

Default Constructor.

FSAuthnRequestEnvelope

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

Constructs a new FSAuthnRequestEnvelope object.

パラメータ:

authnRequest - the authentication request

providerID - the provider's identifier

providerName - name of the provider

assertionConsumerServiceURL - absolute url of the assertion consumer service

idpList - list of identity providers

isPassive - true if identity provider must not interact with the Principal.

FSAuthnRequestEnvelope

public FSAuthnRequestEnvelope(Element root)
                       throws FSMsgException

Constructs a new FSAuthnRequestEnvelope object from a Document Element.

パラメータ:

root - the Document Element .

例外:

FSMsgException - if there is an error creating this object.

メソッドの詳細

getMinorVersion

public int getMinorVersion()

Returns the value of MinorVersion property.

戻り値:

the value of MinorVersion property.

setMinorVersion

public void setMinorVersion(int minorVersion)

Sets the value of MinorVersion property.

パラメータ:

minorVersion - the value of MinorVersion property.

関連項目:

FSAuthnRequestEnvelope.setMinorVersion(int)

toXMLString

public String toXMLString()
                   throws FSMsgException

Returns the request as an XML Document String based on the Liberty Request schema.

戻り値:

XML String representing the request.

例外:

FSMsgException - if there is an error.

FSMsgException

toXMLString

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

Creates a String representation of the <lib:AuthnRequest> element.

パラメータ:

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.

戻り値:

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 <lib:AuthnRequest> element.

パラメータ:

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

例外:

FSMsgException - if there is an error.

FSMsgException

parseXML

public static FSAuthnRequestEnvelope parseXML(String xml)
                                       throws FSMsgException

Returns the FSAuthnRequestEnvelope object.

パラメータ:

xml - the XML string to create this object from

戻り値:

FSAuthnRequestEnvelope object.

例外:

FSMsgException - if there is error creating the object.

getAssertionConsumerServiceURL

public String getAssertionConsumerServiceURL()

Returns the value of AssertionConsumerServiceURL attribute.

戻り値:

the value of AssertionConsumerServiceURL attribute.

関連項目:

FSAuthnRequestEnvelope.setAssertionConsumerServiceURL(String)

setAssertionConsumerServiceURL

public void setAssertionConsumerServiceURL(String assertionConsumerURL)

Sets the value of AssertionConsumerServiceURL attribute.

パラメータ:

assertionConsumerURL - the value of AssertionConsumerServiceURL attribute.

関連項目:

FSAuthnRequestEnvelope.getAssertionConsumerServiceURL()

getAuthnRequest

public FSAuthnRequest getAuthnRequest()

Returns the FSAuthnRequest object.

戻り値:

the FSAuthnRequest object.

関連項目:

FSAuthnRequestEnvelope.setAuthnRequest(FSAuthnRequest)

setAuthnRequest

public void setAuthnRequest(FSAuthnRequest authnRequest)

Sets the FSAuthnRequest object.

パラメータ:

authnRequest - the FSAuthnRequest object.

関連項目:

FSAuthnRequestEnvelope.getAuthnRequest()

getIDPList

public FSIDPList getIDPList()

Returns the FSIDPList object. return the FSIDPList object.

関連項目:

FSAuthnRequestEnvelope.setIDPList(FSIDPList)

setIDPList

public void setIDPList(FSIDPList idpList)

Sets the FSIDPList object.

パラメータ:

idpList - the FSIDPList object.

関連項目:

FSAuthnRequestEnvelope.getIDPList()

getOtherElements

public List getOtherElements()

Returns a list of elements.

戻り値:

list of elements.

関連項目:

FSAuthnRequestEnvelope.setOtherElements(List)

setOtherElements

public void setOtherElements(List otherElements)

Sets a list of elements.

パラメータ:

otherElements - a list of elements.

関連項目:

FSAuthnRequestEnvelope.getOtherElements()

parseBASE64EncodedString

public static FSAuthnRequestEnvelope parseBASE64EncodedString(String encodedReq)
                                                       throws FSMsgException

Returns 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

toBASE64EncodedString

public String toBASE64EncodedString()
                             throws FSMsgException

Returns a Base64 Encoded Authentication Request String.

戻り値:

a Base64 Encoded Authentication Request String.

例外:

FSMsgException - if there is an error encoding the string.