Package com.sun.identity.federation.message

Class FSNameRegistrationResponse

java.lang.Object

com.sun.identity.saml.protocol.AbstractResponse

com.sun.identity.federation.message.FSNameRegistrationResponse

@Deprecated
public class FSNameRegistrationResponse
extends AbstractResponse

Deprecated.

since 12.0.0

This class has methods to create NameRegistrationResponse object.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	id	Deprecated.
protected int	minorVersion	Deprecated.
protected String	signatureString	Deprecated.
protected String	xmlString	Deprecated.

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

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

Constructor Summary

Constructors

Constructor	Description
FSNameRegistrationResponse()	Deprecated. Default Constructor.
FSNameRegistrationResponse(String responseID, String inResponseTo, Status status, String providerId, String relayState)	Deprecated. Constructor creates the FSNameRegistrationResponse object.
FSNameRegistrationResponse(Element root)	Deprecated. Constructor creates the FSNameRegistrationResponse object from Document Element.

Method Summary

Modifier and Type	Method	Description
String	getID()	Deprecated. Returns the value of id attribute.
int	getMinorVersion()	Deprecated. Returns the MinorVersion.
String	getProviderId()	Deprecated. Returns the value of ProviderID attribute.
String	getRelayState()	Deprecated. Returns the value of RelayState attribute.
String	getSignatureString()	Deprecated. Returns the signed NameRegistrationResponse string.
String	getSignedXMLString()	Deprecated. Returns signed XML representation of this object.
Status	getStatus()	Deprecated. Returns the Response Status.
static FSNameRegistrationResponse	parseBASE64EncodedString(String encodedRes)	Deprecated. Returns FSNameRegistrationResponse object.
static FSNameRegistrationResponse	parseURLEncodedRequest(jakarta.servlet.http.HttpServletRequest request)	Deprecated. Returns FSNameRegistrationLogoutResponse object.
static FSNameRegistrationResponse	parseXML(String xml)	Deprecated. Returns the FSNameRegistrationResponse object.
void	setID(String id)	Deprecated. Sets the value of id attribute.
void	setMinorVersion(int version)	Deprecated. Sets the MinorVersion.
void	setProviderId(String providerId)	Deprecated. Sets the value of providerID attribute.
void	setRelayState(String relayState)	Deprecated. Set the value of RelayState attribute.
boolean	setSignature(Element elem)	Deprecated. Sets the Signature.
void	setStatus(Status status)	Deprecated. Sets the Response Status.
void	signXML()	Deprecated. Unsupported operation.
void	signXML(String certAlias)	Deprecated. Signs the Name Registration Response.
String	toBASE64EncodedString()	Deprecated. Returns a Base64 Encoded String.
String	toURLEncodedQueryString()	Deprecated. Returns an URL Encoded String.
String	toXMLString()	Deprecated. Returns the string representation of this object.
String	toXMLString(boolean includeNS, boolean declareNS)	Deprecated. Returns a String representation of the Logout Response.
String	toXMLString(boolean includeNS, boolean declareNS, boolean includeHeader)	Deprecated. Returns a String representation of the Logout Response.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

xmlString

protected String xmlString

Deprecated.

signatureString

protected String signatureString

Deprecated.

id

protected String id

Deprecated.

minorVersion

protected int minorVersion

Deprecated.

Constructor Detail

FSNameRegistrationResponse

public FSNameRegistrationResponse()

Deprecated.

Default Constructor.

FSNameRegistrationResponse

public FSNameRegistrationResponse(String responseID,
                                  String inResponseTo,
                                  Status status,
                                  String providerId,
                                  String relayState)
                           throws FSMsgException

Deprecated.

Constructor creates the FSNameRegistrationResponse object.

Parameters:

responseID - the value of ResponseID attribute.

inResponseTo - the value of InResponseTo attribute.

status - the Status object.

providerId - the value of ProviderID attribute.

relayState - the value of RelayState attribute.

Throws:

FSMsgException - if there is an error creating this object.

FSNameRegistrationResponse

public FSNameRegistrationResponse(Element root)
                           throws FSMsgException,
                                  SAMLException

Deprecated.

Constructor creates the FSNameRegistrationResponse object from Document Element.

Parameters:

root - the Document Element objec.t

Throws:

FSMsgException - if there is an error creating this object.

SAMLException - if there is an error creating this object.

Method Detail

getRelayState

public String getRelayState()

Deprecated.

Returns the value of RelayState attribute.

Returns:

the value of RelayState attribute.

See Also:

setRelayState(String)

setRelayState

public void setRelayState(String relayState)

Deprecated.

Set the value of RelayState attribute.

Parameters:

relayState - the value of RelayState attribute.

See Also:

getRelayState()

getID

public String getID()

Deprecated.

Returns the value of id attribute.

Returns:

the value of id attribute.

See Also:

setID(String)

setID

public void setID(String id)

Deprecated.

Sets the value of id attribute.

Parameters:

id - the value of id attribute.

See Also:

getID()

getProviderId

public String getProviderId()

Deprecated.

Returns the value of ProviderID attribute.

Returns:

the value of ProviderID attribute.

setProviderId

public void setProviderId(String providerId)

Deprecated.

Sets the value of providerID attribute.

Parameters:

providerId - the value of providerID attribute.

See Also:

getProviderId()

getSignedXMLString

public String getSignedXMLString()

Deprecated.

Returns signed XML representation of this object.

Returns:

xmlString signed XML representation of this object.

getSignatureString

public String getSignatureString()

Deprecated.

Returns the signed NameRegistrationResponse string.

Returns:

signatureString the signed NameRegistrationResponse string.

getMinorVersion

public int getMinorVersion()

Deprecated.

Returns the MinorVersion.

Overrides:

getMinorVersion in class AbstractResponse

Returns:

the MinorVersion.

See Also:

setMinorVersion(int)

setMinorVersion

public void setMinorVersion(int version)

Deprecated.

Sets the MinorVersion.

Overrides:

setMinorVersion in class AbstractResponse

Parameters:

version - the MinorVersion.

See Also:

getMinorVersion()

getStatus

public Status getStatus()

Deprecated.

Returns the Response Status.

Returns:

the Response Status.

See Also:

setStatus(Status)

setStatus

public void setStatus(Status status)

Deprecated.

Sets the Response Status.

Parameters:

status - the Response Status

See Also:

getStatus()

parseXML

public static FSNameRegistrationResponse parseXML(String xml)
                                           throws FSMsgException

Deprecated.

Returns the FSNameRegistrationResponse object.

Parameters:

xml - the XML string to be parsed.

Returns:

FSNameRegistrationResponsee object created from the XML string.

Throws:

FSMsgException - if there is error creating the object.

toXMLString

public String toXMLString()
                   throws FSMsgException

Deprecated.

Returns the string representation of this object. This method translates the response to an XML string.

Returns:

An XML String representing the Response.

Throws:

FSMsgException - on error.

toXMLString

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

Deprecated.

Returns a String representation of the Logout Response.

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 to a string.

toXMLString

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

Deprecated.

Returns a String representation of the Logout Response.

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 to a string.

parseBASE64EncodedString

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

Deprecated.

Returns FSNameRegistrationResponse object. The object is created by parsing an Base64 encode Name Registration Response string.

Parameters:

encodedRes - the encoded response string

Throws:

FSMsgException - if there is an error creating this object.

SAMLException - if there is an error creating this object.

toBASE64EncodedString

public String toBASE64EncodedString()
                             throws FSMsgException

Deprecated.

Returns a Base64 Encoded String.

Returns:

a Base64 Encoded String.

Throws:

FSMsgException - if there is an error encoding the string.

signXML

public void signXML(String certAlias)
             throws SAMLException

Deprecated.

Signs the Name Registration Response.

Parameters:

certAlias - the Certificate Alias.

Throws:

SAMLException - if this object cannot be signed.

signXML

public void signXML()
             throws SAMLException

Deprecated.

Unsupported operation.

Specified by:

signXML in class AbstractResponse

Throws:

SAMLException - if could not sign the object.

setSignature

public boolean setSignature(Element elem)

Deprecated.

Sets the Signature.

Overrides:

setSignature in class AbstractResponse

Parameters:

elem - the Document Element.

Returns:

true if success otherwise false.

toURLEncodedQueryString

public String toURLEncodedQueryString()
                               throws FSMsgException

Deprecated.

Returns an URL Encoded String.

Returns:

a url encoded query string.

Throws:

FSMsgException - if there is an error.

parseURLEncodedRequest

public static FSNameRegistrationResponse parseURLEncodedRequest(jakarta.servlet.http.HttpServletRequest request)
                                                         throws FSMsgException,
                                                                SAMLException

Deprecated.

Returns FSNameRegistrationLogoutResponse object. The object is creating by parsing the HttpServletRequest object.

Parameters:

request - the HttpServletRequest object.

Throws:

FSMsgException - if there is an error creating this object.

SAMLException