com.sun.identity.federation.message
Class FSNameRegistrationResponse

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

public class FSNameRegistrationResponse
extends AbstractResponse

This class has methods to create NameRegistrationResponse object.

Field Summary

protected String	id
protected int	minorVersion
protected String	signatureString
protected String	xmlString

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

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

Constructor Summary

FSNameRegistrationResponse()
Default Constructor.

FSNameRegistrationResponse(Element root)
Constructor creates the FSNameRegistrationResponse object from Document Element.

FSNameRegistrationResponse(String responseID, String inResponseTo, Status status, String providerId, String relayState)
Constructor creates the FSNameRegistrationResponse object.

Method Summary

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

Field Detail

xmlString

protected String xmlString

signatureString

protected String signatureString

id

protected String id

minorVersion

protected int minorVersion

Constructor Detail

FSNameRegistrationResponse

public FSNameRegistrationResponse()

Default Constructor.

FSNameRegistrationResponse

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

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

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()

Returns the value of RelayState attribute.

Returns:

the value of RelayState attribute.

See Also:

FSNameRegistrationResponse.setRelayState(String)

setRelayState

public void setRelayState(String relayState)

Set the value of RelayState attribute.

Parameters:

relayState - the value of RelayState attribute.

See Also:

FSNameRegistrationResponse.getRelayState()

getID

public String getID()

Returns the value of id attribute.

Returns:

the value of id attribute.

See Also:

FSNameRegistrationResponse.setID(String)

setID

public void setID(String id)

Sets the value of id attribute.

Parameters:

id - the value of id attribute.

See Also:

FSNameRegistrationResponse.getID()

getProviderId

public String getProviderId()

Returns the value of ProviderID attribute.

Returns:

the value of ProviderID attribute.

See Also:

FSNameRegistrationResponse.setProviderId(String).

setProviderId

public void setProviderId(String providerId)

Sets the value of providerID attribute.

Parameters:

providerId - the value of providerID attribute.

See Also:

FSNameRegistrationResponse.getProviderId()

getSignedXMLString

public String getSignedXMLString()

Returns signed XML representation of this object.

Returns:

xmlString signed XML representation of this object.

getSignatureString

public String getSignatureString()

Returns the signed NameRegistrationResponse string.

Returns:

signatureString the signed NameRegistrationResponse string.

getMinorVersion

public int getMinorVersion()

Returns the MinorVersion.

Overrides:

getMinorVersion in class AbstractResponse

Returns:

the MinorVersion.

See Also:

FSNameRegistrationResponse.setMinorVersion(int)

setMinorVersion

public void setMinorVersion(int version)

Sets the MinorVersion.

Overrides:

setMinorVersion in class AbstractResponse

Parameters:

version - the MinorVersion.

See Also:

FSNameRegistrationResponse.getMinorVersion()

getStatus

public Status getStatus()

Returns the Response Status.

Returns:

the Response Status.

See Also:

FSNameRegistrationResponse.setStatus(Status)

setStatus

public void setStatus(Status status)

Sets the Response Status.

Parameters:

status - the Response StatusSee Also:

FSNameRegistrationResponse.getStatus()

parseXML

public static FSNameRegistrationResponse parseXML(String xml)
                                           throws FSMsgException

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

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

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

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

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

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

Signs the Name Registration Response.

Parameters:

certAlias - the Certificate Alias.

Throws:

SAMLException - if this object cannot be signed.

signXML

public void signXML()
             throws SAMLException

Unsupported operation.

Specified by:

signXML in class AbstractResponse

Throws:

SAMLException - if could not sign the object.

setSignature

public boolean setSignature(Element elem)

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

Returns an URL Encoded String.

Returns:

a url encoded query string.

Throws:

FSMsgException - if there is an error.

parseURLEncodedRequest

public static FSNameRegistrationResponse parseURLEncodedRequest(HttpServletRequest request)
                                                         throws FSMsgException,
                                                                SAMLException

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