com.sun.identity.federation.message
Class FSNameIdentifierMappingResponse

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

public class FSNameIdentifierMappingResponse
extends AbstractResponse

The class FSNameIdentifierMappingResponse is used to create , parse the NameIdentifierMappingResponse.

Field Summary

Fields inherited from class com.sun.identity.saml.protocol.AbstractResponse

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

Constructor Summary

FSNameIdentifierMappingResponse(Element root)
Constructor to create FSNameIdentifierMappingResponse object.

FSNameIdentifierMappingResponse(String providerID, String inResponseTo, Status status, NameIdentifier nameIdentifier)
Constructor to create FSNameIdentifierMappingResponse object.

Method Summary

NameIdentifier	getNameIdentifier() Returns the NameIdentifier object.
String	getProviderID() Returns the value of ProviderID attribute.
Status	getStatus() Returns the Status.
static FSNameIdentifierMappingResponse	parseXML(String xml) Creates FSNameIdentifierMappingResponse object.
void	signXML() Signs the XML document representing NameIdentifierMappingResponse using the certificate indicated by the property "com.sun.identity.saml.xmlsig.certalias" in AMConfig.properties file.
void	signXML(String certAlias) Signs the XML document representing NameIdentifierMappingResponse using the specified certificate.
String	toXMLString() Returns the string representation of this object.
String	toXMLString(boolean includeNS, boolean declareNS) Returns a String representation of this object.
String	toXMLString(boolean includeNS, boolean declareNS, boolean includeHeader) Returns a String representation of this object.

Methods inherited from class com.sun.identity.saml.protocol.AbstractResponse

getInResponseTo, getIssueInstant, getMajorVersion, getMinorVersion, getRecipient, getResponseID, getSignature, isSignatureValid, isSigned, setInResponseTo, setIssueInstant, setMajorVersion, setMinorVersion, setRecipient, setResponseID, setSignature

Constructor Detail

FSNameIdentifierMappingResponse

public FSNameIdentifierMappingResponse(String providerID,
                                       String inResponseTo,
                                       Status status,
                                       NameIdentifier nameIdentifier)
                                throws FSMsgException

Constructor to create FSNameIdentifierMappingResponse object.

Parameters:

providerID - the value of ProviderID attribute.

inResponseTo - the value of InResponseTo attribute.

status - the Status object.

nameIdentifier - the resulting mapped identifier, NameIdentifier, for the desired identity federation.

Throws:

FSMsgException - on an error.

FSNameIdentifierMappingResponse

public FSNameIdentifierMappingResponse(Element root)
                                throws FSMsgException

Constructor to create FSNameIdentifierMappingResponse object. This object is created from the Document Element.

Parameters:

root - the NameIdentifierMappingResponse Document Element

Throws:

FSMsgException - if there is an error creating the object.

Method Detail

parseXML

public static FSNameIdentifierMappingResponse parseXML(String xml)
                                                throws FSMsgException

Creates FSNameIdentifierMappingResponse object. This object is created by parsing the XML string.

Parameters:

xml - the XML string to be parse.

Returns:

the FSNameIdentifierMappingResponse object.

Throws:

FSMsgException - if there is an error in parsing the XML string.

getProviderID

public String getProviderID()

Returns the value of ProviderID attribute.

Returns:

the value of ProviderID attribute.

getStatus

public Status getStatus()

Returns the Status.

Returns:

the Status.

getNameIdentifier

public NameIdentifier getNameIdentifier()

Returns the NameIdentifier object. This is the resulting mapped name identifier for the desired identity federation.

Returns:

NameIdentifier object, the resulting mapped name identifier for the desired identity federation

signXML

public void signXML()
             throws SAMLException

Signs the XML document representing NameIdentifierMappingResponse using the certificate indicated by the property "com.sun.identity.saml.xmlsig.certalias" in AMConfig.properties file.

Specified by:

signXML in class AbstractResponse

Throws:

SAMLException - if there is an error signing the XML string.

signXML

public void signXML(String certAlias)
             throws SAMLException

Signs the XML document representing NameIdentifierMappingResponse using the specified certificate.

Parameters:

certAlias - the alias/name of the certificate used for signing the XML document

Throws:

SAMLException - if there is an error signing the XML string or if the message is already signed.

toXMLString

public String toXMLString()
                   throws FSMsgException

Returns the string representation of this object.

Returns:

An XML String representing the object.

Throws:

FSMsgException - on error.

toXMLString

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

Returns a String representation of this object.

Parameters:

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.

Returns:

a string containing the valid XML for this element

Throws:

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

toXMLString

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

Returns a String representation of this object.

Parameters:

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.

Returns:

a string containing the valid XML for this element

Throws:

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