Fork me on GitHub

Descriptif du plugin

Introduction

Ce module permet de manipuler des données, sous forme de web services REST, des fichiers du plugin BlobStore.

Installation

Configurer les clés privées utilisées pour les signatures dans le fichier blobstore-rest.xml :

<filters>
	<filter>
		<filter-name>CRMRestSecurity</filter-name>
		<url-pattern>/rest/blobstore/*</url-pattern>
		<filter-class>fr.paris.lutece.util.signrequest.servlet.HeaderHashRequestFilter</filter-class>

		<init-param>
			<param-name>elementsSignature</param-name>
			<param-value>blob_key</param-value>
		</init-param>

		<init-param>
			<param-name>validityTimePeriod</param-name>
			<param-value>0</param-value>
		</init-param>

		<init-param>
			<param-name>privateKey</param-name>
			<param-value>change me</param-value>
		</init-param>
	</filter>
</filters>

Usage - JSP de test

Il existe une JSP permettant de faire des tests sur le module-blobstore-rest. Elle est accessible par l'URL suivante :

jsp/admin/plugins/blobstore/modules/rest/TestBlobStoreRest.jsp

Note : Pour accéder à cette JSP, il faut être authentifié dans le Back-Office. Il faut également commenter dans le fichier blobstore-rest.xml les filtres de façon à ce qu'il n'utilise pas la sécurité, sinon une réponse HTTP 401 sera renvoyée.

Syntaxe des URLs

Création d'un blob

Pour créer un blob, il faut faire un formulaire de type POST, ayant un enctype multipart/form-data et avoir les paramètres suivants :

Nom du paramètre Type du paramètre Description du paramètre
blobstore text Correspond au nom du BlobStore Service
blob file Correspond au fichier à uploader

http://myhost/mywebapps/rest/blobstore/create

Suppression d'un blob

Pour supprimer un blob, il faut faire un formulaire de type POST et avoir les paramètres suivants :

Nom du paramètre Type du paramètre Description du paramètre
blob_key text Correspond à l'ID du blob
blobstore text Correspond au nom du BlobStore Service

http://myhost/mywebapps/rest/blobstore/delete