Response Class Reference

EPP Response Class. More...

#include <Response.H>

Inheritance diagram for Response:

AsnCheckRsp AsnCreateRsp AsnInfoRsp AsnRenewRsp AsnTransferRsp BrDomainUpdateRsp ContactCheckRsp ContactCreateRsp ContactInfoRsp DomainCheckRsp DomainCreateRsp DomainInfoRsp DomainRenewRsp IpNetworkCreateRsp IpNetworkInfoRsp IpNetworkRenewRsp IpNetworkTransferRsp PanDataRsp PollRsp

List of all members.

Classes

struct  ResultExtValue
struct  ResultInfo

Public Types

enum  ResultCode {
  UNSET = -1, OK = 1000, OK_ACTION_PENDING = 1001, OK_NO_MESSAGES = 1300,
  OK_ACK_DEQUEUE = 1301, OK_ENDING_SESSION = 1500, UNKNOWN_COMMAND = 2000, COMMAND_SYNTAX_ERROR = 2001,
  COMMAND_USE_ERROR = 2002, PARAMETER_MISSING = 2003, PARAMETER_RANGE_ERROR = 2004, PARAMETER_SYNTAX_ERROR = 2005,
  UNIMPLEMENTED_VERSION = 2100, UNIMPLEMENTED_COMMAND = 2101, UNIMPLEMENTED_OPTION = 2102, UNIMPLEMENTED_EXTENSION = 2103,
  BILLING_FAILURE = 2104, NOT_RENEWABLE = 2105, NOT_TRANSFERABLE = 2106, AUTHENTICATION_ERROR = 2200,
  AUTHORIZATION_ERROR = 2201, INVALID_AUTHORIZATION_INFO = 2202, PENDING_TRANSFER = 2300, NOT_PENDING_TRANSFER = 2301,
  OBJECT_EXISTS = 2302, OBJECT_DOESNT_EXIST = 2303, STATUS_PROHIBITS_OPERATION = 2304, ASSOCIATION_PROHIBITS_OPERATION = 2305,
  PARAMETER_POLICY_ERROR = 2306, UNIMPLEMENTED_SERVICE = 2307, DATA_MGMT_POLICY_VIOLATION = 2308, COMMAND_FAILED = 2400,
  COMMAND_FAILED_CLOSING_CONN = 2500, AUTHENTICATION_ERROR_CLOSING_CONN = 2501, SESSION_LIMIT_EXCEEDED = 2502
}
 Result Codes - See RFC 3730 - Session 3.

Public Member Functions

 Response (bool reset=true)
 Default constructor.
void set_clTRID (const string &clTRID)
 Sets the client transaction ID.
void set_svTRID (const string &svTRID)
 Sets the server transaction ID.
void set_result_lang (const string &result_lang)
 Sets the result message language.
void insert_result (const ResultCode &code, const string &msg, const string &value="", const string &xmlns="", const string &reason="")
 Sets a result element.
string get_clTRID () const
 Returns the client transaction ID.
string get_svTRID () const
 Returns the servers transaction ID.
string get_result_lang ()
 Returns the result message language.
map< ResultCode, ResultInfo > get_result_list () const
 Returns the list of result elements.
void reset ()
 reset attributes
virtual ~Response ()
 virtual destructor

Protected Attributes

string _clTRID
 Client transaction ID.
string _svTRID
 Server transaction ID.
string _result_lang
 Result language.
map< ResultCode, ResultInfo > _result_list
 Result elements list.


Detailed Description

EPP Response Class.

Member Function Documentation

string Response::get_clTRID (  )  const [inline]

Returns the client transaction ID.

Returns:
Client transacion ID

References _clTRID.

Referenced by BrOrgPanDataRsp::copy_parent_data(), and BrDomainPanDataRsp::copy_parent_data().

string Response::get_result_lang (  )  [inline]

Returns the result message language.

Returns:
Result message language

References _result_lang.

map<ResultCode, ResultInfo> Response::get_result_list (  )  const [inline]

Returns the list of result elements.

Returns:
List of result elements

References _result_list.

string Response::get_svTRID (  )  const [inline]

Returns the servers transaction ID.

Returns:
Server transacion ID

References _svTRID.

Referenced by BrOrgPanDataRsp::copy_parent_data(), and BrDomainPanDataRsp::copy_parent_data().

void Response::insert_result ( const ResultCode code,
const string &  msg,
const string &  value = "",
const string &  xmlns = "",
const string &  reason = "" 
) [inline]

Sets a result element.

Parameters:
code Result code
msg Response text
value value sub-element of extValue
xmlns value sub-element's attribute
reason reason sub-element of extValue

References _result_list.

void Response::set_clTRID ( const string &  clTRID  )  [inline]

Sets the client transaction ID.

Parameters:
clTRID Client transacion ID

References _clTRID.

void Response::set_result_lang ( const string &  result_lang  )  [inline]

Sets the result message language.

Parameters:
result_lang Result message language

References _result_lang.

void Response::set_svTRID ( const string &  svTRID  )  [inline]

Sets the server transaction ID.

Parameters:
svTRID Server transacion ID

References _svTRID.


The documentation for this class was generated from the following file:

Generated on Thu Jan 21 14:44:04 2010 for libepp_nicbr by  doxygen 1.5.9