SymmetricKeyEncryption (xdi2-core 0.7.2 API)

java.lang.Object
- xdi2.core.features.encryption.Encryption<SecretKey,SecretKey>
- - xdi2.core.features.encryption.SymmetricKeyEncryption

All Implemented Interfaces:

Serializable, Comparable<Encryption<SecretKey,SecretKey>>
```
public final class SymmetricKeyEncryption
extends Encryption<SecretKey,SecretKey>
```
An XDI encryption, represented as an XDI attribute.

Author:

markus

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static String KEY_ALGORITHM_AES

Fields
Modifier and Type	Field and Description
`static String`	`KEY_ALGORITHM_AES`

Constructor Summary

Constructors
Modifier Constructor and Description

protected SymmetricKeyEncryption(XdiAttribute xdiAttribute)

Constructors
Modifier	Constructor and Description
`protected`	`SymmetricKeyEncryption(XdiAttribute xdiAttribute)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`decrypt(SecretKey secretKey)` Decrypt the encryption value.
`void`	`encrypt(SecretKey secretKey)` Create the encryption value.
`static SymmetricKeyEncryption`	`fromXdiAttribute(XdiAttribute xdiAttribute)` Factory method that creates an XDI encryption bound to a given XDI attribute.
`String`	`getTransformation()`
`static boolean`	`isValid(XdiAttribute xdiAttribute)` Checks if an XDI attribute is a valid XDI encryption.

Methods inherited from class xdi2.core.features.encryption.Encryption
clearAfterDecrypt, clearAfterEncrypt, compareTo, equals, getBaseContextNode, getContextNode, getKeyAlgorithm, getKeyLength, getValue, getXdiAttribute, hashCode, setValue, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - KEY_ALGORITHM_AES
```
public static final String KEY_ALGORITHM_AES
```
    See Also:
    Constant Field Values
- Constructor Detail
  - SymmetricKeyEncryption
```
protected SymmetricKeyEncryption(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 SymmetricKeyEncryption fromXdiAttribute(XdiAttribute xdiAttribute)
```
    Factory method that creates an XDI encryption bound to a given XDI attribute.
    
    Parameters:
    xdiAttribute - The XDI attribute that is an XDI encryption.
    
    Returns:
    The XDI encryption.
  - getTransformation
```
public String getTransformation()
```
    Specified by:
    
    getTransformation in class Encryption<SecretKey,SecretKey>
  - encrypt
```
public void encrypt(SecretKey secretKey)
             throws GeneralSecurityException
```
    Description copied from class: Encryption
    
    Create the encryption value.
    
    Specified by:
    
    encrypt in class Encryption<SecretKey,SecretKey>
    
    Throws:
    
    GeneralSecurityException
  - decrypt
```
public void decrypt(SecretKey secretKey)
             throws GeneralSecurityException
```
    Description copied from class: Encryption
    
    Decrypt the encryption value.
    
    Specified by:
    
    decrypt in class Encryption<SecretKey,SecretKey>
    
    Throws:
    
    GeneralSecurityException

Class SymmetricKeyEncryption

Field Summary

Constructor Summary

Method Summary

Methods inherited from class xdi2.core.features.encryption.Encryption

Methods inherited from class java.lang.Object

Field Detail

KEY_ALGORITHM_AES

Constructor Detail

SymmetricKeyEncryption

Method Detail

isValid

fromXdiAttribute

getTransformation

encrypt

decrypt