xdi2.core.features.encryption

Class Encryption<EKEY extends Key,DKEY extends Key>

java.lang.Object

xdi2.core.features.encryption.Encryption<EKEY,DKEY>

All Implemented Interfaces:

Serializable, Comparable<Encryption<EKEY,DKEY>>

Direct Known Subclasses:

AESEncryption, RSAEncryption

public abstract class Encryption<EKEY extends Key,DKEY extends Key>
extends Object
implements Serializable, Comparable<Encryption<EKEY,DKEY>>

An XDI encryption, represented as an XDI attribute.

Author:

markus

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Encryption(XdiAttribute xdiAttribute)

Method Summary

Modifier and Type	Method and Description
void	clearAfterDecrypt()
void	clearAfterEncrypt()
int	compareTo(Encryption<EKEY,DKEY> other)
abstract void	decrypt(DKEY key) Decrypt the encryption value.
abstract void	encrypt(EKEY key) Create the encryption value.
boolean	equals(Object object)
static Encryption<? extends Key,? extends Key>	fromXdiAttribute(XdiAttribute xdiAttribute) Factory method that creates an XDI encryption bound to a given XDI attribute.
ContextNode	getBaseContextNode()
ContextNode	getContextNode() Returns the underlying context node to which this XDI encryption is bound.
String	getKeyAlgorithm()
Integer	getKeyLength()
abstract String	getTransformation()
String	getValue() Get the value
XdiAttribute	getXdiAttribute() Returns the underlying XDI attribute to which this XDI encryption is bound.
int	hashCode()
static boolean	isValid(XdiAttribute xdiAttribute) Checks if an XDI attribute is a valid XDI encryption.
void	setValue(String value) Set the value
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Encryption

protected Encryption(XdiAttribute xdiAttribute)

Method Detail

isValid

public static boolean isValid(XdiAttribute xdiAttribute)

Checks if an XDI attribute is a valid XDI encryption.

Parameters:

xdiAttribute - The XDI attribute to check.

Returns:

True if the XDI attribute is a valid XDI encryption.

fromXdiAttribute

public static Encryption<? extends Key,? extends Key> fromXdiAttribute(XdiAttribute xdiAttribute)

Factory method that creates an XDI encryption bound to a given XDI attribute.

Parameters:

xdiAttribute - The XDI encryption that is an XDI encryption.

Returns:

The XDI encryption.

clearAfterEncrypt

public void clearAfterEncrypt()

clearAfterDecrypt

public void clearAfterDecrypt()

getXdiAttribute

public XdiAttribute getXdiAttribute()

Returns the underlying XDI attribute to which this XDI encryption is bound.

Returns:

An XDI attribute that represents the XDI encryption.

getContextNode

public ContextNode getContextNode()

Returns the underlying context node to which this XDI encryption is bound.

Returns:

A context node that represents the XDI encryption.

getBaseContextNode

public ContextNode getBaseContextNode()

getKeyAlgorithm

public String getKeyAlgorithm()

getKeyLength

public Integer getKeyLength()

getTransformation

public abstract String getTransformation()

getValue

public String getValue()

Get the value

setValue

public void setValue(String value)

Set the value

encrypt

public abstract void encrypt(EKEY key)
                      throws GeneralSecurityException

Create the encryption value.

Throws:

GeneralSecurityException

decrypt

public abstract void decrypt(DKEY key)
                      throws GeneralSecurityException

Decrypt the encryption value.

Throws:

GeneralSecurityException

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(Encryption<EKEY,DKEY> other)

Specified by:

compareTo in interface Comparable<Encryption<EKEY extends Key,DKEY extends Key>>