Package com.idmedia.translationstudio.api.client.service

Interface IRestCommunication

All Superinterfaces:
IRestConnectiorCommunication, Serializable
All Known Subinterfaces:
IFirstTranslationService
All Known Implementing Classes:
EmptyFirstTranslationService
public interface IRestCommunication extends Serializable, IRestConnectiorCommunication
Author:
Phillip Austerfield

  • Method Details

    • requestFSConnectionTest

      IRestResponse requestFSConnectionTest(String sTranslationStudioUri, String sTranslationStudioPort, String sApiAccessKey, boolean bUseTsHttps, String sFirstSpiritUri, String sFirstSpiritPort, boolean bFirstSpiritConnectionModeHttp, boolean bFirstSpiritConnectionModeSecure, String sFirstSpiritUser, String sFirstSpiritPassword)
      Test FirstSpirit Connection
      Parameters:
      sTranslationStudioUri - FirstSpirit Uri
      sTranslationStudioPort - FirstSpirit Port
      sApiAccessKey -
      bUseTsHttps -
      sFirstSpiritUri - URL
      sFirstSpiritPort - Port
      bFirstSpiritConnectionModeHttp - Use FirstSpirit Connection Mode HTTP
      bFirstSpiritConnectionModeSecure - secure connection
      sFirstSpiritUser - User
      sFirstSpiritPassword - Password
      Returns:
      success state

    • requestSmtpTestMail

      IRestResponse requestSmtpTestMail(String sTranslationStudioUri, String sTranslationStudioPort, String sApiAccessKey, boolean bUseHttps, String sRecipient, String sSender, String sSmtpServerAddress, String sSmtpServerPort, String sSmtpUser, String sSmtpPassword, boolean bTlsEnable)
      Test FirstSpirit Connection
      Parameters:
      sTranslationStudioUri - FirstSpirit Uri
      sTranslationStudioPort - FirstSpirit Port
      sApiAccessKey -
      bUseHttps -
      sRecipient -
      sSender -
      sSmtpServerAddress - SMTP Server Address
      sSmtpServerPort - Port
      sSmtpUser - User
      sSmtpPassword - Password
      bTlsEnable -
      Returns:
      success state

    • queryTranslationStatusReport

      @NotNull IRestResponse queryTranslationStatusReport(@NotNull Map<String,String> pParams)

    • queryTranslationStatusReport

      @NotNull IRestResponse queryTranslationStatusReport(@NotNull Map<String,String> pParams, String sLocalTimezoneId)

    • requestTmsCommunication

      @NotNull IRestResponse requestTmsCommunication(String sUri, String sPort, String sMessage, String sApiAccessKey, boolean bUseHttps, int nTimeout)
      Parameters:
      sUri - Exchange Service Uri
      sPort - Exchange Service Port
      sMessage - Message to be sent
      sApiAccessKey -
      bUseHttps -
      nTimeout -
      Returns:
      Answer

    • pingExchangeService

      boolean pingExchangeService(String sUri, String sPort, String sApiKey, boolean bUseHttps)
      Parameters:
      sUri -
      sPort -
      sApiKey -
      bUseHttps -
      Returns:

    • queryTranslationStatusPage

      @NotNull IRestResponse queryTranslationStatusPage(long lProjectId, long lPageId, long lElementId)
      Query Page Status XML
      Parameters:
      lProjectId -
      lPageId -
      lElementId -
      Returns:

    • encryptString

      @NotNull IRestResponse encryptString(String sUri, String sPort, String sApiAccessKey, @NotNull String sMessage)
      Encrypt a given string
      Parameters:
      sUri -
      sPort -
      sApiAccessKey -
      sMessage - Plain Input
      Returns:
      Encrypted message

    • getConnectorUsage

      @NotNull IRestResponse getConnectorUsage(String sUri, String sPort, String sApiAccessKey, @NotNull String sConnectorID)
      Encrypt a given string
      Parameters:
      sUri -
      sPort -
      sApiAccessKey -
      sConnectorID -
      Returns:

    • sendCustomEvent

      @NotNull IRestResponse sendCustomEvent(@NotNull ICustomEventMessage pEvent) throws IllegalArgumentException
      Send a custom request to TranslationStudio
      Parameters:
      pEvent -
      Returns:
      Throws:
      IllegalArgumentException

    • immediateTranslation

      @NotNull IRestResponse immediateTranslation(@NotNull String sText, boolean bIsXml, @NotNull String sSourceLanguageAbbreviation, @NotNull String sTargetLanguageAbbreviation, @NotNull String sConnectorId, long lProjectId, @NotNull String sFormElementName)
      Translate immediately via AWS/Google Translate
      Parameters:
      sText -
      bIsXml -
      sSourceLanguageAbbreviation -
      sTargetLanguageAbbreviation -
      sConnectorId -
      lProjectId -
      sFormElementName -
      Returns:

    • requestRegisterTransferAction

      @NotNull IRegistrationTransferAction requestRegisterTransferAction()
      Create action to submit translation request
      Returns:

    • requestServerStatusInformation

      @NotNull IRestResponse requestServerStatusInformation()

    • submitTranslationRequest

      boolean submitTranslationRequest(@NotNull String psJson, boolean isUrgent)
      Submit a translation request json
      Parameters:
      psJson -
      isUrgent -
      Returns:

    • pingTranslationStudio

      default boolean pingTranslationStudio()
      Ping the translation studio instance to make sure it is available and ready
      Returns:

    • updateSecondInMilliseconds

      default boolean updateSecondInMilliseconds(long lMillis)

    • downloadLogfile

      @NotNull IRestResponse downloadLogfile()
      Download the current logfile
      Returns:

    • downloadLogfiles

      @NotNull IRestResponse downloadLogfiles()
      Download all logfiles
      Returns:

    • downloadDatabaseMonitoredFiles

      @NotNull IRestResponse downloadDatabaseMonitoredFiles()
      Download database CSV
      Returns:

    • uploadXmlFile

      @NotNull IRestResponse uploadXmlFile(@NotNull String sContent)
      Upload a given XML content
      Parameters:
      sContent -
      Returns:

    • updateMonitoredFileStatusRemove

      @NotNull IRestResponse updateMonitoredFileStatusRemove(@NotNull String sDatasetId)
      Remove entry by id
      Parameters:
      sDatasetId - Dataset id to remove
      Returns:

    • updateMonitoredFileStatusInProgress

      @NotNull IRestResponse updateMonitoredFileStatusInProgress(@NotNull String sDatasetId, @NotNull String sProjectId, boolean bResetRetryCounter)
      Set status to "IN PROGRESS", either by dataset id OR project id
      Parameters:
      sDatasetId - Dataset id (takes precedence)
      sProjectId - Project id
      bResetRetryCounter - Set number of retries to 0 again
      Returns:

    • updateMonitoredFileStatusFinished

      @NotNull IRestResponse updateMonitoredFileStatusFinished(@NotNull String sDatasetId, @NotNull String sProjectId, boolean bResetRetryCounter)
      Set status to "FINISHED", either by dataset id OR project id
      Parameters:
      sDatasetId - Dataset id (takes precedence)
      sProjectId - Project id
      bResetRetryCounter - Set number of retries to 0 again
      Returns:

    • updateMonitoredFileStatusObsolete

      @NotNull IRestResponse updateMonitoredFileStatusObsolete(@NotNull String sDatasetId, @NotNull String sProjectId, boolean bResetRetryCounter)
      Set status to "OBSOLETE", either by dataset id OR project id
      Parameters:
      sDatasetId - Dataset id (takes precedence)
      sProjectId - Project id
      bResetRetryCounter - Set number of retries to 0 again
      Returns:

    • historyDownloadCSV

      @NotNull IRestResponse historyDownloadCSV(long lProjectId)
      Download history
      Parameters:
      lProjectId -
      Returns:

    • getLicenseInformation

      @NotNull IRestResponse getLicenseInformation()
      Get License Information
      Returns:

    • updateLicenseInformation

      @NotNull IRestResponse updateLicenseInformation(@NotNull String sLicenseData)
      Upload new license
      Parameters:
      sLicenseData -
      Returns:

    • historyRemove

      @NotNull IRestResponse historyRemove(@NotNull List<Long> vplDatasetIds)
      Download history
      Parameters:
      vplDatasetIds -
      Returns:

    • getMemoryInformation

      @NotNull IRestResponse getMemoryInformation()
      Get memory information
      Returns:

    • downloadTemporaryFolderList

      @NotNull IRestResponse downloadTemporaryFolderList()
      Download all temp folders
      Returns:

    • downloadTemporaryFolder

      @NotNull IRestResponse downloadTemporaryFolder(@NotNull String sName)
      Download specific folder as zip
      Parameters:
      sName - Folder name
      Returns:

    • countTranslatedXmlFiles

      @NotNull IRestResponse countTranslatedXmlFiles()
      Count the number of XMLs files
      Returns:

    • downloadTranslatedXmlFolder

      @NotNull IRestResponse downloadTranslatedXmlFolder(boolean bSuccessXmls)
      Download specific folder as zip
      Parameters:
      bSuccessXmls - Success-Folder (or failed otherwise)
      Returns:

    • downloadXmlsTranslatable

      @NotNull IRestResponse downloadXmlsTranslatable()
      Download specific folder as zip
      Returns:

    • downloadXmlsTranslated24h

      @NotNull IRestResponse downloadXmlsTranslated24h()
      Download specific folder as zip
      Returns:

    • clearXmlsTranslatable

      @NotNull IRestResponse clearXmlsTranslatable()
      Download specific folder as zip
      Returns:

    • downloadXmlsImportQueue

      @NotNull IRestResponse downloadXmlsImportQueue()
      Download specific folder as zip
      Returns:

    • clearTranslatedXmlFolderUpTo30days

      @NotNull IRestResponse clearTranslatedXmlFolderUpTo30days()
      Download specific folder as zip
      Returns:

    • clearXmlsTranslatables

      @NotNull IRestResponse clearXmlsTranslatables()
      Download specific folder as zip
      Returns:

    • downloadXmlsTempImportExportFolder

      IRestResponse downloadXmlsTempImportExportFolder(String folder)

    • deleteXmlsTempImportExportFolder

      IRestResponse deleteXmlsTempImportExportFolder(String folder)

    • clearTranslatedXmlFolder

      @NotNull IRestResponse clearTranslatedXmlFolder(boolean bSuccessXmls)
      Clear XML files in either success or failed folder
      Parameters:
      bSuccessXmls - Success-Folder (or failed otherwise)
      Returns:

    • insertMonitoredFiles

      @NotNull default boolean insertMonitoredFiles(String jsonArray)
      Insert new monitored files
      Parameters:
      jsonArray - data
      Returns:

    • exportDatabaseTable

      @NotNull IRestResponse exportDatabaseTable(@NotNull String type)

    • importDatabaseTable

      @NotNull IRestResponse importDatabaseTable(@NotNull String type, @NotNull String sContent)

    • translateMedia

      @NotNull default boolean translateMedia(@NotNull String jsonObject)

    • getStartupLicenseData

      @NotNull IRestResponse getStartupLicenseData(boolean bFull)