Interface ProtocolHost

  • All Known Implementing Classes:
    FormCalcScriptHandler.FormCalcParser

    public interface ProtocolHost
    Class ProtocolHost defines the interface by which the CalcParser (FormCalc scripting engine) can access a protocol host whenever it needs to get/put/post url datas.

    FormCalc applications need to inform the FormCalc script engine that they are capable of supporting the ProtocolHost interface by invoking the CalcParser.setProtocolHost(ProtocolHost) method.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      CalcSymbol getUrl​(java.lang.String sUrl)
      Abstract method to get data from an URL.
      CalcSymbol postUrl​(java.lang.String sUrl, java.lang.String sSoapHeader, java.lang.String sData, java.lang.String sContentType, java.lang.String sEnc)
      Abstract method to post data to an URL and get its response.
      CalcSymbol putUrl​(java.lang.String sUrl, java.lang.String sData, java.lang.String sEnc)
      Abstract method to put data to an URL.
    • Method Detail

      • getUrl

        CalcSymbol getUrl​(java.lang.String sUrl)
                   throws CalcException
        Abstract method to get data from an URL.
        Parameters:
        sUrl - the URL to get.
        Returns:
        a returned CalcSymbol value upon success.
        Throws:
        CalcException
      • putUrl

        CalcSymbol putUrl​(java.lang.String sUrl,
                          java.lang.String sData,
                          java.lang.String sEnc)
                   throws CalcException
        Abstract method to put data to an URL.
        Parameters:
        sUrl - the URL to put.
        sData - the data to put.
        sEnc - the encoding to use.
        Returns:
        a returned CalcSymbol value upon success.
        Throws:
        CalcException
      • postUrl

        CalcSymbol postUrl​(java.lang.String sUrl,
                           java.lang.String sSoapHeader,
                           java.lang.String sData,
                           java.lang.String sContentType,
                           java.lang.String sEnc)
                    throws CalcException
        Abstract method to post data to an URL and get its response.
        Parameters:
        sUrl - the URL to post.
        sSoapHeader - an optional post header.
        sData - the data to post.
        sEnc - the encoding to use.
        Returns:
        a returned CalcSymbol value upon success.
        Throws:
        CalcException