StoryscopeInterfaceModule.java

Go to the documentation of this file.

/*
 * Project: Server for annotations sharing
 * Author: Ing. Jaroslav Dytrych idytrych@fit.vutbr.cz
 * File: StoryscopeInterfaceModule.java
 * Description: Class implements AnotServerModule calss for prupose 
 *              of Storyscope Interface module.
 */

/**
 * @file StoryscopeInterfaceModule.java
 *
 * @brief Class provides connection of Storyscope Interface module with server.
 */

/**
 * @package cz.vutbr.fit.knot.annotations.modules.StoryscopeInterface
 * 
 * @brief Classes responsible for export of data (annotations and types) to StoryScope
 */
package cz.vutbr.fit.knot.annotations.modules.StoryscopeInterface;

import cz.vutbr.fit.knot.annotations.comet.AnnotServerModule;
import cz.vutbr.fit.knot.annotations.comet.EditorSession;
import cz.vutbr.fit.knot.annotations.comet.Flier;
import cz.vutbr.fit.knot.annotations.comet.RequestInfo;

/**
 * Class implements AnotServerModule calss for prupose of Storyscope Interface module.
 * 
 * @brief Class provides connection of Storyscope Interface module with server.
 * @author Martin Petr (xpetrm05)
 */
public class StoryscopeInterfaceModule implements AnnotServerModule {
  
  /**
   * Constructor
   */
  public void StoryscopeInterfaceModule(){
  }
  
  /**
   * 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
   */
  @Override
  public String processRequestBeforePersist(RequestInfo requestInfo){
    return "";
  }

  /**
   * 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
   */
  @Override
  public String processRequestAfterPersist(RequestInfo requestInfo, boolean persistFailed){
    if(persistFailed) return "";   //nothing to do here if perist failed
    StoryscopeInterfaceSender sender = new StoryscopeInterfaceSender(requestInfo);
    sender.start();
    return "";
  }

  /**
   * 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.
   */
  @Override
  public String messagesFromFlier(Flier flier, EditorSession session){
    return "";
  }

  /**
   * 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
   */
  @Override
  public String getModuleName(int lang){
    return "StoryscopeInterface";
  }

  /**
   * 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
   */
  @Override
  public String getModuleDescription(int lang){
    return "StoryscopeInterface";
  }
}  // public class StoryscopeInterfaceModule