com.addicticks.net.httpsupload

Class HttpsFileUploaderConfig

java.lang.Object

com.addicticks.net.httpsupload.HttpsFileUploaderConfig

public class HttpsFileUploaderConfig
extends Object

Configuration values for the connection to a HTTP or HTTPS server.

Author:

Addicticks

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONNECT_TIMEOUT_MS Default connect timeout on the URL connection.
static int	READ_TIMEOUT_MS Default read timeout on the URL connection.

Constructor Summary

Constructors

Constructor and Description
HttpsFileUploaderConfig(URL url) Creates a configuration object with only the URL endpoint defined.

Method Summary

Modifier and Type	Method and Description
boolean	endpointRequiresAuthentication() Does the endpoint require authentication?
String[]	getAcceptedIssuers() Gets list of accepted Issuer Organization names that will be accepted for the server's certificate.
Map<String,String>	getAdditionalHeaders() Gets the additional HTTP headers used on the upload POST request.
int	getConnectTimeoutMs() Gets the connect timeout that is used on the URL connection.
String	getEndpointPassword() Gets the endpoint authentication password (authentication type: Basic).
String	getEndpointUsername() Gets the endpoint authentication username (authentication type: Basic).
String	getProxyAddress() Address of proxy if one has been defined.
int	getProxyPort() Gets the port number used by the proxy.
int	getReadTimeoutMs() Gets the read timeout that is used on the URL connection.
URL	getURL() Gets the endpointURLString as a URL object.
boolean	isValidateCertificates() Must certificates from the endpoint be validated?
void	setAcceptedIssuers(String[] acceptedIssuers) Sets the list of Issuer Organization names that will be accepted for the server's certificate.
void	setAdditionalHeaders(Map<String,String> additionalHeaders) Sets additional overall HTTP headers to add to the upload POST request.
void	setConnectTimeoutMs(int connectTimeoutMs) Sets the connect timeout that is used on the URL connection.
void	setEndpointPassword(String endpointPassword) Sets the un-encrypted password for authentication against the endpoint.
void	setEndpointUsername(String endpointUsername) Sets the username for authentication against the endpoint.
void	setProxyAddress(String proxyAddress) Sets the address of the proxy.
void	setProxyPort(int proxyPort) Sets the port of the proxy.
void	setReadTimeoutMs(int readTimeoutMs) Gets the read timeout that is used on the URL connection.
void	setValidateCertificates(boolean validateCertificates) Should certificates from the endpoint be validated ? Default is true.
boolean	usesProxy() Does the connection go through a proxy server?

Methods inherited from class java.lang.Object

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

Field Detail

CONNECT_TIMEOUT_MS

public static final int CONNECT_TIMEOUT_MS

Default connect timeout on the URL connection. (value in milliseconds)

See Also:

Constant Field Values

READ_TIMEOUT_MS

public static final int READ_TIMEOUT_MS

Default read timeout on the URL connection. This is the time from the point where all the data in the HTTP POST message has been sent to the server and to the point where the server replies. (value in milliseconds)

See Also:

Constant Field Values

Constructor Detail

HttpsFileUploaderConfig

public HttpsFileUploaderConfig(URL url)

Creates a configuration object with only the URL endpoint defined. The following defaults apply:

• No use of authentication on endpoint
• No use of proxy
• Certificates from the endpoint are validated

The defaults can be changed by subsequent calls to the setter methods.

Parameters:

url - Sets the URL of the endpoint. This is expected to start with either a HTTP or a HTTPS url. The URL can optionally include a port number.

Method Detail

getEndpointUsername

public String getEndpointUsername()

Gets the endpoint authentication username (authentication type: Basic). Returns null if the setEndpointUsername(java.lang.String) hasn't been called. A value of null indicates that the endpoint does not require authentication.

Returns:

username to use for authentication

setEndpointUsername

public void setEndpointUsername(String endpointUsername)

Sets the username for authentication against the endpoint. Do not set this if the endpoint does not require authentication. Only authentication of type "Basic" is currently supported.

Parameters:

endpointUsername - username to use for authentication

getEndpointPassword

public String getEndpointPassword()

Gets the endpoint authentication password (authentication type: Basic). Returns null if the setEndpointPassword(java.lang.String) hasn't been called. A value of null indicates that the endpoint does not require authentication.

Returns:

un-encrypted password.

setEndpointPassword

public void setEndpointPassword(String endpointPassword)

Sets the un-encrypted password for authentication against the endpoint. Do not set this if the endpoint does not require authentication. Only authentication of type "Basic" is currently supported.

Parameters:

endpointPassword - un-encrypted password

isValidateCertificates

public boolean isValidateCertificates()

Must certificates from the endpoint be validated?

Returns:

setValidateCertificates

public void setValidateCertificates(boolean validateCertificates)

Should certificates from the endpoint be validated ? Default is true. Set to false if the endpoint is trusted but is using a self-signed certificate.

Parameters:

validateCertificates -

getProxyAddress

public String getProxyAddress()

Address of proxy if one has been defined. A value of null indicates no use of proxy.

Returns:

See Also:

setProxyAddress(java.lang.String)

setProxyAddress

public void setProxyAddress(String proxyAddress)

Sets the address of the proxy. If the connection does not need to go through a proxy server in order to reach its endpoint then do not use this method.

Parameters:

proxyAddress - either a string hostname or an IP addresss. Must not include a port number.

getProxyPort

public int getProxyPort()

Gets the port number used by the proxy.

Returns:

See Also:

setProxyPort(int)

setProxyPort

public void setProxyPort(int proxyPort)

Sets the port of the proxy. If the connection does not need to go through a proxy server in order to reach its endpoint then do not use this method.

Parameters:

proxyPort - port number, a value between 1 and 65535. Typically HTTP/HTTPS proxies use port 8080 by convention.

usesProxy

public boolean usesProxy()

Does the connection go through a proxy server?

Returns:

endpointRequiresAuthentication

public boolean endpointRequiresAuthentication()

Does the endpoint require authentication?

Returns:

getURL

public URL getURL()

Gets the endpointURLString as a URL object.

Returns:

getConnectTimeoutMs

public int getConnectTimeoutMs()

Gets the connect timeout that is used on the URL connection. (in milliseconds). Defaults to CONNECT_TIMEOUT_MS if not set explicitly.

Returns:

timeout in milliseconds

setConnectTimeoutMs

public void setConnectTimeoutMs(int connectTimeoutMs)

Sets the connect timeout that is used on the URL connection. (in milliseconds). Defaults to CONNECT_TIMEOUT_MS if not set explicitly.

Parameters:

connectTimeoutMs - connect timeout in milliseconds

getReadTimeoutMs

public int getReadTimeoutMs()

Gets the read timeout that is used on the URL connection. (in milliseconds). Defaults to READ_TIMEOUT_MS if not set explicitly.

Returns:

timeout in milliseconds

setReadTimeoutMs

public void setReadTimeoutMs(int readTimeoutMs)

Gets the read timeout that is used on the URL connection. (in milliseconds). Defaults to READ_TIMEOUT_MS if not set explicitly.

Parameters:

readTimeoutMs - read timeout in milliseconds

getAcceptedIssuers

public String[] getAcceptedIssuers()

Gets list of accepted Issuer Organization names that will be accepted for the server's certificate.

Returns:

the list of accepted Issuer Organization names that will be accepted for the server's certificate or null if all Issuer Organization names are accepted.

See Also:

setAcceptedIssuers(java.lang.String[])

setAcceptedIssuers

public void setAcceptedIssuers(String[] acceptedIssuers)

Sets the list of Issuer Organization names that will be accepted for the server's certificate.

This feature only applies when isValidateCertificates() is false.

The purpose of the feature is to provide some minimal security rather than simply accepting any certificate. If - for example - you create a self-signed certificate then you decide the 'issuer organization' yourself and the issuer organization name you used when you created the certificate can then be validated here.

Parameters:

acceptedIssuers - accept only a certificate from one of these issuer organizations. Check is done against the Organization (O) field in the 'Issued By' section of the server's certificate. A null means all issuer organizations are accepted.

getAdditionalHeaders

public Map<String,String> getAdditionalHeaders()

Gets the additional HTTP headers used on the upload POST request.

Returns:

See Also:

setAdditionalHeaders(java.util.Map)

setAdditionalHeaders

public void setAdditionalHeaders(Map<String,String> additionalHeaders)

Sets additional overall HTTP headers to add to the upload POST request. There's rarely a need to use this method.

The following header fields are automatically set:

    "Connection"
    "Cache-Control"
    "Content-Type"
    "Content-Length"
    "Authorization"
 

and you must never set these here. (if you do they will be ignored)

However you might want to use this method to explicitly set e.g. User-Agent or non-standard header fields that are required for your particular endpoint. For example by overriding User-Agent you can make the upload operation look to the endpoint as if it comes from a browser.

Parameters:

additionalHeaders - Map of HTTP request headers. The key is the header field name and the value is the header field value.