org.apache.sling.engine.impl.filter

Class SlingFilterChainHelper

java.lang.Object

org.apache.sling.engine.impl.filter.SlingFilterChainHelper

public class SlingFilterChainHelper
extends Object

The SlingFilterChainHelper class is used by Sling to support building lists of Filters. To ensure filter ordering, each filter is optionally registered with an ordering index. If none is provided the default ordering index is Integer.MAX_VALUE to append the filter to the end of the list.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SlingFilterChainHelper.FilterListEntry

Method Summary

Methods

Modifier and Type	Method and Description
javax.servlet.Filter	addFilter(javax.servlet.Filter filter, Long filterId, int order, String orderSource)
SlingFilterChainHelper.FilterListEntry[]	getFilterListEntries() Returns the list of FilterListEntrys added to this instance or null if no filters have been added.
javax.servlet.Filter[]	getFilters() Returns the list of Filters added to this instance or null if no filters have been added.
boolean	removeFilterById(Object filterId)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

addFilter

public javax.servlet.Filter addFilter(javax.servlet.Filter filter,
                             Long filterId,
                             int order,
                             String orderSource)

removeFilterById

public boolean removeFilterById(Object filterId)

getFilters

public javax.servlet.Filter[] getFilters()

Returns the list of Filters added to this instance or null if no filters have been added. This method doesn't need to be synced as it is only returned the current cached filter array.

getFilterListEntries

public SlingFilterChainHelper.FilterListEntry[] getFilterListEntries()

Returns the list of FilterListEntrys added to this instance or null if no filters have been added.