com.zoiper.zdk

Class Activation

java.lang.Object

com.zoiper.zdk.Activation

public class Activation
extends java.lang.Object

Handles the Activation process of the ZDK

Constructor Summary

Constructors

Constructor and Description
Activation(long handle) Constructor storing the pointer/address to the underlying native object

Method Summary

Modifier and Type	Method and Description
boolean	activated() Gets the activation status
boolean	checkCodecPermission(AudioVideoCodecs value) Gets whether a given media (audio/video) codec is enabled and can be used
boolean	checkHostname(java.lang.String value) Gets whether a given hostname (domain) is allowed to be used
boolean	checkPermission(PermissionType value) Gets whether a given ZDK functionality is enabled and can be used
Result	createOfflineActivationFile(java.lang.String activationFile, java.lang.String username, java.lang.String password, java.lang.String hddSerial, java.lang.String version, java.lang.String pcUser, java.lang.String pcName) Creates a file required for offline activation For Zoiper internal use only! For SDK builds see createOfflineActivationFileSDK! Creates a file required for offline activation 1.
Result	createOfflineActivationFileSDK(java.lang.String activationFile, java.lang.String username, java.lang.String password) Creates a file required for offline activation For SDK products only! For Zoiper internal use see createOfflineActivationFile! Creates a file required for offline activation 1.
protected void	finalize() Ensures the underlying native object destruction
long	handle() Gets the pointer/address to the underlying native object
Result	start(java.lang.String certCacheFile, java.lang.String moduleName, int opFlags, java.lang.String username, java.lang.String password, java.lang.String version, java.lang.String certPem) Starts activation process For Zoiper internal use only! For SDK builds see startSDK! Starts activation process of the product.
Result	startSDK(java.lang.String certCacheFile, java.lang.String username, java.lang.String password) starts activation for an SDK product For SDK products only! For Zoiper internal use see start! starts activation process of the SDK product.
Result	stop() Stops the activation process Cancels any activation in progress.

Methods inherited from class java.lang.Object

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

Constructor Detail

Activation

public Activation(long handle)

Constructor storing the pointer/address to the underlying native object

Parameters:

handle - Pointer/address to the underlying native object

Method Detail

handle

public long handle()

Gets the pointer/address to the underlying native object

Returns:

Pointer/address to the underlying native object

finalize

protected void finalize()

Ensures the underlying native object destruction

Overrides:

finalize in class java.lang.Object

activated

public boolean activated()

Gets the activation status

Returns:

• 0 - not activated
• 1 - activated

start

public Result start(java.lang.String certCacheFile,
                    java.lang.String moduleName,
                    int opFlags,
                    java.lang.String username,
                    java.lang.String password,
                    java.lang.String version,
                    java.lang.String certPem)

Starts activation process For Zoiper internal use only! For SDK builds see startSDK! Starts activation process of the product. Without activation, much of the functionality is not allowed. Activation first tries to use data from a certificate cache file, the path to which is supplied by the user. If the file is available and valid for the current device, it's contents will be used to set the allowed functionalities. If file is invalid OR not present, the SDK will make an HTTP request to a licensing server. On valid response the results from the server will be used to configure functionality availability and, if the location supplied by the user in certCacheFile is valid and writable, the results will be stored there so that the cache file can be used on next invocation. The activation process is doing a GET request constructed from the arguments of the function. The base URL of the GET request can be changed if the baseUrl parameter is not NULL. All of the parameter values will be properly URL escaped by the library and MUST NOT be already URL escaped when being passed to this function. The password parameter will be scrambled using MD5 and the result will be converted to a hex string before passing it to the web server. It MUST NOT be pre-processed in any way before passing it to this function.

Parameters:

certCacheFile - If non-zero, it is a UTF-8 file name which is used to cache the certificate received from the server. If such file does not exist, the usual HTTP (online) activation is initiated, if possible. After a successful online activation, the resulting certificate will be stored in the file.

moduleName - Provides support for DLL products using this ZDK as a static library. This is not for the case where ZDK is used as a DLL. In that case the @p moduleName is ignored. In the case where ZDK is a static library used to link a DLL project, and that DLL project is used by an external application, the checksum must be calculated from the DLL, not the main application. In this case @p moduleName is needed to hint the Activation object when it tries to discover the file from which we're loaded.

opFlags - A bit field flag controlling the activation options - ActivationFlags enum

username - Client's username ("username" URL parameter)

password - Client's password ("password" URL parameter)

version - The phone build version as configured on the cert site. This is the "version" URL parameter

certPem - The certificate issued by the cert server for this specific phone build. Must match the certificate on the server.

Returns:

Result of the invocation

See Also:

stop onContextActivationCompleted Result ActivationFlags

startSDK

public Result startSDK(java.lang.String certCacheFile,
                       java.lang.String username,
                       java.lang.String password)

starts activation for an SDK product For SDK products only! For Zoiper internal use see start! starts activation process of the SDK product. Without activation, much of the functionality is not allowed. Activation first tries to use data from a certificate cache file, the path to which is supplied by the user. If the file is available and valid for the current device, it's contents will be used to set the allowed functionalities. If file is invalid OR not present, the SDK will make an HTTP request to a licensing server. On valid response the results from the server will be used to configure functionality availability and, if the location supplied by the user in certCacheFile is valid and writable, the results will be stored there so that the cache file can be used on next invocation. The activation process is doing a GET request constructed from the arguments of the function. The base URL of the GET request can be changed if the baseUrl parameter is not NULL. All of the parameter values will be properly URL escaped by the library and MUST NOT be already URL escaped when being passed to this function. The password parameter will be scrambled using MD5 and the result will be converted to a hex string before passing it to the web server. It MUST NOT be pre-processed in any way before passing it to this function.

Parameters:

certCacheFile - If non-zero, it is a UTF-8 file name which is used to cache the certificate received from the server. If such file does not exist, the usual HTTP (online) activation is initiated, if possible. After a successful online activation, the resulting certificate will be stored in the file.

username - Username to use for authentication to the cert server

password - Password to use for authentication to the cert server

Returns:

Result of the invocation

See Also:

stop onContextActivationCompleted Result

stop

public Result stop()

Stops the activation process Cancels any activation in progress.

Returns:

Result of the invocation

See Also:

Result

checkPermission

public boolean checkPermission(PermissionType value)

Gets whether a given ZDK functionality is enabled and can be used

Parameters:

value - Functionality to be checked

Returns:

• 0 - not available
• 1 - available

See Also:

PermissionType

checkCodecPermission

public boolean checkCodecPermission(AudioVideoCodecs value)

Gets whether a given media (audio/video) codec is enabled and can be used

Parameters:

value - Codec to be checked

Returns:

• 0 - not available
• 1 - available

See Also:

AudioVideoCodecs

checkHostname

public boolean checkHostname(java.lang.String value)

Gets whether a given hostname (domain) is allowed to be used

Parameters:

value - Hostname (domain) to be checked

Returns:

• 0 - not allowed
• 1 - allowed

createOfflineActivationFile

public Result createOfflineActivationFile(java.lang.String activationFile,
                                          java.lang.String username,
                                          java.lang.String password,
                                          java.lang.String hddSerial,
                                          java.lang.String version,
                                          java.lang.String pcUser,
                                          java.lang.String pcName)

Creates a file required for offline activation For Zoiper internal use only! For SDK builds see createOfflineActivationFileSDK! Creates a file required for offline activation 1. Create a file with the createOfflineActivationFile. 2. Send the file to "register5@shop.zoiper.com" attached in email. 3. An email will be send to you with the new certificate file needed for offline activation. 4. Use the received file (from the received email from the CERT server) as "certCacheFile" input parameter of start.

Parameters:

activationFile - File name (including full path to it!)

username - The username for the account to be activated

password - The password for the activation of the account

hddSerial - The HDD serial number

version - The build version as configured on the cert site. This is the "version" URL parameter

pcUser - The user name

pcName - The device name

Returns:

Result of the creating of the file

See Also:

start

createOfflineActivationFileSDK

public Result createOfflineActivationFileSDK(java.lang.String activationFile,
                                             java.lang.String username,
                                             java.lang.String password)

Creates a file required for offline activation For SDK products only! For Zoiper internal use see createOfflineActivationFile! Creates a file required for offline activation 1. Create a file with the createOfflineActivationFileSDK. 2. Send the file to "register5@shop.zoiper.com" attached in email. 3. An email will be send to you with the new certificate file needed for offline activation. 4. Use the received file (from the received email from the CERT server) as "certCacheFile" input parameter of startSDK.

Parameters:

activationFile - File name (including full path to it!)

username - the Username for the account to be activated

password - the Password for the activation of the account

Returns:

Result of the creating of the file

See Also:

startSDK