com.sun.identity.liberty.ws.paos
クラス PAOSRequest

java.lang.Object
  上位を拡張 com.sun.identity.liberty.ws.paos.PAOSRequest

public class PAOSRequest
extends Object

The PAOSRequest class is used by a web application on HTTP server side to construct a PAOS request message and send it via an HTTP response to the user agent side.


コンストラクタの概要
PAOSRequest(Element element)
          Constructs the PAOSRequest Object.
PAOSRequest(String xmlString)
          Constructs the PAOSRequest Object.
PAOSRequest(String responseConsumerURL, String service, String messageID, Boolean mustUnderstand, String actor)
          Constructs the PAOSRequest Object.
 
メソッドの概要
 String getActor()
          Returns value of actor attribute.
 String getMessageID()
          Returns the value of the messageID attribute.
 String getResponseConsumerURL()
          Returns the value of the responseConsumerURL attribute.
 String getService()
          Returns the value of the service attribute.
 Boolean isMustUnderstand()
          Returns value of mustUnderstand attribute.
 void setActor(String actor)
          Sets the value of actor attribute.
 void setMessageID(String messageID)
          Sets the value of the messageID attribute.
 void setMustUnderstand(Boolean mustUnderstand)
          Sets the value of the mustUnderstand attribute.
 void setResponseConsumerURL(String responseConsumerURL)
          Sets the value of the responseConsumerURL attribute.
 void setService(String service)
          Sets the value of the service attribute.
 String toXMLString()
          Returns a String representation of this Object.
 String toXMLString(boolean includeNSPrefix, boolean declareNS)
          Returns a String representation
 

コンストラクタの詳細

PAOSRequest

public PAOSRequest(String responseConsumerURL,
                   String service,
                   String messageID,
                   Boolean mustUnderstand,
                   String actor)
            throws PAOSException
Constructs the PAOSRequest Object.

パラメータ:
responseConsumerURL - the value of the responseConsumerURL attribute
service - the value of the service attribute
messageID - the value of the messageID attribute
mustUnderstand - the value of the mustUnderstand attribute
actor - the value of the actor attribute
例外:
PAOSException - if PAOSRequest cannot be created.

PAOSRequest

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

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

PAOSRequest

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

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

getResponseConsumerURL

public String getResponseConsumerURL()
Returns the value of the responseConsumerURL attribute.

戻り値:
the value of the responseConsumerURL attribute.
関連項目:
PAOSRequest.setResponseConsumerURL(String)

setResponseConsumerURL

public void setResponseConsumerURL(String responseConsumerURL)
Sets the value of the responseConsumerURL attribute.

パラメータ:
responseConsumerURL - the value of the responseConsumerURL attribute
関連項目:
PAOSRequest.getResponseConsumerURL()

getService

public String getService()
Returns the value of the service attribute.

戻り値:
the value of the service attribute.
関連項目:
PAOSRequest.setService(String)

setService

public void setService(String service)
Sets the value of the service attribute.

パラメータ:
service - the value of the service attribute
関連項目:
PAOSRequest.getService()

getMessageID

public String getMessageID()
Returns the value of the messageID attribute.

戻り値:
the value of the messageID attribute.
関連項目:
PAOSRequest.setMessageID(String)

setMessageID

public void setMessageID(String messageID)
Sets the value of the messageID attribute.

パラメータ:
messageID - the value of the messageID attribute
関連項目:
PAOSRequest.getMessageID()

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.