Interface ProxyFacade

All Known Implementing Classes:
DefaultProxyFacade

public interface ProxyFacade
Orchestrates calls to ProxyService
  • Method Summary

    Modifier and Type
    Method
    Description
    createEmptyDataForForm(String applicationId, String formId)
    Creates empty YFormData for a form definition via orbeon background API.
    getInlineFormHtml(String applicationId, String formId, YFormDataActionEnum action, String formDataId)
    Gets the embedded HTML representation of a form definition.
    void
    proxy(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
    Proxies content
  • Method Details

    • getInlineFormHtml

      String getInlineFormHtml(String applicationId, String formId, YFormDataActionEnum action, String formDataId) throws YFormServiceException
      Gets the embedded HTML representation of a form definition.
      Parameters:
      applicationId - the application id of the form definition
      formId - the form id of the form definition
      action - the form action
      formDataId - the form data id of the form definition
      Returns:
      the inline representation of the form definition as string
      Throws:
      YFormServiceException - if request with specified parameter cannot be proxied or response is corrupted
    • createEmptyDataForForm

      String createEmptyDataForForm(String applicationId, String formId) throws YFormServiceException
      Creates empty YFormData for a form definition via orbeon background API.
      Parameters:
      applicationId - the application id of the form definition
      formId - the form id of the form definition
      Returns:
      new id for created YFormData
      Throws:
      YFormServiceException - if request with specified parameter cannot be proxied or response is corrupted
    • proxy

      void proxy(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws ProxyException
      Proxies content
      Parameters:
      request - the HttpServletRequest associated with the call
      response - the HttpServletResponse associated with the call
      Throws:
      ProxyException - when request cannot be proxied