Package de.hybris.platform.xyformsservices.proxy

Interface ProxyService

All Known Implementing Classes:
DefaultProxyService
public interface ProxyService
Class that implements some util methods to use the proxy engine.

  • Method Details

    • rewriteURL

      String rewriteURL(String applicationId, String formId, String formDataId, boolean editable, boolean withEmptyData) throws MalformedURLException
      Rewrites a URL to be used for the proxy.
      Parameters:
      applicationId - the application Id
      formId - the form Id
      formDataId - the form data Id
      editable - the flag that specifies whether form should be editable or not
      withEmptyData - the flag that specifies whether create empty data for form via background api
      Returns:
      the URL of the proxy
      Throws:
      MalformedURLException - if result URL is invalid

    • rewriteURL

      String rewriteURL(String applicationId, String formId, String formDataId) throws MalformedURLException
      Rewrites a URL to be used for the proxy.
      Parameters:
      applicationId - the application Id
      formId - the form Id
      formDataId - the form data Id
      Returns:
      the URL of the proxy
      Throws:
      MalformedURLException - if result URL is invalid

    • rewriteURL

      String rewriteURL(String applicationId, String formId, String formDataId, boolean editable) throws MalformedURLException
      Rewrites a URL to be used for the proxy.
      Parameters:
      applicationId - the application Id
      formId - the form Id
      formDataId - the form data Id
      editable - the flag that specifies whether form should be editable or not
      Returns:
      the URL of the proxy
      Throws:
      MalformedURLException - if result URL is invalid

    • rewriteURL

      String rewriteURL(String url, boolean embeddable) throws MalformedURLException
      Rewrites a URL to be used for the proxy.
      Parameters:
      url - the url path to be rewritten
      embeddable - the flag that specifies if the rewriter should produce a URL that produces embeddable content
      Returns:
      the URL of the proxy
      Throws:
      MalformedURLException - if result URL is invalid

    • getNextRandomNamespace

      String getNextRandomNamespace()
      Generates a random namespace.
      Returns:
      the random namespace string

    • extractNamespace

      String extractNamespace(javax.servlet.http.HttpServletRequest request)
      Extracts the namespace from the client request.
      Parameters:
      request - the request to get namespace from
      Returns:
      the extracted namespace

    • getExtraHeaders

      Map<String,String> getExtraHeaders()
      Returns the extra headers configured for the application.
      Returns:
      the extra headers as map

    • proxy

      void proxy(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String namespace, String url, boolean forceGetMethod, Map<String,String> headers) throws ProxyException
      Proxies content.
      Parameters:
      request - the HttpServletRequest associated to the call
      response - the HttpServletResponse associated to the call
      namespace - the namespace for HTML element's id generation
      url - the url to be called
      forceGetMethod - the flag for specifying if only "GET" method should be used, useful when proxying content
      headers - extra headers to be passed to the proxy service
      Throws:
      ProxyException - if request cannot be proxied