com.pkware.smartcrypt.keymanagement

Interface Smartkeys

public interface Smartkeys

Method Summary

Modifier and Type	Method and Description
Observable<Smartkey>	create(SmartkeySpec spec)
Observable<Smartkey>	deserialize(String serialized)
Observable<Set<Smartkey>>	listAll()
void	requestAccess(String serialized)
String	serialize(Smartkey smartkey)
Observable<Smartkey>	update(Smartkey smartkey, SmartkeySpec spec) It is not possible to change whether or not a key is rotatable or its kind.

Method Detail

listAll

@Nonnull
Observable<Set<Smartkey>> listAll()

deserialize

@Nonnull
Observable<Smartkey> deserialize(String serialized)
                                   throws MetaClientException,
                                          IllegalArgumentException

Throws:

IllegalArgumentException - If the serialized content cannot be parsed

MetaClientException - For various reasons, including network errors. It may be worth retrying.

serialize

@Nonnull
String serialize(Smartkey smartkey)
                   throws MetaClientException

Returns:

The serialized Smartkey. This is safe to store in plaintext and with the data.

Throws:

MetaClientException - If the provided key cannot be serialized. This may happen if given an invalid key.

requestAccess

void requestAccess(String serialized)
            throws MetaClientException

Throws:

MetaClientException - With MetaClientException.category of MetaClientException.CATEGORY_UPGRADE if the serialized content cannot be parsed. May also happen as a results of network problems and other reasons.

create

@Nonnull
Observable<Smartkey> create(SmartkeySpec spec)
                              throws MetaClientException

Throws:

MetaClientException - If the Smartkey cannot be created

update

@Nonnull
Observable<Smartkey> update(Smartkey smartkey,
                                     SmartkeySpec spec)
                              throws MetaClientException

It is not possible to change whether or not a key is rotatable or its kind.

Throws:

MetaClientException