Skip to main content
Version: v19 R8 BETA

HTTPRequest

Historique
VersionModifications
v19 R6Classe ajoutée

La classe HTTPRequest vous permet de manipuler des objets HTTPRequest qui peuvent être utilisés pour configurer et envoyer des requêtes à un serveur HTTP, ainsi que pour traiter les réponses du serveur HTTP.

La classe HTTPRequest est disponible dans le class store 4D. Vous créez et envoyez des requêtes HTTP à l'aide de la fonction 4D.HTTPRequest.new(), qui renvoie un objet HTTPRequest.

Exemple

Création d'une classe MyHttpRequestOptions pour les options de la requête :

Class constructor($method : Text ; $headers : Object ; $body : Text)
This.method:=$method
This.headers:=$headers
This.body:=$body

Function onResponse($request : 4D.HTTPRequest ; $event : Object)
//Méthode onResponse, si vous souhaitez traiter la requête de manière asynchrone

Function onError($request : 4D.HTTPRequest ; $event : Object)
//Méthode onError, si vous souhaitez traiter la requête de manière asynchrone

Vous pouvez maintenant créer votre requête :

var $headers : Object
$headers:=New object()
$headers["field1"]:="value1"

var myHttpRequestOptions : cs.MyHttpRequestOptions
myHttpRequestOptions := cs.MyHttpRequestOptions.new("GET" ; $headers; "")

var $request : 4D.HTTPRequest
$request:=4D.HTTPRequest.new("www.google.com" ; myHttpRequestOptions)
$request.wait() //Si vous voulez traiter la requête de manière synchrone
//Maintenant vous pouvez utiliser $request.response pour accéder au résultat de la requête ou $request.error pour vérifier l'erreur qui s'est produite.

Objet HTTPRequest

Un objet HTTPRequest est un objet non partageable.

Les objets HTTPRequest fournissent les propriétés et fonctions suivantes :

dataType : Text    le dataType passé dans l'objet options lors de l'appel à new(), "auto" s'il a été omis
encoding : Text    l'encoding passé dans l'objet options lors de l'appel à new(), "UTF-8" s'il a été omis
errors : Collection    la collection de toutes les erreurs si au moins une erreur a été générée
headers : Object    les headers passés dans l'objet options lors de l'appel à new()
method : Text    la method passée dans l'objet options lors de l'appel à new()
protocol : Text    le protocol passé dans l'objet options lors de l'appel à new()
response : Object    la réponse à la requête si elle a reçu au moins le status code, sinon undefined
returnResponseBody : Boolean    le returnResponseBody passé dans l'objet options lors de l'appel à new()
.terminate()    met fin à la requête HTTP
terminated : Boolean    Vrai si la requête est terminée (après l'appel à onTerminate), Faux sinon
timeout : Real    le timeout passé dans l'objet options lors de l'appel à new()
url : Text    l'URL de la requête HTTP
.wait( { time : Real } ) : 4D.HTTPRequest    attend la réponse du serveur

4D.HTTPRequest.new()

Historique
VersionModifications
v19 R7Prise en charge de la propriété decodeData

4D.HTTPRequest.new( url : Text { ; options : Object } ) : 4D.HTTPRequest

ParamètresTypeDescription
urlText->URL à laquelle envoyer la requête
optionsObject->Propriétés de configuration de la requête
Résultat4D.HTTPRequest<-Nouvel objet HTTPRequest

|

Description

La fonction 4D.HTTPRequest.new() crée et envoie une requête HTTP au serveur HTTP défini dans url avec les options définies, et renvoie un objet 4D.HTTPRequest.

L'objet HTTPRequest retourné est utilisé pour traiter les réponses du serveur HTTP et appeler des méthodes.

Dans url, passez l'URL où vous voulez envoyer la requête. La syntaxe à utiliser est la suivante :

{http://}[{user}:[{password}]@]host[ :{port}][/{path}][ ?{queryString}]
{https://}[{user}:[{password}]@]host[ :{port}][/{path}][ ?{queryString}]

Si vous omettez la partie protocole (http:// ou https://), une requête https est envoyée.

Par exemple, vous pouvez passer les chaînes suivantes :

    http://www.myserver.com
www.myserver.com/path
http://www.myserver.com/path?name="jones"
https://www.myserver.com/login
http://123.45.67.89:8083
http://john:smith@123.45.67.89:8083
http://[2001:0db8:0000:0000:0000:ff00:0042:8329]
http://[2001:0db8:0000:0000:0000:ff00:0042:8329]:8080/index.html (**)

Paramètre options

Dans le paramètre options, passez un objet qui peut contenir les propriétés suivantes :

PropriétéTypeDescriptionPar défaut
bodyVariantCorps de la requête (requis dans le cas des requêtes post ou put). Il peut s'agir d'un texte, d'un blob ou d'un objet. Le content-type est déterminé à partir du type de cette propriété, sauf s'il est défini dans les headersundefined
certificatesFolderFolderDéfinit le dossier actif des certificats du clientundefined
dataTypeTextType de l'attribut response body. Valeurs : "text", "blob", "object", ou "auto". Si "auto", le type du contenu du corps sera déduit de son type MIME (object pour JSON, text pour texte, javascript, xml, message http et url sous forme encodée, blob sinon)"auto"
decodeDataBooleanSi vrai, les données reçues dans le callback onData sont décompresséesFalse
encodingTextUtilisé uniquement dans le cas de requêtes avec un body (méthodes post ou put). Encodage du body content de la requête s'il s'agit d'un texte, ignoré si le content-type est défini dans les headers"UTF-8"
headersObjectHeaders de la requête. Syntaxe : headers.key=value (value peut être une Collection si la même clé doit apparaître plusieurs fois)Objet vide
methodText"POST", "GET", ou autre méthode"GET"
minTLSVersionTextDéfinit la version minimale de TLS : "TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3""TLSv1_2"
onDataFunctionCallback lorsque les données du body sont reçues. Elle reçoit deux objets en paramètres (voir ci-dessous)undefined
onErrorFunctionCallback lorsqu'une erreur se produit. Elle reçoit deux objets en paramètres (voir ci-dessous)undefined
onHeadersFunctionCallback lorsque les headers sont reçus. Elle reçoit deux objets en paramètres (voir ci-dessous)undefined
onResponseFunctionRappel lorsqu'une réponse est reçue. Elle reçoit deux objets en paramètres (voir ci-dessous)undefined
onTerminateFunctionRappel lorsque la requête est terminée. Elle reçoit deux objets en paramètres (voir ci-dessous)undefined
protocolText"auto" ou "HTTP1". "auto" signifie HTTP1 dans l'implémentation actuelle"auto"
proxyAuthenticationauthentication objectObjet manipulant l'authentification du proxyundefined
serverAuthenticationauthentication objectObjet manipulant l'authentification par serveurundefined
returnResponseBodyBooleanSi faux, le body de la réponse n'est pas renvoyé dans l'objet response. Renvoie une erreur si faux et onData est undefinedVrai
timeoutRealTimeout en secondes. Undefined = pas de timeoutUndefined

Fonctions de callback

Toutes les fonctions de callback reçoivent deux paramètres objet:

ParamètresType
$param1objet HTTPRequest
$param2objet Event

Voici la séquence des appels de callbacks :

  1. onHeaders est toujours appelé une fois

  2. onData est appelé zéro ou plusieurs fois (non appelé si la requête n'a pas de body)

  3. Si aucune erreur ne s'est produite, onResponse est toujours appelé une fois

  4. Si une erreur se produit, onError est exécuté une fois (et termine la requête)

  5. onTerminate est toujours exécuté une fois

event object

Un objet event est renvoyé lorsqu'une fonction de callback est appelée. Il contient les propriétés suivantes :

PropriétéTypeDescription
.datablobDonnées reçues. Toujours undefined sauf dans la callback onData
.typetextType d'événement. Valeurs possibles : "response", "error", "headers", "data", or "terminate"

authentication object

Un objet d'authentification gère la propriété options.serverAuthentication ou options.proxyAuthentication . Il peut contenir les propriétés suivantes :

PropriétéTypeDescriptionPar défaut
nameTextNom utilisé pour l'authentificationundefined
passwordTextMot de passe utilisé pour l'authentificationundefined
methodTextMéthode utilisée pour l'authentification : "basic", "digest", "auto""auto"

.dataType

dataType : Text

Description

La propriété .dataType contient le dataType passé dans l'objet options lors de l'appel à new(), "auto" s'il a été omis.

.encoding

encoding : Text

Description

La propriété .encoding contient l'encoding passé dans l'objet options lors de l'appel à new(), "UTF-8" s'il a été omis.

.errors

errors : Collection

Description

La propriété .errors contient la collection de toutes les erreurs si au moins une erreur a été générée.

Voici le contenu de la propriété .errors :

PropriétéTypeDescription
errorsCollectionPile d'erreurs 4D en cas d'erreur
[].errCodeNumberCode d'erreur 4D
[].messageTextDescription de l'erreur 4D
[].componentSignatureTextSignature du composant interne qui a retourné l'erreur

.headers

headers : Object

Description

La propriété .headers contient les headers passés dans l'objet options lors de l'appel à new(). S'il a été omis, contient un objet vide.

.method

method : Text

Description

The .method property contains la method passée dans l'objet options lors de l'appel à new(). .

.protocol

protocol : Text

Description

La propriété .protocol contient le protocol passé dans l'objet options lors de l'appel à new(). S'il a été omis ou si "auto" a été utilisé, contient la version du protocole utilisé.

.response

Historique
VersionModifications
v19 R8.headers renvoie les noms en minuscules. Nouvelle propriété .rawHeaders

response : Object

Description

La propriété .response contient la réponse à la requête si elle a reçu au moins le status code, sinon undefined.

Un objet response est un objet non partageable. Il contient les propriétés suivantes :

PropriétéTypeDescription
.bodyVariantBody de la réponse. Le type du message est défini en fonction de la propriété dataType. Undefined si le body n'a pas encore été reçu
.headersObjectHeaders de la réponse. Les noms des headers sont retournés en minuscules. <headername>.key = valeur (la valeur peut être une collection si la même clé apparaît plusieurs fois). Undefined si les headers n'ont pas encore été reçus.
.statutNumberStatus code de la réponse
.statusTextTextMessage expliquant le status code
.rawHeadersObjectHeaders de la réponse. Les noms des headers sont retournés tels quels (avec leur casse d'origine). <headerName>.key = valeur (la valeur peut être une collection si la même clé apparaît plusieurs fois). Undefined si les headers n'ont pas encore été reçus.

.returnResponseBody

returnResponseBody : Boolean

Description

La propriété .returnResponseBody contient le returnResponseBody passé dans l'objet options lors de l'appel à new(). .

.terminate()

.terminate()

ParamètresTypeDescription
Ne requiert aucun paramètre

|

Description

Cette fonction est thread-safe.

La fonction .terminate() met fin à la requête HTTP. .

.terminated

terminated : Boolean

Description

La propriété .terminated contient Vrai si la requête est terminée (après l'appel à onTerminate), Faux sinon.

.timeout

timeout : Real

Description

La propriété .timeout contient le timeout passé dans l'objet options lors de l'appel à new(). .

.url

url : Text

Description

La propriété .url contient l'URL de la requête HTTP.

.wait()

.wait( { time : Real } ) : 4D.HTTPRequest

ParamètresTypeDescription
timeReal->Délai d'attente maximum en secondes pour la réponse
Résultat4D.HTTPRequest<-Objet HTTPRequest

|

Description

Cette fonction est thread-safe.

La fonction wait() attend la réponse du serveur.

Si un paramètre time est passé, la fonction attendra au maximum le nombre de secondes défini.

Si la réponse du serveur est déjà arrivée, la fonction rend la main immédiatement.