org.ops4j.pax.web.service.spi.model.elements

Class FilterModel

java.lang.Object

org.ops4j.pax.web.service.spi.model.Identity

org.ops4j.pax.web.service.spi.model.elements.ElementModel<javax.servlet.Filter,FilterEventData>

org.ops4j.pax.web.service.spi.model.elements.FilterModel

All Implemented Interfaces:

Comparable<ElementModel<javax.servlet.Filter,FilterEventData>>

public class FilterModel
extends ElementModel<javax.servlet.Filter,FilterEventData>

Set of parameters describing everything that's required to register a Filter.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FilterModel.Builder
static class	FilterModel.DynamicMapping
static class	FilterModel.Mapping

Field Summary

Fields inherited from class org.ops4j.pax.web.service.spi.model.elements.ElementModel

contextModels, contextModelsInfo, dtoFailureCode, isValid

Constructor Summary

Constructors

Constructor and Description
FilterModel(String filterName, javax.servlet.Filter filter, Class<? extends javax.servlet.Filter> filterClass, org.osgi.framework.ServiceReference<javax.servlet.Filter> reference) Constructor used for filter unregistration
FilterModel(String filterName, String[] urlPatterns, String[] servletNames, String[] regexPatterns, Class<? extends javax.servlet.Filter> filterClass, Dictionary<String,String> initParams, Boolean asyncSupported)
FilterModel(String filterName, String[] urlPatterns, String[] servletNames, String[] regexPatterns, javax.servlet.Filter filter, Dictionary<String,String> initParams, Boolean asyncSupported)

Method Summary

Modifier and Type	Method and Description
void	addDynamicServletNameMapping(EnumSet<javax.servlet.DispatcherType> dispatcherTypes, String[] servletNames, boolean isMatchAfter)
void	addDynamicUrlPatternMapping(EnumSet<javax.servlet.DispatcherType> dispatcherTypes, String[] urlPatterns, boolean isMatchAfter)
FilterEventData	asEventData() When sending events related to ElementModel we can't use the same instance which is kept in ServerModel, we have to copy relevant information to lightweight object.
int	compareTo(ElementModel<javax.servlet.Filter,FilterEventData> o) Returns negative value if this element is "lesser" than the argument, which means it should have higher priority.
Class<? extends javax.servlet.Filter>	getActualClass() Returns a Class of the filter whether it is registered as instance, class or reference.
Boolean	getAsyncSupported()
List<FilterModel.DynamicMapping>	getDynamicServletNames()
List<FilterModel.DynamicMapping>	getDynamicUrlPatterns()
javax.servlet.Filter	getFilter()
Class<? extends javax.servlet.Filter>	getFilterClass()
Map<String,String>	getInitParams()
List<FilterModel.Mapping>	getMappingsPerDispatcherTypes()
String	getName()
boolean	isDynamic()
boolean	isPreprocessor()
Boolean	performValidation() Perform element-specific validation and throws different exceptions for all element-specific validation problems.
void	register(WhiteboardWebContainerView view) Each ElementModel can register itself as Whiteboard element.
void	setAsyncSupported(Boolean asyncSupported)
void	setDynamic(boolean dynamic)
void	setPreprocessor(boolean preprocessor)
org.osgi.service.http.runtime.dto.FailedFilterDTO	toFailedFilterDTO(int dtoFailureCode)
org.osgi.service.http.runtime.dto.FailedPreprocessorDTO	toFailedPreprocessorDTO(int dtoFailureCode)
org.osgi.service.http.runtime.dto.FilterDTO	toFilterDTO()
org.osgi.service.http.runtime.dto.PreprocessorDTO	toPreprocessorDTO()
String	toString()
void	unregister(WhiteboardWebContainerView view) Each ElementModel can unregister itself as Whiteboard element.

Methods inherited from class org.ops4j.pax.web.service.spi.model.elements.ElementModel

addContextModel, changeContextModels, equals, getContextFilter, getContextModels, getContextModelsInfo, getContextSelector, getDtoFailureCode, getElementReference, getElementSupplier, getRegisteringBundle, getServiceId, getServiceRank, getTimestamp, hasContextModels, hashCode, isAsynchronusRegistration, isPrototype, isValid, resetContextModels, setAsynchronusRegistration, setCommonEventProperties, setContextSelectFilter, setContextSelector, setDtoFailureCode, setElementReference, setElementSupplier, setRegisteringBundle, setServiceId, setServiceRank, setTimestamp

Methods inherited from class org.ops4j.pax.web.service.spi.model.Identity

getId, getIdPrefix, getNumericId

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FilterModel

public FilterModel(String filterName,
                   javax.servlet.Filter filter,
                   Class<? extends javax.servlet.Filter> filterClass,
                   org.osgi.framework.ServiceReference<javax.servlet.Filter> reference)

Constructor used for filter unregistration

Parameters:

filterName -

filter -

filterClass -

reference -

FilterModel

public FilterModel(String filterName,
                   String[] urlPatterns,
                   String[] servletNames,
                   String[] regexPatterns,
                   javax.servlet.Filter filter,
                   Dictionary<String,String> initParams,
                   Boolean asyncSupported)

FilterModel

public FilterModel(String filterName,
                   String[] urlPatterns,
                   String[] servletNames,
                   String[] regexPatterns,
                   Class<? extends javax.servlet.Filter> filterClass,
                   Dictionary<String,String> initParams,
                   Boolean asyncSupported)

Method Detail

performValidation

public Boolean performValidation()

Description copied from class: ElementModel

Perform element-specific validation and throws different exceptions for all element-specific validation problems. This method should not be called for Whiteboard purposes, where "failure DTO" has to be configured.

This method should be called in Http Service scenario where we immediately need strong feedback - with exceptions thrown for all validation problems. In Whiteboard scenario, the exception is caught, logged and it's the tracker that prevents further registration.

This method may alter the state of the model when (which is possible during validation) some extra information is obtained/compiled/processed.

Specified by:

performValidation in class ElementModel<javax.servlet.Filter,FilterEventData>

Returns:

register

public void register(WhiteboardWebContainerView view)

Description copied from class: ElementModel

Each ElementModel can register itself as Whiteboard element.

Specified by:

register in class ElementModel<javax.servlet.Filter,FilterEventData>

unregister

public void unregister(WhiteboardWebContainerView view)

Description copied from class: ElementModel

Each ElementModel can unregister itself as Whiteboard element.

Specified by:

unregister in class ElementModel<javax.servlet.Filter,FilterEventData>

asEventData

public FilterEventData asEventData()

Description copied from class: ElementModel

When sending events related to ElementModel we can't use the same instance which is kept in ServerModel, we have to copy relevant information to lightweight object.

Specified by:

asEventData in class ElementModel<javax.servlet.Filter,FilterEventData>

Returns:

compareTo

public int compareTo(ElementModel<javax.servlet.Filter,FilterEventData> o)

Description copied from class: ElementModel

Returns negative value if this element is "lesser" than the argument, which means it should have higher priority.

Specified by:

compareTo in interface Comparable<ElementModel<javax.servlet.Filter,FilterEventData>>

Overrides:

compareTo in class ElementModel<javax.servlet.Filter,FilterEventData>

toFilterDTO

public org.osgi.service.http.runtime.dto.FilterDTO toFilterDTO()

toFailedFilterDTO

public org.osgi.service.http.runtime.dto.FailedFilterDTO toFailedFilterDTO(int dtoFailureCode)

toPreprocessorDTO

public org.osgi.service.http.runtime.dto.PreprocessorDTO toPreprocessorDTO()

toFailedPreprocessorDTO

public org.osgi.service.http.runtime.dto.FailedPreprocessorDTO toFailedPreprocessorDTO(int dtoFailureCode)

toString

public String toString()

Overrides:

toString in class ElementModel<javax.servlet.Filter,FilterEventData>

getName

public String getName()

getInitParams

public Map<String,String> getInitParams()

getAsyncSupported

public Boolean getAsyncSupported()

setAsyncSupported

public void setAsyncSupported(Boolean asyncSupported)

isPreprocessor

public boolean isPreprocessor()

setPreprocessor

public void setPreprocessor(boolean preprocessor)

getFilter

public javax.servlet.Filter getFilter()

getFilterClass

public Class<? extends javax.servlet.Filter> getFilterClass()

getActualClass

public Class<? extends javax.servlet.Filter> getActualClass()

Returns a Class of the filter whether it is registered as instance, class or reference.

Returns:

getMappingsPerDispatcherTypes

public List<FilterModel.Mapping> getMappingsPerDispatcherTypes()

getDynamicUrlPatterns

public List<FilterModel.DynamicMapping> getDynamicUrlPatterns()

getDynamicServletNames

public List<FilterModel.DynamicMapping> getDynamicServletNames()

addDynamicServletNameMapping

public void addDynamicServletNameMapping(EnumSet<javax.servlet.DispatcherType> dispatcherTypes,
                                         String[] servletNames,
                                         boolean isMatchAfter)

addDynamicUrlPatternMapping

public void addDynamicUrlPatternMapping(EnumSet<javax.servlet.DispatcherType> dispatcherTypes,
                                        String[] urlPatterns,
                                        boolean isMatchAfter)

setDynamic

public void setDynamic(boolean dynamic)

isDynamic

public boolean isDynamic()