Package i5.las2peer.persistency

Class LocalStorage

java.lang.Object

i5.las2peer.persistency.LocalStorage

All Implemented Interfaces:

L2pStorageInterface

public class LocalStorage
extends Object
implements L2pStorageInterface

Constructor Summary

Constructors

Constructor	Description
LocalStorage()

Method Summary

Modifier and Type	Method	Description
EnvelopeVersion	createEnvelope(EnvelopeVersion previousVersion, Serializable content)	Creates an continuous version instance for the given Envelope.
EnvelopeVersion	createEnvelope(EnvelopeVersion previousVersion, Serializable content, AgentImpl... readers)	Creates an continuous version instance for the given Envelope.
EnvelopeVersion	createEnvelope(EnvelopeVersion previousVersion, Serializable content, Collection<?> readers)	Creates an continous version instance for the given Envelope.
EnvelopeVersion	createEnvelope(String identifier, PublicKey authorPubKey, Serializable content, AgentImpl... readers)	Creates a new version of an Envelope.
EnvelopeVersion	createEnvelope(String identifier, PublicKey authorPubKey, Serializable content, Collection<?> readers)	Creates a new version of an Envelope.
EnvelopeVersion	createUnencryptedEnvelope(EnvelopeVersion previousVersion, Serializable content)	Creates an continous unencrypted version instance for the given Envelope.
EnvelopeVersion	createUnencryptedEnvelope(String identifier, PublicKey authorPubKey, Serializable content)	Creates a new version of an unencrypted Envelope.
EnvelopeVersion	fetchEnvelope(String identifier, long timeoutMs)	Fetches the latest version for the given identifier from the network.
void	fetchEnvelopeAsync(String identifier, StorageEnvelopeHandler envelopeHandler, StorageExceptionHandler exceptionHandler)	Fetches the latest version for the given identifier from the network.
void	removeEnvelope(String identifier)	Removes the envelope with the given identifier from the network.
void	storeEnvelope(EnvelopeVersion envelope, AgentImpl author, long timeoutMs)	Stores the given Envelope in the network.
void	storeEnvelopeAsync(EnvelopeVersion envelope, AgentImpl author, StorageStoreResultHandler resultHandler, StorageCollisionHandler collisionHandler, StorageExceptionHandler exceptionHandler)	Stores the given Envelope in the network.

Methods inherited from class java.lang.Object

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

Constructor Details

LocalStorage

public LocalStorage()

Method Details

createEnvelope

public EnvelopeVersion createEnvelope(String identifier,
 PublicKey authorPubKey,
 Serializable content,
 AgentImpl... readers)
                               throws IllegalArgumentException,
SerializationException,
CryptoException

Description copied from interface: L2pStorageInterface

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

Specified by:

createEnvelope in interface L2pStorageInterface

Parameters:

identifier - An unique identifier for the Envelope.

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

content - The actual content that should be stored.

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

Returns:

Returns the Envelope instance.

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.

createEnvelope

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

Description copied from interface: L2pStorageInterface

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

Specified by:

createEnvelope in interface L2pStorageInterface

Parameters:

identifier - An unique identifier for the Envelope.

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

content - The actual content that should be stored.

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

Returns:

Returns the Envelope instance.

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.

createEnvelope

public EnvelopeVersion createEnvelope(EnvelopeVersion previousVersion,
 Serializable content)
                               throws IllegalArgumentException,
SerializationException,
CryptoException

Description copied from interface: L2pStorageInterface

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

Specified by:

createEnvelope in interface L2pStorageInterface

Parameters:

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

content - The updated content that should be stored.

Returns:

Returns the Envelope instance.

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.

createEnvelope

public EnvelopeVersion createEnvelope(EnvelopeVersion previousVersion,
 Serializable content,
 AgentImpl... readers)
                               throws IllegalArgumentException,
SerializationException,
CryptoException

Description copied from interface: L2pStorageInterface

Creates an continuous version instance for the given Envelope.

Specified by:

createEnvelope in interface L2pStorageInterface

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.

Returns:

Returns the Envelope instance.

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.

createEnvelope

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

Description copied from interface: L2pStorageInterface

Creates an continous version instance for the given Envelope.

Specified by:

createEnvelope in interface L2pStorageInterface

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.

Returns:

Returns the Envelope instance.

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.

createUnencryptedEnvelope

public EnvelopeVersion createUnencryptedEnvelope(String identifier,
 PublicKey authorPubKey,
 Serializable content)
                                          throws IllegalArgumentException,
SerializationException,
CryptoException

Description copied from interface: L2pStorageInterface

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

Specified by:

createUnencryptedEnvelope in interface L2pStorageInterface

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.

Returns:

Returns the Envelope instance.

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.

createUnencryptedEnvelope

public EnvelopeVersion createUnencryptedEnvelope(EnvelopeVersion previousVersion,
 Serializable content)
                                          throws IllegalArgumentException,
SerializationException,
CryptoException

Description copied from interface: L2pStorageInterface

Creates an continous unencrypted version instance for the given Envelope.

Specified by:

createUnencryptedEnvelope in interface L2pStorageInterface

Parameters:

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

content - The updated content that should be stored.

Returns:

Returns the Envelope instance.

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.

storeEnvelope

public void storeEnvelope(EnvelopeVersion envelope,
 AgentImpl author,
 long timeoutMs)
                   throws EnvelopeException

Description copied from interface: L2pStorageInterface

Stores the given Envelope in the network. The content is signed with the key from the given author. If an exception occurs it's wrapped as StorageException. With this method collisions are handled by throwing an EnvelopeAlreadyExistsException.

Specified by:

storeEnvelope in interface L2pStorageInterface

Parameters:

envelope - The Envelope to store in the network.

author - The author that is used to sign the content.

timeoutMs - A timeout after that an EnvelopeException is thrown.

Throws:

EnvelopeAlreadyExistsException - If an Envelope with the given identifier and version is already known in the network.

EnvelopeException - If an issue with the storage occurs.

storeEnvelopeAsync

public void storeEnvelopeAsync(EnvelopeVersion envelope,
 AgentImpl author,
 StorageStoreResultHandler resultHandler,
 StorageCollisionHandler collisionHandler,
 StorageExceptionHandler exceptionHandler)

Description copied from interface: L2pStorageInterface

Stores the given Envelope in the network. The content is signed with the key from the given author. If an exception occurs the operation is canceled and the exception handler is called. Same for collisions. If the operations is completed the result handler is called.

Specified by:

storeEnvelopeAsync in interface L2pStorageInterface

Parameters:

envelope - The Envelope to store in the network.

author - The author that is used to sign the content.

resultHandler - A result handler that is called, if the operation terminates.

collisionHandler - A collision handler that is called, if an Envelope with the given identifier and version already exists.

exceptionHandler - An exception handler that is called, if an exception occurs.

fetchEnvelope

public EnvelopeVersion fetchEnvelope(String identifier,
 long timeoutMs)
                              throws EnvelopeException

Description copied from interface: L2pStorageInterface

Fetches the latest version for the given identifier from the network.

Specified by:

fetchEnvelope in interface L2pStorageInterface

Parameters:

identifier - An unique identifier for the Envelope.

timeoutMs - A timeout after that an EnvelopeException is thrown.

Returns:

Returns the fetched Envelope from the network.

Throws:

EnvelopeNotFoundException - If no envelope or any part of it was not found in the network.

EnvelopeException - If an issue with the storage occurs.

fetchEnvelopeAsync

public void fetchEnvelopeAsync(String identifier,
 StorageEnvelopeHandler envelopeHandler,
 StorageExceptionHandler exceptionHandler)

Description copied from interface: L2pStorageInterface

Fetches the latest version for the given identifier from the network.

Specified by:

fetchEnvelopeAsync in interface L2pStorageInterface

Parameters:

identifier - An unique identifier for the Envelope.

envelopeHandler - A result handler that is called, if the operation terminates.

exceptionHandler - An exception handler that is called, if an exception occurs.

removeEnvelope

public void removeEnvelope(String identifier)
                    throws EnvelopeException

Description copied from interface: L2pStorageInterface

Removes the envelope with the given identifier from the network.

Specified by:

removeEnvelope in interface L2pStorageInterface

Parameters:

identifier - An unique identifier for the Envelope.

Throws:

EnvelopeNotFoundException - If no envelope or any part of it was not found in the network.

EnvelopeException - If an issue with the storage occurs.