- Overview
- Registering a Zoho Client
- Environmental Setup
- Including the SDK in your project
- Using the Java SDK for Zoho CRM through Maven
- Persistence
- Configuration
- Initialization
- Class Hierarchy
- Responses And Exceptions
- Threading
- Sample Code
Zoho CRM JAVA SDK offers a way to create client Java applications that can be integrated with Zoho CRM.
Since Zoho CRM APIs are authenticated with OAuth2 standards, you should register your client app with Zoho. To register your app:
-
Visit this page https://api-console.zoho.com/
-
Click
ADD CLIENT. -
Choose the
Client Type. -
Enter Client Name, Client Domain or Homepage URL and Authorized Redirect URIs. Click
CREATE. -
Your Client app will be created.
-
Select the created OAuth client.
-
Generate grant token by providing the necessary scopes, time duration (the duration for which the generated token is valid) and Scope Description.
JAVA SDK requires Java (version 8 and above) to be set up in your development environment.
Java SDK is available through Maven distribution. You can include the SDK to your project using:
-
Maven
- pom.xml file.
<repositories> <repository> <id>zohocrmsdk-2-0</id> <url>https://maven.zohodl.com</url> </repository> </repositories> <dependencies> <dependency> <groupId>com.zoho.crm</groupId> <artifactId>zohocrmsdk-2-0</artifactId> <version>6.0.0</version> </dependency> </dependencies>
-
Gradle
repositories{ maven { url "https://maven.zohodl.com" } } dependencies{ implementation 'com.zoho.crm:zohocrmsdk-2-0:6.0.0' }
mysql-connector-java-5.1.47-bin.jar
Follow the below steps to use the Java SDK for Zoho CRM through Maven.
-
Create a Maven project.
-
Place the below code in your pom.xml file of your Maven project.
<repositories> <repository> <id>zohocrmsdk-2-0</id> <url>https://maven.zohodl.com</url> </repository> </repositories> <dependencies> <dependency> <groupId>com.zoho.crm</groupId> <artifactId>zohocrmsdk-2-0</artifactId> <version>6.0.0</version> </dependency> </dependencies>
-
Update the maven project.
- Under project explorer, right-click the project name, select Maven > Update Project. The jar will be downloaded in the maven dependencies.
-
Inside your source code, import the appropriate files from the SDK.
-
Generate the grant token when you initialize your application.
Token persistence refers to storing and utilizing the authentication tokens that are provided by Zoho. There are three ways provided by the SDK in which persistence can be utilized. They are DataBase Persistence, File Persistence, and Custom Persistence.
Once the application is authorized, OAuth access and refresh tokens can be used for subsequent user data requests to Zoho CRM. Hence, they need to be persisted by the client app.
The persistence is achieved by writing an implementation of the inbuilt TokenStore interface, which has the following callback methods.
-
getToken(UserSignature user, Token token) - invoked before firing a request to fetch the saved tokens. This method should return an implementation of Token interface object for the library to process it.
-
saveToken(UserSignature user, Token token) - invoked after fetching access and refresh tokens from Zoho.
-
deleteToken(Token token) - invoked before saving the latest tokens.
-
getTokens() - The method to retrieve all the stored tokens.
-
deleteTokens() - The method to delete all the stored tokens.
-
getTokenById(String id, Token token) - The method to retrieve the user's token details based on unique ID.
In case the user prefers to use the default DataBase persistence, MySQL can be used.
-
The database name should be zohooauth.
-
There must be a table named oauthtoken with the following columns.
-
id varchar(255)
-
user_mail varchar(255)
-
client_id varchar(255)
-
client_secret varchar(255)
-
refresh_token varchar(255)
-
access_token varchar(255)
-
grant_token varchar(255)
-
expiry_time varchar(20)
-
redirect_url varchar(255)
-
Note:
- Custom database name and table name can be set in DBStore instance.
CREATE TABLE oauthtoken (
id varchar(255) NOT NULL,
user_mail varchar(255) NOT NULL,
client_id varchar(255),
client_secret varchar(255),
refresh_token varchar(255),
access_token varchar(255),
grant_token varchar(255),
expiry_time varchar(20),
redirect_url varchar(255),
primary key (id)
);/*
* Create an instance of TokenStore.
* host -> DataBase host name. Default "jdbc:mysql://localhost"
* databaseName -> DataBase name. Default "zohooauth"
* userName -> DataBase user name. Default "root"
* tableName -> DataBase table name. Default "oauthtoken"
* password -> DataBase password. Default ""
* portNumber -> DataBase port number. Default "3306"
*/
//TokenStore tokenstore = new DBStore.Builder().build();
TokenStore tokenstore = new DBStore.Builder()
.host("hostName")
.databaseName("databaseName")
.tableName("tableName")
.userName("userName")
.password("password")
.portNumber("portNumber")
.build();In case of default File Persistence, the user can persist tokens in the local drive, by providing the the absolute file path to the FileStore object.
-
The File contains
-
id
-
user_mail
-
client_id
-
client_secret
-
refresh_token
-
access_token
-
grant_token
-
expiry_time
-
redirect_url
-
//Parameter containing the absolute file path to store tokens
TokenStore tokenstore = new FileStore("/Users/user_name/Documents/java_sdk_token.txt");To use Custom Persistence, you must implement TokenStore interface(com.zoho.api.authenticator.store.TokenStore) and override the methods.
package store;
import com.zoho.api.authenticator.Token;
import com.zoho.crm.api.exception.SDKException;
import com.zoho.crm.api.UserSignature;
import com.zoho.api.authenticator.store.TokenStore;
public class CustomStore implements TokenStore
{
/**
* @param user A UserSignature class instance.
* @param token A Token (com.zoho.api.authenticator.OAuthToken) class instance.
* @return A Token class instance representing the user token details.
* @throws SDKException if any problem occurs.
*/
@Override
public Token getToken(UserSignature user, Token token) throws SDKException
{
// Add code to get the token
return null;
}
/**
* @param user A UserSignature class instance.
* @param token A Token (com.zoho.api.authenticator.OAuthToken) class instance.
* @throws SDKException if any problem occurs.
*/
@Override
public void saveToken(UserSignature user, Token token) throws SDKException
{
// Add code to save the token
}
/**
* @param token A Token (com.zoho.api.authenticator.OAuthToken) class instance.
* @throws SDKException if any problem occurs.
*/
@Override
public void deleteToken(Token token) throws SDKException
{
// Add code to delete the token
}
@Override
public void getTokens() throws SDKException
{
// Add code to get the all stored tokens
}
@Override
public void deleteTokens() throws SDKException
{
// Add code to delete the all stored token
}
/**
* This method is used to get user token details by id.
* @param id A String
* @param token A Token class instance.
* @return A Token class instance representing the user token details.
* @throws SDKException if any problem occurs.
*/
@Override
public Token getTokenById(String id, Token token)
{
// Add code to get the token using unique id
return null;
}
}Before you get started with creating your Java application, you need to register your client and authenticate the app with Zoho.
| Mandatory Keys | Optional Keys |
|---|---|
| user | logger |
| environment | store |
| token | SDKConfig |
| requestProxy | |
| resourcePath |
-
Create an instance of UserSignature that identifies the current user.
//Create an UserSignature instance that takes user Email as parameter UserSignature user = new UserSignature("abc@zoho.com");
-
Configure the API environment which decides the domain and the URL to make API calls.
/* * Configure the environment * which is of the pattern Domain.Environment * Available Domains: USDataCenter, EUDataCenter, INDataCenter, CNDataCenter, AUDataCenter * Available Environments: PRODUCTION, DEVELOPER, SANDBOX */ Environment environment = USDataCenter.PRODUCTION;
-
Create an instance of OAuthToken with the information that you get after registering your Zoho client.
/* * Create a Token instance that requires the following * clientId -> OAuth client id. * clientSecret -> OAuth client secret. * refreshToken -> REFRESH token. * accessToken -> Access token. * grantToken -> GRANT token. * id -> User unique id. * redirectURL -> OAuth redirect URL. */ //Create a Token instance // if refresh token is available // The SDK throws an exception, if the given id is invalid. Token token = new OAuthToken.Builder() .id("id") .build(); // if grant token is available Token token = new OAuthToken.Builder() .clientID("clientId") .clientSecret("clientSecret") .grantToken("grantToken") .redirectURL("redirectURL") .build(); // if ID (obtained from persistence) is available Token token = new OAuthToken.Builder() .clientID("clientId") .clientSecret("clientSecret") .refreshToken("refreshToken") .redirectURL("redirectURL") .build(); // if access token is available Token token = new OAuthToken.Builder() .accessToken("accessToken") .build();
-
Create an instance of Logger Class to log exception and API information. By default, the SDK constructs a Logger instance with level - INFO and file_path - (sdk_logs.log, created in the current working directory)
/* * Create an instance of Logger Class that takes two parameters * level -> Level of the log messages to be logged. Can be configured by typing Levels "." and choose any level from the list displayed. * filePath -> Absolute file path, where messages need to be logged. */ Logger logger = new Logger.Builder() .level(Levels.INFO) .filePath("/Users/user_name/Documents/java_sdk_log.log") .build();
-
Create an instance of TokenStore to persist tokens, used for authenticating all the requests. By default, the SDK creates the sdk_tokens.txt created in the current working directory) to persist the tokens.
/* * Create an instance of DBStore that requires the following * host -> DataBase host name. Default value "localhost" * databaseName -> DataBase name. Default value "zohooauth" * userName -> DataBase user name. Default value "root" * password -> DataBase password. Default value "" * portNumber -> DataBase port number. Default value "3306" * tabletName -> DataBase table name. Default value "oauthtoken" */ //TokenStore tokenstore = new DBStore.Builder().build(); TokenStore tokenstore = new DBStore.Builder() .host("hostName") .databaseName("databaseName") .tableName("tableName") .userName("userName") .password("password") .portNumber("portNumber") .build(); //TokenStore tokenstore = new FileStore("/Users/user_name/Documents/java_sdk_token.txt"); //TokenStore tokenStore = new CustomStore();
-
Create an instance of SDKConfig containing SDK configurations.
/* * By default, the SDK creates the SDKConfig instance * autoRefreshFields (default - false) * if true - all the modules' fields will be auto-refreshed in the background, every hour. * if false - the fields will not be auto-refreshed in the background. The user can manually delete the file(s) or refresh the fields using methods from ModuleFieldsHandler(com.zoho.crm.api.util.ModuleFieldsHandler) * * pickListValidation (default - true) * A boolean field that validates user input for a pick list field and allows or disallows the addition of a new value to the list. * true - the SDK validates the input. If the value does not exist in the pick list, the SDK throws an error. * false - the SDK does not validate the input and makes the API request with the user’s input to the pick list */ SDKConfig sdkConfig = new SDKConfig.Builder() .autoRefreshFields(false) .pickListValidation(true) .build();
-
The path containing the absolute directory path to store user-specific files containing module fields information. By default, the SDK stores the user-specific files within a folder in the current working directory.
String resourcePath = "/Users/user_name/Documents/javasdk-application";
-
Create an instance of RequestProxy containing the proxy properties of the user.
/* * Create an instance of RequestProxy * host -> proxyHost * port -> proxyPort * user -> proxyUser * password -> password * userDomain -> userDomain */ RequestProxy requestProxy = new RequestProxy.Builder() .host("host") .port(proxyPort) .user("userName") .password("password") .userDomain("userDomain") .build();
Initialize the SDK using the following code.
package com.zoho.crm.sample.initializer;
import com.zoho.api.authenticator.OAuthToken;
import com.zoho.api.authenticator.Token;
import com.zoho.api.authenticator.store.DBStore;
import com.zoho.api.authenticator.store.FileStore;
import com.zoho.api.authenticator.store.TokenStore;
import com.zoho.api.logger.Logger;
import com.zoho.api.logger.Logger.Levels;
import com.zoho.crm.api.Initializer;
import com.zoho.crm.api.RequestProxy;
import com.zoho.crm.api.SDKConfig;
import com.zoho.crm.api.UserSignature;
import com.zoho.crm.api.dc.DataCenter.Environment;
import com.zoho.crm.api.dc.USDataCenter;
public class Initialize
{
public static void main(String[] args) throws Exception
{
initialize();
}
public static void initialize() throws Exception
{
/*
* Create an instance of Logger Class that takes two parameters
* level -> Level of the log messages to be logged. Can be configured by typing Levels "." and choose any level from the list displayed.
* filePath -> Absolute file path, where messages need to be logged.
*/
Logger logger = new Logger.Builder()
.level(Levels.INFO)
.filePath("/Users/user_name/Documents/java_sdk_log.log")
.build();
//Create an UserSignature instance that takes user Email as parameter
UserSignature user = new UserSignature("abc@zoho.com");
/*
* Configure the environment
* which is of the pattern Domain.Environment
* Available Domains: USDataCenter, EUDataCenter, INDataCenter, CNDataCenter, AUDataCenter
* Available Environments: PRODUCTION, DEVELOPER, SANDBOX
*/
Environment environment = USDataCenter.PRODUCTION;
/*
* Create a Token instance that requires the following
* clientId -> OAuth client id.
* clientSecret -> OAuth client secret.
* refreshToken -> REFRESH token.
* grantToken -> GRANT token.
* id -> User unique id.
* redirectURL -> OAuth redirect URL.
*/
// if grant token is available
Token token = new OAuthToken.Builder()
.clientID("clientId")
.clientSecret("clientSecret")
.grantToken("grantToken")
.redirectURL("redirectURL")
.build();
/*
* Create an instance of DBStore that requires the following
* host -> DataBase host name. Default value "localhost"
* databaseName -> DataBase name. Default value "zohooauth"
* userName -> DataBase user name. Default value "root"
* password -> DataBase password. Default value ""
* portNumber -> DataBase port number. Default value "3306"
* tabletName -> DataBase table name. Default value "oauthtoken"
*/
//TokenStore tokenstore = new DBStore.Builder().build();
TokenStore tokenstore = new DBStore.Builder()
.host("hostName")
.databaseName("databaseName")
.tableName("tableName")
.userName("userName")
.password("password")
.portNumber("portNumber")
.build();
//TokenStore tokenstore = new FileStore("absolute_file_path");
/*
* autoRefreshFields
* if true - all the modules' fields will be auto-refreshed in the background, every hour.
* if false - the fields will not be auto-refreshed in the background. The user can manually delete the file(s) or refresh the fields using methods from ModuleFieldsHandler(com.zoho.crm.api.util.ModuleFieldsHandler)
*
* pickListValidation
* A boolean field that validates user input for a pick list field and allows or disallows the addition of a new value to the list.
* if true - the SDK validates the input. If the value does not exist in the pick list, the SDK throws an error.
* if false - the SDK does not validate the input and makes the API request with the user’s input to the pick list
*/
SDKConfig sdkConfig = new SDKConfig.Builder()
.autoRefreshFields(false)
.pickListValidation(true)
.build();
String resourcePath = "/Users/user_name/Documents/javasdk-application";
/*
* Create an instance of RequestProxy
* host -> proxyHost
* port -> proxyPort
* user -> proxyUser
* password -> password
* userDomain -> userDomain
*/
RequestProxy requestProxy = new RequestProxy.Builder()
.host("host")
.port(proxyPort)
.user("userName")
.password("password")
.userDomain("userDomain")
.build();
/*
* Set the following in InitializeBuilder
* user -> UserSignature instance
* environment -> Environment instance
* token -> Token instance
* store -> TokenStore instance
* SDKConfig -> SDKConfig instance
* resourcePath -> resourcePath - A String
* logger -> Log instance (optional)
* requestProxy -> RequestProxy instance (optional)
*/
new Initializer.Builder()
.user(user)
.environment(environment)
.token(token)
.store(tokenstore)
.SDKConfig(config)
.resourcePath(resourcePath)
.logger(logger)
.initialize();
}
}- You can now access the functionalities of the SDK. Refer to the sample codes to make various API calls through the SDK.
All SDK method calls return an instance of the APIResponse class.
Use the getObject() method in the returned APIResponse object to obtain the response handler interface depending on the type of request (GET, POST,PUT,DELETE).
APIResponse<ResponseHandler> and APIResponse<ActionHandler> are the common wrapper objects for Zoho CRM APIs’ responses.
Whenever the API returns an error response, the response will be an instance of APIException class.
All other exceptions such as SDK anomalies and other unexpected behaviours are thrown under the SDKException class.
-
For operations involving records in Tags
- APIResponse<RecordActionHandler>
-
For getting Record Count for a specific Tag operation
- APIResponse<CountHandler>
-
For operations involving BaseCurrency
- APIResponse<BaseCurrencyActionHandler>
-
For Lead convert operation
- APIResponse<ConvertActionHandler>
-
For retrieving Deleted records operation
- APIResponse<DeletedRecordsHandler>
-
For Record image download operation
- APIResponse<DownloadHandler>
-
For MassUpdate record operations
-
APIResponse<MassUpdateActionHandler>
-
APIResponse<MassUpdateResponseHandler>
-
-
The getObject() of the returned APIResponse instance returns the response handler interface.
-
The ResponseHandler interface interface encompasses the following
- ResponseWrapper class (for application/json responses)
- FileBodyWrapper class (for File download responses)
- APIException class
-
The CountHandler interface encompasses the following
- CountWrapper class (for application/json responses)
- APIException class
-
The DeletedRecordsHandler interface encompasses the following
- DeletedRecordsWrapper class (for application/json responses)
- APIException class
-
The DownloadHandler interface encompasses the following
- FileBodyWrapper class (for File download responses)
- APIException class
-
The MassUpdateResponseHandler interface encompasses the following
- MassUpdateResponseWrapper class (for application/json responses)
- APIException class
-
The getObject() of the returned APIResponse instance returns the action handler interface.
-
The ActionHandler interface encompasses the following
- ActionWrapper class (for application/json responses)
- APIException class
-
The ActionWrapper class contains Property/Properties that may contain one/list of ActionResponse interfaces.
-
The ActionResponse interface encompasses the following
- SuccessResponse class (for application/json responses)
- APIException class
-
The ActionHandler interface encompasses the following
- ActionWrapper class (for application/json responses)
- APIException class
-
The RecordActionHandler interface encompasses the following
- RecordActionWrapper class (for application/json responses)
- APIException class
-
The BaseCurrencyActionHandler interface encompasses the following
- BaseCurrencyActionWrapper class (for application/json responses)
- APIException class
-
The MassUpdateActionHandler interface encompasses the following
- MassUpdateActionWrapper class (for application/json responses)
- APIException class
-
The ConvertActionHandler interface encompasses the following
- ConvertActionWrapper class (for application/json responses)
- APIException class
Threads in a Java program help you achieve parallelism. By using multiple threads, you can make a Java program run faster and do multiple things simultaneously.
The Java SDK (from version 3.x.x) supports both single-threading and multi-threading irrespective of a single-user or a multi-user app.
Multi-threading for multi-users is achieved using Initializer's static switchUser().
new Initializer.Builder()
.user(user)
.environment(environment)
.token(token)
.SDKConfig(config)
.switchUser()Here is a sample code to depict multi-threading for a multi-user app.
package threading.multiuser;
import com.zoho.api.authenticator.OAuthToken;
import com.zoho.api.authenticator.Token;
import com.zoho.api.authenticator.store.DBStore;
import com.zoho.api.authenticator.store.TokenStore;
import com.zoho.api.logger.Logger;
import com.zoho.crm.api.Initializer;
import com.zoho.crm.api.RequestProxy;
import com.zoho.crm.api.SDKConfig;
import com.zoho.crm.api.UserSignature;
import com.zoho.crm.api.dc.USDataCenter;
import com.zoho.crm.api.dc.DataCenter.Environment;
import com.zoho.crm.api.exception.SDKException;
import com.zoho.crm.api.record.RecordOperations;
import com.zoho.crm.api.util.APIResponse;
public class MultiThread extends Thread
{
Environment environment;
UserSignature user;
Token token;
String moduleAPIName;
RequestProxy userProxy;
SDKConfig sdkConfig;
public MultiThread(UserSignature user, Environment environment, Token token, String moduleAPIName, SDKConfig config, RequestProxy proxy)
{
this.environment= environment;
this.user = user;
this.token = token;
this.moduleAPIName = moduleAPIName;
this.sdkConfig = config;
this.userProxy = proxy;
}
public void run()
{
try
{
new Initializer.Builder()
.user(user)
.environment(environment)
.token(token)
.SDKConfig(sdkConfig)
.requestProxy(userProxy)
.switchUser();
System.out.println(Initializer.getInitializer().getUser().getEmail());
RecordOperations cro = new RecordOperations();
@SuppressWarnings("rawtypes")
APIResponse getResponse = cro.getRecords(this.moduleAPIName, null, null);
System.out.println(getResponse.getObject());
}
catch (Exception e)
{
e.printStackTrace();
}
}
public static void main(String[] args) throws SDKException
{
Logger loggerInstance = new Logger.Builder()
.level(Logger.Levels.ALL)
.filePath("/Users/user_name/Documents/java-sdk-logs.log")
.build();
Environment environment = USDataCenter.PRODUCTION;
UserSignature user1 = new UserSignature("user1@zoho.com");
TokenStore tokenstore = new DBStore.Builder()
.host("hostName")
.databaseName("databaseName")
.tableName("tableName")
.userName("userName")
.password("password")
.portNumber("portNumber")
.build();
Token token1 = new OAuthToken.Builder()
.clientID("clientId1")
.clientSecret("clientSecret1")
.refreshToken("refreshToken")
.redirectURL("redirectURL")
.build();
String resourcePath = "/Users/user_name/Documents";
SDKConfig user1Config = new SDKConfig.Builder()
.autoRefreshFields(false)
.pickListValidation(true)
.build();
new Initializer.Builder()
.user(user1)
.environment(environment)
.token(token1)
.store(tokenstore)
.SDKConfig(user1Config)
.resourcePath(resourcePath)
.logger(loggerInstance)
.initialize();
MultiThread multiThread = new MultiThread(user1, environment, token1, "Students", user1Config, null);
multiThread.start();
Environment environment1 = USDataCenter.PRODUCTION;
UserSignature user2 = new UserSignature("user2@zoho.com");
Token token2 = new OAuthToken.Builder()
.clientID("clientId1")
.clientSecret("clientSecret1")
.refreshToken("refreshToken")
.redirectURL("redirectURL")
.build();
RequestProxy user2Proxy = new RequestProxy.Builder()
.host("proxyHost")
.port(80)
.user("proxyUser")
.password("password")
.userDomain("userDomain")
.build();
SDKConfig user2Config = new SDKConfig.Builder()
.autoRefreshFields(true)
.pickListValidation(false)
.build();
multiThread = new MultiThread(user2, environment1, token2, "Leads", user2Config, user2Proxy);
multiThread.start();
}
}-
The program execution starts from main().
-
The details of "user1" are given in the variables user1, token1, environment1.
-
Similarly, the details of another user "user2" are given in the variables user2, token2, environment2.
-
For each user, an instance of MultiThread class is created.
-
When start() is called which in-turn invokes the run(), the details of user1 are passed to the switchUser function through the MultiThread object. Therefore, this creates a thread for user1.
-
Similarly, When the start() is invoked again, the details of user2 are passed to the switchUser function through the MultiThread object. Therefore, this creates a thread for user2.
package threading.singleuser;
import com.zoho.api.authenticator.OAuthToken;
import com.zoho.api.authenticator.Token;
import com.zoho.api.authenticator.store.FileStore;
import com.zoho.api.authenticator.store.TokenStore;
import com.zoho.api.logger.Logger;
import com.zoho.api.logger.Logger.Levels;
import com.zoho.crm.api.Initializer;
import com.zoho.crm.api.SDKConfig;
import com.zoho.crm.api.UserSignature;
import com.zoho.crm.api.dc.USDataCenter;
import com.zoho.crm.api.dc.DataCenter.Environment;
import com.zoho.crm.api.record.RecordOperations;
import com.zoho.crm.api.util.APIResponse;
public class MultiThread extends Thread
{
String moduleAPIName;
public MultiThread(String moduleAPIName)
{
this.moduleAPIName = moduleAPIName;
}
public void run()
{
try
{
RecordOperations record = new RecordOperations();
@SuppressWarnings("rawtypes")
APIResponse getResponse = record.getRecords(this.moduleAPIName, null, null);
}
catch (Exception e)
{
e.printStackTrace();
}
}
public static void main(String[] args) throws SDKException
{
Logger logger = new Logger.Builder()
.level(Levels.INFO)
.filePath("/Users/user_name/Documents/java-sdk-logs.log")
.build();
Environment environment = USDataCenter.PRODUCTION;
TokenStore tokenStore = new FileStore("/Users/user_name/Documents/java-sdk-tokens.txt");
UserSignature user = new UserSignature("user1@zoho.com");
Token token = new OAuthToken.Builder()
.clientID("clientId1")
.clientSecret("clientSecret1")
.refreshToken("refreshToken")
.redirectURL("redirectURL")
.build();
SDKConfig sdkConfig = new SDKConfig.Builder()
.autoRefreshFields(false)
.pickListValidation(true)
.build();
String resourcePath = "/Users/user_name/Documents/javasdk-application";
new Initializer.Builder()
.user(user)
.environment(environment)
.token(token)
.store(tokenstore)
.SDKConfig(sdkConfig)
.resourcePath(resourcePath)
.logger(logger)
.initialize();
MultiThread mtsu = new MultiThread("Deals");
mtsu.start();
mtsu = new MultiThread("Leads");
mtsu.start();
}
}-
The program execution starts from main() where the SDK is initialized with the details of user and an instance of MultiThread class is created .
-
When the start() is called which in-turn invokes the run(), the moduleAPIName is switched through the MultiThread object. Therefore, this creates a thread for the particular MultiThread instance.
-
The MultiThread object is reinitialized with a different moduleAPIName.
-
Similarly, When the start() is invoked again, the moduleAPIName is switched through the MultiThread object. Therefore, this creates a thread for the particular MultiThread instance.
import com.zoho.api.authenticator.Token;
import com.zoho.api.authenticator.store.DBStore;
import com.zoho.api.authenticator.store.FileStore;
import com.zoho.api.authenticator.store.TokenStore;
import com.zoho.crm.api.exception.SDKException;
import java.time.OffsetDateTime;
import java.time.ZoneOffset;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import com.zoho.api.authenticator.OAuthToken;
import com.zoho.crm.api.HeaderMap;
import com.zoho.crm.api.Initializer;
import com.zoho.crm.api.ParameterMap;
import com.zoho.crm.api.SDKConfig;
import com.zoho.crm.api.UserSignature;
import com.zoho.crm.api.dc.DataCenter.Environment;
import com.zoho.crm.api.dc.USDataCenter;
import com.zoho.api.logger.Logger;
import com.zoho.api.logger.Logger.Levels;
import com.zoho.crm.api.record.RecordOperations;
import com.zoho.crm.api.record.ResponseHandler;
import com.zoho.crm.api.record.ResponseWrapper;
import com.zoho.crm.api.tags.Tag;
import com.zoho.crm.api.record.RecordOperations.GetRecordsHeader;
import com.zoho.crm.api.record.RecordOperations.GetRecordsParam;
import com.zoho.crm.api.util.APIResponse;
public class Record
{
public static void main(String[] args) throws SDKException
{
/*
* Create an instance of Logger Class that takes two parameters
* level -> Level of the log messages to be logged. Can be configured by typing Levels "." and choose any level from the list displayed.
* filePath -> Absolute file path, where messages need to be logged.
*/
Logger logger = new Logger.Builder()
.level(Levels.INFO)
.filePath("/Users/user_name/Documents/java-sdk-logs.log")
.build();
//Create an UserSignature instance that takes user Email as parameter
UserSignature user = new UserSignature("abc@zoho.com");
/*
* Configure the environment
* which is of the pattern Domain.Environment
* Available Domains: USDataCenter, EUDataCenter, INDataCenter, CNDataCenter, AUDataCenter
* Available Environments: PRODUCTION, DEVELOPER, SANDBOX
*/
Environment environment = USDataCenter.PRODUCTION;
/*
* Create a Token instance
* clientID -> OAuth client id.
* clientSecret -> OAuth client secret.
* refreshToken -> refresh token.
* redirectURL -> OAuth redirect URL.
*/
Token token = new OAuthToken.Builder()
.clientID("clientId1")
.clientSecret("clientSecret1")
.refreshToken("refreshToken")
.redirectURL("redirectURL")
.build();
/*
* Create an instance of TokenStore.
* host -> DataBase host name. Default "jdbc:mysql://localhost"
* databaseName -> DataBase name. Default "zohooauth"
* userName -> DataBase user name. Default "root"
* tableName -> DataBase table name. Default "oauthtoken"
* password -> DataBase password. Default ""
* portNumber -> DataBase port number. Default "3306"
*/
// TokenStore tokenstore = new DBStore.Builder().build();
TokenStore tokenstore = new DBStore.Builder()
.host("hostName")
.databaseName("databaseName")
.tableName("tableName")
.userName("userName")
.password("password")
.portNumber("portNumber")
.build();
// TokenStore tokenstore = new FileStore("absolute_file_path");
/*
* autoRefreshFields (default value is false)
* true - all the modules' fields will be auto-refreshed in the background, every hour.
* false - the fields will not be auto-refreshed in the background. The user can manually delete the file(s) or refresh the fields using methods from ModuleFieldsHandler
*
* pickListValidation (default value is true)
* A boolean field that validates user input for a pick list field and allows or disallows the addition of a new value to the list.
* true - the SDK validates the input. If the value does not exist in the pick list, the SDK throws an error.
* false - the SDK does not validate the input and makes the API request with the user’s input to the pick list
*/
SDKConfig config = new SDKConfig.Builder()
.autoRefreshFields(true)
.pickListValidation(false)
.build();
String resourcePath = "/Users/user_name/Documents/javasdk-application";
/*
* Set the following in InitializeBuilder
* user -> UserSignature instance
* environment -> Environment instance
* token -> Token instance
* store -> TokenStore instance
* SDKConfig -> SDKConfig instance
* resourcePath -> resourcePath - A String
* logger -> Log instance (optional)
* requestProxy -> RequestProxy instance (optional)
*/
new Initializer.Builder()
.user(user)
.environment(environment)
.token(token)
.store(tokenstore)
.SDKConfig(config)
.resourcePath(resourcePath)
.logger(logger)
.initialize();
String moduleAPIName = "Leads";
RecordOperations recordOperations = new RecordOperations();
ParameterMap paramInstance = new ParameterMap();
paramInstance.add(GetRecordsParam.APPROVED, "both");
HeaderMap headerInstance = new HeaderMap();
OffsetDateTime enddatetime = OffsetDateTime.of(2020, 05, 20, 10, 00, 01, 00, ZoneOffset.of("+05:30"));
headerInstance.add(GetRecordsHeader.IF_MODIFIED_SINCE, enddatetime);
//Call getRecords method
APIResponse<ResponseHandler>response = recordOperations.getRecords(moduleAPIName, paramInstance, headerInstance);
if(response != null)
{
//Get the status code from response
System.out.println("Status Code: " + response.getStatusCode());
if(Arrays.asList(204,304).contains(response.getStatusCode()))
{
System.out.println(response.getStatusCode() == 204? "No Content" : "Not Modified");
return;
}
//Check if expected response is received
if(response.isExpected())
{
//Get the object from response
ResponseHandler responseHandler = response.getObject();
if(responseHandler instanceof ResponseWrapper)
{
//Get the received ResponseWrapper instance
ResponseWrapper responseWrapper = (ResponseWrapper) responseHandler;
//Get the obtained Record instances
List<com.zoho.crm.api.record.Record> records = responseWrapper.getData();
for(com.zoho.crm.api.record.Record record : records)
{
//Get the ID of each Record
System.out.println("Record ID: " + record.getId());
//Get the createdBy User instance of each Record
com.zoho.crm.api.users.User createdBy = record.getCreatedBy();
//Check if createdBy is not null
if(createdBy != null)
{
//Get the ID of the createdBy User
System.out.println("Record Created By User-ID: " + createdBy.getId());
//Get the name of the createdBy User
System.out.println("Record Created By User-Name: " + createdBy.getName());
//Get the Email of the createdBy User
System.out.println("Record Created By User-Email: " + createdBy.getEmail());
}
//Get the CreatedTime of each Record
System.out.println("Record CreatedTime: " + record.getCreatedTime());
//Get the modifiedBy User instance of each Record
com.zoho.crm.api.users.User modifiedBy = record.getModifiedBy();
//Check if modifiedBy is not null
if(modifiedBy != null)
{
//Get the ID of the modifiedBy User
System.out.println("Record Modified By User-ID: " + modifiedBy.getId());
//Get the name of the modifiedBy User
System.out.println("Record Modified By User-Name: " + modifiedBy.getName());
//Get the Email of the modifiedBy User
System.out.println("Record Modified By User-Email: " + modifiedBy.getEmail());
}
//Get the ModifiedTime of each Record
System.out.println("Record ModifiedTime: " + record.getModifiedTime());
//Get the list of Tag instance each Record
List<Tag> tags = record.getTag();
//Check if tags is not null
if(tags != null)
{
for(Tag tag : tags)
{
//Get the Name of each Tag
System.out.println("Record Tag Name: " + tag.getName());
//Get the Id of each Tag
System.out.println("Record Tag ID: " + tag.getId());
}
}
//To get particular field value
System.out.println("Record Field Value: " + record.getKeyValue("Last_Name"));// FieldApiName
System.out.println("Record KeyValues: " );
//Get the KeyValue map
for(Map.Entry<String, Object> entry : record.getKeyValues().entrySet())
{
String keyName = entry.getKey();
Object value = entry.getValue();
if(value != null)
{
System.out.println("Field APIName : " + keyName + "\tValue : " + value.toString());
}
}
}
}
}
}
}
}