Package com.intellij.util.net

Class HttpConfigurable

java.lang.Object

com.intellij.util.net.HttpConfigurable

All Implemented Interfaces:

PersistentStateComponent<HttpConfigurable>, Disposable

public class HttpConfigurable
extends java.lang.Object
implements PersistentStateComponent<HttpConfigurable>, Disposable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpConfigurable.ProxyInfo

Nested classes/interfaces inherited from interface com.intellij.openapi.Disposable

Disposable.Parent

Field Summary

Fields

Modifier and Type	Field and Description
boolean	AUTHENTICATION_CANCELLED
static int	CONNECTION_TIMEOUT Deprecated. use HttpRequests.CONNECTION_TIMEOUT
boolean	KEEP_PROXY_PASSWORD
java.lang.String	LAST_ERROR
Getter<java.net.PasswordAuthentication>	myTestAuthRunnable
Getter<java.net.PasswordAuthentication>	myTestGenericAuthRunnable
java.lang.String	PAC_URL
boolean	PROXY_AUTHENTICATION
java.lang.String	PROXY_EXCEPTIONS
java.lang.String	PROXY_HOST
int	PROXY_PORT
boolean	PROXY_TYPE_IS_SOCKS
static int	READ_TIMEOUT Deprecated. use HttpRequests.READ_TIMEOUT
static int	REDIRECT_LIMIT Deprecated. use HttpRequests.REDIRECT_LIMIT
boolean	USE_HTTP_PROXY
boolean	USE_PAC_URL
boolean	USE_PROXY_PAC

Constructor Summary

Constructors

Constructor and Description
HttpConfigurable()

Method Summary

Modifier and Type	Method and Description
void	clearGenericPasswords()
void	dispose() Usually not invoked directly, see class javadoc.
static boolean	editConfigurable(javax.swing.JComponent parent)
java.net.PasswordAuthentication	getGenericPassword(java.lang.String host, int port)
java.net.PasswordAuthentication	getGenericPromptedAuthentication(java.lang.String prefix, java.lang.String host, java.lang.String prompt, int port, boolean remember)
static HttpConfigurable	getInstance()
java.util.List<Pair<java.lang.String,java.lang.String>>	getJvmProperties(boolean withAutodetection, java.net.URI uri)
static java.util.List<KeyValue<java.lang.String,java.lang.String>>	getJvmPropertiesList(boolean withAutodetection, java.net.URI uri) Deprecated. use getJvmProperties(boolean, URI)
java.net.ProxySelector	getOnlyBySettingsSelector()
java.lang.String	getPlainProxyPassword()
java.net.PasswordAuthentication	getPromptedAuthentication(java.lang.String host, java.lang.String prompt)
java.lang.String	getProxyLogin()
HttpConfigurable	getState()
void	initComponent() Deprecated. use initializeComponent()
void	initializeComponent() If class also is a component, then this method will be called after loading state (even if not state) but only once throughout the life cycle
boolean	isGenericPasswordCanceled(java.lang.String host, int port)
boolean	isHttpProxyEnabledForUrl(java.lang.String url)
boolean	isProxyException(java.lang.String uriHost)
boolean	isProxyException(java.net.URI uri)
static boolean	isRealProxy(java.net.Proxy proxy)
void	loadState(HttpConfigurable state) This method is called when new component state is loaded.
void	noStateLoaded() This method is called when the component is initialized, but no state is persisted.
java.net.URLConnection	openConnection(java.lang.String location)
java.net.HttpURLConnection	openHttpConnection(java.lang.String location) Opens HTTP connection to a given location using configured http proxy settings.
void	prepareURL(java.lang.String url) todo [all] It is NOT necessary to call anything if you obey common IDE proxy settings; todo if you want to define your own behaviour, refer to CommonProxy Also, this method is useful in a way that it tests connection to the host [through proxy].
void	putGenericPassword(java.lang.String host, int port, java.net.PasswordAuthentication authentication, boolean remember)
void	readExternal(Element element) Deprecated. left for compatibility with com.intellij.openapi.project.impl.IdeaServerSettings
void	removeGeneric(CommonProxy.HostInfo info)
void	setGenericPasswordCanceled(java.lang.String host, int port)
void	setPlainProxyPassword(java.lang.String password)
void	setProxyLogin(java.lang.String login)
void	writeExternal(Element element) Deprecated. left for compatibility with com.intellij.openapi.project.impl.IdeaServerSettings

Methods inherited from class java.lang.Object

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

Field Detail

PROXY_TYPE_IS_SOCKS

public boolean PROXY_TYPE_IS_SOCKS

USE_HTTP_PROXY

public boolean USE_HTTP_PROXY

USE_PROXY_PAC

public boolean USE_PROXY_PAC

AUTHENTICATION_CANCELLED

public transient volatile boolean AUTHENTICATION_CANCELLED

PROXY_HOST

public java.lang.String PROXY_HOST

PROXY_PORT

public int PROXY_PORT

PROXY_AUTHENTICATION

public volatile boolean PROXY_AUTHENTICATION

KEEP_PROXY_PASSWORD

public boolean KEEP_PROXY_PASSWORD

LAST_ERROR

public transient java.lang.String LAST_ERROR

PROXY_EXCEPTIONS

public java.lang.String PROXY_EXCEPTIONS

USE_PAC_URL

public boolean USE_PAC_URL

PAC_URL

public java.lang.String PAC_URL

myTestAuthRunnable

public transient Getter<java.net.PasswordAuthentication> myTestAuthRunnable

myTestGenericAuthRunnable

public transient Getter<java.net.PasswordAuthentication> myTestGenericAuthRunnable

CONNECTION_TIMEOUT

@Deprecated
public static final int CONNECTION_TIMEOUT

Deprecated. use HttpRequests.CONNECTION_TIMEOUT

READ_TIMEOUT

@Deprecated
public static final int READ_TIMEOUT

Deprecated. use HttpRequests.READ_TIMEOUT

REDIRECT_LIMIT

@Deprecated
public static final int REDIRECT_LIMIT

Deprecated. use HttpRequests.REDIRECT_LIMIT

Constructor Detail

HttpConfigurable

public HttpConfigurable()

Method Detail

getInstance

public static HttpConfigurable getInstance()

editConfigurable

public static boolean editConfigurable(javax.swing.JComponent parent)

getState

public HttpConfigurable getState()

Specified by:

getState in interface PersistentStateComponent<HttpConfigurable>

Returns:

a component state. All properties, public and annotated fields are serialized. Only values, which differ from the default (i.e., the value of newly instantiated class) are serialized. null value indicates that the returned state won't be stored, as a result previously stored state will be used.

See Also:

XmlSerializer

noStateLoaded

public void noStateLoaded()

Description copied from interface: PersistentStateComponent

This method is called when the component is initialized, but no state is persisted.

Specified by:

noStateLoaded in interface PersistentStateComponent<HttpConfigurable>

initializeComponent

public void initializeComponent()

Description copied from interface: PersistentStateComponent

If class also is a component, then this method will be called after loading state (even if not state) but only once throughout the life cycle

Specified by:

initializeComponent in interface PersistentStateComponent<HttpConfigurable>

initComponent

@Deprecated
public void initComponent()

Deprecated. use initializeComponent()

getOnlyBySettingsSelector

public java.net.ProxySelector getOnlyBySettingsSelector()

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable

loadState

public void loadState(HttpConfigurable state)

Description copied from interface: PersistentStateComponent

This method is called when new component state is loaded. The method can and will be called several times, if config files were externally changed while IDE was running.

State object should be used directly, defensive copying is not required.

Specified by:

loadState in interface PersistentStateComponent<HttpConfigurable>

Parameters:

state - loaded component state

See Also:

XmlSerializerUtil.copyBean(Object, Object)

isGenericPasswordCanceled

public boolean isGenericPasswordCanceled(java.lang.String host,
                                         int port)

setGenericPasswordCanceled

public void setGenericPasswordCanceled(java.lang.String host,
                                       int port)

getGenericPassword

public java.net.PasswordAuthentication getGenericPassword(java.lang.String host,
                                                          int port)

putGenericPassword

public void putGenericPassword(java.lang.String host,
                               int port,
                               java.net.PasswordAuthentication authentication,
                               boolean remember)

getProxyLogin

public java.lang.String getProxyLogin()

setProxyLogin

public void setProxyLogin(java.lang.String login)

getPlainProxyPassword

public java.lang.String getPlainProxyPassword()

setPlainProxyPassword

public void setPlainProxyPassword(java.lang.String password)

getGenericPromptedAuthentication

public java.net.PasswordAuthentication getGenericPromptedAuthentication(java.lang.String prefix,
                                                                        java.lang.String host,
                                                                        java.lang.String prompt,
                                                                        int port,
                                                                        boolean remember)

getPromptedAuthentication

public java.net.PasswordAuthentication getPromptedAuthentication(java.lang.String host,
                                                                 java.lang.String prompt)

readExternal

@Deprecated
public void readExternal(Element element)
                  throws InvalidDataException

Deprecated. left for compatibility with com.intellij.openapi.project.impl.IdeaServerSettings

Throws:

InvalidDataException

writeExternal

@Deprecated
public void writeExternal(Element element)
                   throws WriteExternalException

Deprecated. left for compatibility with com.intellij.openapi.project.impl.IdeaServerSettings

Throws:

WriteExternalException

prepareURL

public void prepareURL(java.lang.String url)
                throws java.io.IOException

todo [all] It is NOT necessary to call anything if you obey common IDE proxy settings; todo if you want to define your own behaviour, refer to CommonProxy Also, this method is useful in a way that it tests connection to the host [through proxy].

Parameters:

url - URL for HTTP connection

Throws:

java.io.IOException

openConnection

public java.net.URLConnection openConnection(java.lang.String location)
                                      throws java.io.IOException

Throws:

java.io.IOException

openHttpConnection

public java.net.HttpURLConnection openHttpConnection(java.lang.String location)
                                              throws java.io.IOException

Opens HTTP connection to a given location using configured http proxy settings.

Parameters:

location - url to connect to

Returns:

instance of HttpURLConnection

Throws:

java.io.IOException - in case of any I/O troubles or if created connection isn't instance of HttpURLConnection.

isHttpProxyEnabledForUrl

public boolean isHttpProxyEnabledForUrl(java.lang.String url)

getJvmProperties

public java.util.List<Pair<java.lang.String,java.lang.String>> getJvmProperties(boolean withAutodetection,
                                                                                java.net.URI uri)

isProxyException

public boolean isProxyException(java.net.URI uri)

isProxyException

public boolean isProxyException(java.lang.String uriHost)

isRealProxy

public static boolean isRealProxy(java.net.Proxy proxy)

clearGenericPasswords

public void clearGenericPasswords()

removeGeneric

public void removeGeneric(CommonProxy.HostInfo info)

getJvmPropertiesList

@Deprecated
public static java.util.List<KeyValue<java.lang.String,java.lang.String>> getJvmPropertiesList(boolean withAutodetection,
                                                                                               java.net.URI uri)

Deprecated. use getJvmProperties(boolean, URI)