Package tigase.server

# Interface PacketFilterIfc

All Known Implementing Classes:
  `PacketCounter`

public interface PacketFilterIfc
An interface for loadable packet filters to the Tigase server. Every Tigase component can have an independent list of packet filters for outgoing and incoming traffic. A filter can make any change to the processed packet or can block the packet from further processing. Please refer to the `filter()` method for more details.
Created: Jun 8, 2009 1:29:49 PM

Author:
  Artur Hefczyc

- ## Method Summary

  Modifier and Type
  Method
  Description
  `Packet`
  `filter(Packet packet)`
  This is the actual packet filtering method.
  `void`
  `getStatistics(StatisticsList list)`
  A filter may optionally return some processing statistics.
  `void`
  `init(String name, QueueType qType)`
  The method initializes the filter.

- ## Method Details

  - ### init

    void init(String name, QueueType qType)
    The method initializes the filter. It is always called only once after an instance of the filter has been created.
    Parameters:
      `name` - is a component name which loaded and initialized the filter. This is the name of the component which uses the filter.
      `qType` - is a packet queue type, differnt one for outgoing traffic and different for incoming. A filter may want to treat the traffic differently depending on the direction it flows.

  - ### filter

    Packet filter(Packet packet)
    This is the actual packet filtering method. It receives a packet as a parameter and may make any change to the packet it wishes, remove or add specific payloads or redirect the packet to specific destination. Please note! it is recommended not to modify the actual packet itself. If the filter needs to make any changes to the packet it should create a copy of the object, then make any changes on the copy and return the copy as the result. It may also optionally block the packet from further processing. This means that the packet is effectivelly dropped and forgotten.
    If the method returns a `Packet` as a result. It is normally recommended not to modify the existing packet as it maybe processed simultanuously by other components/threads at the same time. Modifying packet while it is being processed may lead to unpredictable results. Therefore, if the filter wants to modify the packet it should create a copy of the packet and return modified copy from the method. If the filter decided to block the packet it just has to return null. In most cases, however the method returns the packet it received as a parameter to method call.
    Parameters:
      `packet` - for the filter processing.
      Please note, the packet filtering may affect performance significantly therefore this method should be carefully tested and optimized under a high load.
    Returns:
      a Packet object which is further processed by the system. If the method decided to block the packet it returns null. If the method want the packet to be processed without any modifications it returns the same object it received as a parameter. It may also return a modified copy of the Packet.

  - ### getStatistics

    void getStatistics(StatisticsList list)
    A filter may optionally return some processing statistics. Please note the method may be called quite frequently (once a second) therefore no expensive calculation should be performed inside the method.
    Parameters:
      `list` - of statistics created by the master object. The packet instance should add its statistics to the list.