org.cassproject.ebac.identity

Class EcContact

java.lang.Object

org.cassproject.ebac.identity.EcContact

public class EcContact
extends Object

A contact is an identity that we do not own. Using the public key we may: 1. Send them information (by encrypting data with their public key) 2. Verify a signed message that was sent (by using the verify function of the public key) 3. Distinguish between this identity and other identities through the displayName.

Author:

fritz.ray@eduworks.com

Field Summary

Fields

Modifier and Type	Field and Description
String	displayName Display Name of the contact
EcPk	pk Public Key of the contact
String	source URL to the home server of the contact

Constructor Summary

Constructors

Constructor and Description
EcContact()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Comparison method that checks if the key is the same as another EcContact
static EcContact	fromEncryptedContact(EbacContact contact, String secret, String source) Helper function to decrypt an encrypted contact (storable version of an contact) into an contact
String	getImageUrl() Returns the URL to generic image that should be displayed for the contact
EbacContact	toEncryptedContact(String secret) Helper function to encrypt a contact into an encrypted contact (storable version of a contact)

Methods inherited from class java.lang.Object

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

Field Detail

pk

public EcPk pk

Public Key of the contact

displayName

public String displayName

Display Name of the contact

source

public String source

URL to the home server of the contact

Constructor Detail

EcContact

public EcContact()

Method Detail

fromEncryptedContact

public static EcContact fromEncryptedContact(EbacContact contact,
                                             String secret,
                                             String source)

Helper function to decrypt an encrypted contact (storable version of an contact) into an contact

Parameters:

{EbacContact} - contact Contact to decrypt.

{String} - secret AES secret used to decrypt the credential.

{String} - source Source of the credential, used to track where a contact came from.

Returns:

{EcContact} Decrypted identity object, ready for use.

equals

public boolean equals(Object obj)

Comparison method that checks if the key is the same as another EcContact

Overrides:

equals in class Object

Parameters:

{Object} - obj Contact to compare if same key

Returns:

{boolean} true if the key is the same, false if not

getImageUrl

public String getImageUrl()

Returns the URL to generic image that should be displayed for the contact

Returns:

{String} URL of generic image file

toEncryptedContact

public EbacContact toEncryptedContact(String secret)

Helper function to encrypt a contact into an encrypted contact (storable version of a contact)

Parameters:

{String} - secret AES secret used to encrypt the contact.

Returns:

{EbacContact} Encrypted contact object.