Package i5.las2peer.persistency

Class EnvelopeVersion

java.lang.Object

i5.las2peer.persistency.EnvelopeVersion

All Implemented Interfaces:

XmlAble, Serializable

public class EnvelopeVersion
extends Object
implements Serializable, XmlAble

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final long	LATEST_VERSION	freshly created local instance, can be considered as null
static final long	MAX_UPDATE_CYCLES	The following constant is used for practical purposes to prohibit some otherwise almost infinite loops.
static final long	NULL_VERSION	freshly created local instance, can be considered as null
static final long	START_VERSION	first version, that reaches the network

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EnvelopeVersion(EnvelopeVersion previousVersion, Serializable content)	Creates an continuous version instance for the given Envelope.
protected	EnvelopeVersion(EnvelopeVersion previousVersion, Serializable content, Collection<?> readers)	Creates an continuous version instance for the given Envelope.
protected	EnvelopeVersion(String identifier, long version, PublicKey authorPubKey, Serializable content, Collection<?> readers, Set<String> readerGroups)	Creates an envelope with the given identifier, version, content and readable by the given reader list.
protected	EnvelopeVersion(String identifier, PublicKey authorPubKey, Serializable content, Collection<?> readers)	Creates a new version of an Envelope.

Method Summary

Modifier and Type	Method	Description
static EnvelopeVersion	createFromXml(String xml)	factory for generating an envelope from the given XML String representation
static EnvelopeVersion	createFromXml(Element rootElement)	factory for generating an envelope from the given XML String representation
static String	getAgentIdentifier(String agentId)
PublicKey	getAuthorPublicKey()	Gets the authors public key of this envelope.
Serializable	getContent()
Serializable	getContent(AgentContext context)
String	getIdentifier()	Gets the identifier for this envelope.
Set<String>	getReaderGroupIds()
HashMap<PublicKey,byte[]>	getReaderKeys()
long	getVersion()	Gets the version of this envelope.
boolean	isEncrypted()
String	toString()
String	toXmlString()	Returns a XML representation of this object.

Methods inherited from class java.lang.Object

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

Field Details

LATEST_VERSION

public static final long LATEST_VERSION

freshly created local instance, can be considered as null

See Also:

• Constant Field Values

NULL_VERSION

public static final long NULL_VERSION

freshly created local instance, can be considered as null

See Also:

• Constant Field Values

START_VERSION

public static final long START_VERSION

first version, that reaches the network

See Also:

• Constant Field Values

MAX_UPDATE_CYCLES

public static final long MAX_UPDATE_CYCLES

The following constant is used for practical purposes to prohibit some otherwise almost infinite loops. It describes the maximum number of write cycles to an envelope (identifier). Its value may be set to any value from 1 (not useful at all!) up to Long.MAX_VALUE (some parts will take almost forever).

See Also:

• Constant Field Values

Constructor Details

EnvelopeVersion

protected EnvelopeVersion(String identifier,
 PublicKey authorPubKey,
 Serializable content,
 Collection<?> readers)
                   throws IllegalArgumentException,
SerializationException,
CryptoException

Creates a new version of an Envelope. The envelope uses by default the start version number.

Parameters:

identifier - An unique identifier for the envelope.

authorPubKey - The authors public key. Validated on store operation.

content - The updated content that should be stored.

readers - An arbitrary number of Agents, who are allowed to read the content.

Throws:

IllegalArgumentException - If the given identifier is null, the version number is below the start version number or too high.

SerializationException - If a problem occurs with object serialization.

CryptoException - If an cryptographic issue occurs.

EnvelopeVersion

protected EnvelopeVersion(EnvelopeVersion previousVersion,
 Serializable content)
                   throws IllegalArgumentException,
SerializationException,
CryptoException

Creates an continuous version instance for the given Envelope. This method copies the reader list from the previous envelope instance.

Parameters:

previousVersion - The previous version of the envelope that should be updated.

content - The updated content that should be stored.

Throws:

IllegalArgumentException - If the given identifier is null, the version number is below the start version number or too high.

SerializationException - If a problem occurs with object serialization.

CryptoException - If an cryptographic issue occurs.

EnvelopeVersion

protected EnvelopeVersion(EnvelopeVersion previousVersion,
 Serializable content,
 Collection<?> readers)
                   throws IllegalArgumentException,
SerializationException,
CryptoException

Creates an continuous version instance for the given Envelope.

Parameters:

previousVersion - The previous version of the envelope that should be updated.

content - The updated content that should be stored.

readers - An arbitrary number of Agents, who are allowed to read the content.

Throws:

IllegalArgumentException - If the given identifier is null, the version number is below the start version number or too high.

SerializationException - If a problem occurs with object serialization.

CryptoException - If an cryptographic issue occurs.

EnvelopeVersion

protected EnvelopeVersion(String identifier,
 long version,
 PublicKey authorPubKey,
 Serializable content,
 Collection<?> readers,
 Set<String> readerGroups)
                   throws IllegalArgumentException,
SerializationException,
CryptoException

Creates an envelope with the given identifier, version, content and readable by the given reader list.

Parameters:

identifier - An unique identifier for the envelope.

version - The version number for this envelope.

authorPubKey - The authors public key for this envelope.

content - The actual content that should be stored.

readers - An arbitrary number of Agents, who are allowed to read the content.

readerGroups - A set of group agent id's with read access.

Throws:

IllegalArgumentException - If the given identifier is null, the version number is below the start version number or too high.

SerializationException - If a problem occurs with object serialization.

CryptoException - If an cryptographic issue occurs.

Method Details

getAgentIdentifier

public static String getAgentIdentifier(String agentId)

getIdentifier

public String getIdentifier()

Gets the identifier for this envelope.

Returns:

Returns the identifier.

getVersion

public long getVersion()

Gets the version of this envelope.

Returns:

Returns the version number.

getAuthorPublicKey

public PublicKey getAuthorPublicKey()

Gets the authors public key of this envelope.

Returns:

Returns the authors public key.

toString

public String toString()

Overrides:

toString in class Object

isEncrypted

public boolean isEncrypted()

getReaderKeys

public HashMap<PublicKey,byte[]> getReaderKeys()

getReaderGroupIds

public Set<String> getReaderGroupIds()

getContent

public Serializable getContent()
                        throws CryptoException,
EnvelopeAccessDeniedException,
SerializationException

Throws:

CryptoException

EnvelopeAccessDeniedException

SerializationException

getContent

public Serializable getContent(AgentContext context)
                        throws CryptoException,
EnvelopeAccessDeniedException,
SerializationException

Throws:

CryptoException

EnvelopeAccessDeniedException

SerializationException

toXmlString

public String toXmlString()
                   throws SerializationException

Description copied from interface: XmlAble

Returns a XML representation of this object.

Specified by:

toXmlString in interface XmlAble

Returns:

a XML (string) representation of this envelope

Throws:

SerializationException - If serialization fails

createFromXml

public static EnvelopeVersion createFromXml(Element rootElement)
                                     throws MalformedXMLException

factory for generating an envelope from the given XML String representation

Parameters:

rootElement - A root element to use

Returns:

envelope created from the given XML String serialization

Throws:

MalformedXMLException - If the XML data is malformed

createFromXml

public static EnvelopeVersion createFromXml(String xml)
                                     throws MalformedXMLException

factory for generating an envelope from the given XML String representation

Parameters:

xml - An XML data string

Returns:

envelope created from the given XML String serialization

Throws:

MalformedXMLException - If the XML data string is malformed