com.sun.identity.liberty.ws.paos
クラス 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.


コンストラクタの概要
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.
 
メソッドの概要
 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
 

コンストラクタの詳細

PAOSResponse

public PAOSResponse(String refToMessageID,
                    Boolean mustUnderstand,
                    String actor)
             throws PAOSException
Constructs the PAOSResponse Object.

パラメータ:
refToMessageID - the value of the refToMessageID attribute
mustUnderstand - the value of the mustUnderstand attribute
actor - the value of the actor attribute
例外:
PAOSException - if PAOSResponse cannot be created.

PAOSResponse

public PAOSResponse(Element element)
             throws PAOSException
Constructs the PAOSResponse Object.

パラメータ:
element - the Document Element of PAOS Response object.
例外:
PAOSException - if PAOSResponse cannot be created.

PAOSResponse

public PAOSResponse(String xmlString)
             throws PAOSException
Constructs the PAOSResponse Object.

パラメータ:
xmlString - the XML String representation of this object.
例外:
PAOSException - if PAOSResponse cannot be created.
メソッドの詳細

getRefToMessageID

public String getRefToMessageID()
Returns the value of the refToMessageID attribute.

戻り値:
the value of the refToMessageID attribute.
関連項目:
PAOSResponse.setRefToMessageID(String)

setRefToMessageID

public void setRefToMessageID(String refToMessageID)
Sets the value of the refToMessageID attribute.

パラメータ:
refToMessageID - the value of the refToMessageID attribute
関連項目:
PAOSResponse.getRefToMessageID()

isMustUnderstand

public Boolean isMustUnderstand()
Returns value of mustUnderstand attribute.

戻り値:
value of mustUnderstand attribute.

setMustUnderstand

public void setMustUnderstand(Boolean mustUnderstand)
Sets the value of the mustUnderstand attribute.

パラメータ:
mustUnderstand - the value of mustUnderstand attribute.

getActor

public String getActor()
Returns value of actor attribute.

戻り値:
value of actor attribute

setActor

public void setActor(String actor)
Sets the value of actor attribute.

パラメータ:
actor - the value of actor attribute

toXMLString

public String toXMLString()
                   throws PAOSException
Returns a String representation of this Object.

戻り値:
a String representation of this Object.
例外:
PAOSException - if it could not create String object

toXMLString

public String toXMLString(boolean includeNSPrefix,
                          boolean declareNS)
                   throws PAOSException
Returns a String representation

パラメータ:
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.
戻り値:
a String representation of this Object.
例外:
PAOSException - ,if it could not create String object.