EPP XML Lib

Data Structures
class	EPPTCPSSL
class	EPPTRANSPORT
class	EPPNS
class	EPPResponse
class	EPPXML
Functions
	EPPTCPSSL::EPPTCPSSL (EPPXML *pXml, map< Str, Str > params)
virtual void	EPPTCPSSL::connect (Str host, int port, Str login, Str password, bool useSsl=true, int timeOut=60)
virtual void	EPPTCPSSL::send (void)
virtual Str	EPPTCPSSL::recv (void)
virtual Str	EPPTCPSSL::getLog (void)
	EPPTRANSPORT::EPPTRANSPORT (EPPXML *pXml, map< Str, Str > params)
virtual void	EPPTRANSPORT::send (void)=0
virtual Str	EPPTRANSPORT::recv (void)=0
	EPPXML::EPPXML (STLRT::Log::Entry &_logger)
virtual Str	EPPXML::getXML (void)
virtual Str	EPPXML::getEPP_NS_EPP_10 (void)
virtual Str	EPPXML::getEPP_NS_DOMAIN_10 (void)
virtual Str	EPPXML::getEPP_NS_CONTACT_10 (void)
virtual void	EPPXML::FormHelo (void)
virtual void	EPPXML::FormHelo (map< Str, Str > extension)
virtual void	EPPXML::CustomizeFormHelo (map< Str, Str > extension)
virtual void	EPPXML::ParseHelo (Str answer)
virtual void	EPPXML::FormLogin (Str Login, Str Pwd)
virtual void	EPPXML::FormLogin (Str Login, Str Pwd, map< Str, Str > extension)
virtual void	EPPXML::CustomizeFormLogin (map< Str, Str > extension)
virtual void	EPPXML::FormLogout (void)
virtual void	EPPXML::FormLogout (map< Str, Str > extension)
virtual void	EPPXML::CustomizeFormLogout (map< Str, Str > extension)
virtual void	EPPXML::FormCheckContact (list< Str > input)
virtual void	EPPXML::FormCheckContact (list< Str >, map< Str, Str > extension)
virtual void	EPPXML::CustomizeFormCheckContact (map< Str, Str > extension)
virtual map< Str, int >	EPPXML::ParseCheckContact (Str answer)
virtual void	EPPXML::FormCreateContactGeneral (EPPContact CI, map< Str, Str > ex, Str type)
virtual Str	EPPXML::ParseCreateContact (Str answer)
virtual void	EPPXML::FormCreateContactLoc (EPPContact CI)
virtual void	EPPXML::FormCreateContactLoc (EPPContact CI, map< Str, Str > extension)
virtual void	EPPXML::CustomizeFormCreateContactLoc (map< Str, Str > extension)
virtual Str	EPPXML::ParseCreateContactLoc (Str answer)
virtual void	EPPXML::FormCreateContactInt (EPPContact CI)
virtual void	EPPXML::FormCreateContactInt (EPPContact CI, map< Str, Str > extension)
virtual void	EPPXML::CustomizeFormCreateContactInt (map< Str, Str > extension)
virtual void	EPPXML::FormInfoContact (Str ID, Str Pwd)
virtual void	EPPXML::FormInfoContact (Str ID, Str Pwd, map< Str, Str > ex)
virtual void	EPPXML::CustomizeFormInfoContact (map< Str, Str > ex)
virtual void	EPPXML::FormUpdateContactLoc (EPPContact CI)
virtual void	EPPXML::FormUpdateContactLoc (EPPContact CI, map< Str, Str > extension)
virtual void	EPPXML::CustomizeFormUpdateContactLoc (map< Str, Str > extension)
virtual void	EPPXML::FormCheckDomain (list< Str > input)
virtual void	EPPXML::FormCheckDomain (list< Str > input, map< Str, Str > extension)
virtual void	EPPXML::CustomizeFormCheckDomain (map< Str, Str > extension)
virtual map< Str, int >	EPPXML::ParseCheckDomain (Str answer)
virtual void	EPPXML::FormCreateDomain (Str DomainName, Int Period, map< Str, Str > contacts, Str Password, list< EPPNS > NSes)
virtual void	EPPXML::FormCreateDomain (Str DomainName, Int Period, map< Str, Str > contacts, Str Password, list< EPPNS > NSes, map< Str, Str > extension)
virtual void	EPPXML::CustomizeFormCreateDomain (map< Str, Str > extension)
virtual int	EPPXML::ParseCreateDomain (Str answer)
virtual void	EPPXML::FormInfoDomain (Str Domain)
virtual void	EPPXML::FormInfoDomain (Str Domain, map< Str, Str > extension)
virtual void	EPPXML::CustomizeFormInfoDomain (map< Str, Str > extension)
virtual int	EPPXML::ParseInfoDomain (Str answer)
virtual void	EPPXML::FormUpdateDomain (Str domain, list< EPPNS > old_nses, list< EPPNS > new_nses, map< Str, Str > old_contacts, map< Str, Str > new_contacts)
virtual void	EPPXML::FormUpdateDomain (Str domain, list< EPPNS > old_nses, list< EPPNS > new_nses, map< Str, Str > old_contacts, map< Str, Str > new_contacts, map< Str, Str > extension)
virtual void	EPPXML::CustomizeFormUpdateDomain (map< Str, Str > extension)
virtual void	EPPXML::FormRenewDomain (Str Domain, Str ExpDate, Int Period)
virtual void	EPPXML::FormRenewDomain (Str Domain, Str ExpDate, Int Period, map< Str, Str > extension)
virtual void	EPPXML::CustomizeFormRenewDomain (map< Str, Str > extension)
virtual void	EPPXML::FormTransferDomain (Str Domain, Str Password)
virtual void	EPPXML::FormTransferDomain (Str Domain, Str Password, map< Str, Str > extension)
virtual void	EPPXML::CustomizeFormTransferDomain (map< Str, Str > extension)
virtual void	EPPXML::FormDeleteDomain (Str Domain)
virtual void	EPPXML::FormDeleteDomain (Str Domain, map< Str, Str > extension)
virtual void	EPPXML::CustomizeFormDeleteDomain (map< Str, Str > extension)
virtual void	EPPXML::FormCheckHost (list< Str > input)
virtual void	EPPXML::FormCheckHost (list< Str > input, map< Str, Str > extension)
virtual void	EPPXML::CustomizeFormCheckHost (map< Str, Str > extension)
virtual map< Str, int >	EPPXML::ParseCheckHost (Str answer)
virtual void	EPPXML::FormCreateHost (Str hostName, list< Str > ip)
virtual void	EPPXML::FormCreateHost (Str hostName, list< Str > ip, map< Str, Str > extension)
virtual void	EPPXML::CustomizeFormCreateHost (map< Str, Str > extension)
virtual int	EPPXML::ParseCreateHost (Str answer)

---

Function Documentation

void EPPTCPSSL::connect	(	Str	host,
		int	port,
		Str	login,
		Str	password,
		bool	useSsl = true,
		int	timeOut = 60
	)		[virtual]

Connect to server

void EPPXML::CustomizeFormCheckContact

(

map< Str, Str >

extension

)

[virtual]

Method for customization XML of check contact form. Empty by default.

void EPPXML::CustomizeFormCheckDomain

(

map< Str, Str >

extension

)

[virtual]

Method for customization XML of check contact form. Empty by default.

void EPPXML::CustomizeFormCheckHost

(

map< Str, Str >

extension

)

[virtual]

Method for customization XML of Check Host Request. Empty by default.

void EPPXML::CustomizeFormCreateContactInt

(

map< Str, Str >

extension

)

[virtual]

Method for customization XML of check contact form. Empty by default.

void EPPXML::CustomizeFormCreateContactLoc

(

map< Str, Str >

extension

)

[virtual]

Method for customization XML of check contact form. Empty by default.

void EPPXML::CustomizeFormCreateDomain

(

map< Str, Str >

extension

)

[virtual]

Method for customization XML of Create Domain Request. Empty by default.

void EPPXML::CustomizeFormCreateHost

(

map< Str, Str >

extension

)

[virtual]

Method for customization XML of Check Host Request. Empty by default.

void EPPXML::CustomizeFormDeleteDomain

(

map< Str, Str >

extension

)

[virtual]

Method for customization XML of Delete Domain Request. Empty by default.

void EPPXML::CustomizeFormHelo

(

map< Str, Str >

extension

)

[virtual]

Method for customization Helo Form. Empty by default. Called in case of using EPPXML::FormHelo(map<Str, Str> extension)

Parameters:

extension

- map of parameter's Name,Value.

void EPPXML::CustomizeFormInfoContact

(

map< Str, Str >

ex

)

[virtual]

Method for customization XML of check contact form. Empty by default.

void EPPXML::CustomizeFormInfoDomain

(

map< Str, Str >

extension

)

[virtual]

Method for customization XML of Create Info Request. Empty by default.

void EPPXML::CustomizeFormLogin

(

map< Str, Str >

extension

)

[virtual]

Method for customization Helo Form. Empty by default. Called in case of using EPPXML::FormLogin(map<Str, Str> extension)

Parameters:

extension

- map of parameter's Name,Value.

void EPPXML::CustomizeFormLogout

(

map< Str, Str >

extension

)

[virtual]

Method for customization XML of logout form. Empty by default.

void EPPXML::CustomizeFormRenewDomain

(

map< Str, Str >

extension

)

[virtual]

Method for customization XML of Update Domain Request. Empty by default.

void EPPXML::CustomizeFormTransferDomain

(

map< Str, Str >

extension

)

[virtual]

Method for customization XML of Transfer Domain Request. Empty by default.

void EPPXML::CustomizeFormUpdateContactLoc

(

map< Str, Str >

extension

)

[virtual]

Method for customization XML of check contact form. Empty by default.

void EPPXML::CustomizeFormUpdateDomain

(

map< Str, Str >

extension

)

[virtual]

Method for customization XML of Update Domain Request. Empty by default.

EPPTCPSSL::EPPTCPSSL	(	EPPXML *	pXml,
		map< Str, Str >	params
	)		[inline]

Constructor

Parameters:

pXml	- EPPXML
params	- params

EPPTRANSPORT::EPPTRANSPORT	(	EPPXML *	pXml,
		map< Str, Str >	params
	)		[inline]

Constructor

Parameters:

pXml	- EPPXML
params	- additional parameters

EPPXML::EPPXML

(

STLRT::Log::Entry &

_logger

)

[inline]

Paren of all EPPXML implementations. All childs inheriting EPPXML should call this constructor like that: MYEPPXML( STLRT::Log::Entry& _logger): EPPXML(_logger) {};

void EPPXML::FormCheckContact	(	list< Str >	cnts,
		map< Str, Str >	extension
	)		[virtual]

Generates XMl for checking contacts

Parameters:

input	- list of contactIds
extension	- map of parameter's Name,Value

void EPPXML::FormCheckContact

(

list< Str >

input

)

[virtual]

Generates XMl for checking contacts

Parameters:

input

- list of contactIds

Examples:

eppxml_example.cpp.

void EPPXML::FormCheckDomain

(

list< Str >

input

)

[virtual]

Generates XML for Check domain operaion

Parameters:

input

- list of Domain Names

Examples:

eppxml_example.cpp.

void EPPXML::FormCheckDomain	(	list< Str >	input,
		map< Str, Str >	extension
	)		[virtual]

Generates XML for Check domain operaion

Parameters:

input	- list of Domain Names
extension	- map of parameter's Name,Value.

void EPPXML::FormCheckHost

(

list< Str >

input

)

[virtual]

Generates XML for Check Host Request

Parameters:

input

- list of Hosts

void EPPXML::FormCheckHost	(	list< Str >	input,
		map< Str, Str >	extension
	)		[virtual]

Generates XML for Check Host Request

Parameters:

input	- list of Hosts
extension	- map of parameter's Name,Value.

void EPPXML::FormCreateContactGeneral	(	EPPContact	CI,
		map< Str, Str >	ex,
		Str	type
	)		[virtual]

Generates XML for Contact Creation Form

Parameters:

CI	- EPP contact
ex	- extensions (map of parameter's Name and Value )
type	of EPP entity. (e.g. "loc" or "int")

void EPPXML::FormCreateContactInt

(

EPPContact

CI

)

[virtual]

Generate Xml for Contact Creation form with type "int"

Parameters:

CI	- EPP contact

void EPPXML::FormCreateContactInt	(	EPPContact	CI,
		map< Str, Str >	extension
	)		[virtual]

Generate Xml for Contact Creation form with type "int"

Parameters:

CI	- EPP contact
extension	- map of parameter's Name,Value

void EPPXML::FormCreateContactLoc

(

EPPContact

CI

)

[virtual]

Generate Xml for Contact Creation form with type "loc"

Parameters:

CI	- EPP contact

Examples:

eppxml_example.cpp.

void EPPXML::FormCreateContactLoc	(	EPPContact	CI,
		map< Str, Str >	extension
	)		[virtual]

Generate Xml for Contact Creation form with type "loc"

Parameters:

CI	- EPP contact
extension	- map of parameter's Name,Value

void EPPXML::FormCreateDomain	(	Str	DomainName,
		Int	Period,
		map< Str, Str >	contacts,
		Str	Password,
		list< EPPNS >	NSes
	)		[virtual]

Generates XML for Create Domain request

Parameters:

DomainName	- Full Domain Name
Period	- domain period
contacts	- map of contacts parametet's Name,Value
Password	- password
NSes	- list of EPPNSs.

Examples:

eppxml_example.cpp.

void EPPXML::FormCreateDomain	(	Str	DomainName,
		Int	Period,
		map< Str, Str >	contacts,
		Str	Password,
		list< EPPNS >	NSes,
		map< Str, Str >	extension
	)		[virtual]

Generates XML for Create Domain request

Parameters:

DomainName	- Full Domain Name
Period	- domain period
contacts	- map of contacts parametet's Name,Value
Password	- password
NSes	- list of EPPNSs.
extension	- map of parameter's Name,Value.

void EPPXML::FormCreateHost	(	Str	hostName,
		list< Str >	ip
	)		[virtual]

Generates XML for Create Host request

Parameters:

hostName	- Host Name
ip	- list of ip addresses.

void EPPXML::FormCreateHost	(	Str	hostName,
		list< Str >	ip,
		map< Str, Str >	extension
	)		[virtual]

Generates XML for Create Host request

Parameters:

hostName	- Host Name
ip	- list of ip addresses.
extension	- map of parameter's Name,Value.

void EPPXML::FormDeleteDomain

(

Str

Domain

)

[virtual]

Generates XML for Delete Domain request

Parameters:

Domain

- Full Domain Name

Examples:

eppxml_example.cpp.

void EPPXML::FormDeleteDomain	(	Str	Domain,
		map< Str, Str >	extension
	)		[virtual]

Generates XML for Delete Domain request

Parameters:

Domain	- Full Domain Name
extension	- map of parameter's Name,Value.

void EPPXML::FormHelo

(

void

)

[virtual]

Create standart EPP Helo Form

void EPPXML::FormHelo

(

map< Str, Str >

extension

)

[virtual]

Create standart EPP Helo Form

Parameters:

extension

for Helo Form

void EPPXML::FormInfoContact	(	Str	ID,
		Str	Pwd,
		map< Str, Str >	ex
	)		[virtual]

Generates EPPXML for Contact Info request

Parameters:

ID	- contact's Id
Pwd	- contact's password

void EPPXML::FormInfoContact	(	Str	ID,
		Str	Pwd
	)		[virtual]

Generates EPPXML for Contact Info request

Parameters:

ID	- contact's Id
Pwd	- contact's password

void EPPXML::FormInfoDomain

(

Str

Domain

)

[virtual]

Generates Xml for Domain Info request

Parameters:

Domain

- Full Domain Name

Examples:

eppxml_example.cpp.

void EPPXML::FormInfoDomain	(	Str	Domain,
		map< Str, Str >	extension
	)		[virtual]

Generates Xml for Domain Info request

Parameters:

Domain

- Full Domain Name - map of parameter's Name,Value

void EPPXML::FormLogin	(	Str	Login,
		Str	Pwd
	)		[virtual]

Create XML Form for Login

Parameters:

Login	login
Pwd	password

Examples:

eppxml_example.cpp.

void EPPXML::FormLogin	(	Str	Login,
		Str	Pwd,
		map< Str, Str >	extension
	)		[virtual]

Create XML Form for Login

Parameters:

Login	login
Pwd	password
extension	- map of parameter's Name,Value

void EPPXML::FormLogout

(

void

)

[virtual]

Generates XML for Logout form.

Examples:

eppxml_example.cpp.

void EPPXML::FormLogout

(

map< Str, Str >

extension

)

[virtual]

Generates XML for Logout form with extensions.

Parameters:

extension

- Map of parameter's Name,Value.

void EPPXML::FormRenewDomain	(	Str	Domain,
		Str	ExpDate,
		Int	Period,
		map< Str, Str >	extension
	)		[virtual]

Generates XML for Create Domain request

Parameters:

Domain	- Full Domain Name
ExpDate	- domain period
Period	- domain period
extension	- map of parameter's Name,Value.

void EPPXML::FormRenewDomain	(	Str	Domain,
		Str	ExpDate,
		Int	Period
	)		[virtual]

Generates XML for Create Domain request

Parameters:

Domain	- Full Domain Name
ExpDate	- domain period
Period	- domain period

Examples:

eppxml_example.cpp.

void EPPXML::FormTransferDomain	(	Str	Domain,
		Str	Password,
		map< Str, Str >	extension
	)		[virtual]

Generates XML for Transfer Domain request

Parameters:

Domain	- Full Domain Name
Password	- password
extension	- map of parameter's Name,Value.

void EPPXML::FormTransferDomain	(	Str	Domain,
		Str	Password
	)		[virtual]

Generates XML for Transfer Domain request

Parameters:

Domain	- Full Domain Name
Password	- password

Examples:

eppxml_example.cpp.

void EPPXML::FormUpdateContactLoc	(	EPPContact	CI,
		map< Str, Str >	extension
	)		[virtual]

Generates XML form for updating Contacts with type 'loc'

Parameters:

CI	- EPP contact

void EPPXML::FormUpdateContactLoc

(

EPPContact

CI

)

[virtual]

Generates XML form for updating Contacts with type 'loc'

Parameters:

CI	- EPP contact

void EPPXML::FormUpdateDomain	(	Str	domain,
		list< EPPNS >	old_nses,
		list< EPPNS >	new_nses,
		map< Str, Str >	old_contacts,
		map< Str, Str >	new_contacts,
		map< Str, Str >	extension
	)		[virtual]

Generates XML for Update Domain Form.

Parameters:

domain	- Full Domain Name
old_nses	- list of EPP Name Servers, that will be dropped
new_nses	- list of EPP Name Servers, that will be added
old_contacts	- list of EPP Contacts, that will be dropped
new_contacts	- list of EPP Contacts, that will be added
extension	- map of parameter's Name,Value

void EPPXML::FormUpdateDomain	(	Str	domain,
		list< EPPNS >	old_nses,
		list< EPPNS >	new_nses,
		map< Str, Str >	old_contacts,
		map< Str, Str >	new_contacts
	)		[virtual]

Generates XML for Update Domain Form.

Parameters:

domain	- Full Domain Name
old_nses	- list of EPP Name Servers, that will be dropped
new_nses	- list of EPP Name Servers, that will be added
old_contacts	- list of EPP Contacts, that will be dropped
new_contacts	- list of EPP Contacts, that will be added

Examples:

eppxml_example.cpp.

Str EPPXML::getEPP_NS_CONTACT_10

(

void

)

[virtual]

Returns:

EPP_NS_CONTACT_10

Str EPPXML::getEPP_NS_DOMAIN_10

(

void

)

[virtual]

Returns:

EPP_SCHEMA_LOCATION_EPP_10

Str EPPXML::getEPP_NS_EPP_10

(

void

)

[virtual]

Returns:

EPP_SCHEMA_LOCATION_EPP_10

virtual Str EPPTCPSSL::getLog

(

void

)

[inline, virtual]

Returns:

log of requests/responses with server

Str EPPXML::getXML

(

void

)

[virtual]

Returns:

generated xml

Examples:

eppxml_example.cpp.

map< Str, int > EPPXML::ParseCheckContact

(

Str

answer

)

[virtual]

Parse servers response after check contact request

Returns:

map of ContactId and Status Status may have following values:

• EPP_AVAILABLE_CONTACT (contact available)
• EPP_N_AVAILABLE_CONTACT (contact unavailable)

map< Str, int > EPPXML::ParseCheckDomain

(

Str

answer

)

[virtual]

Parse server's response on Check Domain Operation

Parameters:

answer

- server's response

Returns:

map of Domain Name and Status. Status may have following values:

• EPP_AVAILABLE_DOMAIN (domain available)
• EPP_N_AVAILABLE_DOMAIN (domain unavailable)

map< Str, int > EPPXML::ParseCheckHost

(

Str

answer

)

[virtual]

Parse server's response after Check Host Request

Parameters:

answer

- server's response

Returns:

map of Host and Status. Status may have following values:

• EPP_AVAILABLE_HOST (host available)
• EPP_N_AVAILABLE_HOST (host unavailable)

Str EPPXML::ParseCreateContact

(

Str

answer

)

[virtual]

Parce server's response after Contact Creation request

Str EPPXML::ParseCreateContactLoc

(

Str

answer

)

[virtual]

Parsing response on Create Contact with type 'loc' request

int EPPXML::ParseCreateDomain

(

Str

answer

)

[virtual]

Parse server's response after Create Domain Request

int EPPXML::ParseCreateHost

(

Str

answer

)

[virtual]

Parse server's response after Create Host Request

Parameters:

answer

- server's response

Returns:

error code

void EPPXML::ParseHelo

(

Str

answer

)

[virtual]

Parsing Helo result

Parameters:

answer

from server

int EPPXML::ParseInfoDomain

(

Str

answer

)

[virtual]

Parse server's response after Domain Info Request

Parameters:

answer

- server's response

Returns:

error code of operation

virtual Str EPPTRANSPORT::recv

(

void

)

[pure virtual]

Returns:

get response

Implemented in EPPTCPSSL.

Str EPPTCPSSL::recv

(

void

)

[virtual]

receive response from server

Implements EPPTRANSPORT.

Examples:

eppxml_example.cpp.

virtual void EPPTRANSPORT::send

(

void

)

[pure virtual]

send request

Implemented in EPPTCPSSL.

void EPPTCPSSL::send

(

void

)

[virtual]

send request to server

Implements EPPTRANSPORT.

Examples:

eppxml_example.cpp.