IFilterChain

All Known Implementing Classes:: SFSExtensionFilterChain

public interface IFilterChain

Method Summary

Modifier and Type

Method

Description

void

addFilter(String filterName, SFSExtensionFilter filter)

Add a filter to the Filter Chain.

void

destroy()

Shut down the Filter Chain.

void

remove(String filterName)

Remove a Filter from the Filter Chain.

FilterAction

runEventInChain(ISFSEvent event)

FilterAction

runRequestInChain(String requestId, User sender, ISFSObject params)

int

size()

Get the size of the Filter Chain.

Method Details
- addFilter
  
  void addFilter(String filterName, SFSExtensionFilter filter)
  
  Add a filter to the Filter Chain. Filters will be executed in the same order in which they were added to the Filter Chain.
  
  Parameters:
  
  filterName - the name of the filter
  
  filter - the filter that is going to be added
- remove
  
  void remove(String filterName)
  
  Remove a Filter from the Filter Chain.
  
  Parameters:
  
  filterName - the name of the Filter
- runRequestInChain
  
  FilterAction runRequestInChain(String requestId, User sender, ISFSObject params)
- runEventInChain
  
  FilterAction runEventInChain(ISFSEvent event) throws SFSException
  
  Throws:
  
  SFSException
- size
  
  int size()
  
  Get the size of the Filter Chain.
  
  Returns:
  
  the size of the Filter Chain.
- destroy
  
  void destroy()
  
  Shut down the Filter Chain.