com.sun.identity.federation.message.common
Class GetComplete

java.lang.Object
  extended by com.sun.identity.federation.message.common.EntityName
      extended by com.sun.identity.federation.message.common.GetComplete

public class GetComplete
extends EntityName

This class contains methods for the GetComplete Element. This element specifies a URI which resolves to the complete IDPList.


Field Summary
 
Fields inherited from class com.sun.identity.federation.message.common.EntityName
otherElements, uri
 
Constructor Summary
GetComplete()
          Default Constructor.
GetComplete(Element root)
          Constructor creates GetComplete object from the Document Element.
GetComplete(String uri)
          Constructor create GetComplete object.
GetComplete(String uri, List otherElements)
          Constructor create GetComplete object.
 
Method Summary
static GetComplete parseXML(String xml)
          Returns GetComplete object.
 String toXMLString()
          Returns the string representation of this object.
 String toXMLString(boolean includeNS, boolean declareNS)
          Returns a String representation of the <samlp:Response> element.
 String toXMLString(boolean includeNS, boolean declareNS, boolean includeHeader)
          Returns a String representation of the <samlp:Response> element.
 
Methods inherited from class com.sun.identity.federation.message.common.EntityName
getOtherElements, setOtherElements, setURI
 

Constructor Detail

GetComplete

public GetComplete()
Default Constructor.


GetComplete

public GetComplete(String uri)
Constructor create GetComplete object.

Parameters:
uri - the value of the URI.

GetComplete

public GetComplete(String uri,
                   List otherElements)
Constructor create GetComplete object.

Parameters:
uri - the value of the URI.
otherElements - list of other elements.

GetComplete

public GetComplete(Element root)
            throws FSMsgException
Constructor creates GetComplete object from the Document Element.

Parameters:
root - the Document Element object.
Throws:
FSMsgException - if error creating this object.
Method Detail

parseXML

public static GetComplete parseXML(String xml)
                            throws FSMsgException
Returns GetComplete object. This object is created by parsing the XML string.

Parameters:
xml - XML String
Returns:
the GetComplete object.
Throws:
FSMsgException - if there is an error creating this object.

toXMLString

public String toXMLString()
                   throws FSMsgException
Returns the string representation of this object.

Returns:
An XML String representing this object.
Throws:
FSMsgException

toXMLString

public String toXMLString(boolean includeNS,
                          boolean declareNS)
                   throws FSMsgException
Returns a String representation of the <samlp:Response> 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 there is an error converting this object ot a string.

toXMLString

public String toXMLString(boolean includeNS,
                          boolean declareNS,
                          boolean includeHeader)
                   throws FSMsgException
Returns a String representation of the <samlp:Response> 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 there is an error converting this object ot a string.