com.virgilsecurity.sdk.client

Class PrivateKeyClient

java.lang.Object

com.virgilsecurity.sdk.client.AbstractClient

com.virgilsecurity.sdk.client.PrivateKeyClient

public class PrivateKeyClient
extends AbstractClient

Private Key service client.

Author:

Andrii Iakovenko

Field Summary

Fields

Modifier and Type	Field and Description
static String	PRIVATE_KEY_BASE_URL

Fields inherited from class com.virgilsecurity.sdk.client.AbstractClient

accessToken, builder, httpClient

Constructor Summary

Constructors

Constructor and Description
PrivateKeyClient(String baseUrl, String accessToken, VirgilCard serviceCard) Create a new instance of PrivateKeyClient
PrivateKeyClient(String accessToken, VirgilCard serviceCard) Create a new instance of PrivateKeyClient

Method Summary

Modifier and Type	Method and Description
<S> S	createService(Class<S> serviceClass, PrivateKey privateKey, Password privateKeyPassword, Password responsePassword) Create new instance of Retrofit service.
void	destroy(String virgilCardId, PrivateKey privateKey) Deletes the private key from service by specified card ID.
void	destroy(String virgilCardId, PrivateKey privateKey, Password password) Deletes the private key from service by specified card ID.
void	destroy(String virgilCardId, PrivateKey privateKey, Password password, VoidResponseCallback callback) Deletes the private key from service by specified card ID.
void	destroy(String virgilCardId, PrivateKey privateKey, VoidResponseCallback callback) Deletes the private key from service by specified card ID.
PrivateKeyInfo	get(String virgilCardId, ValidatedIdentity identity) Downloads private part of key by its public id.
void	get(String virgilCardId, ValidatedIdentity identity, ResponseCallback<PrivateKeyInfo> callback) Downloads private part of key by its public id.
Object	handleResponse(retrofit2.Response<?> response) Handle response from Virgil service.
void	stash(String virgilCardId, PrivateKey privateKey) Uploads private key to private key store.
void	stash(String virgilCardId, PrivateKey privateKey, Password password) Uploads private key to private key store.
void	stash(String virgilCardId, PrivateKey privateKey, Password password, VoidResponseCallback callback) Uploads private key to private key store.
void	stash(String virgilCardId, PrivateKey privateKey, VoidResponseCallback callback) Uploads private key to private key store.

Methods inherited from class com.virgilsecurity.sdk.client.AbstractClient

createService

Methods inherited from class java.lang.Object

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

Field Detail

PRIVATE_KEY_BASE_URL

public static final String PRIVATE_KEY_BASE_URL

See Also:

Constant Field Values

Constructor Detail

PrivateKeyClient

public PrivateKeyClient(String accessToken,
                        VirgilCard serviceCard)

Create a new instance of PrivateKeyClient

Parameters:

accessToken - the access token.

serviceCard - the the service's Virgil Card

PrivateKeyClient

public PrivateKeyClient(String baseUrl,
                        String accessToken,
                        VirgilCard serviceCard)

Create a new instance of PrivateKeyClient

Parameters:

baseUrl - the base URL of Virgil Keys endpoint.

accessToken - the access token.

serviceCard - the the service's Virgil Card

Method Detail

createService

public <S> S createService(Class<S> serviceClass,
                           PrivateKey privateKey,
                           Password privateKeyPassword,
                           Password responsePassword)

Create new instance of Retrofit service.

Parameters:

serviceClass - Retrofit service class

privateKey - the PrivateKey used for request signing

privateKeyPassword - the Password used for PrivateKey protection

responsePassword - the Password to encrypt server response. Up to 31 characters.

Returns:

created instance of service

See Also:

PrivateKey, Password

handleResponse

public Object handleResponse(retrofit2.Response<?> response)
                      throws IOException

Description copied from class: AbstractClient

Handle response from Virgil service.

Overrides:

handleResponse in class AbstractClient

Returns:

Throws:

IOException

stash

public void stash(String virgilCardId,
                  PrivateKey privateKey)

Uploads private key to private key store.

Parameters:

virgilCardId - The public key identifier.

privateKey - The private key value. Private key is used to produce sign. It is not transfered over network.

stash

public void stash(String virgilCardId,
                  PrivateKey privateKey,
                  Password password)

Uploads private key to private key store.

Parameters:

virgilCardId - The public key identifier.

privateKey - The private key value. Private key is used to produce sign. It is not transfered over network.

password - The private key password.

stash

public void stash(String virgilCardId,
                  PrivateKey privateKey,
                  VoidResponseCallback callback)

Uploads private key to private key store.

Parameters:

virgilCardId - The public key identifier.

privateKey - The private key value. Private key is used to produce sign. It is not transfered over network.

callback -

stash

public void stash(String virgilCardId,
                  PrivateKey privateKey,
                  Password password,
                  VoidResponseCallback callback)

Uploads private key to private key store.

Parameters:

virgilCardId - the public key identifier.

privateKey - the private key value. Private key is used to produce sign. It is not transfered over network.

password - the private key password.

callback -

get

public PrivateKeyInfo get(String virgilCardId,
                          ValidatedIdentity identity)

Downloads private part of key by its public id.

Parameters:

virgilCardId - the public key identifier.

identity - the validated identity token with.

Returns:

get

public void get(String virgilCardId,
                ValidatedIdentity identity,
                ResponseCallback<PrivateKeyInfo> callback)

Downloads private part of key by its public id.

Parameters:

virgilCardId - the public key identifier.

identity - the validated identity token with.

destroy

public void destroy(String virgilCardId,
                    PrivateKey privateKey)

Deletes the private key from service by specified card ID.

Parameters:

virgilCardId - The public key identifier.

privateKey - The private key value. Private key is used to produce sign. It is not transfered over network.

destroy

public void destroy(String virgilCardId,
                    PrivateKey privateKey,
                    Password password)

Deletes the private key from service by specified card ID.

Parameters:

virgilCardId - The public key identifier.

privateKey - The private key value. Private key is used to produce sign. It is not transfered over network.

password - The private key password.

destroy

public void destroy(String virgilCardId,
                    PrivateKey privateKey,
                    VoidResponseCallback callback)

Deletes the private key from service by specified card ID.

Parameters:

virgilCardId - the public key identifier.

privateKey - the private key value. Private key is used to produce sign. It is not transfered over network.

callback -

destroy

public void destroy(String virgilCardId,
                    PrivateKey privateKey,
                    Password password,
                    VoidResponseCallback callback)

Deletes the private key from service by specified card ID.

Parameters:

virgilCardId - the public key identifier.

privateKey - the private key value. Private key is used to produce sign. It is not transfered over network.

password - the private key password.

callback -