Persistentie
Persistente klassen in een applicatie implementeren de entiteiten van het bedrijfsprobleem. In Java SDK worden twee standaard persistentieklassen met hun implementaties geleverd. Als een ontwikkelaar daarentegen zijn specifieke implementatie wil, kan hij zijn aangepaste implementatie definiëren door verbinding te maken met het bijbehorende databasesysteem.
OAuth-persistentie implementeren
Zodra de applicatie is geautoriseerd, kunnen OAuth-toegangs- en vernieuwingstokens worden gebruikt voor volgende gebruikersgegevensverzoeken aan Zoho CRM. Daarom moeten ze worden bewaard door de clientapp.
De persistentie wordt bereikt door het schrijven van een implementatie van de ingebouwde ZohoPersistenceHandler-interface, die de volgende terugbelmethoden heeft.
- saveOAuthData (ZohoOAuthTokens-tokens) – wordt aangeroepen tijdens het ophalen van toegangs- en vernieuwingstokens van Zoho.
- deleteOAuthTokens() – wordt aangeroepen voordat de zojuist ontvangen tokens worden opgeslagen.
- getOAuthTokens() – wordt aangeroepen voordat een verzoek wordt verzonden om de opgeslagen tokens op te halen. Bij deze methode moet het object ZohoOAuthTokens worden geretourneerd zodat de bibliotheek het kan verwerken.
Onze Java SDK biedt twee voorbeeldimplementaties van de interface ZohoPersistenceHandler in de clientbibliotheek, zoals hieronder weergegeven:
U kunt een van de bovengenoemde interface-implementaties in de bibliotheek gebruiken.
ZohoOAuthFilePersistence
ZohoOAuthFilePersistence gebruikt een bestand met lokale eigenschappen om de OAuth-tokens te schrijven en te lezen. Als u deze persistentie gebruikt, moet u de volgende attributen en hun waarden opgeven in het bestand oauth_configuration.properties.
persistence_handler_class=com.zoho.oauth.clientapp.ZohoOAuthFilePersistence
oauth_tokens_file_path= relatieve pad van het bestand 'oauthtokens.properties' in de werkruimte.
ZohoOAuthDBPersistence
ZohoOAuthDBPersistence maakt gebruik van een aangepaste MySQL-persistentie. Om dit te kunnen gebruiken, moet u voor het volgende zorgen:
- MySQL moet worden uitgevoerd op dezelfde machine die op de standaardpoort 3306 wordt gebruikt.
- De naam van de database moet 'zohooauth' zijn.
- Er moet een tabel 'oauthtokens' zijn met de kolommen 'useridentifier' (varchar), 'accesstoken' (varchar), 'refreshtoken' (varchar) en 'expirytime'(bigint).
Als u ZohoOAuthDBPersistence gebruikt, moet u de volgende kenmerken en waarden opgeven in het bestandoauth_configuration.properties
persistence_handler_class=com.zoho.oauth.clientapp.ZohoOAuthDBPersistence
mysql_username=root
mysql_password=
Let op:
- De implementatie van ZohoOAuthFilePersistence ondersteunt alleen het opslaan en vernieuwen van een token van één gebruiker. Daarom wordt dit alleen gebruikt als uw app toegang heeft tot Zoho API's namens één gebruiker.
- Als uw app meerdere gebruikers moet ondersteunen, gebruik dan ZohoOAuthDBPersistence of schrijf uw eigen implementatie van ZohoPersistenceHandler.