Package i5.las2peer.persistency

Class SharedStorage

java.lang.Object

i5.las2peer.api.Configurable

i5.las2peer.persistency.SharedStorage

All Implemented Interfaces:

L2pStorageInterface

public class SharedStorage
extends Configurable
implements L2pStorageInterface

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SharedStorage.STORAGE_MODE	Storage mode for the pastry node – either use only memory or the file system for stored artifacts.

Field Summary

Fields

Modifier and Type	Field	Description
static final long	DEFAULT_ASYNC_INSERT_OPERATION_TIMEOUT
static final int	DEFAULT_MAXIMUM_CACHE_SIZE
static final long	DEFAULT_MAXIMUM_STORAGE_SIZE
static final int	DEFAULT_NUM_OF_REPLICAS
static final String	DEFAULT_STORAGE_ROOT_DIR

Constructor Summary

Constructors

Constructor	Description
SharedStorage(rice.p2p.commonapi.Node node, SharedStorage.STORAGE_MODE storageMode, ExecutorService threadpool, String storageDir)

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 expectedAuthorPubKey, Serializable content, AgentImpl... readers)	Creates a new version of an Envelope.
EnvelopeVersion	createEnvelope(String identifier, PublicKey expectedAuthorPubKey, 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 expectedAuthorPubKey, 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.
EnvelopeVersion	fetchEnvelope(String identifier, long version, long timeoutMs)
void	fetchEnvelopeAsync(String identifier, long version, StorageEnvelopeHandler envelopeHandler, StorageExceptionHandler exceptionHandler)
void	fetchEnvelopeAsync(String identifier, StorageEnvelopeHandler envelopeHandler, StorageExceptionHandler exceptionHandler)	Fetches the latest version for the given identifier from the network.
byte[]	fetchHashedContent(byte[] hash, long timeoutMs)
void	fetchHashedContentAsync(byte[] hash, StorageArtifactHandler artifactHandler, StorageExceptionHandler exceptionHandler)
long	getLocalMaxSize()
long	getLocalSize()
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.
void	storeHashedContent(byte[] content, long timeoutMs)
void	storeHashedContentAsync(byte[] content, StorageStoreResultHandler resultHandler, StorageExceptionHandler exceptionHandler)

Methods inherited from class i5.las2peer.api.Configurable

getProperties, setFieldValues

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_NUM_OF_REPLICAS

public static final int DEFAULT_NUM_OF_REPLICAS

See Also:

• Constant Field Values

DEFAULT_MAXIMUM_CACHE_SIZE

public static final int DEFAULT_MAXIMUM_CACHE_SIZE

See Also:

• Constant Field Values

DEFAULT_STORAGE_ROOT_DIR

public static final String DEFAULT_STORAGE_ROOT_DIR

DEFAULT_MAXIMUM_STORAGE_SIZE

public static final long DEFAULT_MAXIMUM_STORAGE_SIZE

See Also:

• Constant Field Values

DEFAULT_ASYNC_INSERT_OPERATION_TIMEOUT

public static final long DEFAULT_ASYNC_INSERT_OPERATION_TIMEOUT

See Also:

• Constant Field Values

Constructor Details

SharedStorage

public SharedStorage(rice.p2p.commonapi.Node node,
 SharedStorage.STORAGE_MODE storageMode,
 ExecutorService threadpool,
 String storageDir)
              throws EnvelopeException

Throws:

EnvelopeException

Method Details

getLocalSize

public long getLocalSize()

getLocalMaxSize

public long getLocalMaxSize()

createEnvelope

public EnvelopeVersion createEnvelope(String identifier,
 PublicKey expectedAuthorPubKey,
 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.

expectedAuthorPubKey - 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 expectedAuthorPubKey,
 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.

expectedAuthorPubKey - 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 expectedAuthorPubKey,
 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.

expectedAuthorPubKey - 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 EnvelopeNotFoundException,
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.

fetchEnvelope

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

Throws:

EnvelopeNotFoundException

EnvelopeException

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.

fetchEnvelopeAsync

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

removeEnvelope

public void removeEnvelope(String identifier)
                    throws EnvelopeNotFoundException,
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.

storeHashedContentAsync

public void storeHashedContentAsync(byte[] content,
 StorageStoreResultHandler resultHandler,
 StorageExceptionHandler exceptionHandler)

storeHashedContent

public void storeHashedContent(byte[] content,
 long timeoutMs)
                        throws EnvelopeException

Throws:

EnvelopeException

fetchHashedContentAsync

public void fetchHashedContentAsync(byte[] hash,
 StorageArtifactHandler artifactHandler,
 StorageExceptionHandler exceptionHandler)

fetchHashedContent

public byte[] fetchHashedContent(byte[] hash,
 long timeoutMs)
                          throws EnvelopeException

Throws:

EnvelopeException