fr.paris.lutece.portal.service.filter
Class LuteceFilter

java.lang.Object
  extended by fr.paris.lutece.portal.service.filter.LuteceFilter
All Implemented Interfaces:
Comparable<LuteceFilter>

public class LuteceFilter
extends Object
implements Comparable<LuteceFilter>

LuteceFilter


Field Summary
static int ORDER_NOT_DEFINED
           
 
Constructor Summary
LuteceFilter(String strName, javax.servlet.Filter filter, String strMapping, Plugin plugin, Map<String,String> mapInitParameters)
          Constructor
 
Method Summary
 int compareTo(LuteceFilter luteceFilter)
          
 javax.servlet.Filter getFilter()
          Returns the filter
 Map<String,String> getInitParameters()
          Returns init parameters
 String getMappingUrlPattern()
          Returns the Mapping
 String getName()
          Returns the Name
 int getOrder()
          Returns the order.
 Plugin getPlugin()
          Returns the Plugin
 void setFilter(javax.servlet.Filter filter)
          Sets the filter
 void setMappingUrlPattern(String strMapping)
          Sets the Mapping
 void setName(String strName)
          Sets the Name
 void setOrder(int nOrder)
          nOrder == == -1 means there is no priority set for the filter
 void setPlugin(Plugin plugin)
          Sets the Plugin
 String toString()
          for debug purpose
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

ORDER_NOT_DEFINED

public static final int ORDER_NOT_DEFINED
See Also:
Constant Field Values
Constructor Detail

LuteceFilter

public LuteceFilter(String strName,
                    javax.servlet.Filter filter,
                    String strMapping,
                    Plugin plugin,
                    Map<String,String> mapInitParameters)
Constructor

Parameters:
strName - The name
filter - The filter class
strMapping - The mapping url pattern
plugin - The plugin
mapInitParameters - Init parameters as a map
Method Detail

getName

public String getName()
Returns the Name

Returns:
The Name

setName

public void setName(String strName)
Sets the Name

Parameters:
strName - The Name

getFilter

public javax.servlet.Filter getFilter()
Returns the filter

Returns:
The filter

setFilter

public void setFilter(javax.servlet.Filter filter)
Sets the filter

Parameters:
filter - The filter

getMappingUrlPattern

public String getMappingUrlPattern()
Returns the Mapping

Returns:
The Mapping

setMappingUrlPattern

public void setMappingUrlPattern(String strMapping)
Sets the Mapping

Parameters:
strMapping - The Mapping

getPlugin

public Plugin getPlugin()
Returns the Plugin

Returns:
The Plugin

setPlugin

public void setPlugin(Plugin plugin)
Sets the Plugin

Parameters:
plugin - The plugin

getInitParameters

public Map<String,String> getInitParameters()
Returns init parameters

Returns:
Init parameters in a map object

toString

public String toString()
for debug purpose

Overrides:
toString in class Object
Returns:
The name of the filter

getOrder

public int getOrder()
Returns the order. getOrder() == -1 means there is no priority set for the filter

Returns:
the order

setOrder

public void setOrder(int nOrder)
nOrder == == -1 means there is no priority set for the filter

Parameters:
nOrder - the order

compareTo

public int compareTo(LuteceFilter luteceFilter)

Specified by:
compareTo in interface Comparable<LuteceFilter>


Copyright © 2014 Mairie de Paris. All Rights Reserved.