com.sun.identity.federation.message
Class FSNameIdentifierMappingRequest

java.lang.Object
  com.sun.identity.saml.protocol.AbstractRequest
      com.sun.identity.federation.message.FSNameIdentifierMappingRequest

public class FSNameIdentifierMappingRequest

extends AbstractRequest

The class FSNameIdentifierMappingRequest is used to create or parse NameIdentifierMappingRequest.

Constructor Summary

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

FSNameIdentifierMappingRequest(java.lang.String providerID, NameIdentifier nameIdentifier, java.lang.String targetNamespace)
Constructor

Method Summary

NameIdentifier	getNameIdentifier() Get the Name Identifier qualified by the requesting service provider
java.lang.String	getProviderID() Get the requesting service provider's ID
java.lang.String	getTargetNamespace() Get the provider ID of the other service provider which the requesting service provider would subsequently communicate with
static FSNameIdentifierMappingRequest	parseXML(java.lang.String xml) Parse the XML and creates an Request
void	signXML() Sign the XML document representing NameIdentifierMappingRequest 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 NameIdentifierMappingRequest using the specified certificate.
java.lang.String	toXMLString() Gets a String representation of the FSNameIdentifierMappingRequest element.
java.lang.String	toXMLString(boolean includeNS, boolean declareNS) Gets a String representation of the FSNameIdentifierMappingRequest element.
java.lang.String	toXMLString(boolean includeNS, boolean declareNS, boolean includeHeader) Gets a String representation of the FSNameIdentifierMappingRequest element.

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

addRespondWith, getIssueInstant, getMajorVersion, getMinorVersion, getRequestID, getRespondWith, getSignature, isSignatureValid, isSigned, setIssueInstant, setMajorVersion, setMinorVersion, setRequestID, setSignature

Methods inherited from class java.lang.Object

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

Constructor Detail

FSNameIdentifierMappingRequest

public FSNameIdentifierMappingRequest(java.lang.String providerID,
                                      NameIdentifier nameIdentifier,
                                      java.lang.String targetNamespace)
                               throws FSMsgException

Constructor

Parameters:

nameIdentifier - the name ID qualified by the requesting service provider

targetNamespace - the provider ID of the other service provider which the requesting service provider would subsequently communicate with

Throws:

FSMsgException

FSNameIdentifierMappingRequest

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

Constructor

Parameters:

root - NameIdentifierMappingRequest XML root element

Throws:

FSMsgException

Method Detail

parseXML

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

Parse the XML and creates an Request

Parameters:

xml - XML String

Returns:

FSNameIdentifierMappingRequest NameIdentifierMappingRequest

Throws:

FSMsgException

getProviderID

public java.lang.String getProviderID()

Get the requesting service provider's ID

Returns:

String the requesting service provider's ID

getNameIdentifier

public NameIdentifier getNameIdentifier()

Get the Name Identifier qualified by the requesting service provider

Returns:

String the Name Identifier qualified by the requesting service provider

getTargetNamespace

public java.lang.String getTargetNamespace()

Get the provider ID of the other service provider which the requesting service provider would subsequently communicate with

Returns:

the remote service provider's ID

signXML

public void signXML()
             throws SAMLException

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

Specified by:

signXML in class AbstractRequest

Throws:

SAMLException - if unable to sign the request.

signXML

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

Sign the XML document representing NameIdentifierMappingRequest 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 request.

toXMLString

public java.lang.String toXMLString()
                             throws FSMsgException

Gets a String representation of the FSNameIdentifierMappingRequest 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 FSNameIdentifierMappingRequest 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 FSNameIdentifierMappingRequest 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.