Package com.atlassian.confluence.util.http

Class BaseHttpRetrievalService

java.lang.Object

com.atlassian.confluence.util.http.BaseHttpRetrievalService

All Implemented Interfaces:

HttpRetrievalService

Direct Known Subclasses:

HttpClientHttpRetrievalService

@Deprecated(forRemoval=true)
public abstract class BaseHttpRetrievalService
extends Object
implements 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 Use RequestFactory or ReadOnlyApplicationLink instead.

Since:

4.1

Field Summary

Fields

Modifier and Type	Field	Description
protected com.atlassian.bandana.BandanaManager	bandanaManager	Deprecated, for removal: This API element is subject to removal in a future version.
protected com.atlassian.plugins.whitelist.OutboundWhitelist	outboundWhitelist	Deprecated, for removal: This API element is subject to removal in a future version.

Fields inherited from interface com.atlassian.confluence.util.http.HttpRetrievalService

DEFAULT_MAX_CACHE_AGE, DEFAULT_MAX_DOWNLOAD_SIZE, HTTP_INCLUDE_STACK_MAX_DEPTH, HTTP_USER_AGENT_STRING, NET_REQUEST_ALLOW_ALL_HOSTS

Constructor Summary

Constructors

Constructor	Description
BaseHttpRetrievalService()	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
HttpResponse	get(String url)	Deprecated, for removal: This API element is subject to removal in a future version. Retrieve a URL using the default HttpRequest settings for that URL.
ConfluenceHttpParameters	getConnectionParameters()	Deprecated, for removal: This API element is subject to removal in a future version.
HttpRequest	getDefaultRequestFor(String url)	Deprecated, for removal: This API element is subject to removal in a future version. Retrieve the default configured HttpRequest for a particular URL.
HttpRetrievalServiceConfig	getHttpRetrievalServiceConfig()	Deprecated, for removal: This API element is subject to removal in a future version. Retrieve the configuration for this service
void	setBandanaManager(com.atlassian.bandana.BandanaManager bandanaManager)	Deprecated, for removal: This API element is subject to removal in a future version.
void	setHttpRetrievalServiceConfig(HttpRetrievalServiceConfig config)	Deprecated, for removal: This API element is subject to removal in a future version. Overwrite the configuration for this service
void	setOutboundWhitelist(com.atlassian.plugins.whitelist.OutboundWhitelist outboundWhitelist)	Deprecated, for removal: This API element is subject to removal in a future version.
void	setSettingsManager(SettingsManager settingsManager)	Deprecated, for removal: This API element is subject to removal in a future version.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.atlassian.confluence.util.http.HttpRetrievalService

get, getAvailableAuthenticators

Field Detail

bandanaManager

protected com.atlassian.bandana.BandanaManager bandanaManager

Deprecated, for removal: This API element is subject to removal in a future version.

outboundWhitelist

protected com.atlassian.plugins.whitelist.OutboundWhitelist outboundWhitelist

Deprecated, for removal: This API element is subject to removal in a future version.

Constructor Detail

BaseHttpRetrievalService

public BaseHttpRetrievalService()

Deprecated, for removal: This API element is subject to removal in a future version.

Method Detail

get

public HttpResponse get(String url)
                 throws IOException

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: HttpRetrievalService

Retrieve a URL using the default HttpRequest settings for that URL. The equivalent of calling get(service.getDefaultRequestFor(url));

Specified by:

get in interface HttpRetrievalService

Parameters:

url - the URL to retrieve

Returns:

a response object encapsulating the result of the request

Throws:

IOException - if the retrieval fails

getDefaultRequestFor

public HttpRequest getDefaultRequestFor(String url)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: HttpRetrievalService

Retrieve the default configured HttpRequest for a particular URL. Will come prepackaged with the configured system defaults for authentication, retrieval size and caching.

Specified by:

getDefaultRequestFor in interface HttpRetrievalService

Parameters:

url - the URL that is going to be retrieved

Returns:

the system default HttpRequest for that URL.

getHttpRetrievalServiceConfig

public HttpRetrievalServiceConfig getHttpRetrievalServiceConfig()

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: HttpRetrievalService

Retrieve the configuration for this service

Specified by:

getHttpRetrievalServiceConfig in interface HttpRetrievalService

Returns:

the service configuration

getConnectionParameters

public ConfluenceHttpParameters getConnectionParameters()

Deprecated, for removal: This API element is subject to removal in a future version.

setHttpRetrievalServiceConfig

public void setHttpRetrievalServiceConfig(HttpRetrievalServiceConfig config)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: HttpRetrievalService

Overwrite the configuration for this service

Specified by:

setHttpRetrievalServiceConfig in interface HttpRetrievalService

Parameters:

config - the service configuration to save

setBandanaManager

public void setBandanaManager(com.atlassian.bandana.BandanaManager bandanaManager)

Deprecated, for removal: This API element is subject to removal in a future version.

setSettingsManager

public void setSettingsManager(SettingsManager settingsManager)

Deprecated, for removal: This API element is subject to removal in a future version.

setOutboundWhitelist

public void setOutboundWhitelist(com.atlassian.plugins.whitelist.OutboundWhitelist outboundWhitelist)

Deprecated, for removal: This API element is subject to removal in a future version.