com.sun.identity.liberty.ws.paos
Class 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.

Constructor Summary

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.

Method Summary

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

Constructor Detail

PAOSRequest

public PAOSRequest(String responseConsumerURL,
                   String service,
                   String messageID,
                   Boolean mustUnderstand,
                   String actor)
            throws PAOSException

Constructs the PAOSRequest Object.

Parameters:

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

Throws:

PAOSException - if PAOSRequest cannot be created.

PAOSRequest

public PAOSRequest(Element element)
            throws PAOSException

Constructs the PAOSRequest Object.

Parameters:

element - the Document Element of PAOS Request object.

Throws:

PAOSException - if PAOSRequest cannot be created.

PAOSRequest

public PAOSRequest(String xmlString)
            throws PAOSException

Constructs the PAOSRequest Object.

Parameters:

xmlString - the XML String representation of this object.

Throws:

PAOSException - if PAOSRequest cannot be created.

Method Detail

getResponseConsumerURL

public String getResponseConsumerURL()

Returns the value of the responseConsumerURL attribute.

Returns:

the value of the responseConsumerURL attribute.

See Also:

PAOSRequest.setResponseConsumerURL(String)

setResponseConsumerURL

public void setResponseConsumerURL(String responseConsumerURL)

Sets the value of the responseConsumerURL attribute.

Parameters:

responseConsumerURL - the value of the responseConsumerURL attribute

See Also:

PAOSRequest.getResponseConsumerURL()

getService

public String getService()

Returns the value of the service attribute.

Returns:

the value of the service attribute.

See Also:

PAOSRequest.setService(String)

setService

public void setService(String service)

Sets the value of the service attribute.

Parameters:

service - the value of the service attribute

See Also:

PAOSRequest.getService()

getMessageID

public String getMessageID()

Returns the value of the messageID attribute.

Returns:

the value of the messageID attribute.

See Also:

PAOSRequest.setMessageID(String)

setMessageID

public void setMessageID(String messageID)

Sets the value of the messageID attribute.

Parameters:

messageID - the value of the messageID attribute

See Also:

PAOSRequest.getMessageID()

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.