org.apache.sling.servlets.annotations

Annotation Type SlingServletFilter

@ComponentPropertyType
public @interface SlingServletFilter

Component Property Type (as defined by OSGi DS 1.4) for Sling Servlet Filters. Takes care of writing the relevant service properties as being used by the Sling Servlet Resolver (ServletResolverConstants) to register the annotated servlet filter component as Sling servlet filter.

The order of the filter is determined by the property service.ranking. To set it use the annotation ServiceRanking. Its value is used to sort the filters. Filters with a higher order are executed before a filter with a lower order. If two filters have the same order, the one with the lower service id is executed first.

Please note that the ordering is actually depending on the used Apache Sling Engine bundle version. Version older than 2.3.4 of that bundle are sorting the filters in the wrong reverse order. Make sure to run a newer version of the Sling engine to get the correct ordering (see also SLING-2920).

See Also:

Felix SCR annotation, Sling Servlet Filter

Field Summary

Fields

Modifier and Type	Fields and Description
static String	PREFIX_ Prefix for every property being generated from the annotations elements (as defined in OSGi 7 Compendium, 112.8.2.1)

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	pattern Restrict the filter to paths that match the supplied regular expression.
SlingServletFilterScope[]	scope The scopes of the filter.

Field Detail

PREFIX_

public static final String PREFIX_

Prefix for every property being generated from the annotations elements (as defined in OSGi 7 Compendium, 112.8.2.1)

Element Detail

pattern

public abstract String pattern

Restrict the filter to paths that match the supplied regular expression. Requires Sling Engine 2.4.0.

Returns:

the pattern to restrict the filter

Default:

""

scope

public abstract SlingServletFilterScope[] scope

The scopes of the filter. If the filter has request scope, it is run once for a request. If the filter has component scope, it is run once for every included component (rendering).

Returns:

the scope of the filter

Default:

org.apache.sling.servlets.annotations.SlingServletFilterScope.REQUEST