Référence de la classe ServiceException

Gestion des exceptions de service. Plus de détails...

#include <ServiceException.h>

Fonctions membres publiques
	ServiceException (std::string locator, ExceptionCode code, std::string message, std::string service, std::string format="text/xml")
std::string	toString ()
	Génère la chaîne de caracteres relative à l'exception décrite par l'objet. Plus de détails...
std::string	getService ()
	Retourne le nom du service. Plus de détails...
std::string	getFormat ()
	Retourne le format du message. Plus de détails...
ExceptionCode	getCode ()
	Retourne le code de l'erreur. Plus de détails...

Fonctions membres publiques statiques
static std::string	getCodeAsString (ExceptionCode code)
	Retourne le code d'erreur sous forme de texte. Plus de détails...
static int	getCodeAsStatusCode (ExceptionCode code)
	Retourne le status code HTTP associe à l'exception. Plus de détails...
static std::string	getStatusCodeAsReasonPhrase (int statusCode)
	Retourne la phrase explicative associée au status code http. Plus de détails...

Description détaillée

Gestion des exceptions de service.

Auteur

Institut national de l'information géographique et forestière

Gère les informations permettant de générer la partie du message d'erreur XML suivante:

<ServiceException code='__CODE__' locator='__LOCATOR__' >
             __MESSAGE__
</ServiceException>

Documentation des constructeurs et destructeur

ServiceException()

ServiceException::ServiceException	(	std::string	locator,
		ExceptionCode	code,
		std::string	message,
		std::string	service,
		std::string	format = "text/xml"
	)

constructeur d'une exception

Paramètres

[in]	locator	la valeur de l'attribut locator (selon specs OGC)
[in]	code	la valeur de l'attribut code (selon specs OGC)
[in]	message	le texte du message d'erreur
[in]	service	le type de service ("wms" ou "wmts")
[in]	format	le format du message à retourner ("text/xml" ou "application/json")

Documentation des fonctions membres

getCode()

ExceptionCode ServiceException::getCode ( )

inline

Retourne le code de l'erreur.

Renvoie

code

getCodeAsStatusCode()

int ServiceException::getCodeAsStatusCode ( ExceptionCode  code )

static

Retourne le status code HTTP associe à l'exception.

Paramètres

[in]

code

le code d'erreur énuméré

Renvoie

code de status HTTP

getCodeAsString()

std::string ServiceException::getCodeAsString ( ExceptionCode  code )

static

Retourne le code d'erreur sous forme de texte.

Paramètres

[in]

code

le code d'erreur énuméré

Renvoie

réprésentation textuelle

getFormat()

std::string ServiceException::getFormat ( )

inline

Retourne le format du message.

Renvoie

format

getService()

std::string ServiceException::getService ( )

inline

Retourne le nom du service.

Renvoie

service

getStatusCodeAsReasonPhrase()

std::string ServiceException::getStatusCodeAsReasonPhrase ( int  statusCode )

static

Retourne la phrase explicative associée au status code http.

Paramètres

[in]

statusCode

code de status HTTP

Renvoie

phrase explicative

toString()

std::string ServiceException::toString

(

)

Génère la chaîne de caracteres relative à l'exception décrite par l'objet.

Renvoie

représentation textuelle de l'exception

---

La documentation de cette classe a été générée à partir des fichiers suivants :

• src/ServiceException.h
• src/ServiceException.cpp