Signature (xdi2-core 0.7.2 API)

java.lang.Object
- xdi2.core.features.signatures.Signature<SKEY,VKEY>

All Implemented Interfaces:

Serializable, Comparable<Signature<SKEY,VKEY>>

Direct Known Subclasses:

KeyPairSignature, SymmetricKeySignature
```
public abstract class Signature<SKEY extends Key,VKEY extends Key>
extends Object
implements Serializable, Comparable<Signature<SKEY,VKEY>>
```
An XDI signature, represented as an XDI attribute.

Author:

markus

See Also:
Serialized Form

Constructor Summary

Constructors
Modifier Constructor and Description

protected Signature(XdiAttribute xdiAttribute)

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

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`compareTo(Signature<SKEY,VKEY> other)`
`boolean`	`equals(Object object)`
`static Signature<? extends Key,? extends Key>`	`fromXdiAttribute(XdiAttribute xdiAttribute)` Factory method that creates an XDI signature bound to a given XDI attribute.
`abstract String`	`getAlgorithm()`
`ContextNode`	`getBaseContextNode()`
`ContextNode`	`getContextNode()` Returns the underlying context node to which this XDI signature is bound.
`String`	`getDigestAlgorithm()`
`Integer`	`getDigestLength()`
`String`	`getKeyAlgorithm()`
`Integer`	`getKeyLength()`
`String`	`getValue()` Get the value
`XdiAttribute`	`getXdiAttribute()` Returns the underlying XDI attribute to which this XDI signature is bound.
`int`	`hashCode()`
`static boolean`	`isValid(XdiAttribute xdiAttribute)` Checks if an XDI attribute is a valid XDI signature.
`void`	`setValue(String value)` Set the value
`abstract void`	`sign(SKEY key)` Create the signature value.
`String`	`toString()`
`abstract boolean`	`validate(VKEY key)` Validate the signature value.

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

- Constructor Detail
  - Signature
```
protected Signature(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 Signature<? extends Key,? extends Key> fromXdiAttribute(XdiAttribute xdiAttribute)
```
    Factory method that creates an XDI signature bound to a given XDI attribute.
    
    Parameters:
    xdiAttribute - The XDI signature that is an XDI signature.
    
    Returns:
    The XDI signature.
  - getXdiAttribute
```
public XdiAttribute getXdiAttribute()
```
    Returns the underlying XDI attribute to which this XDI signature is bound.
    
    Returns:
    An XDI attribute that represents the XDI signature.
  - getContextNode
```
public ContextNode getContextNode()
```
    Returns the underlying context node to which this XDI signature is bound.
    
    Returns:
    A context node that represents the XDI signature.
  - getBaseContextNode
```
public ContextNode getBaseContextNode()
```
  - getDigestAlgorithm
```
public String getDigestAlgorithm()
```
  - getDigestLength
```
public Integer getDigestLength()
```
  - getKeyAlgorithm
```
public String getKeyAlgorithm()
```
  - getKeyLength
```
public Integer getKeyLength()
```
  - getAlgorithm
```
public abstract String getAlgorithm()
```
  - getValue
```
public String getValue()
```
    Get the value
  - setValue
```
public void setValue(String value)
```
    Set the value
  - sign
```
public abstract void sign(SKEY key)
                   throws GeneralSecurityException
```
    Create the signature value.
    
    Throws:
    
    GeneralSecurityException
  - validate
```
public abstract boolean validate(VKEY key)
                          throws GeneralSecurityException
```
    Validate the signature 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(Signature<SKEY,VKEY> other)
```
    Specified by:
    
    compareTo in interface Comparable<Signature<SKEY extends Key,VKEY extends Key>>

Class Signature<SKEY extends Key,VKEY extends Key>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Signature

Method Detail

isValid

fromXdiAttribute

getXdiAttribute

getContextNode

getBaseContextNode

getDigestAlgorithm

getDigestLength

getKeyAlgorithm

getKeyLength

getAlgorithm

getValue

setValue

sign

validate

toString

equals

hashCode

compareTo