O Serviço de imagem suporta um mecanismo de pré-processamento de solicitação simples que se baseia em regras de substituição e correspondência de expressão regular.
As coleções de regras de pré-processamento (conjuntos de regras) podem ser anexadas aos catálogos de imagens ou ao catálogo padrão. As regras no catálogo padrão se aplicam somente se a solicitação não identificar um catálogo de imagens principal específico.
As regras de pré-processamento de solicitação podem modificar as partes de caminho e query das solicitações antes de serem processadas pelo analisador do Servidor de plataforma, incluindo manipular o caminho, adicionar comandos, alterar valores de comando e aplicar modelos ou macros. As regras também podem ser usadas para configurar e substituir determinados recursos de segurança que normalmente são controlados apenas com atributos de catálogo, como ofuscação de solicitação, marcação de água, além de limitar o serviço a endereços IP específicos do cliente.
Os conjuntos de regras são armazenados como arquivos de documento XML. O caminho relativo ou absoluto do arquivo de conjunto de regras deve ser especificado em 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>
Os elementos <?xml>
e <ruleset>
são sempre necessários em um arquivo XML de conjunto de regras válido, mesmo que nenhuma regra real seja definida.
Um elemento <ruleset>
contendo qualquer número de elementos <rule>
é permitido.
O conteúdo dos arquivos de regras de pré-processamento faz distinção entre maiúsculas e minúsculas.
Uma cópia de RuleSet.xsd é fornecida na pasta do catálogo e deve ser usada para validar um arquivo de conjunto de regras antes de registrá-lo no arquivo catalog.ini. Observe que o Serviço de imagem usa uma cópia interna de RuleSet.xsd para validação.
Antes de qualquer outro processamento, uma solicitação HTTP recebida é parcialmente analisada para determinar qual catálogo de imagens deve ser aplicado. Depois que o catálogo é identificado, o conjunto de regras para o catálogo selecionado (ou o catálogo padrão, se nenhum catálogo específico foi identificado) é aplicado.
Os elementos <rule>
são pesquisados na ordem especificada para uma correspondência com o conteúdo do elemento <expression>
( expression
).
Se um <rule>
for correspondido, o substitution
opcional será aplicado e a string de solicitação modificada será transmitida ao analisador de solicitação do servidor para processamento normal.
Se nenhuma correspondência bem-sucedida for feita quando o fim de <ruleset>
for atingido, a solicitação será transmitida ao analisador sem modificação.
O comportamento padrão pode ser modificado com o atributo OnMatch
do elemento <rule>
. OnMatch
pode ser definido como break
(padrão), continue
ou error
.
Elemento e atributo | Comportamento quando ocorre uma correspondência |
---|---|
<rule OnMatch="break"> |
O processamento da regra é encerrado imediatamente após a aplicação da substituição desta regra. Padrão. |
<rule OnMatch="continue"> |
A substituição é aplicada e o processamento continua com a regra seguinte. |
<rule OnMatch="error"> |
O processamento da regra é encerrado imediatamente e um status de resposta "solicitação recusada" é retornado ao cliente. |
<rule>
como opção, os elementos podem definir atributos que substituem os atributos do catálogo correspondente quando a regra for correspondida com êxito. Se várias regras correspondentes definirem o mesmo atributo, o último prevalecerá. Consulte a descrição do elemento [<rule>](../../../../../is-api/image-catalog/image-serving-api-ref/c-image-catalog-reference/c-rule-set-reference/r-rule-rule.md#reference-af76c0e2b8be48dabb52b71fe7e51ee9)
para obter uma lista de atributos que podem ser controlados com regras.
A correspondência de sequência simples funciona para aplicativos muito básicos, mas expressões comuns são necessárias na maioria das instâncias. Embora as expressões regulares sejam padrão do setor, a implementação específica varia de instância para instância.
package java.util.regex descreve a implementação regular específica da expressão usada pelo Serviço de imagem.
Para facilitar modificações complexas de URL, as subsequências de caracteres podem ser capturadas na expressão ao delimitar a subsequência de caracteres com parênteses (…). As subsequências capturadas são numeradas sequencialmente começando com 1 de acordo com a posição dos parênteses à esquerda. As subsequências capturadas podem ser inseridas na substituição usando $ *
n*
, onde n
é o número de sequência da subsequência de caracteres capturada.
Um arquivo de conjunto de regras pode ser anexado a cada catálogo de imagens com o atributo de catálogo attribute::RuleSetFile
. Embora seja possível editar o arquivo de conjunto de regras a qualquer momento, o servidor de imagens reconhece as alterações somente quando o catálogo de imagens associado é recarregado. Esse recarregamento ocorre quando o servidor da plataforma é iniciado ou reiniciado e sempre que o arquivo do catálogo primário, que tem um sufixo de arquivo .ini, é modificado ou "tocado" para alterar a data do arquivo.
Exemplo A. Defina uma regra que aumente as configurações de qualidade da imagem se o nome da imagem tiver o sufixo " _hg":
<rule>
<expression>(?i)_hg$</expression>
<substitution>\?&qlt=95,1&resmode=bicub</substitution>
</rule>
A expressão de regra especifica uma correspondência que não diferencia maiúsculas de minúsculas de " _hg" no final da string de URL. O sufixo é substituído pela string de query especificada, que altera as configurações de qualidade da imagem. Observe que o caractere ?
na string de substituição é escapado, pois esse é um caractere especial nas expressões regulares.
A codificação necessária para o caractere de E comercial. Como alternativa, a string de substituição pode ser fechada em um bloco CDATA:
<substitution><![CDATA[&qlt=95,1&resmode=bicub]]></substitution>
Exemplo B. Um aplicativo da Web específico não permite strings de query. Defina uma regra que traduza o elemento de caminho à direita small
, medium
ou large
para um modelo, usando o restante do caminho como o nome da imagem. Por exemplo, myCat/myImage/small
traduziria para myCat/smallTemplate?src=myCat/myImage
.
Podemos usar subsequências para reestruturar a solicitação:
<rule>
<expression>([^/]+)/(small|medium|large)$</expression>
<substitution>$2Template?src=sample/$1</substitution>
</rule>