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 and Description
static interface	RedirectFilter.Configuration

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACS_REDIRECTS_RESOURCE_TYPE
static String	DEFAULT_STORAGE_PATH
static String	REDIRECT_RULE_RESOURCE_TYPE

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

CHANGES, PATHS, PROPERTY_NAMES_HINT

Constructor Summary

Constructors

Constructor and Description
RedirectFilter()

Method Summary

Modifier and Type	Method and Description
protected 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)
protected Collection<String>	getExtensions()
protected Collection<String>	getMethods()
protected List<org.apache.http.Header>	getOnDeliveryHeaders()
protected Collection<String>	getPaths()
TabularData	getRedirectConfigurations() Display cache contents in the MBean
static Collection<RedirectRule>	getRules(org.apache.sling.api.resource.Resource resource) Read redirect configurations from the repository, i.e.
String	getStoragePath()
void	handleEvent(org.osgi.service.event.Event event)
boolean	handleRedirect(org.apache.sling.api.SlingHttpServletRequest slingRequest, org.apache.sling.api.SlingHttpServletResponse slingResponse)
void	init(javax.servlet.FilterConfig filterConfig)
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)
void	refreshCache()

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 Detail

DEFAULT_STORAGE_PATH

public static final String DEFAULT_STORAGE_PATH

See Also:

Constant Field Values

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

Constructor Detail

RedirectFilter

public RedirectFilter()
               throws NotCompliantMBeanException

Throws:

NotCompliantMBeanException

Method Detail

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

refreshCache

public void refreshCache()

Specified by:

refreshCache in interface RedirectFilterMBean

getRules

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

Read redirect configurations from the repository, i.e. /conf/acs-commons/redirects --> Collection

Parameters:

resource - the parent resource containing redirect configurations

Returns:

a list of redirect configurations . Can be empty if no redirects are configured.

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

handleRedirect

public boolean handleRedirect(org.apache.sling.api.SlingHttpServletRequest slingRequest,
                              org.apache.sling.api.SlingHttpServletResponse slingResponse)

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

getStoragePath

public String getStoragePath()

getExtensions

protected Collection<String> getExtensions()

getPaths

protected Collection<String> getPaths()

getMethods

protected Collection<String> getMethods()

getOnDeliveryHeaders

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

getRedirectConfigurations

public TabularData getRedirectConfigurations()
                                      throws OpenDataException

Display cache contents in the MBean

Specified by:

getRedirectConfigurations in interface RedirectFilterMBean

Returns:

the redirect configurations in a tabular format for the MBean

Throws:

OpenDataException