Interface HttpRetrievalService

    • Field Detail

      • DEFAULT_MAX_DOWNLOAD_SIZE

        static final int DEFAULT_MAX_DOWNLOAD_SIZE
        Deprecated, for removal: This API element is subject to removal in a future version.
        See Also:
        Constant Field Values
      • DEFAULT_MAX_CACHE_AGE

        static final int DEFAULT_MAX_CACHE_AGE
        Deprecated, for removal: This API element is subject to removal in a future version.
        See Also:
        Constant Field Values
      • HTTP_INCLUDE_STACK_MAX_DEPTH

        static final int HTTP_INCLUDE_STACK_MAX_DEPTH
        Deprecated, for removal: This API element is subject to removal in a future version.
        See Also:
        Constant Field Values
      • HTTP_USER_AGENT_STRING

        static final String HTTP_USER_AGENT_STRING
        Deprecated, for removal: This API element is subject to removal in a future version.
        See Also:
        Constant Field Values
    • Method Detail

      • get

        @Deprecated
        HttpResponse get​(String url)
                  throws IOException
        Deprecated.
        since 7.0.1 use RequestFactory.createRequest(com.atlassian.sal.api.net.Request.MethodType, java.lang.String) instead.
        Retrieve a URL using the default HttpRequest settings for that URL. The equivalent of calling get(service.getDefaultRequestFor(url));
        Parameters:
        url - the URL to retrieve
        Returns:
        a response object encapsulating the result of the request
        Throws:
        IOException - if the retrieval fails
      • get

        @Deprecated
        HttpResponse get​(HttpRequest request)
                  throws IOException
        Deprecated.
        since 7.0.1 use RequestFactory.createRequest(com.atlassian.sal.api.net.Request.MethodType, java.lang.String) instead.
        Retrieve a URL using custom HttpRequest settings
        Parameters:
        request - the request we want to make
        Returns:
        a response object encapsulating the result of the request
        Throws:
        IOException - if the retrieval fails
      • getDefaultRequestFor

        @Deprecated
        HttpRequest getDefaultRequestFor​(String url)
        Deprecated.
        since 7.0.1 use RequestFactory.createRequest(com.atlassian.sal.api.net.Request.MethodType, java.lang.String) instead.
        Retrieve the default configured HttpRequest for a particular URL. Will come prepackaged with the configured system defaults for authentication, retrieval size and caching.
        Parameters:
        url - the URL that is going to be retrieved
        Returns:
        the system default HttpRequest for that URL.
      • getAvailableAuthenticators

        @Deprecated
        Class[] getAvailableAuthenticators()
        Deprecated.
        since 7.0.1
        Retrieve the list of authenticators that can be used with this HttpRetrievalService
        Returns:
        the list of authenticators that can be used with this HttpRetrievalService
      • getHttpRetrievalServiceConfig

        @Deprecated
        HttpRetrievalServiceConfig getHttpRetrievalServiceConfig()
        Deprecated.
        since 7.0.1
        Retrieve the configuration for this service
        Returns:
        the service configuration
      • setHttpRetrievalServiceConfig

        @Deprecated
        void setHttpRetrievalServiceConfig​(HttpRetrievalServiceConfig config)
        Deprecated.
        since 7.0.1
        Overwrite the configuration for this service
        Parameters:
        config - the service configuration to save