com.pkware.smartcrypt.keymanagement.smartkeys

Class ErrorSmartkey

java.lang.Object

com.pkware.smartcrypt.keymanagement.smartkeys.ErrorSmartkey

All Implemented Interfaces:

Smartkey

public final class ErrorSmartkey
extends Object
implements Smartkey

Indicates that an error occurred while loading a Smartkey. Used in an observable stream to avoid breaking the stream. Developers should already be coding to handle scenarios such as no decryption key, not being allowed to encrypt, etc.

See Also:

to further investigate the error

Field Summary

Fields

Modifier and Type	Field and Description
MetaClientException	cause

Constructor Summary

Constructors

Constructor and Description
ErrorSmartkey(MetaClientException cause)

Method Summary

Modifier and Type	Method and Description
boolean	canDecrypt()
boolean	canEncrypt()
boolean	canManage()
List<Feature>	getFeatures()
SecretKey	getKey()
SecretKey	getKeyForDecryption(int revision)
String	getName() Useful for displaying in UIs.
List<KnownUser>	getParticipants()
int	getRevision()
String	getUrn() The URN for a Smartkey will never change.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

cause

@Nonnull
public final MetaClientException cause

Constructor Detail

ErrorSmartkey

public ErrorSmartkey(MetaClientException cause)

Method Detail

getName

@Nonnull
public String getName()

Description copied from interface: Smartkey

Useful for displaying in UIs. May change over time, so not good for programmatic filtering. An empty value indicates that human users should not be aware of this Smartkey.

Specified by:

getName in interface Smartkey

Returns:

may be empty

getUrn

@Nonnull
public String getUrn()

Description copied from interface: Smartkey

The URN for a Smartkey will never change.

Specified by:

getUrn in interface Smartkey

Returns:

A globally unique identifier for this Smartkey

getKey

@Nonnull
public SecretKey getKey()
                          throws MetaClientException

Specified by:

getKey in interface Smartkey

Returns:

the AES key matching the current Smartkey.getRevision()

Throws:

MetaClientException - if not allowed to encrypt using this key

See Also:

Smartkey.canEncrypt()

getRevision

public int getRevision()

Specified by:

getRevision in interface Smartkey

Returns:

revision of the highest AES key this Smartkey manages

getFeatures

@Nonnull
public List<Feature> getFeatures()

Specified by:

getFeatures in interface Smartkey

Returns:

Unmodifiable; perform a copy if you need to change the list. May be empty.

getParticipants

@Nonnull
public List<KnownUser> getParticipants()

Specified by:

getParticipants in interface Smartkey

Returns:

Unmodifiable; perform a copy if you need to change the list. May be empty.

canManage

public boolean canManage()

Specified by:

canManage in interface Smartkey

Returns:

true if this user is allowed to modify this smartkey. If false, attempts at modification will result in errors.

canEncrypt

public boolean canEncrypt()

Specified by:

canEncrypt in interface Smartkey

Returns:

true if this user is allowed to encrypt using this smartkey. If false, attempts to retrieve the encryption key will throw an exception.

canDecrypt

public boolean canDecrypt()

Specified by:

canDecrypt in interface Smartkey

Returns:

true if this user is allowed to decrypt using this smartkey. If false, attempts to retrieve the decryption key with throw an exception.

getKeyForDecryption

public SecretKey getKeyForDecryption(int revision)
                              throws MetaClientException

Specified by:

getKeyForDecryption in interface Smartkey

Returns:

null if no key is available for the given revision

Throws:

MetaClientException - if this key is not allowed to be used for decryption

See Also:

Smartkey.canDecrypt()

toString

public String toString()

Overrides:

toString in class Object