AnnotServerModule.java

Go to the documentation of this file.

/*
 * Project: Server for annotations sharing
 * Author: Ing. Jaroslav Dytrych idytrych@fit.vutbr.cz
 * File: AnnotServerModule.java
 * Description: Interface for server module
 */

/**
 * @file AnnotServerModule.java
 *
 * @brief Interface for server module
 */

package cz.vutbr.fit.knot.annotations.comet;

/**
 * Interface for server module
 *
 * @brief Interface for server module
 * @author idytrych
 */
public interface AnnotServerModule {
  /**
   * This method is called when client sent message and these message
   * has been processed. Changes in types, annotations and in other entities
   * are persisted after calling this method from all modules.
   *
   * @param requestInfo Informations about client request
   * @return String with messages for client or empty string
   */
  public String processRequestBeforePersist(RequestInfo requestInfo);

  /**
   * This method is called when client sent message, these message
   * has been processed and changes in entities are persisted.
   * Composed response is sent to client after calling this method from
   * all modules.
   *
   * @param requestInfo Informations about client request
   * @param persistFailed True if changes not persisted, false otherwise.
   * @return String with messages for client or empty string
   */
  public String processRequestAfterPersist(RequestInfo requestInfo, boolean persistFailed);

  /**
   * This method is called for each sleeping comet handler when he receives
   * flier (part of informations about this or another client request).
   *
   * @param flier Flier, which has been sent to all comet handlers.
   * @param session Session associated with comet handler.
   * @return If this handler hasn't react to this flier (not interested) return
   *         null, else return messages for client in single string.
   */
  public String messagesFromFlier(Flier flier, EditorSession session);

  /**
   * Returns name of this module. Name will be included in XML element
   * attribute so usable characters are restricted.
   *
   * @param lang Requested language of name
   * @return Name of this module
   */
  public String getModuleName(int lang);

  /**
   * Returns description of this module. It will be part of information
   * about server functions.
   *
   * @param lang Requested language of description
   * @return Description of this module
   */
  public String getModuleDescription(int lang);

}  // interface AnnotServerModule