Image Server supporta un semplice meccanismo di preelaborazione delle richieste basato su regole di corrispondenza e sostituzione delle espressioni regolari.
Raccolte di regole di pre-elaborazione (set di regole) può essere allegato ai cataloghi di immagini o al catalogo predefinito. Le regole del catalogo predefinito si applicano solo se la richiesta non identifica un catalogo principale di immagini specifico.
Le regole di pre-elaborazione delle richieste possono modificare il percorso e eseguire query su parti delle richieste prima che vengano elaborate da Platform Serverparser di, inclusa la modifica del percorso, l'aggiunta di comandi, la modifica dei valori dei comandi e l'applicazione di modelli o macro. Le regole possono essere utilizzate anche per configurare e ignorare alcune funzioni di sicurezza che di solito sono controllate solo con attributi di catalogo, come offuscamento delle richieste, watermark, nonché per limitare il servizio a specifici indirizzi IP client.
I set di regole vengono memorizzati come file di documenti XML. Il percorso relativo o assoluto del file del set di regole deve essere specificato in attribute::RuleSetFile
.
<?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>
Il <?xml>
e <ruleset>
Gli elementi sono sempre necessari in un file XML di set di regole valido, anche se non sono definite regole effettive.
Uno <ruleset>
elemento contenente un numero qualsiasi di <rule>
sono consentiti.
Il contenuto dei file delle regole di preelaborazione distingue tra maiuscole e minuscole.
Una copia di RuleSet.xsd viene fornito nella cartella del catalogo e deve essere utilizzato per convalidare un file di set di regole prima di registrarlo in catalog.ini file. Image Server utilizza una copia interna di RuleSet.xsd per la convalida.
Prima di qualsiasi altra elaborazione, viene parzialmente analizzata una richiesta HTTP in ingresso per determinare quale catalogo immagini applicare. Una volta identificato il catalogo, viene applicato il set di regole per il catalogo selezionato (o il catalogo predefinito, se non è stato identificato alcun catalogo specifico).
Il <rule>
Gli elementi vengono cercati nell'ordine specificato per una corrispondenza con il contenuto del <expression>
elemento ( expression
).
Se un <rule>
corrisponde, l'opzione substitution
viene applicata e la stringa di richiesta modificata viene passata al parser di richieste del server per la normale elaborazione.
Se non viene trovata alcuna corrispondenza corretta quando la fine del <ruleset>
viene raggiunto, la richiesta viene passata al parser senza modifiche.
Il comportamento predefinito può essere modificato con OnMatch
attributo del <rule>
elemento. OnMatch
può essere impostato su break
(impostazione predefinita), continue
, o error
.
Elemento e attributo | Comportamento quando si verifica una corrispondenza |
---|---|
<rule OnMatch="break"> |
L'elaborazione delle regole viene terminata immediatamente dopo l'applicazione della sostituzione per questa regola. Predefinito. |
<rule OnMatch="continue"> |
La sostituzione viene applicata e l’elaborazione continua con la regola successiva. |
<rule OnMatch="error"> |
L’elaborazione delle regole viene interrotta immediatamente e al client viene restituito lo stato di risposta "richiesta rifiutata". |
Il rule
L'elemento può facoltativamente definire attributi che sostituiscono gli attributi di catalogo corrispondenti quando la regola viene trovata correttamente. Se più regole corrispondenti impostano lo stesso attributo, prevale l’ultimo. Consulta regola per un elenco di attributi che possono essere controllati tramite regole.
La corrispondenza delle stringhe semplice funziona per applicazioni molto semplici, ma nella maggior parte dei casi sono necessarie espressioni regolari. Anche se le espressioni regolari sono standard di settore, l’implementazione specifica varia da un’istanza all’altra.
package java.util.regex descrive l’implementazione specifica di espressioni regolari utilizzata da Image Server.
Per facilitare modifiche URL complesse, è possibile acquisire sottostringhe nell’espressione racchiudendo la sottostringa tra parentesi (…). Le sottostringhe acquisite vengono numerate in sequenza iniziando da 1 in base alla posizione delle parentesi iniziali. Le sottostringhe acquisite possono essere inserite nella sostituzione utilizzando $ *
n*
, dove n
è il numero di sequenza della sottostringa acquisita.
È possibile allegare un file di set di regole a ciascun catalogo immagini con l’attributo catalogo attribute::RuleSetFile
. Anche se è possibile modificare il file del set di regole in qualsiasi momento, il server immagini riconosce le modifiche solo quando il catalogo immagini associato viene ricaricato. Questo ricaricamento si verifica all'avvio o al riavvio del server della piattaforma e ogni volta che il file di catalogo principale, che include .ini suffisso del file, viene modificato o "toccato" per modificare la data del file.
Esempio A. Definisci una regola che aumenti le impostazioni di qualità delle immagini se il nome dell’immagine ha il suffisso " _hg":
<rule>
<expression>(?i)_hg$</expression>
<substitution>\?&qlt=95,1&resmode=bicub</substitution>
</rule>
L’espressione della regola specifica una corrispondenza senza distinzione tra maiuscole e minuscole di " _hg" alla fine della stringa URL. Il suffisso viene sostituito con la stringa di query specificata che modifica le impostazioni di qualità dell'immagine. Tieni presente che ?
carattere nella stringa di sostituzione è preceduta da un carattere di escape, in quanto si tratta di un carattere speciale nelle espressioni regolari.
La codifica richiesta per il carattere e commerciale. In alternativa, la stringa di sostituzione potrebbe essere racchiusa in un blocco CDATA:
<substitution><![CDATA[&qlt=95,1&resmode=bicub]]></substitution>
Esempio B. Una particolare applicazione Web non consente stringhe di query. Definisci una regola che traduca l’elemento del percorso finale small
, medium
, o large
in un modello, utilizzando il resto del percorso come nome dell'immagine. Ad esempio: myCat/myImage/small
tradurrebbe in myCat/smallTemplate?src=myCat/myImage
.
È possibile utilizzare le sottostringhe per ristrutturare la richiesta:
<rule>
<expression>([^/]+)/(small|medium|large)$</expression>
<substitution>$2Template?src=sample/$1</substitution>
</rule>