Package org.eclipse.core.net.proxy

Interface IProxyService

  • public interface IProxyService
    Manages the proxy data and related information. The proxy service is registered as an OSGi service. Clients can obtain an instance of the service from their bundle context or from a service tracker.

    Clients that wish to make a connection and need to determine whether to use a proxy or not should call either getProxyDataForHost(String) or getProxyDataForHost(String, String).

    Since:
    1.0
    Restriction:
    This interface is not intended to be implemented by clients.

    • Method Detail

      • isProxiesEnabled

        boolean isProxiesEnabled()
        Returns whether proxy support should be enabled. When disabled, all connections will be direct.

        Returns false, when the system proxies support is enabled but hasSystemProxies() returns false.

        Returns:
        whether proxy support should be enabled

      • hasSystemProxies

        boolean hasSystemProxies()
        Returns whether system proxy support is available.
        Returns:
        whether system proxy support is available
        Since:
        1.1

      • setSystemProxiesEnabled

        void setSystemProxiesEnabled​(boolean enabled)
        Sets whether system proxies should be used, when the proxy support is enabled.
        Parameters:
        enabled - whether system proxies should be used
        Since:
        1.1

      • isSystemProxiesEnabled

        boolean isSystemProxiesEnabled()
        Returns whether system proxy should be used when the proxy support is enabled.
        Returns:
        whether system proxy is used when the proxy support is enabled
        Since:
        1.1

      • select

        IProxyData[] select​(URI uri)
        Returns all the applicable proxy data to access the specified URI.

        Clients that wish to make a connection and need to determine whether to use a proxy should use this method.

        Parameters:
        uri - the URI for which proxies are returned
        Returns:
        list of all applicable proxy data, if no proxy is applicable then an empty array is returned
        Since:
        1.2

      • getProxyDataForHost

        @Deprecated
IProxyData[] getProxyDataForHost​(String host)
        Deprecated.
        This method is deprecated because of its ambiguity. Use select(URI) instead.
        Returns the list of known proxy types and their settings for the given host. If proxies are disabled or if the host matches any entries in the non-proxied hosts lists or if a matching proxy type has no data, then an empty array is returned.

        Clients that wish to make a connection and need to determine whether to use a proxy should use this method.

        Parameters:
        host - the host for which a connection is desired
        Returns:
        the list of known proxy types and their settings for the given host

      • getProxyDataForHost

        @Deprecated
IProxyData getProxyDataForHost​(String host,
                               String type)
        Deprecated.
        This method is deprecated because of its ambiguity. Use select(URI) instead.
        Returns the proxy data for the proxy of the given type or null if the proxy type is not known by this service, the proxy data is empty for that type or the host is in the non-proxied host list.

        Clients that wish to make a connection and need to determine whether to use a proxy should use this method.

        Parameters:
        host - the host for which a connection is desired
        type - the proxy type
        Returns:
        the proxy data for the proxy of the given type or null
        See Also:
        IProxyData.HTTP_PROXY_TYPE, IProxyData.HTTPS_PROXY_TYPE, IProxyData.SOCKS_PROXY_TYPE

      • setProxyData

        void setProxyData​(IProxyData[] proxies)
           throws CoreException
        Sets the information associated with known proxy types. If an unknown type is provided, it will be ignored. Any known types that are not present in the list of the provided proxy data will be unaffected.

        This method affects only proxies defined in Eclipse by user and doesn't affect settings of the system proxies (being used when the system support is enabled).

        Parameters:
        proxies - the proxy data whose information is to be set.
        Throws:
        CoreException - if the proxy could not be set

      • setNonProxiedHosts

        void setNonProxiedHosts​(String[] hosts)
                 throws CoreException
        Sets the list of hosts for which non proxy should be used.

        This method affects only non-proxied hosts defined in Eclipse by user and doesn't affect settings of the system proxies (being used when the system support is enabled).

        Parameters:
        hosts - the list of hosts for which non proxy should be used
        Throws:
        CoreException - if the non-proxied host list could not be set

      • addProxyChangeListener

        void addProxyChangeListener​(IProxyChangeListener listener)
        Registers a listener that will be notified when proxy related information changes. Adding a listener that is already registered has no effect.
        Parameters:
        listener - a change listener

      • removeProxyChangeListener

        void removeProxyChangeListener​(IProxyChangeListener listener)
        Removes a listener. Removing a listener that is not registered has no effect.
        Parameters:
        listener - a change listener