com.sapportals.portal.ivs.proxy

Interface IProxyServerService

All Superinterfaces:

IService

public interface IProxyServerService
extends IService

Field Summary

static String

KEY

Method Summary

void	setProxyServer(String protocol, String proxyServer, int port, String proxySet, String nonProxyHosts) Set the proxy server and port to use if there is one.
void	useBasicAuthintication(String username, String password, HttpURLConnection httpCon) Set the connection according the proxy Authorization
boolean	validateProxyInitialized() Check if the proxy settings of both protocols (http & https) were set.
boolean	validateProxyInitialized(String protocol) Check if the proxy settings of the specific protocol were set.

Methods inherited from interface com.sapportals.portal.prt.service.IService

afterInit, configure, destroy, getContext, getKey, init, release

Field Detail

KEY

static final String KEY

See Also:

Constant Field Values

Method Detail

setProxyServer

void setProxyServer(String protocol,
                    String proxyServer,
                    int port,
                    String proxySet,
                    String nonProxyHosts)
                    throws NullPointerException,
                           IndexOutOfBoundsException

Set the proxy server and port to use if there is one.

Parameters:

protocol - the protocol to set the proxy to (http, https...).

proxyServer - the name or IP address of the proxy server to use

port - the port to connect to the proxy server.

Throws:

NullPointerException - thrown if a null reference is sent

IndexOutOfBoundsException

useBasicAuthintication

void useBasicAuthintication(String username,
                            String password,
                            HttpURLConnection httpCon)

Set the connection according the proxy Authorization

validateProxyInitialized

boolean validateProxyInitialized(String protocol)
                                 throws Exception

Check if the proxy settings of the specific protocol were set.

Parameters:

protocol - the type of protocol to check (http / https).

Returns:

true if successful false if no settings were provided

Throws:

Exception - thrown if connection to the proxy could not be established.

validateProxyInitialized

boolean validateProxyInitialized()
                                 throws Exception

Check if the proxy settings of both protocols (http & https) were set.

Returns:

true if successful false if no settings were provided

Throws:

Exception - thrown if connection to the proxy could not be established.

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] EP-RUNTIME	[sap.com] tc/ep/connectivity/services/api	api	EP-PIN