Interface HttpRetrievalService
-
- All Known Implementing Classes:
BaseHttpRetrievalService
,HttpClientHttpRetrievalService
@Deprecated(forRemoval=true) public interface HttpRetrievalService
Deprecated, for removal: This API element is subject to removal in a future version.since 7.0.1 will be removed in 9.0 UseRequestFactory
orReadOnlyApplicationLink
instead.- Since:
- 4.1
-
-
Field Summary
Fields Modifier and Type Field Description static int
DEFAULT_MAX_CACHE_AGE
Deprecated, for removal: This API element is subject to removal in a future version.static int
DEFAULT_MAX_DOWNLOAD_SIZE
Deprecated, for removal: This API element is subject to removal in a future version.static int
HTTP_INCLUDE_STACK_MAX_DEPTH
Deprecated, for removal: This API element is subject to removal in a future version.static String
HTTP_USER_AGENT_STRING
Deprecated, for removal: This API element is subject to removal in a future version.
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description HttpResponse
get(HttpRequest request)
Deprecated.since 7.0.1 useRequestFactory.createRequest(com.atlassian.sal.api.net.Request.MethodType, java.lang.String)
instead.HttpResponse
get(String url)
Deprecated.since 7.0.1 useRequestFactory.createRequest(com.atlassian.sal.api.net.Request.MethodType, java.lang.String)
instead.Class[]
getAvailableAuthenticators()
Deprecated.since 7.0.1HttpRequest
getDefaultRequestFor(String url)
Deprecated.since 7.0.1 useRequestFactory.createRequest(com.atlassian.sal.api.net.Request.MethodType, java.lang.String)
instead.HttpRetrievalServiceConfig
getHttpRetrievalServiceConfig()
Deprecated.since 7.0.1void
setHttpRetrievalServiceConfig(HttpRetrievalServiceConfig config)
Deprecated.since 7.0.1
-
-
-
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 useRequestFactory.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 callingget(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 useRequestFactory.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 useRequestFactory.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.1Retrieve 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.1Retrieve the configuration for this service- Returns:
- the service configuration
-
setHttpRetrievalServiceConfig
@Deprecated void setHttpRetrievalServiceConfig(HttpRetrievalServiceConfig config)
Deprecated.since 7.0.1Overwrite the configuration for this service- Parameters:
config
- the service configuration to save
-
-