com.netphantom.server.utils

Class ServerProxySelector

java.lang.Object

java.net.ProxySelector

com.netphantom.server.utils.ServerProxySelector

public class ServerProxySelector
extends ProxySelector

This class handles the definition of Proxy settings for the Server (and Editor).

Author:

Christopher Mindus

Constructor Summary

Constructors

Constructor and Description
ServerProxySelector() Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	connectFailed(URI uri, SocketAddress sa, IOException ioe) Called to indicate that a connection could not be established to a proxy/socks server.
static HttpsURLConnection	createHttpsURLConnection(URL url, String proxyUserID, String destUserID) Creates a HTTPS connection.
static HttpURLConnection	createHttpURLConnection(URL url, String proxyUserID, String destUserID) Creates a HTTP connection.
static URLConnection	createURLConnection(URL url) Creates an URL connection.
static void	initialize(IniFile ini) Initializes the proxy selector from the INI file.
static int	processDialog(VirtualSessionManager vsm, boolean doModal) Displays and process the Proxy settings dialog box.
List<Proxy>	select(URI uri) Selects all the applicable proxies based on the protocol to access the resource with and a destination address to access the resource at.

Methods inherited from class java.net.ProxySelector

getDefault, setDefault

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerProxySelector

public ServerProxySelector()

Creates a new instance.

Method Detail

initialize

public static void initialize(IniFile ini)

Initializes the proxy selector from the INI file.

createURLConnection

public static URLConnection createURLConnection(URL url)
                                         throws IOException,
                                                URISyntaxException

Creates an URL connection.

Parameters:

url - The URL to connect to.

Throws:

IOException - for connection failures.

URISyntaxException - for invalid URL to URI conversions.

IllegalArgumentException - if either argument is null.

createHttpURLConnection

public static HttpURLConnection createHttpURLConnection(URL url,
                                                        String proxyUserID,
                                                        String destUserID)
                                                 throws IOException,
                                                        URISyntaxException

Creates a HTTP connection. The flag isInteractive can be set for the NetPhantom Editor in the case a message box would ask for the user ID and password for e.g. a proxy server. For NetPhantom Server, this will rely on an existing user ID.

Parameters:

url - The URL to connect to.

proxyUserID - The user ID to use when no interaction is allowed (e.g. NetPhantom Server). Set this parameter to null if a message box should be popped up.

destUserID - The destination user ID to use when no interaction is allowed (e.g. NetPhantom Server). Set this parameter to null if a message box should be popped up.

Returns:

The HttpURLConnection, initialized properly.

Throws:

IOException - for connection failures.

URISyntaxException - for invalid URL to URI conversions.

IllegalArgumentException - if either argument is null.

createHttpsURLConnection

public static HttpsURLConnection createHttpsURLConnection(URL url,
                                                          String proxyUserID,
                                                          String destUserID)
                                                   throws IOException,
                                                          URISyntaxException

Creates a HTTPS connection. The userID can be set to null, causing e.g. NetPhantom Editor to prompt a message box that would ask for the user ID and password for e.g. a proxy server or the HTTP server. For NetPhantom Server, this will rely on existing user IDs.

Parameters:

url - The URL to connect to.

proxyUserID - The user ID to use when no interaction is allowed (e.g. NetPhantom Server). Set this parameter to null if a message box should be popped up.

destUserID - The destination user ID to use when no interaction is allowed (e.g. NetPhantom Server). Set this parameter to null if a message box should be popped up.

Returns:

The HttpURLConnection, initialized properly.

Throws:

IOException - for connection failures.

URISyntaxException - for invalid URL to URI conversions.

IllegalArgumentException - if either argument is null.

connectFailed

public void connectFailed(URI uri,
                          SocketAddress sa,
                          IOException ioe)

Called to indicate that a connection could not be established to a proxy/socks server. An implementation of this method can temporarily remove the proxies or reorder the sequence of proxies returned by select(String, String), using the address and they kind of IOException given.

Specified by:

connectFailed in class ProxySelector

Parameters:

uri - The URI that the proxy at "sa" (see parameter below) failed to serve.

sa - The socket address of the proxy/SOCKS server

ioe - The I/O exception thrown when the connect failed.

Throws:

IllegalArgumentException - if either argument is null

See Also:

ProxySelector.connectFailed(java.net.URI, java.net.SocketAddress, java.io.IOException)

select

public List<Proxy> select(URI uri)

Selects all the applicable proxies based on the protocol to access the resource with and a destination address to access the resource at. The format of the URI is defined as follow:

• http URI for http connections
• https URI for https connections
• ftp URI for ftp connections
• socket://host:port for tcp client sockets connections

Specified by:

select in class ProxySelector

Parameters:

uri - The URI that a connection is required to.

Returns:

a List of Proxies. Each element in the the List is of type Proxy; when no proxy is available, the list will contain one element of type Proxy that represents a direct connection.

Throws:

IllegalArgumentException - if either argument is null

See Also:

ProxySelector.select(java.net.URI)

processDialog

public static int processDialog(VirtualSessionManager vsm,
                                boolean doModal)

Displays and process the Proxy settings dialog box.