Référence d’ensemble de règles

La diffusion d’images prend en charge un mécanisme de prétraitement des requêtes simple basé sur les règles de correspondance et de substitution des expressions régulières.

Les collections de règles de prétraitement (ensembles de règles) peuvent être jointes aux catalogues d’images ou au catalogue par défaut. Les règles du catalogue par défaut s’appliquent uniquement si la requête n’identifie pas un catalogue d’images principal spécifique.

Les règles de prétraitement des requêtes peuvent modifier les parties de chemin et de requête des requêtes avant qu’elles ne soient traitées par l’analyseur du serveur Platform, notamment en manipulant le chemin, en ajoutant des commandes, en modifiant les valeurs de commande et en appliquant des modèles ou des macros. Des règles peuvent également être utilisées pour configurer et remplacer certaines fonctionnalités de sécurité qui sont normalement contrôlées uniquement avec des attributs de catalogue, comme l’obscurcissement des demandes, le marquage à l’eau, ainsi que la limitation du service à des adresses IP client spécifiques.

Les ensembles de règles sont stockés sous la forme de fichiers de document XML. Le chemin relatif ou absolu du fichier d’ensemble de règles doit être spécifié dans attribute::RuleSetFile.

Structure générale

 <?xml version="1.0" encoding="UTF-8"?> 
<ruleset> 
   <rule> 
      <expression> 
<varname>
  expression 
</varname></expression> 
      <substitution> 
<varname>
  substitution 
</varname></substitution> 
      <addressfilter> 
<varname>
  addressFilter 
</varname></addressfilter> 
      <header> 
<varname>
  headerValue 
</varname></header>  
   </rule> 
</ruleset>

Les éléments <?xml> et <ruleset> sont toujours requis dans un fichier XML d’ensemble de règles valide, même si aucune règle réelle n’est définie.

Un élément <ruleset> contenant un nombre indéfini d'éléments <rule> est autorisé.

Le contenu des fichiers de règles de prétraitement est sensible à la casse.

Validation des jeux de règles

Une copie de RuleSet.xsd est fournie dans le dossier de catalogue et doit être utilisée pour valider un fichier d’ensemble de règles avant de l’enregistrer dans le fichier catalog.ini. Notez que le serveur d’images utilise une copie interne de RuleSet.xsd pour la validation.

Prétraitement des URL

Avant tout autre traitement, une requête HTTP entrante est partiellement analysée afin de déterminer quel catalogue d’images doit être appliqué. Une fois le catalogue identifié, le jeu de règles pour le catalogue sélectionné (ou le catalogue par défaut, si aucun catalogue spécifique n’a été identifié) est appliqué.

Les éléments <rule> sont recherchés dans l’ordre spécifié pour une correspondance avec le contenu de l’élément <expression> ( expression).

Si une correspondance <rule> est trouvée, la valeur facultative substitution est appliquée et la chaîne de requête modifiée est transmise à l’analyseur de requêtes du serveur pour un traitement normal.

Si aucune correspondance réussie n’est effectuée lorsque la fin de <ruleset> est atteinte, la requête est transmise à l’analyseur sans modification.

Attribut OnMatch

Le comportement par défaut peut être modifié avec l'attribut OnMatch de l'élément <rule>. OnMatch peut être défini sur break (par défaut), continue ou error.

Elément et attribut Comportement lorsqu’une correspondance se produit

<rule OnMatch="break">

Le traitement des règles est arrêté immédiatement après l’application de la substitution de cette règle. Par défaut.

<rule OnMatch="continue">

La substitution est appliquée et le traitement se poursuit avec la règle suivante.

<rule OnMatch="error">

Le traitement de la règle est arrêté immédiatement et un état de réponse "demande refusée" est renvoyé au client.

Remplacement des attributs de catalogue

<rule> Les éléments peuvent éventuellement définir des attributs qui remplacent les attributs de catalogue correspondants lorsque la règle est correctement mise en correspondance. Si plusieurs règles correspondantes définissent le même attribut, le dernier l’emporte. Reportez-vous à la description de l’élément [<rule>](../../../../../is-api/image-catalog/image-serving-api-ref/c-image-catalog-reference/c-rule-set-reference/r-rule-rule.md#reference-af76c0e2b8be48dabb52b71fe7e51ee9) pour obtenir la liste des attributs qui peuvent être contrôlés avec des règles.

Expressions régulières

Une correspondance de chaîne simple fonctionne pour les applications très basiques, mais des expressions régulières sont requises dans la plupart des cas. Bien que les expressions régulières soient standard dans le secteur, l’implémentation spécifique varie d’une instance à l’autre.

package java.util.regex décrit l’implémentation spécifique des expressions régulières utilisée par le serveur d’images.

Sous-chaînes capturées

Pour faciliter des modifications d’URL complexes, les sous-chaînes peuvent être capturées dans l’expression en encadrant la sous-chaîne avec des parenthèses (…). Les sous-chaînes capturées sont numérotées de manière séquentielle, en commençant par 1, selon la position de la parenthèse de début. Les sous-chaînes capturées peuvent être insérées dans la substitution à l’aide de $ *n*, où n est le numéro de séquence de la sous-chaîne capturée.

Gestion des fichiers de jeu de règles

Un fichier d’ensemble de règles peut être joint à chaque catalogue d’images avec l’attribut de catalogue attribute::RuleSetFile. Bien que vous puissiez modifier le fichier d’ensemble de règles à tout moment, le serveur d’images ne reconnaît les modifications que lorsque le catalogue d’images associé est rechargé. Ce rechargement se produit au démarrage ou au redémarrage du serveur de plateforme et chaque fois que le Principal fichier catalogue, portant le suffixe .ini, est modifié ou "modifié" pour modifier la date du fichier.

Exemples

Exemple A. Définissez une règle qui augmente les paramètres de qualité de l’image si le nom de l’image porte le suffixe " _hg" :

<rule> 
   <expression>(?i)_hg$</expression> 
   <substitution>\?&amp;qlt=95,1&amp;resmode=bicub</substitution> 
</rule>

L’expression de règle spécifie une correspondance "_hg" non sensible à la casse à la fin de la chaîne d’URL. Le suffixe est remplacé par la chaîne de requête spécifiée qui modifie les paramètres de qualité de l’image. Notez que le caractère ? de la chaîne de substitution est échappé car il s’agit d’un caractère spécial dans les expressions régulières.

REMARQUE

Codage requis pour le caractère esperluette. Une autre solution consiste à placer la chaîne de substitution dans un bloc CDATA :

<substitution><![CDATA[&qlt=95,1&resmode=bicub]]></substitution>

Exemple B. Une application web particulière n’autorise pas les chaînes de requête. Définissez une règle qui convertit l’élément de chemin de fin small, medium ou large en modèle, en utilisant le reste du chemin comme nom de l’image. Par exemple, myCat/myImage/small signifie myCat/smallTemplate?src=myCat/myImage.

Nous pouvons utiliser des sous-chaînes pour restructurer la requête :

<rule> 
   <expression>([^/]+)/(small|medium|large)$</expression> 
   <substitution>$2Template?src=sample/$1</substitution> 
</rule>

Voir aussi

package java.util.regex

Sur cette page