com.day.cq.xss

Interface EscapingRule

Deprecated.

@Deprecated
public interface EscapingRule

This interface must be implemented for each ProtectionContext.

Since:

5.4

Method Summary

Modifier and Type	Method and Description
void	configure(String policyPath, String[] relPathPrefixes, SlingRepository repository) Deprecated. Configures the rule.
String	escape(String str) Deprecated. Escapes the specified string according to the implementes rule.

Method Detail

configure

void configure(String policyPath,
               String[] relPathPrefixes,
               SlingRepository repository)
        throws XSSProtectionException

Deprecated.

Configures the rule.

Parameters:

policyPath - Path to the policy file to be used

relPathPrefixes - Array containing prefixes for resolving relative path prefixes

repository - The repository to use

Throws:

XSSProtectionException - if an error occured during configuring the service

escape

String escape(String str)
       throws XSSProtectionException

Deprecated.

Escapes the specified string according to the implementes rule.

Parameters:

str - The string to be encoded

Returns:

The escaped string

Throws:

XSSProtectionException - if an error occured while escaping the string