Vert.x 4.5.13 · io.vertx.core.net.ProxyOptions · APIdia, the JavaDoc alternative

Field Summary

Modifier and Type	Field and Description
public static final String	DEFAULT_HOST The default hostname for proxy connect = "localhost"
public static final int	DEFAULT_PORT The default port for proxy connect = 3128 3128 is the default port for e.g. Squid
public static final ProxyType	DEFAULT_TYPE The default proxy type (HTTP)
private String	host
private String	password
private int	port
private ProxyType	type
private String	username

Constructor Summary

Access	Constructor and Description
public	ProxyOptions() Default constructor.
public	ProxyOptions(ProxyOptions the options to copy other) Copy constructor.
public	ProxyOptions(JsonObject the JSON json) References Deprecated `JsonObject` is deprecated or references (maybe indirectly) at least one deprecated element. Create options from JSON.

Method Summary

Modifier and Type	Method and Description
public String	Returns: proxy hosts getHost() Get proxy host.
public String	Returns: proxy password getPassword() Get proxy password.
public int	Returns: proxy port getPort() Get proxy port.
public ProxyType	Returns: proxy type getType() Get proxy type.
public String	Returns: proxy username getUsername() Get proxy username.
public ProxyOptions	Returns: a reference to this, so the API can be used fluently setHost(String the proxy host to connect to host) Set proxy host.
public ProxyOptions	Returns: a reference to this, so the API can be used fluently setPassword(String the proxy password password) Set proxy password.
public ProxyOptions	Returns: a reference to this, so the API can be used fluently setPort(int the proxy port to connect to port) Set proxy port.
public ProxyOptions	Returns: a reference to this, so the API can be used fluently setType(ProxyType the proxy type to connect to type) Set proxy type.
public ProxyOptions	Returns: a reference to this, so the API can be used fluently setUsername(String the proxy username username) Set proxy username.
public JsonObject	Returns: the JSON toJson() References Deprecated `JsonObject` is deprecated or references (maybe indirectly) at least one deprecated element. Convert to JSON

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

DEFAULT_HOST	back to summary
public static final String DEFAULT_HOST The default hostname for proxy connect = "localhost"

DEFAULT_PORT	back to summary
public static final int DEFAULT_PORT The default port for proxy connect = 3128 3128 is the default port for e.g. Squid

DEFAULT_TYPE	back to summary
public static final ProxyType DEFAULT_TYPE The default proxy type (HTTP)

host	back to summary
private String host

password	back to summary
private String password

port	back to summary
private int port

type	back to summary
private ProxyType type

username	back to summary
private String username

Constructor Detail

ProxyOptions	back to summary
public ProxyOptions() Default constructor.

ProxyOptions	back to summary
public ProxyOptions(ProxyOptions other) Copy constructor. Parameters other:ProxyOptions the options to copy

ProxyOptions

back to summary

public ProxyOptions(ProxyOptions other)

Copy constructor.

Parameters

other:ProxyOptions: the options to copy

ProxyOptions back to summary

ProxyOptions	back to summary
public ProxyOptions(JsonObject json) References Deprecated `JsonObject` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Create options from JSON. Parameters json:JsonObject the JSON

public ProxyOptions(JsonObject json)

References Deprecated

JsonObject is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Create options from JSON.

Parameters

json:JsonObject: the JSON

Method Detail

getHost	back to summary
public String getHost() Get proxy host. Returns:String proxy hosts

getHost

back to summary

public String getHost()

Get proxy host.

Returns:String: proxy hosts

getPassword	back to summary
public String getPassword() Get proxy password. Returns:String proxy password

getPassword

back to summary

public String getPassword()

Get proxy password.

Returns:String: proxy password

getPort	back to summary
public int getPort() Get proxy port. Returns:int proxy port

getPort

back to summary

public int getPort()

Get proxy port.

Returns:int: proxy port

getType	back to summary
public ProxyType getType() Get proxy type. ProxyType can be HTTP, SOCKS4 and SOCKS5 Returns:ProxyType proxy type

getType

back to summary

public ProxyType getType()

Get proxy type.

ProxyType can be HTTP, SOCKS4 and SOCKS5

Returns:ProxyType: proxy type

getUsername	back to summary
public String getUsername() Get proxy username. Returns:String proxy username

getUsername

back to summary

public String getUsername()

Get proxy username.

Returns:String: proxy username

setHost	back to summary
public ProxyOptions setHost(String host) Set proxy host. Parameters host:String the proxy host to connect to Returns:ProxyOptions a reference to this, so the API can be used fluently

setHost

back to summary

public ProxyOptions setHost(String host)

Set proxy host.

Parameters

host:String: the proxy host to connect to

Returns:ProxyOptions

a reference to this, so the API can be used fluently

setPassword	back to summary
public ProxyOptions setPassword(String password) Set proxy password. Parameters password:String the proxy password Returns:ProxyOptions a reference to this, so the API can be used fluently

setPassword

back to summary

public ProxyOptions setPassword(String password)

Set proxy password.

Parameters

password:String: the proxy password

Returns:ProxyOptions

a reference to this, so the API can be used fluently

setPort	back to summary
public ProxyOptions setPort(int port) Set proxy port. Parameters port:int the proxy port to connect to Returns:ProxyOptions a reference to this, so the API can be used fluently

setPort

back to summary

public ProxyOptions setPort(int port)

Set proxy port.

Parameters

port:int: the proxy port to connect to

Returns:ProxyOptions

a reference to this, so the API can be used fluently

setType	back to summary
public ProxyOptions setType(ProxyType type) Set proxy type. ProxyType can be HTTP, SOCKS4 and SOCKS5 Parameters type:ProxyType the proxy type to connect to Returns:ProxyOptions a reference to this, so the API can be used fluently

setType

back to summary

public ProxyOptions setType(ProxyType type)

Set proxy type.

ProxyType can be HTTP, SOCKS4 and SOCKS5

Parameters

type:ProxyType: the proxy type to connect to

Returns:ProxyOptions

a reference to this, so the API can be used fluently

setUsername	back to summary
public ProxyOptions setUsername(String username) Set proxy username. Parameters username:String the proxy username Returns:ProxyOptions a reference to this, so the API can be used fluently

setUsername

back to summary

public ProxyOptions setUsername(String username)

Set proxy username.

Parameters

username:String: the proxy username

Returns:ProxyOptions

a reference to this, so the API can be used fluently

toJson back to summary

toJson	back to summary
public JsonObject toJson() References Deprecated `JsonObject` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Convert to JSON Returns:JsonObject the JSON

public JsonObject toJson()

References Deprecated

JsonObject is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Convert to JSON

Returns:JsonObject: the JSON

public Class ProxyOptions

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail