StreamHTTPSParms interface

Represents HTTPS stream parameters that define how to communicate with a MobiLink server using secure HTTPS connections.

Syntax

public interface StreamHTTPSParms

Members

All members of StreamHTTPSParms interface, including all inherited members.

Name	Description
getCertificateCompany method	Returns the certificate company name for verification of secure connections.
getCertificateName method	Returns the certificate common name for verification of secure connections.
getCertificateUnit method	Returns the certificate unit name for verification of secure connections.
getE2eePublicKey method [Android]	Get the name of the file containing the end-to-end public key.
getExtraParameters method [Android]	Gets the extra MobiLink client network protocol options.
getHost method	Returns the host name of the MobiLink server.
getOutputBufferSize method	Returns the size, in bytes, of the output buffer used to store data before it is sent to the MobiLink server.
getPort method	Returns the port number used to connect to the MobiLink server.
getTrustedCertificates method	Returns the name of the file containing a list of trusted root certificates used for secure synchronization.
getURLSuffix method	Returns the URL suffix of the MobiLink server.
isRestartable method	Determines whether restartable HTTP is used.
setCertificateCompany method	Sets the certificate company name for verification of secure connections.
setCertificateName method	Sets the certificate common name for verification of secure connections.
setCertificateUnit method	Sets the certificate unit name for verification of secure connections.
setE2eePublicKey method [Android]	Sets the name of the file containing the end-to-end public key.
setExtraParameters method [Android]	Sets extra MobiLink client network protocol options.
setHost method	Sets the host name of the MobiLink server.
setOutputBufferSize method	Sets the size, in bytes, of the output buffer used to store data before it is sent to the MobiLink server.
setPort method	Sets the port number used to connect to the MobiLink server.
setRestartable method	Enables or disables restartable HTTP.
setTrustedCertificates method	Sets a file containing a list of trusted root certificates used for secure synchronization.
setURLSuffix method	Specifies the URL suffix to connect to the MobiLink server.
setZlibCompression method	Enables or disables ZLIB compression.
setZlibDownloadWindowSize method	Sets the download window size for ZLIB compression.
setZlibUploadWindowSize method	Sets the upload window size for ZLIB compression.
zlibCompressionEnabled method	Determines if ZLIB compression is enabled.

The following example sets the stream parameters to communicate with a MobiLink server on host name "MyMLHost". The server started with the following parameters: "-x https(port=1234;certificate=RSAServer.crt;certificate_password=x)"

SyncParms syncParms = myConnection.createSyncParms(
        SyncParms.HTTPS_STREAM,
        "MyUniqueMLUserID",
        "MyMLScriptVersion"
    );
StreamHTTPSParms httpsParms =
    (StreamHTTPSParms) syncParms.getStreamParms();
httpsParms.setHost("MyMLHost");
httpsParms.setPort(1234);

The above example assumes that the certificate in RSAServer.crt is chained to a trusted root certificate already installed on the client host or device.

For J2SE, you can deploy the required trusted root certificate using one of the following methods:

Install the trusted root certificate in the lib/security/cacerts key store of the JRE.
Build your own key store using the Java keytool utility and setting the javax.net.ssl.trustStore Java system property to its location (set the javax.net.ssl.trustStorePassword method to an appropriate value)
Use the setTrustedCertificates(String) parameter to point to the deployed certificate file.

To enhance security, the setCertificateName, setCertificateCompany, and setCertificateUnit methods should be used to turn on validation of the MobiLink server certificate.

Instances implementing this interface are returned by the SyncParms.getStreamParms method when the SyncParms object is created for HTTPS synchronization.