nl.renarj.jasdb.service.metadata

Class JasDBMetadataStore

java.lang.Object

nl.renarj.jasdb.service.metadata.JasDBMetadataStore

All Implemented Interfaces:

MetadataStore

@Component
 @Singleton
public class JasDBMetadataStore
extends Object
implements MetadataStore

Author:

Renze de Vries

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_INSTANCE

Constructor Summary

Constructors

Constructor and Description
JasDBMetadataStore()

Method Summary

Modifier and Type	Method and Description
void	addBag(Bag bag) Adds a new bag to the storage
void	addBagIndex(String instanceId, String bagName, IndexDefinition indexDefinition) Adds an index to an existing bag in a certain instance
void	addInstance(Instance instance) Adds an instance using the specified instance metadata
long	addMetadataEntity(SimpleEntity entity) Generic operation to add a metadata entity to the metadata store
void	closeStore() Close the store
boolean	containsBag(String instanceId, String bag) Checks if a bag in an instance exists in the metadata store
boolean	containsIndex(String instanceId, String bagName, IndexDefinition indexDefinition) Checks if the index is already present in the metadata store
boolean	containsInstance(String instanceId) Checks if the instance alredy exists
void	deleteMetadataEntity(long recordPointer) Deletes a generic metadata entity
Bag	getBag(String instanceId, String name) Gets the a specific bag in an instance
List<Bag>	getBags(String instanceId) Gets the bags for the given instanceId
Instance	getInstance(String instanceId) Gets a specific instance identified by the instanceId
List<Instance>	getInstances() Gets the registered instances
<T extends MetadataProvider> T	getMetadataProvider(String type) Gets a metadata provider that can handle non standard metadata stored in the metadata store
boolean	isLastShutdownClean() Checks whether the last shutdown was done cleanly
void	removeBag(String instanceId, String name) Remove a bag from the metadata store
void	removeBagIndex(String instanceId, String bagName, IndexDefinition indexDefinition)
void	removeInstance(String instanceId) Removes an instance from the metadata list
void	updateInstance(Instance instance) Updates the instance metadata
long	updateMetadataEntity(SimpleEntity entity, long previousRecord) Generic operation to update a metadata entity in the metadata store

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_INSTANCE

public static final String DEFAULT_INSTANCE

See Also:

Constant Field Values

Constructor Detail

JasDBMetadataStore

public JasDBMetadataStore()
                   throws JasDBStorageException

Throws:

JasDBStorageException

Method Detail

isLastShutdownClean

public boolean isLastShutdownClean()
                            throws JasDBStorageException

Description copied from interface: MetadataStore

Checks whether the last shutdown was done cleanly

Specified by:

isLastShutdownClean in interface MetadataStore

Returns:

True if the last shutdown was clean, False if not

Throws:

JasDBStorageException - If unable to determine if last shutdown is clean

closeStore

@PreDestroy
public void closeStore()
                            throws JasDBStorageException

Description copied from interface: MetadataStore

Close the store

Specified by:

closeStore in interface MetadataStore

Throws:

JasDBStorageException - If unable to close the store cleanly

addMetadataEntity

public long addMetadataEntity(SimpleEntity entity)
                       throws JasDBStorageException

Description copied from interface: MetadataStore

Generic operation to add a metadata entity to the metadata store

Specified by:

addMetadataEntity in interface MetadataStore

Parameters:

entity - The metadata entity to add

Returns:

The data pointer for the metadata record

Throws:

JasDBStorageException - If unable to add the metadata entity

updateMetadataEntity

public long updateMetadataEntity(SimpleEntity entity,
                                 long previousRecord)
                          throws JasDBStorageException

Description copied from interface: MetadataStore

Generic operation to update a metadata entity in the metadata store

Specified by:

updateMetadataEntity in interface MetadataStore

Parameters:

entity - The updated entity

previousRecord - The previous record pointer

Returns:

The new record pointer

Throws:

JasDBStorageException - If unable to update the entity

deleteMetadataEntity

public void deleteMetadataEntity(long recordPointer)
                          throws JasDBStorageException

Description copied from interface: MetadataStore

Deletes a generic metadata entity

Specified by:

deleteMetadataEntity in interface MetadataStore

Parameters:

recordPointer - The record pointer

Throws:

JasDBStorageException - If unable to delete the entity

getBags

public List<Bag> getBags(String instanceId)
                  throws JasDBStorageException

Description copied from interface: MetadataStore

Gets the bags for the given instanceId

Specified by:

getBags in interface MetadataStore

Parameters:

instanceId - The instanceId

Returns:

The list of bags for that instance

Throws:

JasDBStorageException - If unable to load the bags

getBag

public Bag getBag(String instanceId,
                  String name)
           throws JasDBStorageException

Description copied from interface: MetadataStore

Gets the a specific bag in an instance

Specified by:

getBag in interface MetadataStore

Parameters:

instanceId - The instanceId

name - The name of the bag

Returns:

The bag if present, null if not

Throws:

JasDBStorageException - If unable to load the bag

containsBag

public boolean containsBag(String instanceId,
                           String bag)
                    throws JasDBStorageException

Description copied from interface: MetadataStore

Checks if a bag in an instance exists in the metadata store

Specified by:

containsBag in interface MetadataStore

Parameters:

instanceId - The instance in which the bag should exist

bag - The bag that should exist

Returns:

True if the bag exists in the instance, False if not

Throws:

JasDBStorageException - If unable to check if the bag exists in the instance

addBag

public void addBag(Bag bag)
            throws JasDBStorageException

Description copied from interface: MetadataStore

Adds a new bag to the storage

Specified by:

addBag in interface MetadataStore

Parameters:

bag - The bag to add

Throws:

JasDBStorageException - If unable to add the bag

removeBag

public void removeBag(String instanceId,
                      String name)
               throws JasDBStorageException

Description copied from interface: MetadataStore

Remove a bag from the metadata store

Specified by:

removeBag in interface MetadataStore

Parameters:

instanceId - The name of the instance holding the bag

name - The name of the bag

Throws:

JasDBStorageException - If unable to remove the bag

addBagIndex

public void addBagIndex(String instanceId,
                        String bagName,
                        IndexDefinition indexDefinition)
                 throws JasDBStorageException

Description copied from interface: MetadataStore

Adds an index to an existing bag in a certain instance

Specified by:

addBagIndex in interface MetadataStore

Parameters:

instanceId - The instance that contains the bag

bagName - The bag to add the index to

indexDefinition - The index definition

Throws:

JasDBStorageException - If unable to add the index

removeBagIndex

public void removeBagIndex(String instanceId,
                           String bagName,
                           IndexDefinition indexDefinition)
                    throws JasDBStorageException

Specified by:

removeBagIndex in interface MetadataStore

Parameters:

instanceId - The instance that contains the bag

bagName - The bag to remove the index from

indexDefinition - The index definition

Throws:

JasDBStorageException - If unable to remove the index

containsIndex

public boolean containsIndex(String instanceId,
                             String bagName,
                             IndexDefinition indexDefinition)
                      throws JasDBStorageException

Description copied from interface: MetadataStore

Checks if the index is already present in the metadata store

Specified by:

containsIndex in interface MetadataStore

Parameters:

instanceId - The instance that contains the bag

bagName - The bag to check the index presence on

indexDefinition - The index definition

Returns:

True if the index is already present, False if not

Throws:

JasDBStorageException - If unable to check if the index is present

getInstances

public List<Instance> getInstances()
                            throws JasDBStorageException

Description copied from interface: MetadataStore

Gets the registered instances

Specified by:

getInstances in interface MetadataStore

Returns:

The list of known instances

Throws:

JasDBStorageException - If unable to get the list of instances

getInstance

public Instance getInstance(String instanceId)
                     throws JasDBStorageException

Description copied from interface: MetadataStore

Gets a specific instance identified by the instanceId

Specified by:

getInstance in interface MetadataStore

Parameters:

instanceId - The instanceId

Returns:

The instance if found, null if not

Throws:

JasDBStorageException - If unable to get the instance

containsInstance

public boolean containsInstance(String instanceId)
                         throws JasDBStorageException

Description copied from interface: MetadataStore

Checks if the instance alredy exists

Specified by:

containsInstance in interface MetadataStore

Parameters:

instanceId - The instanceId

Returns:

True if the instance exists, False if not

Throws:

JasDBStorageException - If unable to check if the instance exists

addInstance

public void addInstance(Instance instance)
                 throws JasDBStorageException

Description copied from interface: MetadataStore

Adds an instance using the specified instance metadata

Specified by:

addInstance in interface MetadataStore

Parameters:

instance - The instance

Throws:

JasDBStorageException - If unable to add the instance

removeInstance

public void removeInstance(String instanceId)
                    throws JasDBStorageException

Description copied from interface: MetadataStore

Removes an instance from the metadata list

Specified by:

removeInstance in interface MetadataStore

Parameters:

instanceId - The instance to remove

Throws:

JasDBStorageException - If unable to remove the instance

updateInstance

public void updateInstance(Instance instance)
                    throws JasDBStorageException

Description copied from interface: MetadataStore

Updates the instance metadata

Specified by:

updateInstance in interface MetadataStore

Parameters:

instance - The instance

Throws:

JasDBStorageException - If unable to update the instance

getMetadataProvider

public <T extends MetadataProvider> T getMetadataProvider(String type)

Description copied from interface: MetadataStore

Gets a metadata provider that can handle non standard metadata stored in the metadata store

Specified by:

getMetadataProvider in interface MetadataStore

Type Parameters:

T - The subtype of the metadata provider

Parameters:

type - The type of metadata provider requested

Returns:

The metadataprovider if it exists