com.hivemq.spi.services.rest.servlet

Class ServletFilter<T extends javax.servlet.Filter>

java.lang.Object

com.hivemq.spi.services.rest.servlet.ServletFilter<T>

@Immutable
public class ServletFilter<T extends javax.servlet.Filter>
extends Object

A wrapper for encapsulating a Servlet filter with their corresponding DispatcherTypes.

This class can either be used to wrap a concrete instance of a filter or a class which is instantiated by HiveMQ in order to provide dependency injection to that given filter.

Author:

Dominik Obermaier

Constructor Summary

Constructors

Constructor and Description
ServletFilter(Class<T> filterClass, javax.servlet.DispatcherType... dispatcherTypes) Creates a new wrapper for a Servlet Filter class and its corresponding dispatcher types.
ServletFilter(T filter, javax.servlet.DispatcherType... dispatcherTypes) Creates a new wrapper for a concrete Servlet Filter object and its corresponding dispatcher types.

Method Summary

Methods

Modifier and Type	Method and Description
List<javax.servlet.DispatcherType>	getDispatcherTypes() Returns a immutable list of all supported Dispatcher types by that filter
com.google.common.base.Optional<T>	getFilter()
com.google.common.base.Optional<Class<T>>	getFilterClass()

Methods inherited from class java.lang.Object

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

Constructor Detail

ServletFilter

public ServletFilter(@NotNull
             T filter,
             @NotNull
             javax.servlet.DispatcherType... dispatcherTypes)

Creates a new wrapper for a concrete Servlet Filter object and its corresponding dispatcher types.

If no dispatcher type is given, DispatcherType.REQUEST is used as default dispatcher type

Parameters:

filter - a concrete filter instance

dispatcherTypes - all supported dispatcher types by that filter

Throws:

NullPointerException - if the filter or the dispatcher types array is null

ServletFilter

public ServletFilter(@NotNull
             Class<T> filterClass,
             @NotNull
             javax.servlet.DispatcherType... dispatcherTypes)

Creates a new wrapper for a Servlet Filter class and its corresponding dispatcher types. The Filter class will be instantiated and dependency injection can be used

If no dispatcher type is given, DispatcherType.REQUEST is used as default dispatcher type

Parameters:

filterClass - a filter class which should be instantiated with dependency injection

dispatcherTypes - all supported dispatcher types by that filter

Throws:

NullPointerException - if the filter or the dispatcher types array is null

Method Detail

getFilter

public com.google.common.base.Optional<T> getFilter()

getFilterClass

public com.google.common.base.Optional<Class<T>> getFilterClass()

getDispatcherTypes

@ReadOnly
public List<javax.servlet.DispatcherType> getDispatcherTypes()

Returns a immutable list of all supported Dispatcher types by that filter

Returns:

a immutable List of all supported Dispatcher types by that filter