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 java.lang.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
java.lang.String[]	extensions Restrict the filter to extensions that match request's.
java.lang.String[]	methods Restrict the filter to methods that match request's.
java.lang.String	pattern Restrict the filter to request paths that match the supplied regular expression.
java.lang.String[]	resourceTypes Restrict the filter to resources that match any of the supplied resource types.
SlingServletFilterScope[]	scope The scopes of the filter.
java.lang.String[]	selectors Restrict the filter to request selectors that match any of the request's.
java.lang.String	suffix_pattern Restrict the filter to request suffixes that match the supplied regular expression.

Field Detail

PREFIX_

public static final java.lang.String PREFIX_

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

Element Detail

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

pattern

public abstract java.lang.String pattern

Restrict the filter to request paths that match the supplied regular expression. Empty value will not restrict the filter on request path. Requires Sling Engine 2.4.0.

Returns:

the request path pattern to restrict the filter

Default:

""

suffix_pattern

public abstract java.lang.String suffix_pattern

Restrict the filter to request suffixes that match the supplied regular expression. Empty value will not restrict the filter on request suffix. Requires Sling Engine 2.7.0.

Returns:

the suffix pattern to restrict the filter

Default:

""

resourceTypes

public abstract java.lang.String[] resourceTypes

Restrict the filter to resources that match any of the supplied resource types. Please note this is a sling resource API isResourceType() match, not a string match. Empty value will not restrict the filter on request's resource type. Requires Sling Engine 2.7.0.

Returns:

the resourceTypes to restrict the filter

Default:

{}

methods

public abstract java.lang.String[] methods

Restrict the filter to methods that match request's. Empty value will not restrict the filter on request method. Requires Sling Engine 2.7.0.

Returns:

the methods to restrict the filter

Default:

{}

extensions

public abstract java.lang.String[] extensions

Restrict the filter to extensions that match request's. Empty value will not restrict the filter on request extension. Requires Sling Engine 2.7.0.

Returns:

the extensions to restrict the filter

Default:

{}

selectors

public abstract java.lang.String[] selectors

Restrict the filter to request selectors that match any of the request's. At least one selector must match one of the provided selectors. Empty value will not restrict the filter on request selectors. Requires Sling Engine 2.7.0.

Returns:

the selectors to restrict the filter

Default:

{}