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

java.lang.Object
  com.sun.identity.saml.protocol.AbstractResponse
      com.sun.identity.saml.protocol.Response
          com.sun.identity.federation.message.FSResponse

public class FSResponse
extends Response

This class contains methods for creating a Liberty Response.

フィールドの概要

protected String

id

クラス com.sun.identity.saml.protocol.Response から継承されたフィールド

assertions, issuer, signatureString, status, xmlString

クラス com.sun.identity.saml.protocol.AbstractResponse から継承されたフィールド

inResponseTo, issueInstant, majorVersion, minorVersion, recipient, responseID, signature, signed, valid, validationDone

コンストラクタの概要

FSResponse(Element root)
Constructor creates FSResponse object form a Document Element.

FSResponse(String responseID, String inResponseTo, Status status, List contents)
Constructor creates FSResponse object.

メソッドの概要

String	getID() Returns the value of id attribute.
int	getMinorVersion() Returns the MinorVersion.
String	getSignatureString() Returns the signed XML string.
static FSResponse	parseBASE64EncodedString(String encodedRes) Returns FSResponse object.
static FSResponse	parseResponseXML(String xml)
void	setID(String id) Sets the value of id attribute.
void	setMinorVersion(int version) Sets the MinorVersion.
void	signXML() Unsupported operation.
void	signXML(String certAlias) Signs the Response.
String	toBASE64EncodedString() Returns a Base64 Encoded String.
String	toXMLString() Returns a String representation of the Logout Response.
String	toXMLString(boolean includeNS, boolean declareNS) Returns a String representation of the Logout Response.
String	toXMLString(boolean includeNS, boolean declareNS, boolean includeHeader)

クラス com.sun.identity.saml.protocol.Response から継承されたメソッド

addAssertion, getAssertion, getStatus, isSignatureValid, parseXML, parseXML, setSignature, setStatus, toString, toString, toString

クラス com.sun.identity.saml.protocol.AbstractResponse から継承されたメソッド

getInResponseTo, getIssueInstant, getMajorVersion, getRecipient, getResponseID, getSignature, isSigned, setInResponseTo, setIssueInstant, setMajorVersion, setRecipient, setResponseID

フィールドの詳細

id

protected String id

コンストラクタの詳細

FSResponse

public FSResponse(String responseID,
                  String inResponseTo,
                  Status status,
                  List contents)
           throws SAMLException,
                  FSMsgException

Constructor creates FSResponse object.

パラメータ:

responseID - value of ResponseId attribute.

inResponseTo - value of inResponseTo attribute.

status - the Status object.

contents - list containing response elements.

例外:

SAMLException - it there is an error creating this object.

FSMsgException - it there is an error creating this object.

FSResponse

public FSResponse(Element root)
           throws SAMLException,
                  FSMsgException

Constructor creates FSResponse object form a Document Element.

パラメータ:

root - the Document Element object.

例外:

SAMLException - if there is an error creating this object.

FSMsgException - if there is an error creating this object.

メソッドの詳細

getID

public String getID()

Returns the value of id attribute.

戻り値:

the value of id attribute.

関連項目:

FSResponse.setID(String)

setID

public void setID(String id)

Sets the value of id attribute.

パラメータ:

id - the value of id attribute.

関連項目:

FSResponse.getID()

getSignatureString

public String getSignatureString()

Returns the signed XML string.

戻り値:

the signed XML string.

getMinorVersion

public int getMinorVersion()

Returns the MinorVersion.

オーバーライド:

クラス AbstractResponse 内の getMinorVersion

戻り値:

the MinorVersion.

関連項目:

FSResponse.setMinorVersion(int)

setMinorVersion

public void setMinorVersion(int version)

Sets the MinorVersion.

オーバーライド:

クラス AbstractResponse 内の setMinorVersion

パラメータ:

version - the MinorVersion.

関連項目:

FSResponse.getMinorVersion()

parseResponseXML

public static FSResponse parseResponseXML(String xml)
                                   throws SAMLException,
                                          FSMsgException

例外:

SAMLException

FSMsgException

toXMLString

public String toXMLString()
                   throws FSMsgException

Returns a String representation of the Logout Response.

戻り値:

a string containing the valid XML for this element

例外:

FSMsgException - if there is an error converting this object to a string.

toXMLString

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

Returns a String representation of the Logout Response.

パラメータ:

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 converting this object ot a string.

toXMLString

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

例外:

FSMsgException

parseBASE64EncodedString

public static FSResponse parseBASE64EncodedString(String encodedRes)
                                           throws FSMsgException,
                                                  SAMLException

Returns FSResponse object. The object is created by parsing an Base64 encoded response string.

パラメータ:

encodedRes - the encoded response string

例外:

FSMsgException - if there is an error creating FSResponse object.

FSMsgException - if there is an error creating FSResponse object.

SAMLException

toBASE64EncodedString

public String toBASE64EncodedString()
                             throws FSMsgException

Returns a Base64 Encoded String.

戻り値:

a Base64 Encoded String.

例外:

FSMsgException - if there is an error encoding the string.

signXML

public void signXML(String certAlias)
             throws SAMLException

Signs the Response.

パラメータ:

certAlias - the Certificate Alias.

例外:

XMLSignatureException - if FSAuthnRequest cannot be signed.

SAMLException

signXML

public void signXML()
             throws SAMLException

Unsupported operation.

オーバーライド:

クラス Response 内の signXML

例外:

SAMLException - if could not sign the Response.