Package tigase.xmpp.mam.modules

# Class GetFormModule

java.lang.Object
tigase.xmpp.mam.modules.GetFormModule

All Implemented Interfaces:
  `Module`

@Bean(name="mamGetFormModule", active=true) public class GetFormModule extends Object implements Module
Implementation of module responsible for handling request to retrive form used in XEP-0313: Message Archive Management
Created by andrzej on 19.07.2016.

- ## Field Summary

  ### Fields inherited from interface tigase.component.modules.Module

  `EMPTY_FEATURES`

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `GetFormModule()`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `boolean`
  `canHandle(Packet packet)`
  Returns true if Packet can be procesed by module.
  `String[]`
  `getFeatures()`
  Returns XMPP features offered by module.
  `Criteria`
  `getModuleCriteria()`
  Returns critera used by Component to select module to handle incoming stanza.
  `void`
  `process(Packet packet)`
  Process incoming stanza.

  ### Methods inherited from class java.lang.Object

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

- ## Constructor Details

  - ### GetFormModule

    public GetFormModule()

- ## Method Details

  - ### getFeatures

    public String[] getFeatures()
    Description copied from interface: `Module`
    Returns XMPP features offered by module. Features will be returned by Service Discovery.
    Specified by:
      `getFeatures` in interface `Module`
    Returns:
      array of features or `null`.

  - ### getModuleCriteria

    public Criteria getModuleCriteria()
    Description copied from interface: `Module`
    Returns critera used by Component to select module to handle incoming stanza.
    Specified by:
      `getModuleCriteria` in interface `Module`
    Returns:
      criteria of selecting module.

  - ### canHandle

    public boolean canHandle(Packet packet)
    Description copied from interface: `Module`
    Returns true if Packet can be procesed by module. Default implementation uses Criteria.
    Specified by:
      `canHandle` in interface `Module`

  - ### process

    public void process(Packet packet) throws ComponentException, TigaseStringprepException
    Description copied from interface: `Module`
    Process incoming stanza.
    Specified by:
      `process` in interface `Module`
    Parameters:
      `packet` - received `stanza`.
    Throws:
      `ComponentException` - if stanza can't be processed correctly. ComponentException is converted to error stanza and returned to stanza sender.
      `TigaseStringprepException` - if there was an error during stringprep processing.