org.pfsw.net.http

Class ProxyBuilder

java.lang.Object

org.pfsw.net.http.ProxyBuilder

public class ProxyBuilder
extends java.lang.Object

A builder to create Proxy instances.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_HTTP_PROXY_ENV_VAR

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ProxyBuilder()

Method Summary

Modifier and Type	Method and Description
ProxyBuilder	address(java.net.InetSocketAddress inetSocketAddress)
java.net.Proxy	build()
static ProxyBuilder	create() Returns a new ProxyBuilder instance.
static ProxyBuilder	create(java.lang.String hostname, int port) Returns a new ProxyBuilder instance initialized with the given hostname and port.
static ProxyBuilder	from(java.lang.String proxyUrl) Returns a ProxyBuilder initialized from the given proxy server URL.
static ProxyBuilder	fromDefaultEnvVar() Returns a ProxyBuilder initialized from environment variable "HTTP_PROXY".
static ProxyBuilder	fromEnvVar(java.lang.String envVarName) Returns a ProxyBuilder initialized from the given environment variable.
protected java.net.InetSocketAddress	getAddress()
protected java.net.Proxy.Type	getType()
protected void	setAddress(java.net.InetSocketAddress address)
protected void	setType(java.net.Proxy.Type type)
ProxyBuilder	type(java.net.Proxy.Type proxyType)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_HTTP_PROXY_ENV_VAR

public static final java.lang.String DEFAULT_HTTP_PROXY_ENV_VAR

See Also:

Constant Field Values

Constructor Detail

ProxyBuilder

protected ProxyBuilder()

Method Detail

create

public static ProxyBuilder create()

Returns a new ProxyBuilder instance.

create

public static ProxyBuilder create(java.lang.String hostname,
                                  int port)

Returns a new ProxyBuilder instance initialized with the given hostname and port. Defaults to type HTTP.

fromDefaultEnvVar

public static ProxyBuilder fromDefaultEnvVar()

Returns a ProxyBuilder initialized from environment variable "HTTP_PROXY".

Returns:

The newly created builder.

Throws:

ConfigRuntimeException - If the specified environment variable cannot be found.

InvalidUrlException - If the value of the specified environment variable is no valid URL.

fromEnvVar

public static ProxyBuilder fromEnvVar(java.lang.String envVarName)

Returns a ProxyBuilder initialized from the given environment variable.

Parameters:

envVarName - The name of the environment variable that specifies the proxy URL (must not be null).

Returns:

The newly created builder.

Throws:

ConfigRuntimeException - If the specified environment variable cannot be found.

InvalidUrlException - If the value of the specified environment variable is no valid URL.

from

public static ProxyBuilder from(java.lang.String proxyUrl)

Returns a ProxyBuilder initialized from the given proxy server URL.

Parameters:

proxyUrl - The proxy URL with scheme, host and port (must not be null).

Returns:

The newly created builder.

Throws:

InvalidUrlException - If the value of the specified environment variable is no valid URL.

type

public ProxyBuilder type(java.net.Proxy.Type proxyType)

address

public ProxyBuilder address(java.net.InetSocketAddress inetSocketAddress)

build

public java.net.Proxy build()

getType

protected java.net.Proxy.Type getType()

setType

protected void setType(java.net.Proxy.Type type)

getAddress

protected java.net.InetSocketAddress getAddress()

setAddress

protected void setAddress(java.net.InetSocketAddress address)