Regelsatzreferenz

Image Serving unterstützt einen einfachen Anfragevorverarbeitungsmechanismus, der auf Übereinstimmungs- und Ersatzregeln für reguläre Ausdrücke basiert.

Sammlungen von Vorverarbeitungsregeln (Regelsätze) können an Bildkataloge oder den Standardkatalog angehängt werden. Regeln im Standardkatalog gelten nur, wenn die Anforderung keinen bestimmten Hauptbildkatalog identifiziert.

Die Vorab-Verarbeitungsregeln für Anfragen können den Pfad und die Anfrageabschnitte ändern, bevor sie vom Parser des Platform-Servers verarbeitet werden. Dazu gehören das Manipulieren des Pfads, das Hinzufügen von Befehlen, das Ändern von Befehlswerten und das Anwenden von Vorlagen oder Makros. Regeln können auch verwendet werden, um bestimmte Sicherheitsfunktionen zu konfigurieren und zu überschreiben, die normalerweise nur mit Katalogattributen gesteuert werden, z. B. Anforderungsverschleierung, Wasserzeichen und Beschränkung des Diensts auf bestimmte Client-IP-Adressen.

Regelsätze werden als XML-Dokumentdateien gespeichert. Der relative oder absolute Pfad der Regelsatzdatei muss in attribute::RuleSetFile angegeben werden.

Allgemeine Struktur

 <?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>

Die Elemente <?xml> und <ruleset> sind immer in einer gültigen XML-Regelsatz-Datei erforderlich, auch wenn keine tatsächlichen Regeln definiert sind.

Ein <ruleset> -Element, das eine beliebige Anzahl von <rule> -Elementen enthält, ist zulässig.

Beim Inhalt von Regeldateien zur Vorverarbeitung wird zwischen Groß- und Kleinschreibung unterschieden.

Regelsatzvalidierung

Eine Kopie von RuleSet.xsd wird im Katalogordner bereitgestellt und sollte verwendet werden, um eine Regelsatzdatei zu validieren, bevor sie in der Datei catalog.ini registriert wird. Beachten Sie, dass Image Serving eine interne Kopie von RuleSet.xsd zur Validierung verwendet.

URL-Vorverarbeitung

Vor jeder anderen Verarbeitung wird eine eingehende HTTP-Anforderung teilweise analysiert, um zu bestimmen, welcher Bildkatalog angewendet werden soll. Sobald der Katalog identifiziert wurde, wird der Regelsatz für den ausgewählten Katalog (oder der Standardkatalog, wenn kein bestimmter Katalog identifiziert wurde) angewendet.

Die <rule> -Elemente werden in der Reihenfolge gesucht, die für eine Übereinstimmung mit dem Inhalt des <expression> -Elements ( expression) angegeben ist.

Wenn eine <rule>-Übereinstimmung vorliegt, wird das optionale substitution angewendet und die geänderte Anforderungszeichenfolge wird zur normalen Verarbeitung an den Anforderungsparser des Servers übergeben.

Wenn beim Erreichen des Endes von <ruleset> keine erfolgreiche Übereinstimmung erfolgt, wird die Anforderung ohne Änderung an den Parser übergeben.

Das OnMatch-Attribut

Das Standardverhalten kann mit dem Attribut OnMatch des Elements <rule> geändert werden. OnMatch kann auf break (Standard), continue oder errorgesetzt werden.

Element und Attribut Verhalten bei Übereinstimmung

<rule OnMatch="break">

Die Regelverarbeitung wird sofort beendet, nachdem die Ersetzung für diese Regel vorgenommen wurde. Standard.

<rule OnMatch="continue">

Die Ersetzung wird angewendet und die Verarbeitung wird mit der nächsten Regel fortgesetzt.

<rule OnMatch="error">

Die Regelverarbeitung wird sofort beendet und der Antwortstatus "Anfrage verweigert"wird an den Client zurückgegeben.

Überschreiben von Katalogattributen

<rule> -Elemente können optional Attribute definieren, die die entsprechenden Katalogattribute überschreiben, wenn die Regel erfolgreich abgeglichen wird. Wenn mehrere übereinstimmende Regeln dasselbe Attribut festlegen, hat das letzte Vorrang. Eine Liste der Attribute, die mit Regeln gesteuert werden können, finden Sie in der Beschreibung des Elements [<rule>](../../../../../is-api/image-catalog/image-serving-api-ref/c-image-catalog-reference/c-rule-set-reference/r-rule-rule.md#reference-af76c0e2b8be48dabb52b71fe7e51ee9) .

Reguläre Ausdrücke

Einfache Zeichenfolgenabgleiche funktionieren für sehr einfache Anwendungen, aber in den meisten Fällen sind reguläre Ausdrücke erforderlich. Während reguläre Ausdrücke den Branchenstandard aufweisen, variiert die spezifische Implementierung von Instanz zu Instanz.

package java.util.regex beschreibt die spezifische Implementierung regulärer Ausdrücke, die von Image Serving verwendet wird.

Erfasste Unterzeichenfolgen

Um komplexe URL-Änderungen zu erleichtern, können Unterzeichenfolgen im Ausdruck erfasst werden, indem die Unterzeichenfolge in Klammern (…) eingeschlossen wird. Erfasste Teilzeichenfolgen werden in der Reihenfolge mit 1 beginnend gemäß der Position der führenden Klammer nummeriert. Die erfassten Unterzeichenfolgen können mithilfe von $ *n* in die Substitution eingefügt werden, wobei n die Sequenznummer der erfassten Unterzeichenfolge ist.

Verwalten von Regelsatzdateien

An jeden Bildkatalog mit dem Katalogattribut attribute::RuleSetFile kann eine Regelsatzdatei angehängt werden. Sie können die Regelsatzdatei zwar jederzeit bearbeiten, der Bildserver erkennt die Änderungen jedoch nur, wenn der zugehörige Bildkatalog neu geladen wird. Diese Neuladung erfolgt beim Start oder Neustart des Plattformservers und immer dann, wenn die primäre Katalogdatei mit dem Suffix .ini geändert oder "geändert"wird, um das Dateidatum zu ändern.

Beispiele

Beispiel A. Definieren Sie eine Regel, die die Bildqualitätseinstellungen erhöht, wenn der Bildname das Suffix " _hg" aufweist:

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

Der Regelausdruck gibt eine Übereinstimmung von "_hg"ohne Unterscheidung zwischen Groß- und Kleinschreibung am Ende der URL-Zeichenfolge an. Das Suffix wird durch die angegebene Abfragezeichenfolge ersetzt, die die Bildqualitätseinstellungen ändert. Beachten Sie, dass das Zeichen ? in der Ersatzzeichenfolge mit Escapezeichen versehen ist, da es sich hierbei in regulären Ausdrücken um ein Sonderzeichen handelt.

HINWEIS

Die erforderliche Kodierung für das kaufmännische Und-Zeichen. Alternativ kann die Ersatzzeichenfolge in einen CDATA-Block eingeschlossen werden:

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

Beispiel B. Eine bestimmte Webanwendung lässt keine Abfragezeichenfolgen zu. Definieren Sie eine Regel, die das nachfolgende Pfadelement small, medium oder large in eine Vorlage übersetzt, wobei der restliche Pfad als Bildname verwendet wird. myCat/myImage/small würde beispielsweise in myCat/smallTemplate?src=myCat/myImage übersetzen.

Wir können Unterzeichenfolgen verwenden, um die Anforderung neu zu strukturieren:

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

Verwandte Themen

package java.util.regex

Auf dieser Seite