com.sun.identity.federation.message
Class FSAuthnResponseEnvelope

java.lang.Object
  extended bycom.sun.identity.federation.message.FSAuthnResponseEnvelope

public class FSAuthnResponseEnvelope
extends java.lang.Object

This class FSAuthnResponse is used to create/parse an ID-FF authentication response envelop.


Constructor Summary
FSAuthnResponseEnvelope()
          Default constructor
FSAuthnResponseEnvelope(org.w3c.dom.Element root)
          Constructor.
FSAuthnResponseEnvelope(FSAuthnResponse authnResponse)
          Constructor
 
Method Summary
 java.lang.String getAssertionConsumerServiceURL()
          Gets AssertionConsumerServiceURL parameter.
 FSAuthnResponse getAuthnResponse()
          Gets the response object.
 int getMinorVersion()
          Gets the minor version.
 java.util.List getOtherElements()
          Gets Other element
static FSAuthnResponseEnvelope parseBASE64EncodedString(java.lang.String encodedReq)
          Creates FSAuthnResponseEnvelope from BASE 64 encoded string.
static FSAuthnResponseEnvelope parseXML(java.lang.String xml)
          Creats the FSAuthnResponseEnvelope from XML string.
 void setAssertionConsumerServiceURL(java.lang.String assertionConsumerUrl)
          Sets AssertionConsumerServiceURL parameter.
 void setAuthnResponse(FSAuthnResponse authnResponse)
          Sets the response object.
 void setMinorVersion(int minorVersion)
          Sets the minor version
 void setOtherElements(java.util.List otherElement)
          Sets Other element
 java.lang.String toBASE64EncodedString()
          Gets the BASE 64 encoded format of the request
 java.lang.String toXMLString()
          Gets a String representation of the AuthnResponseEnvelop element.
 java.lang.String toXMLString(boolean includeNS, boolean declareNS)
          Gets a String representation of the AuthnResponseEnvelop element.
 java.lang.String toXMLString(boolean includeNS, boolean declareNS, boolean includeHeader)
          Gets a String representation of the AuthnResponseEnvelope element.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FSAuthnResponseEnvelope

public FSAuthnResponseEnvelope()
Default constructor


FSAuthnResponseEnvelope

public FSAuthnResponseEnvelope(FSAuthnResponse authnResponse)
Constructor

Parameters:
authnResponse - FSAuthnResponse object

FSAuthnResponseEnvelope

public FSAuthnResponseEnvelope(org.w3c.dom.Element root)
                        throws FSMsgException,
                               SAMLException
Constructor.

Parameters:
root - response envelope element.
Throws:
FSMsgException - if unable to parse the element.
SAMLException - if unable to construct the object.
Method Detail

getMinorVersion

public int getMinorVersion()
Gets the minor version.

Returns:
minor version.

setMinorVersion

public void setMinorVersion(int minorVersion)
Sets the minor version

Parameters:
minorVersion - minor version to be set.

getOtherElements

public java.util.List getOtherElements()
Gets Other element

Returns:
List of Other Elements as String.

setOtherElements

public void setOtherElements(java.util.List otherElement)
Sets Other element

Parameters:
otherElement - List of Other Elements to be set.

getAuthnResponse

public FSAuthnResponse getAuthnResponse()
Gets the response object.

Returns:
the response object.

setAuthnResponse

public void setAuthnResponse(FSAuthnResponse authnResponse)
Sets the response object.

Parameters:
authnResponse - the response object to be set.

getAssertionConsumerServiceURL

public java.lang.String getAssertionConsumerServiceURL()
Gets AssertionConsumerServiceURL parameter.

Returns:
assertion consumer service URL

setAssertionConsumerServiceURL

public void setAssertionConsumerServiceURL(java.lang.String assertionConsumerUrl)
Sets AssertionConsumerServiceURL parameter.

Parameters:
assertionConsumerUrl - assertion consumer service URL to be set

parseXML

public static FSAuthnResponseEnvelope parseXML(java.lang.String xml)
                                        throws FSMsgException
Creats the FSAuthnResponseEnvelope from XML string.

Parameters:
xml - XML string
Returns:
the FSAuthnResponseEnvelope object.
Throws:
FSMsgException - if error occurs.

toXMLString

public java.lang.String toXMLString()
                             throws FSMsgException
Gets a String representation of the AuthnResponseEnvelop element.

Returns:
XML String representing the AuthnResponseEnvelop.
Throws:
FSMsgException - if error occurs.

toXMLString

public java.lang.String toXMLString(boolean includeNS,
                                    boolean declareNS)
                             throws FSMsgException
Gets a String representation of the AuthnResponseEnvelop 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:
XML String representing the AuthnResponseEnvelop.
Throws:
FSMsgException - if error occurs.

toXMLString

public java.lang.String toXMLString(boolean includeNS,
                                    boolean declareNS,
                                    boolean includeHeader)
                             throws FSMsgException
Gets a String representation of the AuthnResponseEnvelope 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 error occurs.

toBASE64EncodedString

public java.lang.String toBASE64EncodedString()
                                       throws FSMsgException
Gets the BASE 64 encoded format of the request

Returns:
BASE 64 encoded string of the request
Throws:
FSMsgException - if unable to get the BASE 64 encoded format

parseBASE64EncodedString

public static FSAuthnResponseEnvelope parseBASE64EncodedString(java.lang.String encodedReq)
                                                        throws FSMsgException
Creates FSAuthnResponseEnvelope from BASE 64 encoded string.

Parameters:
encodedReq - BASE 64 encoded string representing the object.
Returns:
FSAuthnResponseEnvelope object
Throws:
FSMsgException - if unable to parse the encoded string.


Copyright 2005 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.