com.sun.identity.liberty.ws.paos

Class PAOSResponse

java.lang.Object

com.sun.identity.liberty.ws.paos.PAOSResponse

public class PAOSResponse
extends Object

The PAOSResponse class is used by a web application on HTTP server side to receive and parse a PAOS response via an HTTP request from the user agent side. From this class, the original PAOSRequest object could obtained to correlate with this response.

Constructor Summary

Constructors

Constructor and Description
PAOSResponse(Element element) Constructs the PAOSResponse Object.
PAOSResponse(String xmlString) Constructs the PAOSResponse Object.
PAOSResponse(String refToMessageID, Boolean mustUnderstand, String actor) Constructs the PAOSResponse Object.

Method Summary

Modifier and Type	Method and Description
String	getActor() Returns value of actor attribute.
String	getRefToMessageID() Returns the value of the refToMessageID attribute.
Boolean	isMustUnderstand() Returns value of mustUnderstand attribute.
void	setActor(String actor) Sets the value of actor attribute.
void	setMustUnderstand(Boolean mustUnderstand) Sets the value of the mustUnderstand attribute.
void	setRefToMessageID(String refToMessageID) Sets the value of the refToMessageID attribute.
String	toXMLString() Returns a String representation of this Object.
String	toXMLString(boolean includeNSPrefix, boolean declareNS) Returns a String representation

Methods inherited from class java.lang.Object

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

Constructor Detail

PAOSResponse

public PAOSResponse(String refToMessageID,
                    Boolean mustUnderstand,
                    String actor)
             throws PAOSException

Constructs the PAOSResponse Object.

Parameters:

refToMessageID - the value of the refToMessageID attribute

mustUnderstand - the value of the mustUnderstand attribute

actor - the value of the actor attribute

Throws:

PAOSException - if PAOSResponse cannot be created.

PAOSResponse

public PAOSResponse(Element element)
             throws PAOSException

Constructs the PAOSResponse Object.

Parameters:

element - the Document Element of PAOS Response object.

Throws:

PAOSException - if PAOSResponse cannot be created.

PAOSResponse

public PAOSResponse(String xmlString)
             throws PAOSException

Constructs the PAOSResponse Object.

Parameters:

xmlString - the XML String representation of this object.

Throws:

PAOSException - if PAOSResponse cannot be created.

Method Detail

getRefToMessageID

public String getRefToMessageID()

Returns the value of the refToMessageID attribute.

Returns:

the value of the refToMessageID attribute.

See Also:

PAOSResponse.setRefToMessageID(String)

setRefToMessageID

public void setRefToMessageID(String refToMessageID)

Sets the value of the refToMessageID attribute.

Parameters:

refToMessageID - the value of the refToMessageID attribute

See Also:

PAOSResponse.getRefToMessageID()

isMustUnderstand

public Boolean isMustUnderstand()

Returns value of mustUnderstand attribute.

Returns:

value of mustUnderstand attribute.

setMustUnderstand

public void setMustUnderstand(Boolean mustUnderstand)

Sets the value of the mustUnderstand attribute.

Parameters:

mustUnderstand - the value of mustUnderstand attribute.

getActor

public String getActor()

Returns value of actor attribute.

Returns:

value of actor attribute

setActor

public void setActor(String actor)

Sets the value of actor attribute.

Parameters:

actor - the value of actor attribute

toXMLString

public String toXMLString()
                   throws PAOSException

Returns a String representation of this Object.

Returns:

a String representation of this Object.

Throws:

PAOSException - if it could not create String object

toXMLString

public String toXMLString(boolean includeNSPrefix,
                          boolean declareNS)
                   throws PAOSException

Returns a String representation

Parameters:

includeNSPrefix - 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 representation of this Object.

Throws:

PAOSException - ,if it could not create String object.