Services RPC (server)

De Wiki1000
(Différences entre les versions)
(Nouvelle page : ===Introduction=== Le serveur Ligne 1000 contient un service REST qui permet d’accéder aux différents services techniques du serveur. Sa fonction première est d’offrir un acc...)
 
 
(9 révisions intermédiaires par un utilisateur sont masquées)
Ligne 1 : Ligne 1 :
 
===Introduction===
 
===Introduction===
−
Le serveur Ligne 1000 contient un service REST qui permet d’accéder aux différents services techniques du serveur.  
+
Le serveur Ligne 1000 contient un service RPC qui permet d’accéder aux différents services techniques du serveur.  
 
Sa fonction première est d’offrir un accès à travers HTTP aux services techniques 1000 et de permettre ainsi une utilisation plus large de ces services.  
 
Sa fonction première est d’offrir un accès à travers HTTP aux services techniques 1000 et de permettre ainsi une utilisation plus large de ces services.  
 
   
 
   
−
Le serveur REST 1000 interprète une URI, exécute le service REST concerné et retourne le résultat en XML.
+
Le serveur RPC 1000 interprète une URI, exécute le service RPC concerné et retourne le résultat en XML.
  
 
===Format d'URL===
 
===Format d'URL===
−
Les points d’accès aux services REST sont des URL définies à partir de la racine de l’URL du serveur Web.
+
Les points d’accès aux services RPC sont des URL définies à partir de la racine de l’URL du serveur Web.
−
L’URL d’un service REST est définie ainsi :  
+
L’URL d’un service RPC est définie ainsi :  
  
−
  http://hostname/servicename/server/rpc.l1000/rest/restName.restAction1.restAction2?param1=value1&param2=value2& …
+
<pre>
 +
  GET
 +
 
 +
url:
 +
  http://host/service/server/rpc.l1000?parameters
 +
 
 +
Headers:
 +
  X-Rpc-Method=service.action
 +
 
 +
Accept:
 +
  application/xml
 +
  application/json
 +
</pre>
  
 
{|class="wikitable"
 
{|class="wikitable"
Ligne 19 : Ligne 31 :
 
|Nom du service Ligne 1000 sur la machine
 
|Nom du service Ligne 1000 sur la machine
 
|-
 
|-
−
|restName
+
|X-Rpc-Method
−
|Nom du service REST à exécuter
+
|Champ spécifique de l'entête de requête contenant la méthode à exécuter
 
|-
 
|-
−
|restAction1
+
|Accept
−
|Nom principal de l’action du service REST à exécuter
+
|Type de contenu accepté
 
|-
 
|-
−
|restAction2
 
−
|Nom auxiliaire de l’action du service REST à exécuter ; généralement pas utilisé
 
−
|-
 
−
|Couples « paramètre=valeur »
 
 
|Paramètres de l’action.
 
|Paramètres de l’action.
 +
|Couples « paramètre=valeur »
 
|}
 
|}
  
 
L’appelant doit exécuter une commande HTTP / GET sur l’URL du service.
 
L’appelant doit exécuter une commande HTTP / GET sur l’URL du service.
−
La réponse d’un service REST est un flux XML dont la structure et le contenu vari suivant le service.
+
La réponse d’un service RPC est un flux XML ou JSON dont la structure et le contenu varie suivant le service.
 +
 
 +
===Aiguillage des requêtes===
 +
Lorsque le champ X-Rpc-Method n'est pas spécifié, le chemin de l'url est interprété pour déterminer la méthode :
 +
 
 +
{|class="wikitable"
 +
|-
 +
!url action
 +
!X-Rpc-Method
 +
|-
 +
|login.l1000
 +
|design.login
 +
|-
 +
|action.l1000
 +
|design.action
 +
|-
 +
|rpc.l1000
 +
|
 +
|-
 +
|portal.l1000
 +
|url.portal
 +
|-
 +
|connect.l1000
 +
|url.connect
 +
|-
 +
|rss.l1000
 +
|rss.<url fragment>
 +
|-
 +
|sdata.l1000
 +
|sdatajson.execute
 +
|-
 +
|sdata
 +
|sdatajson.execute
 +
|}
  
 
===Authentification===
 
===Authentification===
Ligne 39 : Ligne 81 :
  
 
{|class="wikitable"
 
{|class="wikitable"
 +
|-
 +
!Mode
 +
!Usage
 
|-
 
|-
 
|Aucun
 
|Aucun
Ligne 50 : Ligne 95 :
 
|}
 
|}
  
−
Voir aussi :
+
===Liste des services RPC===
−
 
+
[[:Category:Service RPC]]
−
*[[Service REST d'évènements métiers (server)|Service REST d'évènements métiers]]
+
  
 
{{footer}}
 
{{footer}}
 
[[Category:Serveur]]
 
[[Category:Serveur]]
 +
[[Category:Service RPC]]

Version actuelle en date du 9 octobre 2013 à 08:03

Sommaire

Introduction

Le serveur Ligne 1000 contient un service RPC qui permet d’accéder aux différents services techniques du serveur. Sa fonction première est d’offrir un accès à travers HTTP aux services techniques 1000 et de permettre ainsi une utilisation plus large de ces services.

Le serveur RPC 1000 interprète une URI, exécute le service RPC concerné et retourne le résultat en XML.

Format d'URL

Les points d’accès aux services RPC sont des URL définies à partir de la racine de l’URL du serveur Web. L’URL d’un service RPC est définie ainsi : 

 GET

 url:
   http://host/service/server/rpc.l1000?parameters

 Headers:
   X-Rpc-Method=service.action

 Accept:
   application/xml
   application/json
HostName Nom DNS de la machine Serveur
ServiceName Nom du service Ligne 1000 sur la machine
X-Rpc-Method Champ spécifique de l'entête de requête contenant la méthode à exécuter
Accept Type de contenu accepté
Paramètres de l’action. Couples « paramètre=valeur »

L’appelant doit exécuter une commande HTTP / GET sur l’URL du service. La réponse d’un service RPC est un flux XML ou JSON dont la structure et le contenu varie suivant le service.

Aiguillage des requêtes

Lorsque le champ X-Rpc-Method n'est pas spécifié, le chemin de l'url est interprété pour déterminer la méthode :

url action X-Rpc-Method
login.l1000 design.login
action.l1000 design.action
rpc.l1000
portal.l1000 url.portal
connect.l1000 url.connect
rss.l1000 rss.<url fragment>
sdata.l1000 sdatajson.execute
sdata sdatajson.execute

Authentification

Il existe différent modes d'authentification suivant l'usage du service :

Mode Usage
Aucun Le service ne requière pas d’authentification.
Anonyme Le service requière une authentification, si celle-ci n’est pas fournie dans les paramètres de l’appel une session anonyme, rattachée à l’utilisateur du serveur, sera créée.
Authentifié Le service requière une authentification passée en paramètre. L’identifiant de session doit être passé dans un paramètre SID de l'URL ou bien à travers les cookies de session.

Liste des services RPC

Category:Service RPC

— Développement DSM —

Récupérée de « https://frp.sage.fr/wiki1000/index.php?title=Services_RPC_(server)&oldid=7675 »
Outils personnels