SECDInterfaceModule.java

Go to the documentation of this file.

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

/**
 * @file SECDInterfaceModule.java
 *
 * @brief Class provides connection of SEC Dictionary module with server.
 */

/**
 * @package cz.vutbr.fit.knot.annotations.modules.SECDictionaryInterface
 * 
 * @brief Classes responsible for connection to the controlled vocabulary
 */
package cz.vutbr.fit.knot.annotations.modules.SECDictionaryInterface;

import cz.vutbr.fit.knot.annotations.app.AppBean;
import cz.vutbr.fit.knot.annotations.app.Constants;
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;
import cz.vutbr.fit.knot.annotations.modules.suggestionManager.SECAPIConn;
import cz.vutbr.fit.knot.annotations.modules.suggestionManager.SECAPIInterface;
import cz.vutbr.fit.knot.annotations.modules.suggestionManager.SecApiReqTypeDef;
import cz.vutbr.fit.knot.annotations.modules.suggestionManager.SuggestionManager;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.logging.Level;
import java.util.logging.Logger;


/**
 * Class implements AnotServerModule calls for prupose of SEC Dictionary module.
 * 
 * @brief Class provides connection of SEC Dictionary module with server.
 * @author Martin Petr (xpetrm05)
 */
public class SECDInterfaceModule implements 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
   */
  @Override
  public String processRequestBeforePersist(RequestInfo requestInfo) {
    if(requestInfo.getEntityRequest() != null){
      // if there is some request for entities
      SECDInterfaceThread thread = new SECDInterfaceThread(requestInfo);
      thread.start();
    }
    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.
   * It performs:
   * - processing of request for entity types
   *
   * @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) {
    StringBuilder response = new StringBuilder();
    
    // Check whether user asked for entity types
    if(requestInfo.isGetEntityTypes()){
      response.append(processGetEntityTypes(requestInfo));
    }

    return response.toString();
  }  // processRequestAfterPersist()

  /**
   * 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 "";
  }

  /**
   * Prepares response for request for entity types.
   * 
   * @param requestInfo Informations about client request
   * @return Returns response for client
   */
  private String processGetEntityTypes(RequestInfo requestInfo) {

    // initialisation of arrays with types
    if (initArrays(requestInfo)) {
      return "";
    }

    // Getting list of entity types
    Iterator<SecApiReqTypeDef> avIt;
    if (AppBean.getReqTypeDefinitionsEA() != null && !AppBean.getReqTypeDefinitionsEA().isEmpty()) {
      avIt = AppBean.getReqTypeDefinitionsEA().iterator();
    } else {
      avIt = AppBean.getAvTypeDefinitions().iterator();
    }

    //Creating messages with entity types got from SECApi
    String message = "";

    if (avIt.hasNext()) {
      message = "<entityTypes>\n";

      while (avIt.hasNext()) {
        SecApiReqTypeDef td = avIt.next();
        if (!Constants.FORBIDDEN_ENTITY_TYPES.contains(td.getTypeName())) {
          message += "  <type name=\"" + td.getTypeName() + "\"";
          if (td.getAltDescDef() != null) {
            message += " description=\"" + td.getAltDescDef() + "\"/>\n";
          } else {
            message += "/>\n";
          }
        }
      }
      message += "</entityTypes>\n";
    }

    return message;

  }  // processGetEntityTypes()

  /**
   * Initialization of arrays
   * Remote - always
   * Local - sometimes
   * 
   * @param requestInfo Info about client's request
   * 
   * @return In case of success returns false, true otherwise
   */
  private boolean initArrays(RequestInfo requestInfo) {
    // Remote
    if (Constants.USE_REMOTE_SEC_API || SECAPIInterface.isSecCommandEmpty()) {
      try {
        SECAPIConn sac = new SECAPIConn();
        SuggestionManager.initReqTypesFromRemote(sac, requestInfo);
      } catch (Exception e) {
        String message = "SECApi call error: " + e.getMessage();
        Logger.getLogger(SECDInterfaceModule.class.getName()).log(Level.SEVERE, message);
      }
      //Init has failed
      if (AppBean.getAvTypeDefinitions() == null || AppBean.getAvTypeDefinitions().isEmpty()) {
        Logger.getLogger(SECDInterfaceModule.class.getName()).log(Level.WARNING, "SECApi has failed or connection timeout!");
        return true;
      }
    } //Local
    else {
      // If it's not initialized
      if (AppBean.getAvTypeDefinitions() == null || AppBean.getAvTypeDefinitions().isEmpty()) {
        try {
          SuggestionManager.initReqTypes();
        } catch (Exception e) {
          String logMessage = "SECApi call error: " + e.getMessage();
          Logger.getLogger(SECDInterfaceModule.class.getName()).log(Level.SEVERE, logMessage);
        }

        //Init has failed
        if (AppBean.getAvTypeDefinitions() == null || AppBean.getAvTypeDefinitions().isEmpty()) {
          Logger.getLogger(SECDInterfaceModule.class.getName()).log(Level.WARNING, "SECApi has failed!");
          return true;
        }
      }
    }
    return false;  // succsee
  }  // initArrays()
  
  /**
   * 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 "SECDInterfaceModule";
  }

  /**
   * 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 "Module provides communication between 4A Server and SEC Store API for"+ "prupose of controlled dictionary.";
  }
  
}  // public class SECDInterfaceModule