com.kony.sdk.client

Class KonyClient

java.lang.Object

com.kony.sdk.client.KonyClient

public class KonyClient
extends Object

KonyClient class will fetch the appConfig file with given appKey,appSecret,servicecURL.

Field Summary

Fields

Modifier and Type	Field and Description
static StorageManager	defaultStorageManager
String[]	globalRequestParamType
protected static com.kony.cms.client.KonyCMSClient	konyCMSClient
static Context	mContext Context object used to get global information an application environment

Constructor Summary

Constructors

Constructor and Description
KonyClient()

Method Summary

Modifier and Type	Method and Description
static void	acceptSelfSignedCertificates() Deprecated.
void	appendGlobalBodyParams(Map<String,String> bodyparameters)
void	appendGlobalHeaders(Map<String,String> headers)
String	appendGlobalParams(String url, Map<String,String> headers, Map<String,String> params)
String	appendGlobalQueryParams(String url)
String	getAppKey() This method returns the appKey for application.
static String	getApplicationKey() Deprecated.
static String	getApplicationSecret() Deprecated.
String	getAppSecret() This method returns the appSecret for application.
static Context	getContext()
Map<String,String>	getGlobalRequestParams(String paramType)
IdentityService	getIdentityService(String identityName) Method will create the IdentityService instance with the provided identityName.
IntegrationService	getIntegrationService(String operationName) Method will create the IntegrationService instance with the provided operationName.
MessagingService	getMessagingService() Method will create the MessagingService instance.
com.kony.cms.services.metrics.MetricsService	getMetricsService() Method will create the MetricsService instance.
static NetworkOptions	getNetworkOptions() Deprecated.
NetworkOptions	getNWOptions()
ObjectService	getObjectService(String serviceName) Method will create the ObjectService instance.
IKonyApplicationSync	getOfflineObjects() Method will create the Kony Sync Application instance.
static String	getSdkType() This method will be used by Client-SDK-Developer, to get the SDK type
static String	getSdkVersion() This method will be used by Client-SDK-Developer, to get the SDK version
ServiceDoc	getServiceDoc()
static JSONObject	getServiceDocument() Deprecated.
static String	getServiceURLString() Deprecated.
protected static StorageManager	getStorageManager()
Sync	getSyncService(KonyFactoryOptions options) Method will create the SyncService instance and initializes the sync.
void	ignoreSSLCertErrors() This method will be used by Client-SDK-Developer, to accept the self-signed certificate for the services.Make sure to include KonyAllowAllTrustManager jar (available in libs folder of the plugin)
void	initAsync(Context context, String appKey, String appSecret, String serviceUrl, InitCallback initCallback) Initialization method for the Kony Client SDK.
static void	initInBackground(Context context, String appKey, String appSecret, String serviceUrl, InitCallback initCallback) Deprecated.
void	initWithServiceDoc(Context context, String appKey, String appSecret, JSONObject serviceDoc) Initialization method for the Kony Client SDK.
static void	loadLibs()
void	removeGlobalRequestParam(String paramName, String paramType)
void	resetGlobalRequestParams()
void	setClientParams(Hashtable<String,Object> clientParams)
static void	setContext(Context context)
void	setGlobalRequestParam(String paramName, String paramValue, String paramType)
static void	setIdentyServiceProviderEndpoint(String provider, String identityServiceEndpoint) Deprecated.
static void	setIntegrationServiceEndpoint(String serviceName, String integrationServiceEndpoint) Deprecated.
static void	setMessagingServiceEndpoint(String messagingServiceEndpoint) Deprecated.
static void	setNetworkOptions(NetworkOptions networkOptions) Deprecated.
void	setNWOptions(NetworkOptions networkOptions)
static void	setStorageManager(StorageManager storageManager) Deprecated.
void	setStorageMgr(StorageManager storageManager) This method will be used by Client-SDK-Developer, to override the KonyStorageManager instance with custom storage implementation where Client-SDK-Developer can write the storage code by taking care of his own encryption logic.
static void	setSyncServiceEndpoint(String syncServiceEndpoint) Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

mContext

public static Context mContext

Context object used to get global information an application environment

defaultStorageManager

public static StorageManager defaultStorageManager

konyCMSClient

protected static com.kony.cms.client.KonyCMSClient konyCMSClient

globalRequestParamType

public String[] globalRequestParamType

Constructor Detail

KonyClient

public KonyClient()

Method Detail

initAsync

public void initAsync(Context context,
                      String appKey,
                      String appSecret,
                      String serviceUrl,
                      InitCallback initCallback)
               throws KonyException

Initialization method for the Kony Client SDK. This method will fetch the App configuration file from the server. This method has to be invoked before invoking any other SDK methods.

Parameters:

context - - Context object used to get global information an application environment

appKey - - AppKey of the application

appSecret - - AppSecret of the application

serviceUrl - - URL of the Server.

initCallback - - initCallback interface is having the following success/failure callback methods. - onSuccess(JSONObject response) - onFailure(KonyException konyException)

Throws:

KonyException

initWithServiceDoc

public void initWithServiceDoc(Context context,
                               String appKey,
                               String appSecret,
                               JSONObject serviceDoc)
                        throws KonyException

Initialization method for the Kony Client SDK. This method will fetch the App configuration file from the server. This method has to be invoked before invoking any other SDK methods.

Parameters:

context - - Context object used to get global information an application environment

appKey - - AppKey of the application

appSecret - - AppSecret of the application

serviceDoc - - ServiceDocuent JSON.

Throws:

KonyException

getApplicationKey

@Deprecated
public static String getApplicationKey()

Deprecated.

This method returns the appKey for application.

Returns:

Returns the appKey for application.

getApplicationSecret

@Deprecated
public static String getApplicationSecret()

Deprecated.

This method returns the appSecret for application.

Returns:

Returns the appSecret for application.

getServiceURLString

@Deprecated
public static String getServiceURLString()

Deprecated.

This method returns the serviceURL for application.

Returns:

returns the serviceURL for application.

setStorageManager

@Deprecated
public static void setStorageManager(StorageManager storageManager)

Deprecated.

This method will be used by Client-SDK-Developer, to override the KonyStorageManager instance with custom storage implementation where Client-SDK-Developer can write the storage code by taking care of his own encryption logic.

Parameters:

storageManager - storageManager instance used to store, get and remove the items.

getStorageManager

protected static StorageManager getStorageManager()

getContext

public static Context getContext()

setContext

public static void setContext(Context context)

loadLibs

public static void loadLibs()

getNetworkOptions

@Deprecated
public static NetworkOptions getNetworkOptions()

Deprecated.

Returns:

the networkOptions

setNetworkOptions

@Deprecated
public static void setNetworkOptions(NetworkOptions networkOptions)

Deprecated.

Parameters:

networkOptions - the networkOptions to set

setMessagingServiceEndpoint

@Deprecated
public static void setMessagingServiceEndpoint(String messagingServiceEndpoint)
                                                     throws KonyException

Deprecated.

This method sets the Messaging Service EndPoint for the application.

Parameters:

messagingServiceEndpoint - url for the messaging service.

Throws:

KonyException

setSyncServiceEndpoint

@Deprecated
public static void setSyncServiceEndpoint(String syncServiceEndpoint)
                                                throws KonyException

Deprecated.

This method sets the Sync Service EndPoint for the application.

Parameters:

syncServiceEndpoint - url for the Sync service.

Throws:

KonyException

setIdentyServiceProviderEndpoint

@Deprecated
public static void setIdentyServiceProviderEndpoint(String provider,
                                                                 String identityServiceEndpoint)
                                                          throws KonyException

Deprecated.

This method sets the Identity Service EndPoint for the application.

Parameters:

provider - Identity service provider name for which the url has to be set

identityServiceEndpoint - endpoint url for that particular service

Throws:

KonyException

setIntegrationServiceEndpoint

@Deprecated
public static void setIntegrationServiceEndpoint(String serviceName,
                                                              String integrationServiceEndpoint)
                                                       throws KonyException

Deprecated.

This method sets the Integration Service EndPoint for the application.

Parameters:

serviceName - service name for which the url has to be set

integrationServiceEndpoint - endpoint url for that particular service

Throws:

KonyException

getServiceDocument

@Deprecated
public static JSONObject getServiceDocument()

Deprecated.

This method will be used by Client-SDK-Developer, to get back the service document at any point of time during the application lifecycle.

Returns:

serviceDocument JSON document of the Kony Service Document.

acceptSelfSignedCertificates

@Deprecated
public static void acceptSelfSignedCertificates()

Deprecated.

This method will be used by Client-SDK-Developer, to accept the self-signed certificate for the services.

getServiceDoc

public ServiceDoc getServiceDoc()

getAppKey

public String getAppKey()

This method returns the appKey for application.

Returns:

Returns the appKey for application.

getAppSecret

public String getAppSecret()

This method returns the appSecret for application.

Returns:

Returns the appSecret for application.

getIdentityService

public IdentityService getIdentityService(String identityName)
                                   throws KonyException

Method will create the IdentityService instance with the provided identityName.

Parameters:

identityName - - - Name of the Identity.

Returns:

IdentityService instance.

Throws:

KonyException - - if the invalid identity name provided or identity list is empty.

getIntegrationService

public IntegrationService getIntegrationService(String operationName)
                                         throws KonyException

Method will create the IntegrationService instance with the provided operationName.

Parameters:

operationName - - Name of the Operation Name

Returns:

IntegrationService instance.

Throws:

KonyException - - if the invalid operationName name provided or IntegrationService list is empty.

getObjectService

public ObjectService getObjectService(String serviceName)
                               throws KonyException

Method will create the ObjectService instance.

Returns:

ObjectService instance.

Throws:

KonyException - if the ObjectService list is empty.

getMessagingService

public MessagingService getMessagingService()
                                     throws KonyException

Method will create the MessagingService instance.

Returns:

MessagingService instance.

Throws:

KonyException - if the MessagingService list is empty.

getOfflineObjects

public IKonyApplicationSync getOfflineObjects()
                                       throws KonyException

Method will create the Kony Sync Application instance.

Returns:

Kony Sync Application instance.

Throws:

KonyException

getMetricsService

public com.kony.cms.services.metrics.MetricsService getMetricsService()
                                                               throws KonyException

Method will create the MetricsService instance.

Returns:

MetricsService instance.

Throws:

KonyException - if the MetricsService list is empty.

getSyncService

public Sync getSyncService(KonyFactoryOptions options)
                    throws KonyException

Method will create the SyncService instance and initializes the sync. Passphrase will be used if it is provided in options.

Parameters:

options - contains configuration options to initialize the Sync

Returns:

Sync instance.

Throws:

KonyException - if the Sync Configuration list is empty.

setStorageMgr

public void setStorageMgr(StorageManager storageManager)

This method will be used by Client-SDK-Developer, to override the KonyStorageManager instance with custom storage implementation where Client-SDK-Developer can write the storage code by taking care of his own encryption logic.

Parameters:

storageManager - storageManager instance used to store, get and remove the items.

getNWOptions

public NetworkOptions getNWOptions()

Returns:

the networkOptions

setNWOptions

public void setNWOptions(NetworkOptions networkOptions)

Parameters:

networkOptions - the networkOptions to set

ignoreSSLCertErrors

public void ignoreSSLCertErrors()
                         throws KonyException

This method will be used by Client-SDK-Developer, to accept the self-signed certificate for the services.Make sure to include KonyAllowAllTrustManager jar (available in libs folder of the plugin)

Throws:

KonyException

initInBackground

@Deprecated
public static void initInBackground(Context context,
                                                 String appKey,
                                                 String appSecret,
                                                 String serviceUrl,
                                                 InitCallback initCallback)
                                          throws KonyException

Deprecated.

Initialization method for the Kony Client SDK. This method will fetch the App configuration file from the server. This method has to be invoked before invoking any other SDK methods.

Parameters:

context - - Context object used to get global information an application environment

appKey - - AppKey of the application

appSecret - - AppSecret of the application

serviceUrl - - URL of the Server.

initCallback - - initCallback interface is having the following success/failure callback methods. - onSuccess(JSONObject response) - onFailure(KonyException konyException)

Throws:

KonyException

setClientParams

public void setClientParams(Hashtable<String,Object> clientParams)

getSdkVersion

public static String getSdkVersion()

This method will be used by Client-SDK-Developer, to get the SDK version

Returns:

sdkVersion

getSdkType

public static String getSdkType()

This method will be used by Client-SDK-Developer, to get the SDK type

Returns:

SdkType

removeGlobalRequestParam

public void removeGlobalRequestParam(String paramName,
                                     String paramType)

resetGlobalRequestParams

public void resetGlobalRequestParams()

appendGlobalHeaders

public void appendGlobalHeaders(Map<String,String> headers)

appendGlobalBodyParams

public void appendGlobalBodyParams(Map<String,String> bodyparameters)

appendGlobalQueryParams

public String appendGlobalQueryParams(String url)

appendGlobalParams

public String appendGlobalParams(String url,
                                 Map<String,String> headers,
                                 Map<String,String> params)

getGlobalRequestParams

public Map<String,String> getGlobalRequestParams(String paramType)

setGlobalRequestParam

public void setGlobalRequestParam(String paramName,
                                  String paramValue,
                                  String paramType)