com.softwareag.mobile.data.client

Class Context

java.lang.Object

com.softwareag.mobile.data.client.Context

public class Context
extends java.lang.Object

Returns an instance of the Context class. One instance is available for the entire application.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAppName() Returns the application name set by the application.
java.lang.String	getAppVersion() Returns the application version set by the application.
static java.lang.String	getConnectionProtocol() Gets the protocol used for communication with the server.
static Context	getContext() Returns an instance of the Context class.
java.lang.String	getDeviceType() Returns the device type set by the application.
java.lang.String	getHost() Returns the server host name set by the application.
static Logger	getLogger() Returns the logger instance to caller.
java.lang.String	getPassword() Returns the password used for authentication as set by the application.
java.lang.String	getPort() Returns the server port number set by the application.
java.lang.String	getServerURL() Returns the server URL set by the Mobile Support Client.
java.lang.String	getUserName() Returns the user name needed for authentication.
static void	setInitializeConf(java.lang.String host, java.lang.String port, java.lang.String appName, java.lang.String appVersion, java.lang.String deviceType, java.lang.String userName, java.lang.String password, java.lang.String conProtocolType) Initializes basic configuration for client-server communication (host, port, authentication details and connection protocol).
static void	setLogger(Logger loggerInstance) Sets the logger instance.

Methods inherited from class java.lang.Object

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

Method Detail

getContext

public static Context getContext()

Returns an instance of the Context class. One instance is available for the entire application.

Returns:

Context

setInitializeConf

public static void setInitializeConf(java.lang.String host,
                     java.lang.String port,
                     java.lang.String appName,
                     java.lang.String appVersion,
                     java.lang.String deviceType,
                     java.lang.String userName,
                     java.lang.String password,
                     java.lang.String conProtocolType)
                              throws com.softwareag.mobile.data.client.SyncClientException

Initializes basic configuration for client-server communication (host, port, authentication details and connection protocol). Use this method before performing any download or synchronization operation.

Parameters:

host - Server host name or IP address.

port - Server port number.

appName - Name of the application that is registered with the mobile sync component.

appVersion - Version of the application that is registered with the mobile sync component.

deviceType - Name of the device type that is registered with the mobile sync component.

userName - Name of the user to authenticate with the server.

password - Password for authentication with the server.

conProtocolType - Type of communication protocol to use (0 indicates HTTP, 1 indicates HTTPS).

Throws:

com.softwareag.mobile.data.client.SyncClientException - - Handles errors related to data synchronization operations.

- Thrown when initializing configuration and client detects that one or more parameters are null. No parameter can be null.

getServerURL

public java.lang.String getServerURL()

Returns the server URL set by the Mobile Support Client.

Returns:

String object that represents the server URL.

getHost

public java.lang.String getHost()

Returns the server host name set by the application.

Returns:

String object represent server host.

getPort

public java.lang.String getPort()

Returns the server port number set by the application.

Returns:

String object that represents the server port.

getUserName

public java.lang.String getUserName()

Returns the user name needed for authentication.

Returns:

String object represent user name.

getPassword

public java.lang.String getPassword()

Returns the password used for authentication as set by the application.

Returns:

String object that represents the password.

getAppName

public java.lang.String getAppName()

Returns the application name set by the application.

Returns:

String object that represents the application name.

getAppVersion

public java.lang.String getAppVersion()

Returns the application version set by the application.

Returns:

String object that represents the application version.

getDeviceType

public java.lang.String getDeviceType()

Returns the device type set by the application.

Returns:

String object that represents the device type.

setLogger

public static void setLogger(Logger loggerInstance)

Sets the logger instance. Used throughout the application for logging purposes.

Parameters:

{@link - com.softwareag.mobile.data.utils.Logger Logger}

getLogger

public static Logger getLogger()

Returns the logger instance to caller.

Returns:

Logger

getConnectionProtocol

public static java.lang.String getConnectionProtocol()

Gets the protocol used for communication with the server.

Returns:

protocolType Type of communication protocol to use (0 indicates HTTP, 1 indicates HTTPS). The default is 0.