com.virgilsecurity.sdk.highlevel

Class VirgilCard

java.lang.Object

com.virgilsecurity.sdk.highlevel.VirgilCard

public class VirgilCard
extends Object

A Virgil Card is the main entity of the Virgil Security services, it includes an information about the user and his public key. The Virgil Card identifies the user by one of his available types, such as an email, a phone number, etc.

Author:

Andrii Iakovenko

Method Summary

Modifier and Type	Method and Description
static VirgilCard	create(CreateCardRequest request) Creates a new VirgilCard by request.
byte[]	encrypt(byte[] data) Encrypts the specified data for current VirgilCard recipient.
byte[]	encryptText(String text) Encrypts the text.
static VirgilCards	find(List<String> identities, String type) Finds the VirgilCards by specified criteria.
static VirgilCards	find(String identity, String type) Finds the VirgilCards by specified criteria.
static VirgilCards	findGlobal(List<String> identities) Finds the VirgilCards in global scope by specified criteria.
static VirgilCards	findGlobal(List<String> identities, GlobalIdentityType type) Finds the VirgilCards in global scope by specified criteria.
static VirgilCards	findGlobal(String identity) Finds the VirgilCards in global scope by specified criteria.
static VirgilCards	findGlobal(String identity, GlobalIdentityType type) Finds the VirgilCards in global scope by specified criteria.
static VirgilCard	get(String cardId) Gets the VirgilCard by specified identifier.
Map<String,String>	getData() Gets the custom parameters.
String	getId() Gets the unique identifier for the Virgil Card.
String	getIdentity() Gets the value of current Virgil Card identity.
String	getIdentityType() Gets the type of current Virgil Card identity.
byte[]	getPublicKey() Gets the Public Key of current Virgil Card.
static void	revoke(RevokeCardRequest request) Revokes a VirgilCard by revocation request.
boolean	verify(byte[] data, byte[] signature) Verifies the specified data and signature with current VirgilCard recipient.
boolean	verifyText(String text, byte[] signature) Verifies that a digital signature is valid for specified text.

Methods inherited from class java.lang.Object

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

Method Detail

encrypt

public byte[] encrypt(byte[] data)

Encrypts the specified data for current VirgilCard recipient.

Parameters:

data - the data to be encrypted.

Returns:

encrypted data.

verify

public boolean verify(byte[] data,
                      byte[] signature)

Verifies the specified data and signature with current VirgilCard recipient.

Parameters:

data - The data to be verified.

signature - The signature used to verify the data integrity.

Returns:

true if verification successed.

get

public static VirgilCard get(String cardId)

Gets the VirgilCard by specified identifier.

Parameters:

cardId - The identifier that represents a VirgilCard.

Returns:

The Virgil Card.

findGlobal

public static VirgilCards findGlobal(String identity)

Finds the VirgilCards in global scope by specified criteria.

Parameters:

identity - The identity.

Returns:

A list of found VirgilCards.

findGlobal

public static VirgilCards findGlobal(String identity,
                                     GlobalIdentityType type)

Finds the VirgilCards in global scope by specified criteria.

Parameters:

identity - The identity.

type - Type of the identity.

Returns:

A list of found VirgilCards.

findGlobal

public static VirgilCards findGlobal(List<String> identities)

Finds the VirgilCards in global scope by specified criteria.

Parameters:

identities - The identities.

Returns:

A list of found VirgilCards.

findGlobal

public static VirgilCards findGlobal(List<String> identities,
                                     GlobalIdentityType type)

Finds the VirgilCards in global scope by specified criteria.

Parameters:

identities - The identities.

type - Type of the identity.

Returns:

A list of found VirgilCards.

find

public static VirgilCards find(String identity,
                               String type)

Finds the VirgilCards by specified criteria.

Parameters:

identity - The identity.

type - Type of the identity.

Returns:

A list of found VirgilCards.

find

public static VirgilCards find(List<String> identities,
                               String type)

Finds the VirgilCards by specified criteria.

Parameters:

identities - The identities.

type - Type of the identity.

Returns:

A list of found VirgilCards.

create

public static VirgilCard create(CreateCardRequest request)

Creates a new VirgilCard by request.

Parameters:

request - The request.

Returns:

The created card.

revoke

public static void revoke(RevokeCardRequest request)

Revokes a VirgilCard by revocation request.

Parameters:

request - The request.

encryptText

public byte[] encryptText(String text)

Encrypts the text.

Parameters:

text - The text to encrypt.

Returns:

The encrypted data.

Throws:

EmptyArgumentException

verifyText

public boolean verifyText(String text,
                          byte[] signature)

Verifies that a digital signature is valid for specified text.

Parameters:

text - The text to encrypt.

signature - The signature.

Returns:

true if the signature is valid; otherwise, false.

getId

public String getId()

Gets the unique identifier for the Virgil Card.

Returns:

the unique identifier for the Virgil Card.

getIdentity

public String getIdentity()

Gets the value of current Virgil Card identity.

Returns:

the value of current Virgil Card identity.

getIdentityType

public String getIdentityType()

Gets the type of current Virgil Card identity.

Returns:

the type of current Virgil Card identity.

getData

public Map<String,String> getData()

Gets the custom parameters.

Returns:

the custom parameters.

getPublicKey

public byte[] getPublicKey()

Gets the Public Key of current Virgil Card.

Returns:

the Public Key of current Virgil Card.