Package com.adobe.acs.commons.redirects.filter

Class RedirectFilter

java.lang.Object

javax.management.StandardMBean

com.adobe.granite.jmx.annotation.AnnotatedStandardMBean

com.adobe.acs.commons.redirects.filter.RedirectFilter

All Implemented Interfaces:

RedirectFilterMBean, DynamicMBean, MBeanRegistration, javax.servlet.Filter, org.apache.sling.api.resource.observation.ResourceChangeListener, org.osgi.service.event.EventHandler

public class RedirectFilter
extends com.adobe.granite.jmx.annotation.AnnotatedStandardMBean
implements javax.servlet.Filter, org.osgi.service.event.EventHandler, org.apache.sling.api.resource.observation.ResourceChangeListener, RedirectFilterMBean

A request filter that implements support for virtual redirects.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static @interface	RedirectFilter.Configuration

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACS_REDIRECTS_RESOURCE_TYPE
static final String	DEFAULT_CONFIG_BUCKET
static final String	DEFAULT_CONFIG_NAME
static final String	REDIRECT_RULE_RESOURCE_TYPE

Fields inherited from interface org.apache.sling.api.resource.observation.ResourceChangeListener

CHANGE_ADDED, CHANGE_CHANGED, CHANGE_PROVIDER_ADDED, CHANGE_PROVIDER_REMOVED, CHANGE_REMOVED, CHANGES, PATHS, PROPERTY_NAMES_HINT

Constructor Summary

Constructors

Constructor	Description
RedirectFilter()

Method Summary

Modifier and Type	Method	Description
protected final void	activate(RedirectFilter.Configuration config, org.osgi.framework.BundleContext context)
void	deactivate()
void	destroy()
void	doFilter(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain)
String	getBucket()
String	getConfigName()
protected Collection<String>	getExtensions()
protected Collection<String>	getMethods()
protected List<org.apache.http.Header>	getOnDeliveryHeaders()
protected Collection<String>	getPaths()
Collection<String>	getRedirectConfigurations()	JMX Operation: get a list of loaded configurations, e.g.
TabularData	getRedirectRules(String storagePath)	JMX Operation: Display loaded rules for a path, e.g.
static Collection<RedirectRule>	getRules(org.apache.sling.api.resource.Resource resource)
void	handleEvent(org.osgi.service.event.Event event)
void	init(javax.servlet.FilterConfig filterConfig)
void	invalidateAll()
protected boolean	isEnabled()
protected boolean	mapUrls()
protected void	modify(org.osgi.framework.BundleContext context, RedirectFilter.Configuration config)
void	onChange(List<org.apache.sling.api.resource.observation.ResourceChange> changes)

Methods inherited from class com.adobe.granite.jmx.annotation.AnnotatedStandardMBean

getAnnotation, getConstructor, getConstructors, getDescription, getDescription, getDescription, getDescription, getDescription, getImpact, getMethod, getParamAnnotation, getParamAnnotation, getParameterName, getParameterName, getReadMethod, getWriteMethod

Methods inherited from class javax.management.StandardMBean

cacheMBeanInfo, getAttribute, getAttributes, getCachedMBeanInfo, getClassName, getDescription, getDescription, getImplementation, getImplementationClass, getMBeanInfo, getMBeanInterface, invoke, postDeregister, postRegister, preDeregister, preRegister, setAttribute, setAttributes, setImplementation

Methods inherited from class java.lang.Object

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

Field Details

ACS_REDIRECTS_RESOURCE_TYPE

public static final String ACS_REDIRECTS_RESOURCE_TYPE

See Also:

• Constant Field Values

REDIRECT_RULE_RESOURCE_TYPE

public static final String REDIRECT_RULE_RESOURCE_TYPE

See Also:

• Constant Field Values

DEFAULT_CONFIG_BUCKET

public static final String DEFAULT_CONFIG_BUCKET

See Also:

• Constant Field Values

DEFAULT_CONFIG_NAME

public static final String DEFAULT_CONFIG_NAME

See Also:

• Constant Field Values

Constructor Details

RedirectFilter

public RedirectFilter()
               throws NotCompliantMBeanException

Throws:

NotCompliantMBeanException

Method Details

init

public void init(javax.servlet.FilterConfig filterConfig)
          throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Filter

Throws:

javax.servlet.ServletException

activate

protected final void activate(RedirectFilter.Configuration config,
 org.osgi.framework.BundleContext context)

modify

protected void modify(org.osgi.framework.BundleContext context,
 RedirectFilter.Configuration config)

deactivate

public void deactivate()

handleEvent

public void handleEvent(org.osgi.service.event.Event event)

Specified by:

handleEvent in interface org.osgi.service.event.EventHandler

onChange

public void onChange(List<org.apache.sling.api.resource.observation.ResourceChange> changes)

Specified by:

onChange in interface org.apache.sling.api.resource.observation.ResourceChangeListener

invalidateAll

public void invalidateAll()

Specified by:

invalidateAll in interface RedirectFilterMBean

getRules

public static Collection<RedirectRule> getRules(org.apache.sling.api.resource.Resource resource)

doFilter

public void doFilter(javax.servlet.ServletRequest request,
 javax.servlet.ServletResponse response,
 javax.servlet.FilterChain chain)
              throws IOException,
javax.servlet.ServletException

Specified by:

doFilter in interface javax.servlet.Filter

Throws:

IOException

javax.servlet.ServletException

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Filter

mapUrls

protected boolean mapUrls()

isEnabled

protected boolean isEnabled()

Returns:

whether redirection is enabled

getExtensions

protected Collection<String> getExtensions()

getPaths

protected Collection<String> getPaths()

getMethods

protected Collection<String> getMethods()

getOnDeliveryHeaders

protected List<org.apache.http.Header> getOnDeliveryHeaders()

getRedirectRules

public TabularData getRedirectRules(String storagePath)
                             throws OpenDataException

JMX Operation: Display loaded rules for a path, e.g. /conf/global/settings/redirects

Specified by:

getRedirectRules in interface RedirectFilterMBean

Returns:

the redirect configurations in a tabular format for the MBean

Throws:

OpenDataException

getRedirectConfigurations

public Collection<String> getRedirectConfigurations()

JMX Operation: get a list of loaded configurations, e.g. [/conf/global/settings/redirects, /conf/wknd/settings/redirects]

Specified by:

getRedirectConfigurations in interface RedirectFilterMBean

getBucket

public String getBucket()

Specified by:

getBucket in interface RedirectFilterMBean

getConfigName

public String getConfigName()

Specified by:

getConfigName in interface RedirectFilterMBean