PARAM

SuiteParam

Þ

SuiteParam ZoneParam | ZoneParam

ZoneParam

Þ

IdVar

Þ

IdVar, GenreSOAP

(Seulement dans le cas de service Web SOAP)

Þ

IdVar, GenreSOAP, NomExport

(Seulement dans le cas de service Web SOAP)

Þ

IdVar, GenreRest

Seulement dans le cas de service Web Rest)

Þ

IdVar, GenreRest, NomExport

Seulement dans le cas de service Web Rest)

GenreSOAP

Þ

I | O | B

GenreRest

Þ

I[NatureI] | O[NatureO]

NatureI

Þ

path

Þ

query:ReqOpt

Þ

header:ReqOpt

Þ

header(csteAlpha):ReqOpt

Þ

form:ReqOpt

Þ

form(csteAlpha):ReqOpt

Þ

cookie:ReqOpt

Þ

cookie(csteAlpha):ReqOpt

Þ

content

Þ

multipart:ReqOpt

Þ

multipart(csteAlpha):ReqOpt

Þ

multipart:type(csteAlpha):ReqOpt

Þ

multipart(csteAlpha):type(csteAlpha):ReqOpt

Þ

attachment

ReqOpt

Þ

required | optional | optional(cste)

cste

Þ

csteNum | csteAlpha

NatureO

Þ

header

Þ

header(csteAlpha)

Þ

cookie

Þ

cookie(csteAlpha)

Þ

cookie:comment(csteAlpha)

Þ

cookie:max_age(csteNum)

Þ

cookie(csteAlpha):comment(csteAlpha):max_age(csteNum)

Þ

content

Þ

multipart

Þ

multipart(csteAlpha)

Þ

multipart:type(csteAlpha)

Þ

multipart(csteAlpha):type(csteAlpha)

Þ

attachment

Þ

HTTPstatus

path

SSI

N

Non

non

Paramètre associé à une variable citée via une annotation @Path.

Exemple :

/car/{idcar}/{idcolor}

Le nombre d'occurrences est égal au nombre trouvé de {variable} dans l'URI.

Exemple :

PARAM idcar,I[path] idcolor,I[path]

query

SSI ou

SSI_1D

N

Oui

oui

Paramètre associé à un paramètre d'une URL.

Exemple :

/car?id=10&color=blue

Le nombre d'occurrences est égal au nombre trouvé de variables paramètre dans l'URL.

Exemple :

/car?id=10&color=blue

PARAM id,I[query:required] color,I[query:optional('red')]

Il est possible d'avoir plusieurs variables paramètre de même nom et donc de récupérer une collection de valeurs.

Le paramètre déclaré doit alors être une table de dimension 1.

Exemple :

/car?color=blue&color=green&color=red

ALPHA(32) color(5)

PARAM color,I[query:required],color

Pour un paramètre de nom interne NomParam, ne définissant pas de nom externe, le nom du paramètre à écrire dans la chaîne de paramètres de l'URL doit être : pmNOMPARAM

Exemple :

NUM_BIN_4 id

ALPHA(32) color

PARAM id,I[query:required] color,I[query:optional('red')]

URL : /car?pmID=10&pmCOLOR=red

header

SSI

ou

SSI_1D

N

Oui

Oui

Paramètre associé à un header HTTP.

Le nombre d'occurrences est égal au nombre de header à récupérer.

Il est possible d'avoir plusieurs champs header de même nom et donc de récupérer une collection de valeurs. Le paramètre déclaré doit alors être une table de dimension 1.

Exemple :

ALPHA(256) hdrCT

PARAM hdrCT,I[header('Content-Type'):required]

form

SSI

N

Oui

Non

Paramètre associé à un champ de formulaire HTTP.

Exemple :

ALPHA(256) NomCli

PARAM NomCli,I[form('name'):required]

cookie

SSI

N

Oui

Non

Paramètre associé à un cookie.

Le nombre d'occurrences est égal au nombre de cookies à récupérer.

Exemple :

ALPHA(256) infCookCli

PARAM infCookcli,I[cookie('cook_inf_lastcli'):required]

content

SwCLS

1

Non

Non

Paramètre associé au contenu (corps) de la requête HTTP. Le format de ce contenu est l'un de ceux définis via l'annotation @Consumes.

Le contenu peut être récupéré dans un type simple ou dans une classe Adélia.

multipart

SwCLS

N

Oui

Non

Paramètre associé à une partie de contenu de la requête HTTP dans le cas d'un message composé de plusieurs ensembles de données regroupées dans un même corps ; le format de ce contenu est nommé multipart.

Chaque partie identifiée du contenu peut être associée à un paramètre ; un type mime (Content-Type) peut être précisé pour chacune des parties.

Exemple :

REF_CLASSE(COMPUTER) iComputer

REF_CLASSE(PRINTER) iPrinter

PARAM iComputer,I[multipart('id1'):type('application/xml'):required] iPrinter,I[multipart('id2'):type('application/json'):optional] ]

Note : pour le format consommé il faut choisir l'un des types mime multipart existant, à savoir :

• multipart/mixed

• multipart/form-data

• multipart/alternative

• multipart/related

Exemple :

SW_CONFIGURER *OPERATION '@Consumes' 'multipart/mixed'

attachment

ALPHA ou

ALPHA(n) ou

LISTE

1

Non

Oui

Paramètre associé à un ou plusieurs fichiers à récupérer (upload).

Le paramètre est alors soit de type ALPHA, soit une table ALPHA à une dimension, soit une liste d'une zone ALPHA.

Le paramètre contient le(s) nom(s) et emplacement(s) du(des) fichier(s) uploadé(s).

Le répertoire cible de stockage des fichiers attachés est par défaut le répertoire défini par la variable d'environnement java.temp de la JVM.

La fonction VaToolBx VaToolBxWSSetAttachmentDirectory permet de changer cet emplacement.

Exemple :

SW_CONFIGURER *OPERATION '@Consumes' 'multipart/form-data'

ALPHA(256) FileName

LISTE LstAttachedFiles FileName

PARAM LstAttachedFiles,I[attachment]
...

APPELER_CLASS 'VaToolBx' 'VaToolBxWSSetAttachmentDirectory' 'c:\temp\files'

header

SSI

N

Non

Paramètre associé à un header HTTP.

Le nombre d'occurrences est égal au nombre de champs header à envoyer.

Exemple :

ALPHA(256) hdrLocation

PARAM hdrLocation,O[header('Content-Location')]

cookie

SSI

N

Non

Paramètre associé à un cookie.

Le nombre d'occurrences est égal au nombre de cookies à envoyer.

La directive comment permet, si besoin, de joindre un commentaire au cookie.

La directive max_age permet, si besoin, de fixer une limite de temps (exprimée en secondes) au cookie.

Exemple :

ALPHA(256) infCookCli

PARAM infCookcli,I[cookie('cook_inf_lastcli'):comment('comment'):max_age(3600)]

content

SwCLS

N

Non

Paramètre associé au contenu (corps) de la réponse HTTP. Le format de ce contenu est l'un de ceux définis via l'annotation @Produces.

Le contenu à envoyer peut s'appuyer sur l'ensemble des types Adélia suivants (types simples, tables à 1 dimension, LISTE, REF_CLASSE).

Il est possible de déclarer plusieurs paramètres en sortie de nature content ; ces derniers sont alors agrégés dans une structure qu'il est possible de nommer à l'aide de l'ordre :

SW_CONFIGURER *OPERATION '_root_result_name' 'NomDeLaStructure'

multipart

SwCLS

N

Non

Paramètre associé à une partie de contenu de la réponse HTTP pour un message composé de plusieurs ensembles de données regroupées dans un même corps ; le format de ce contenu est nommé multipart.
Chaque partie identifiée du contenu peut être associée à un paramètre ;

un type mime (Content-Type) peut-être précisé pour chacune des parties.

Exemple :

REF_CLASSE(COMPUTER) iComputer

REF_CLASSE(PRINTER) iPrinter

PARAM iComputer,O[multipart('part1'):type('application/xml')] iPrinter,I[multipart('part2'):type('application/json')] ]

Note : pour le format produit il faut choisir l'un des types mime multipart existant, à savoir :

• multipart/mixed

• multipart/form-data

• multipart/alternative

• multipart/related

Exemple :

SW_CONFIGURER *OPERATION '@Consumes' 'multipart/mixed'

attachment

ALPHA ou
ALPHA(n) ou
LISTE

1

Oui

Paramètre associé à un ou plusieurs fichiers à envoyer (download).

Le paramètre est alors soit de type ALPHA, soit une table ALPHA à une dimension, soit une liste d'une zone ALPHA.

Le paramètre contient le(s) nom(s) et emplacement(s) du(des) fichier(s) à télécharger.

Exemple :

ALPHA(256) FileNames(2)

BOOL cRet

PARAM FileNames,O[attachment]

/* Téléchargement des fichiers pic1.jpg et pic2.jpg situés dans le répertoire

/* '/images' de l'application web.

APPELER_CLASS 'VaToolBx' 'VaToolBxAwsGetRealPath' '/images/pic1.jpg' FileNames(1) cRet

APPELER_CLASS 'VaToolBx' 'VaToolBxAwsGetRealPath' '/images/pic2.jpg' FileNames(2) cRet

HTTPstatus

NUM_BIN_2

1

Non

Paramètre associé au code de status HTTP retourné par le service.

Le paramètre de nature HTTPstatus n'est pas obligatoire ; il se substitue au code calculé par défaut et ce qui, dans certains cas,  permet de définir un code retour plus pertinent.

Exemple :

NUM_BIN_4     httpstatus

PARAM httpstatus,o[httpstatus]

si ok_lecture

  httpstatus = 200 /* on retourne le code HTTP 200 : OK

sinon

  httpstatus = 404 /* on retourne le code http 404 : non trouvé

fin