com.virgilsecurity.sdk.client

Class PublicKeyClient

java.lang.Object

com.virgilsecurity.sdk.client.AbstractClient

com.virgilsecurity.sdk.client.PublicKeyClient

public class PublicKeyClient
extends AbstractClient

Public Key service client.

Author:

Andrii Iakovenko

Field Summary

Fields

Modifier and Type	Field and Description
static String	PUBLIC_KEY_BASE_URL

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

accessToken, builder, httpClient

Constructor Summary

Constructors

Constructor and Description
PublicKeyClient(String accessToken) Create a new instance of PublicKeyClient.
PublicKeyClient(String baseUrl, String accessToken) Create a new instance of PublicKeyClient.

Method Summary

Modifier and Type	Method and Description
VirgilCard	createCard(VirgilCardTemplate template, PrivateKey privateKey) Create new Virgil Card.
VirgilCard	createCard(VirgilCardTemplate template, PrivateKey privateKey, Password password) Create new Virgil Card.
void	createCard(VirgilCardTemplate template, PrivateKey privateKey, Password password, ResponseCallback<VirgilCard> callback) Create new Virgil Card asynchronously.
void	createCard(VirgilCardTemplate template, PrivateKey privateKey, ResponseCallback<VirgilCard> callback) Create new Virgil Card asynchronously.
<S> S	createService(Class<S> serviceClass) Create new instance of Retrofit service.
<S> S	createService(Class<S> serviceClass, PrivateKey privateKey) Create new instance of Retrofit service.
<S> S	createService(Class<S> serviceClass, PrivateKey privateKey, Password password) Create new instance of Retrofit service.
void	deleteCard(ValidatedIdentity identity, String signerCardId, PrivateKey privateKey) Revoke a Virgil Card endpoint.
void	deleteCard(ValidatedIdentity identity, String cardId, PrivateKey privateKey, Password password) Revoke a Virgil Card endpoint.
void	deleteCard(ValidatedIdentity identity, String cardId, PrivateKey privateKey, Password password, VoidResponseCallback callback) Revoke a Virgil Card endpoint.
void	deleteCard(ValidatedIdentity identity, String cardId, PrivateKey privateKey, VoidResponseCallback callback) Revoke a Virgil Card endpoint.
void	deleteKey(String publicKeyId, List<ValidatedIdentity> identities, VoidResponseCallback callback) Revoke a Public Key endpoint.
VirgilCard	getCard(String cardId) Returns the information about the Virgil Card by the ID.
void	getCard(String cardId, ResponseCallback<VirgilCard> callback) Returns the information about the Virgil Card by the ID.
PublicKeyInfo	getKey(String publicKeyId) Returns the information about the Public Key by the ID.
void	getKey(String publicKeyId, ResponseCallback<PublicKeyInfo> callback) Returns the information about the Public Key by the ID.
List<VirgilCard>	search(SearchCriteria searchCriteria) Performs the search by search criteria.
void	search(SearchCriteria searchCriteria, ResponseCallback<List<VirgilCard>> callback) Performs the asynchronous search by search criteria.

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

handleResponse

Methods inherited from class java.lang.Object

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

Field Detail

PUBLIC_KEY_BASE_URL

public static final String PUBLIC_KEY_BASE_URL

See Also:

Constant Field Values

Constructor Detail

PublicKeyClient

public PublicKeyClient(String accessToken)

Create a new instance of PublicKeyClient.

Parameters:

accessToken - the access token.

PublicKeyClient

public PublicKeyClient(String baseUrl,
                       String accessToken)

Create a new instance of PublicKeyClient.

Parameters:

baseUrl - the base URL of Virgil Keys endpoint.

accessToken - the access token.

Method Detail

createService

public <S> S createService(Class<S> serviceClass)

Create new instance of Retrofit service.

Overrides:

createService in class AbstractClient

Parameters:

serviceClass - Retrofit service class

Returns:

created instance of service

createService

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

Create new instance of Retrofit service.

Parameters:

serviceClass - Retrofit service class

privateKey - the PrivateKey used for request signing

Returns:

created instance of service

See Also:

PrivateKey

createService

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

Create new instance of Retrofit service.

Parameters:

serviceClass - Retrofit service class

privateKey - the PrivateKey used for request signing

password - the Password used for PrivateKey protection

Returns:

created instance of service

See Also:

PrivateKey, Password

createCard

public void createCard(VirgilCardTemplate template,
                       PrivateKey privateKey,
                       ResponseCallback<VirgilCard> callback)

Create new Virgil Card asynchronously.

Parameters:

template - the template of created Virgil Card

privateKey - the PrivateKey used for request signing

callback -

createCard

public void createCard(VirgilCardTemplate template,
                       PrivateKey privateKey,
                       Password password,
                       ResponseCallback<VirgilCard> callback)

Create new Virgil Card asynchronously.

Parameters:

template - the template of created Virgil Card

privateKey - the PrivateKey used for request signing

password - the Password used for PrivateKey protection

callback -

createCard

public VirgilCard createCard(VirgilCardTemplate template,
                             PrivateKey privateKey)

Create new Virgil Card.

Parameters:

template - the template of created Virgil Card

privateKey - the PrivateKey used for request signing

Returns:

createCard

public VirgilCard createCard(VirgilCardTemplate template,
                             PrivateKey privateKey,
                             Password password)

Create new Virgil Card.

Parameters:

template - the template of created Virgil Card

privateKey - the PrivateKey used for request signing

password - the Password used for PrivateKey protection

password -

Returns:

deleteKey

public void deleteKey(String publicKeyId,
                      List<ValidatedIdentity> identities,
                      VoidResponseCallback callback)
               throws IOException

Revoke a Public Key endpoint. To revoke the Public Key it's mandatory to pass validation tokens obtained on Virgil Identity service for all confirmed Virgil Cards for this Public Key.

Parameters:

publicKeyId - the Public Key's ID.

identities -

callback -

Throws:

IOException

getCard

public VirgilCard getCard(String cardId)

Returns the information about the Virgil Card by the ID.

Parameters:

cardId - the Virgil Card's ID.

getCard

public void getCard(String cardId,
                    ResponseCallback<VirgilCard> callback)

Returns the information about the Virgil Card by the ID.

Parameters:

cardId - the Virgil Card's ID.

callback -

getKey

public PublicKeyInfo getKey(String publicKeyId)

Returns the information about the Public Key by the ID.

Parameters:

publicKeyId - the Public Key's ID.

getKey

public void getKey(String publicKeyId,
                   ResponseCallback<PublicKeyInfo> callback)

Returns the information about the Public Key by the ID.

Parameters:

publicKeyId - the Public Key's ID.

callback -

search

public List<VirgilCard> search(SearchCriteria searchCriteria)

Performs the search by search criteria.

Parameters:

searchCriteria - the criteria to search

Returns:

search

public void search(SearchCriteria searchCriteria,
                   ResponseCallback<List<VirgilCard>> callback)

Performs the asynchronous search by search criteria.

Parameters:

searchCriteria - the criteria to search

callback -

deleteCard

public void deleteCard(ValidatedIdentity identity,
                       String signerCardId,
                       PrivateKey privateKey)

Revoke a Virgil Card endpoint.

Parameters:

identity -

signerCardId -

privateKey - the PrivateKey used for request signing

deleteCard

public void deleteCard(ValidatedIdentity identity,
                       String cardId,
                       PrivateKey privateKey,
                       Password password)

Revoke a Virgil Card endpoint.

Parameters:

identity -

cardId -

privateKey - the PrivateKey used for request signing

password - the Password used for PrivateKey protection

deleteCard

public void deleteCard(ValidatedIdentity identity,
                       String cardId,
                       PrivateKey privateKey,
                       VoidResponseCallback callback)

Revoke a Virgil Card endpoint.

Parameters:

identity -

cardId -

privateKey - the PrivateKey used for request signing

callback -

deleteCard

public void deleteCard(ValidatedIdentity identity,
                       String cardId,
                       PrivateKey privateKey,
                       Password password,
                       VoidResponseCallback callback)

Revoke a Virgil Card endpoint.

Parameters:

identity -

cardId -

privateKey - the PrivateKey used for request signing

password - the Password used for PrivateKey protection

callback -