rwsf::MessageProperties

• Local Index
• Header File
• Description
• Public Constructors
• Public Destructor
• Enumeration

Members

getBoolProperty() getCancelSession() getErrorMessage() getIntProperty() getLogLevel() getRequest() getResponse() getSoapAction()

getStringProperty() hasResponse() isClient() isMessageProcessingStopped() isRequest() LogLevel MessageProperties() setBoolProperty()

setCancelSession() setErrorMessage() setHasResponse() setIntProperty() setIsClient() setIsRequest() setLogLevel() setRequest()

setResponse() setSoapAction() setStringProperty() stopMessageProcessing() ~MessageProperties()

#include <rw/rwsf/soapworx/MessageProperties.h>

The base class for rwsf::CallInfo. Includes functionality to get and set various message and service properties, including transport properties, SOAP header properties, logging levels, and so on.

This class is not intended to be used directly.

MessageProperties();

Default constructor.

~MessageProperties();

Destructor.

enum LogLevel {
      None,
      Info,
      Warning,
      Error,
      Fatal
    };

Enumeration containing logger levels. When a level is set, the logger reports messages at that level and below. For example, if the level is set to Info, which is the default for all clients, the logger reports messages at all levels from Info through Fatal.

bool 
getBoolProperty(const std::string& name, 
                bool def = false) const;

Returns the bool setting for the property name. If the property is not set, returns def. If the property is "true", returns true; otherwise false.

bool 
getCancelSession() const;

Returns the bool setting for the property rwsf:CancelSession. If this value is true, then an HTTP transport will not maintain the session across calls. This value can be changed between requests.

std::string 
getErrorMessage() const;

Returns an error message as a string.

int 
getIntProperty(const std::string& name) const;

Given a property name, returns the value as an int.

LogLevel 
getLogLevel() const;

Returns the LogLevel.

std::string 
getRequest() const;

Returns the request as a string.

std::string 
getResponse() const;

Returns the response as a string.

std::string 
getSoapAction() const;

Returns the value of the property rwsf:SoapAction.

std::string 
getStringProperty(const std::string& name) const;

Given a property name, returns the value as a string.

bool 
hasResponse() const;

Returns the bool value for the property rwsf:HasResponse. If true, this message requires a response; if false, no response is required.

bool 
isClient() const;

Returns the bool value of the property rwsf:IsClient.If the value is true, this is the client; otherwise, it's the server.

bool 
isMessageProcessingStopped() const;

Returns the bool value of isMsgProcessingStopped.

bool 
isRequest() const;

Returns the bool value of the property rwsf:isRequest. While requests are usually from clients, they may also come from servers in certain message patterns (such as notification); therefore, both properties rwsf:isClient and rwsf:isRequest must be true for this to be a client request.

void 
setBoolProperty(const std::string& name, bool value);

Sets the value of the property name to value.

void 
setCancelSession(bool c);

Sets the bool value for the property rwsf:cancel-session. If this value is true, then an HTTP transport will not maintain the session across calls. This value can be changed between requests.

void 
setErrorMessage(const std::string& message);

Sets the error message to message.

void 
setHasResponse(bool response);

Sets the bool value of rwsf:HasResponse. A value of true means this callInfo object contains a response; otherwise, it does not contain a response.

void 
setIntProperty(const std::string& name, int value);

Sets an int value on property name.

void 
setIsClient(bool client);

Sets the bool value of rwsf:isClient. A value of true identifies this message as a client; otherwise, it's a service.

void 
setIsRequest(bool req);

Sets the bool value of the property rwsf:IsRequest. A value of true identifies this message as a request; otherwise, it's a response.

void 
setLogLevel(LogLevel l);

Sets the LogLevel. The default is Error.

void 
setRequest(const std::string& request);

Sets the value of the rwsf::Request.

void 
setResponse(const std::string& response);

Sets the value of the rwsf:Response.

void 
setSoapAction(const std::string& soapAction);

Sets the value of the property rwsf:soapAction. The rwsf:soapAction attribute specifies the value of the SOAPAction header for a given operation.

void 
setStringProperty(const std::string& name, const std::string& value);

Sets a name/value property.

void 
stopMessageProcessing();

Stops the further processing of a message by the message processing layer. No other handlers will be invoked. Invoke this method from your handler implementation by calling callInfo.stopMessageProcessing(). For more information, see Section 15.4.2.3, "Aborting Handler Processing," in the HydraExpress Web Service Development Guide.

©2004-2007 Copyright Quovadx, Inc. All Rights Reserved.
Quovadx and Rogue Wave are registered trademarks of Quovadx, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.
Contact Rogue Wave about documentation or support issues.