SymmetricKeySignature (xdi2-core 0.7.2 API)

java.lang.Object
- xdi2.core.features.signatures.Signature<SecretKey,SecretKey>
- - xdi2.core.features.signatures.SymmetricKeySignature

All Implemented Interfaces:

Serializable, Comparable<Signature<SecretKey,SecretKey>>
```
public final class SymmetricKeySignature
extends Signature<SecretKey,SecretKey>
```
An XDI signature, represented as an XDI attribute.

Author:

markus

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static String DIGEST_ALGORITHM_SHA

static String KEY_ALGORITHM_AES

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

Constructor Summary

Constructors
Modifier Constructor and Description

protected SymmetricKeySignature(XdiAttribute xdiAttribute)

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

Method Summary

Methods
Modifier and Type	Method and Description
`static SymmetricKeySignature`	`fromXdiAttribute(XdiAttribute xdiAttribute)` Factory method that creates an XDI signature bound to a given XDI attribute.
`String`	`getAlgorithm()`
`static boolean`	`isValid(XdiAttribute xdiAttribute)` Checks if an XDI attribute is a valid XDI signature.
`void`	`sign(SecretKey secretKey)` Create the signature value.
`boolean`	`validate(SecretKey secretKey)` Validate the signature value.

Methods inherited from class xdi2.core.features.signatures.Signature
compareTo, equals, getBaseContextNode, getContextNode, getDigestAlgorithm, getDigestLength, 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
  - DIGEST_ALGORITHM_SHA
```
public static final String DIGEST_ALGORITHM_SHA
```
    See Also:
    Constant Field Values
- Constructor Detail
  - SymmetricKeySignature
```
protected SymmetricKeySignature(XdiAttribute xdiAttribute)
```
- Method Detail
  - isValid
```
public static boolean isValid(XdiAttribute xdiAttribute)
```
    Checks if an XDI attribute is a valid XDI signature.
    
    Parameters:
    xdiAttribute - The XDI attribute to check.
    
    Returns:
    True if the XDI attribute is a valid XDI signature.
  - fromXdiAttribute
```
public static SymmetricKeySignature fromXdiAttribute(XdiAttribute xdiAttribute)
```
    Factory method that creates an XDI signature bound to a given XDI attribute.
    
    Parameters:
    xdiAttribute - The XDI attribute that is an XDI signature.
    
    Returns:
    The XDI signature.
  - getAlgorithm
```
public String getAlgorithm()
```
    Specified by:
    
    getAlgorithm in class Signature<SecretKey,SecretKey>
  - sign
```
public void sign(SecretKey secretKey)
          throws GeneralSecurityException
```
    Description copied from class: Signature
    
    Create the signature value.
    
    Specified by:
    
    sign in class Signature<SecretKey,SecretKey>
    
    Throws:
    
    GeneralSecurityException
  - validate
```
public boolean validate(SecretKey secretKey)
                 throws GeneralSecurityException
```
    Description copied from class: Signature
    
    Validate the signature value.
    
    Specified by:
    
    validate in class Signature<SecretKey,SecretKey>
    
    Throws:
    
    GeneralSecurityException

Class SymmetricKeySignature

Field Summary

Constructor Summary

Method Summary

Methods inherited from class xdi2.core.features.signatures.Signature

Methods inherited from class java.lang.Object

Field Detail

KEY_ALGORITHM_AES

DIGEST_ALGORITHM_SHA

Constructor Detail

SymmetricKeySignature

Method Detail

isValid

fromXdiAttribute

getAlgorithm

sign

validate