com.ingenico.sdk.apimanagement

Class ApiManagement

java.lang.Object

com.ingenico.sdk.ServiceConnector

com.ingenico.sdk.apimanagement.ApiManagement

All Implemented Interfaces:

IApiManagement, IIngenicoApi

public final class ApiManagement
extends ServiceConnector
implements IApiManagement

Access to the Ingenico APIs access control service.

Nested Class Summary

Nested classes/interfaces inherited from class com.ingenico.sdk.ServiceConnector

ServiceConnector.InternalServiceConnection

Field Summary

Fields inherited from class com.ingenico.sdk.ServiceConnector

ACTION_BIND_V2, SERVICES_PACKAGE

Method Summary

Modifier and Type	Method and Description
static IApiManagement	getInstance(android.content.Context context) Return a global instance of ApiManagement, which is the default implementation of IApiManagement, and instantiate it if needed.
protected java.lang.String	getServiceName() Must be overrided to provide service class name used for binding.
ApiManagementToken	getUsageToken() Deprecated.
protected void	onServiceReady(android.os.IBinder service) Internal callback when service is connected.
protected void	onServiceUnbinded() Internal callback when service is disconnected.
long	subscribe(java.lang.String apiKey) Request a new token and register it for API usage.
long	subscribe(java.lang.String apiKey, boolean forceRenewal) Request a new token and register it for API usage.
long	subscribe(java.lang.String apiKey, java.lang.String isvRecord) Request a new token and register it for API usage.
long	subscribe(java.lang.String apiKey, java.lang.String isvRecord, boolean forceRenewal) Request a new token and register it for API usage.

Methods inherited from class com.ingenico.sdk.ServiceConnector

connect, connectSync, disconnect, ensureServiceIsReady, getBindIntent, getContext, isConnected

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ingenico.sdk.IIngenicoApi

connect, disconnect, isConnected

Method Detail

getInstance

public static IApiManagement getInstance(android.content.Context context)

Return a global instance of ApiManagement, which is the default implementation of IApiManagement, and instantiate it if needed.

Be aware that only one instance will be created for the whole application, so the associated context should not be a component which could be destroyed at some point, ie. an Activity. Passing the Application to this method is preferred over other context types.

Parameters:

context - A valid context to initialize the instance.

Returns:

subscribe

public long subscribe(java.lang.String apiKey)
               throws IngenicoException

Request a new token and register it for API usage.

This method make network requests and can be blocking, it must NOT be called from the main thread.

Specified by:

subscribe in interface IApiManagement

Parameters:

apiKey - the secret authenticating the registered right to use the API set

Returns:

a timestamp for the expiration of the token

Throws:

IngenicoException - errors subscribing to the API management, see message for details

subscribe

public long subscribe(java.lang.String apiKey,
                      java.lang.String isvRecord)
               throws IngenicoException

Request a new token and register it for API usage.

This method make network requests and can be blocking, it must NOT be called from the main thread.

Specified by:

subscribe in interface IApiManagement

Parameters:

apiKey - the secret authenticating the registered right to use the API set

isvRecord - an ISV defined record (json) containing detailed information on its application installation and configuration (this information can be used later to associate the token request to ISV own billing system).

Returns:

a timestamp for the expiration of the token

Throws:

IngenicoException - errors subscribing to the API management, see message for details

subscribe

public long subscribe(java.lang.String apiKey,
                      boolean forceRenewal)
               throws IngenicoException

Description copied from interface: IApiManagement

Request a new token and register it for API usage.

This method make network requests and can be blocking, it must NOT be called from the main thread.

If forceRenewal is true, a new usage token with an updated expiration date will be requested on the token server. If false, the previous token is reused if not expired, or a new token will be requested.

Specified by:

subscribe in interface IApiManagement

Parameters:

apiKey - the secret authenticating the registered right to use the API set

forceRenewal - set true to ensure the renewal of the existing token

Returns:

a timestamp for the expiration of the token

Throws:

IngenicoException - errors subscribing to the API management, see message for details

subscribe

public long subscribe(java.lang.String apiKey,
                      java.lang.String isvRecord,
                      boolean forceRenewal)
               throws IngenicoException

Description copied from interface: IApiManagement

Request a new token and register it for API usage.

This method make network requests and can be blocking, it must NOT be called from the main thread.

If forceRenewal is true, a new usage token with an updated expiration date will be requested on the token server. If false, the previous token is reused if not expired, or a new token will be requested.

Specified by:

subscribe in interface IApiManagement

Parameters:

apiKey - the secret authenticating the registered right to use the API set

isvRecord - an ISV defined record (json) containing detailed information on its application installation and configuration (this information can be used later to associate the token request to ISV own billing system)

forceRenewal - set true to ensure the renewal of the existing token

Returns:

a timestamp for the expiration of the token

Throws:

IngenicoException - errors subscribing to the API management, see message for details

getUsageToken

@Deprecated
public ApiManagementToken getUsageToken()
                                             throws IngenicoException

Deprecated.

Request the current usage token for the current application.

Specified by:

getUsageToken in interface IApiManagement

Returns:

Throws:

IngenicoException

getServiceName

protected java.lang.String getServiceName()

Description copied from class: ServiceConnector

Must be overrided to provide service class name used for binding.

Specified by:

getServiceName in class ServiceConnector

Returns:

onServiceReady

protected void onServiceReady(android.os.IBinder service)

Description copied from class: ServiceConnector

Internal callback when service is connected. This is where we should retrieve the aidl interface.

Specified by:

onServiceReady in class ServiceConnector

onServiceUnbinded

protected void onServiceUnbinded()

Description copied from class: ServiceConnector

Internal callback when service is disconnected.

Specified by:

onServiceUnbinded in class ServiceConnector