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 or parse NameIdentifierMappingResponse.

Constructor Summary

FSNameIdentifierMappingResponse(org.w3c.dom.Element root)
Constructor

FSNameIdentifierMappingResponse(java.lang.String providerID, java.lang.String inResponseTo, Status status, NameIdentifier nameIdentifier)
Constructor

Method Summary

NameIdentifier	getNameIdentifier() Get the resulting mapped name identifier for the desired identity federation
java.lang.String	getProviderID() Get the responding service provider's ID
Status	getStatus() Get the status of request reception and processing
static FSNameIdentifierMappingResponse	parseXML(java.lang.String xml) Parse the XML and creates an Response
void	signXML() Sign the XML document representing NameIdentifierMappingResponse using the certificate indicated by the property "com.sun.identity.saml.xmlsig.certalias" in AMConfig.properties file
void	signXML(java.lang.String certAlias) Sign the XML document representing NameIdentifierMappingResponse using the specified certificate.
java.lang.String	toXMLString() Gets a String representation of the FSNameIdentifierMappingResponse element.
java.lang.String	toXMLString(boolean includeNS, boolean declareNS) Gets a String representation of the FSNameIdentifierMappingResponse element.
java.lang.String	toXMLString(boolean includeNS, boolean declareNS, boolean includeHeader) Gets a String representation of the FSNameIdentifierMappingResponse element.

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FSNameIdentifierMappingResponse

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

Constructor

Parameters:

inResponseTo - the original request ID

status - the status code indicating the reception and processing status of the message

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

Throws:

FSMsgException

FSNameIdentifierMappingResponse

public FSNameIdentifierMappingResponse(org.w3c.dom.Element root)
                                throws FSMsgException

Constructor

Parameters:

root - NameIdentifierMappingResponse XML root element

Throws:

FSMsgException

Method Detail

parseXML

public static FSNameIdentifierMappingResponse parseXML(java.lang.String xml)
                                                throws FSMsgException

Parse the XML and creates an Response

Parameters:

xml - XML String

Returns:

FSNameIdentifierMappingResponse NameIdentifierMappingResponse

Throws:

FSMsgException

getProviderID

public java.lang.String getProviderID()

Get the responding service provider's ID

Returns:

String the responding service provider's ID

getStatus

public Status getStatus()

Get the status of request reception and processing

Returns:

Status the status of request reception and processing

getNameIdentifier

public NameIdentifier getNameIdentifier()

Get the resulting mapped name identifier for the desired identity federation

Returns:

NameIdentifier the resulting mapped name identifier for the desired identity federation

signXML

public void signXML()
             throws SAMLException

Sign 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 unable to sign the object.

signXML

public void signXML(java.lang.String certAlias)
             throws SAMLException

Sign 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 unable to sign the object.

toXMLString

public java.lang.String toXMLString()
                             throws FSMsgException

Gets a String representation of the FSNameIdentifierMappingResponse element.

Returns:

A string containing the valid XML for this element

Throws:

FSMsgException - if unable to get the XML string.

toXMLString

public java.lang.String toXMLString(boolean includeNS,
                                    boolean declareNS)
                             throws FSMsgException

Gets a String representation of the FSNameIdentifierMappingResponse element.

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 unable to get the XML string.

toXMLString

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

Gets a String representation of the FSNameIdentifierMappingResponse element.

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 unable to get the XML string.