Interface ProxyService

All Known Implementing Classes:
DefaultProxyService

@Deprecated(since="2211", forRemoval=true) public interface ProxyService
Deprecated, for removal: This API element is subject to removal in a future version.
Class that implements some util methods to use the proxy engine.
  • Method Summary

    Modifier and Type
    Method
    Description
    extractNamespace(javax.servlet.http.HttpServletRequest request)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Extracts the namespace from the client request.
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the extra headers configured for the application.
    Deprecated, for removal: This API element is subject to removal in a future version.
    Generates a random namespace.
    void
    proxy(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String namespace, String url, boolean forceGetMethod, Map<String,String> headers)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Proxies content.
    rewriteURL(String url, boolean embeddable)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Rewrites a URL to be used for the proxy.
    rewriteURL(String applicationId, String formId, String formDataId)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Rewrites a URL to be used for the proxy.
    rewriteURL(String applicationId, String formId, String formDataId, boolean editable)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Rewrites a URL to be used for the proxy.
    rewriteURL(String applicationId, String formId, String formDataId, boolean editable, boolean withEmptyData)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Rewrites a URL to be used for the proxy.
  • Method Details

    • rewriteURL

      String rewriteURL(String applicationId, String formId, String formDataId, boolean editable, boolean withEmptyData) throws MalformedURLException
      Deprecated, for removal: This API element is subject to removal in a future version.
      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
      Deprecated, for removal: This API element is subject to removal in a future version.
      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
      Deprecated, for removal: This API element is subject to removal in a future version.
      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
      Deprecated, for removal: This API element is subject to removal in a future version.
      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()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Generates a random namespace.
      Returns:
      the random namespace string
    • extractNamespace

      String extractNamespace(javax.servlet.http.HttpServletRequest request)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Extracts the namespace from the client request.
      Parameters:
      request - the request to get namespace from
      Returns:
      the extracted namespace
    • getExtraHeaders

      Map<String,String> getExtraHeaders()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the extra headers configured for the application.
      Returns:
      a new instance of 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
      Deprecated, for removal: This API element is subject to removal in a future version.
      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