org.datanucleus.store
Interface StoreManager

All Known Implementing Classes:

AbstractStoreManager, FederationManager, MappedStoreManager

public interface StoreManager

Interface defining management of a datastore. To be implemented by all new datastore support. Please use AbstractStoreManager and extend it.

Method Summary

void	addClass(java.lang.String className, ClassLoaderResolver clr) Method to add a class to the managed list for this datastore manager.
void	addClasses(java.lang.String[] classNames, ClassLoaderResolver clr) Add classes to the persistence model for the datastore.
void	close() Release of resources.
ApiAdapter	getApiAdapter() Accessor for the API adapter.
Store	getBackingStoreForField(ClassLoaderResolver clr, AbstractMemberMetaData fmd, java.lang.Class type) Accessor for the backing store for the specified field.
java.lang.String	getClassNameForObjectID(java.lang.Object id, ClassLoaderResolver clr, ExecutionContext ec) Returns the class corresponding to the given object identity.
ManagedConnection	getConnection(ExecutionContext ec) Accessor for a connection for the specified ObjectManager.
ManagedConnection	getConnection(ExecutionContext ec, java.util.Map options) Accessor for a connection for the specified ObjectManager.
java.lang.String	getConnectionDriverName() Convenience accessor for the driver name to use for the connection.
java.lang.Object	getConnectionFactory() Convenience accessor for the factory for the connection (transactional).
java.lang.Object	getConnectionFactory2() Convenience accessor for the factory for the connection (non-transactional).
java.lang.String	getConnectionFactory2Name() Convenience accessor for the factory name for the connection (non-transactional).
java.lang.String	getConnectionFactoryName() Convenience accessor for the factory name for the connection (transactional).
ConnectionManager	getConnectionManager() Accessor for the connection manager for this store manager.
java.lang.String	getConnectionPassword() Convenience accessor for the password to use for the connection.
java.lang.String	getConnectionURL() Convenience accessor for the URL for the connection.
java.lang.String	getConnectionUserName() Convenience accessor for the user name to use for the connection.
java.util.Date	getDatastoreDate() Get the date/time of the datastore.
Extent	getExtent(ExecutionContext ec, java.lang.Class c, boolean subclasses) Interface to getting an Extent for a class.
NucleusConnection	getNucleusConnection(ExecutionContext ec) Method to return a connection for the ObjectManager.
NucleusSequence	getNucleusSequence(ExecutionContext ec, SequenceMetaData seqmd) Method to return a datastore sequence for this datastore matching the passed sequence MetaData.
OMFContext	getOMFContext() Accessor for the context in which this StoreManager is running
StorePersistenceHandler	getPersistenceHandler() Accessor for the store persistence handler.
java.lang.String	getQueryCacheKey() Accessor for the key used for representing this store manager in the query cache.
StoreManagerRuntime	getRuntimeManager() Accessor for the runtime management of this component (if specified as required to the PMF/EMF).
StoreSchemaHandler	getSchemaHandler() Accessor for the store schema handler (if this datastore supports the concept of a schema).
java.lang.String	getStoreManagerKey() Accessor for the key for this store manager.
java.lang.Object	getStrategyValue(ExecutionContext ec, AbstractClassMetaData cmd, int absoluteFieldNumber) Method to retrieve the value for a strategy for a particular field.
java.util.HashSet	getSubClassesForClass(java.lang.String className, boolean includeDescendents, ClassLoaderResolver clr) Utility to return the names of the classes that are known subclasses of the provided class.
java.util.Collection	getSupportedOptions() Accessor for the supported options in string form
ValueGenerationManager	getValueGenerationManager() Accessor for the ValueGenerationManager for obtaining sequences.
boolean	isStrategyDatastoreAttributed(IdentityStrategy identityStrategy, boolean datastoreIdentityField) Check if the strategy is attributed by the database when the PersistenceCapable object is inserted into the database
java.lang.String	manageClassForIdentity(java.lang.Object id, ClassLoaderResolver clr) Convenience method to ensure that the class defined by the passed OID/SingleFIeldIdentity is managed by the store.
boolean	managesClass(java.lang.String className) Accessor for whether the specified class is managed currently
void	notifyObjectIsOutdated(ObjectProvider sm) Notifies this store manager that the main memory (RAM, heap) copy of the PC object of the supplied StateManager may not be regarded as valid anymore.
void	performVersionCheck(ObjectProvider sm, java.lang.Object versionDatastore, VersionMetaData versionMetaData) Perform an optimistic version check on the passed object, against the passed version in the datastore.
void	printInformation(java.lang.String cat, java.io.PrintStream ps) Method to output particular information owned by this datastore.
void	removeAllClasses(ClassLoaderResolver clr) Remove all classes from the persistence model for the datastore.
boolean	supportsQueryLanguage(java.lang.String language) Accessor for whether this query language is supported.
boolean	supportsValueStrategy(java.lang.String strategy) Accessor for whether this value strategy is supported.
void	transactionCommitted(ExecutionContext ec) Method to inform the StoreManager that a transaction has committed for the specified execution context.
void	transactionRolledBack(ExecutionContext ec) Method to inform the StoreManager that a transaction has rolled back for the specified execution context.
void	transactionStarted(ExecutionContext ec) Method to inform the StoreManager that a transaction has started for the specified execution context.

Method Detail

getSupportedOptions

java.util.Collection getSupportedOptions()

Accessor for the supported options in string form

close

void close()

Release of resources.

getRuntimeManager

StoreManagerRuntime getRuntimeManager()

Accessor for the runtime management of this component (if specified as required to the PMF/EMF).

Returns:

Runtime manager (JMX) for this store

getPersistenceHandler

StorePersistenceHandler getPersistenceHandler()

Accessor for the store persistence handler.

Returns:

Store persistence handler.

getSchemaHandler

StoreSchemaHandler getSchemaHandler()

Accessor for the store schema handler (if this datastore supports the concept of a schema).

Returns:

Store schema handler.

getNucleusSequence

NucleusSequence getNucleusSequence(ExecutionContext ec,
                                   SequenceMetaData seqmd)

Method to return a datastore sequence for this datastore matching the passed sequence MetaData.

Parameters:

ec - execution context

seqmd - SequenceMetaData

Returns:

The Sequence

getNucleusConnection

NucleusConnection getNucleusConnection(ExecutionContext ec)

Method to return a connection for the ObjectManager.

Parameters:

ec - execution context

Returns:

The datastore Connection

getConnectionManager

ConnectionManager getConnectionManager()

Accessor for the connection manager for this store manager.

Returns:

connection manager

getConnection

ManagedConnection getConnection(ExecutionContext ec)

Accessor for a connection for the specified ObjectManager.

If there is an active transaction, a connection from the transactional connection factory will be returned. If there is no active transaction, a connection from the nontransactional connection factory will be returned.

Parameters:

ec - execution context

Returns:

The Connection

Throws:

NucleusException - Thrown if an error occurs getting the connection

getConnection

ManagedConnection getConnection(ExecutionContext ec,
                                java.util.Map options)

Accessor for a connection for the specified ObjectManager.

If there is an active transaction, a connection from the transactional connection factory will be returned. If there is no active transaction, a connection from the nontransactional connection factory will be returned.

Parameters:

ec - execution context

options - connetion options

Returns:

The Connection

Throws:

NucleusException - Thrown if an error occurs getting the connection

getConnectionDriverName

java.lang.String getConnectionDriverName()

Convenience accessor for the driver name to use for the connection.

Returns:

driver name

getConnectionURL

java.lang.String getConnectionURL()

Convenience accessor for the URL for the connection.

Returns:

connection URL

getConnectionUserName

java.lang.String getConnectionUserName()

Convenience accessor for the user name to use for the connection.

Returns:

user name

getConnectionPassword

java.lang.String getConnectionPassword()

Convenience accessor for the password to use for the connection.

Returns:

Password

getConnectionFactory

java.lang.Object getConnectionFactory()

Convenience accessor for the factory for the connection (transactional).

Returns:

Connection Factory (transactional)

getConnectionFactoryName

java.lang.String getConnectionFactoryName()

Convenience accessor for the factory name for the connection (transactional).

Returns:

Connection Factory name (transactional)

getConnectionFactory2

java.lang.Object getConnectionFactory2()

Convenience accessor for the factory for the connection (non-transactional).

Returns:

Connection Factory (non-transactional)

getConnectionFactory2Name

java.lang.String getConnectionFactory2Name()

Convenience accessor for the factory name for the connection (non-transactional).

Returns:

Connection Factory name (non-transactional)

getValueGenerationManager

ValueGenerationManager getValueGenerationManager()

Accessor for the ValueGenerationManager for obtaining sequences.

Returns:

The ValueGenerationManagerr for this datastore

getApiAdapter

ApiAdapter getApiAdapter()

Accessor for the API adapter.

Returns:

API adapter

getStoreManagerKey

java.lang.String getStoreManagerKey()

Accessor for the key for this store manager.

Returns:

StoreManager key

getQueryCacheKey

java.lang.String getQueryCacheKey()

Accessor for the key used for representing this store manager in the query cache.

Returns:

Key for the query cache

getOMFContext

OMFContext getOMFContext()

Accessor for the context in which this StoreManager is running

Returns:

Returns the context.

getDatastoreDate

java.util.Date getDatastoreDate()

Get the date/time of the datastore.

Returns:

Date/time of the datastore

printInformation

void printInformation(java.lang.String cat,
                      java.io.PrintStream ps)
                      throws java.lang.Exception

Method to output particular information owned by this datastore. Each StoreManager can support whichever categories it likes.

Parameters:

cat - Category of information

ps - PrintStream

Throws:

java.lang.Exception - Thrown if an error occurs in the output process

managesClass

boolean managesClass(java.lang.String className)

Accessor for whether the specified class is managed currently

Parameters:

className - The name of the class

Returns:

Whether it is managed

addClass

void addClass(java.lang.String className,
              ClassLoaderResolver clr)

Method to add a class to the managed list for this datastore manager.

Parameters:

className - Name of the class

clr - The ClassLoaderResolver

addClasses

void addClasses(java.lang.String[] classNames,
                ClassLoaderResolver clr)

Add classes to the persistence model for the datastore.

This method is primarily useful for applications that wish to perform all of their datastore initialization up front, rather than wait for the runtime to do it on-demand.

Parameters:

classNames - The class(es) to be added.

clr - The ClassLoaderResolver

Throws:

DatastoreValidationException - If there is some mismatch between the current datastore contents and those necessary to enable persistence of the given classes.

removeAllClasses

void removeAllClasses(ClassLoaderResolver clr)

Remove all classes from the persistence model for the datastore. This empties the datastore of all datastore objects managed by us. All objects of types not managed are left untouched. In the case of RDBMS this means drop all tables for types managed by us.

Parameters:

clr - The ClassLoaderResolver

manageClassForIdentity

java.lang.String manageClassForIdentity(java.lang.Object id,
                                        ClassLoaderResolver clr)

Convenience method to ensure that the class defined by the passed OID/SingleFIeldIdentity is managed by the store.

Parameters:

id - OID

clr - ClassLoader resolver

Returns:

The class name of the class associated to this identity

Throws:

NucleusUserException - if the identity is assigned to the wrong class

getExtent

Extent getExtent(ExecutionContext ec,
                 java.lang.Class c,
                 boolean subclasses)

Interface to getting an Extent for a class.

Parameters:

ec - execution context

c - The class requiring the Extent

subclasses - Whether to include subclasses of 'c'

Returns:

The Extent.

supportsQueryLanguage

boolean supportsQueryLanguage(java.lang.String language)

Accessor for whether this query language is supported.

Parameters:

language - The language

Returns:

Whether it is supported.

supportsValueStrategy

boolean supportsValueStrategy(java.lang.String strategy)

Accessor for whether this value strategy is supported.

Parameters:

strategy - The strategy

Returns:

Whether it is supported.

getClassNameForObjectID

java.lang.String getClassNameForObjectID(java.lang.Object id,
                                         ClassLoaderResolver clr,
                                         ExecutionContext ec)

Returns the class corresponding to the given object identity. If the object is an OID (datastore-identity), return the PC class specified in the identity. If the object is SingleFieldIdentity, return the PC class specified in the identity If the object is an AppID PK, return the PC class that uses it. If the object is a SCOID, return the SCO class. If the object is a PersistenceCapable class, return the class.

Parameters:

id - The identity of some object.

clr - ClassLoader resolver

ec - execution context

Returns:

For datastore identity, return the class of the corresponding object. For application identity, return the class of the corresponding object or null if object does not exist.

Throws:

java.lang.ClassCastException - If the type of ID is not recognized (OID or SCOID).

isStrategyDatastoreAttributed

boolean isStrategyDatastoreAttributed(IdentityStrategy identityStrategy,
                                      boolean datastoreIdentityField)

Check if the strategy is attributed by the database when the PersistenceCapable object is inserted into the database

Parameters:

identityStrategy - the identityStrategy

datastoreIdentityField - Whether this is for the surrogate datastore identity field

Returns:

if the object for the strategy is attributed by the database

getStrategyValue

java.lang.Object getStrategyValue(ExecutionContext ec,
                                  AbstractClassMetaData cmd,
                                  int absoluteFieldNumber)

Method to retrieve the value for a strategy for a particular field.

Parameters:

ec - execution context

cmd - AbstractClassMetaData for the class

absoluteFieldNumber - The field number

Returns:

The value

performVersionCheck

void performVersionCheck(ObjectProvider sm,
                         java.lang.Object versionDatastore,
                         VersionMetaData versionMetaData)

Perform an optimistic version check on the passed object, against the passed version in the datastore.

Parameters:

sm - StateManager of the object to check

versionDatastore - Version of the object in the datastore

versionMetaData - VersionMetaData to use for checking

Throws:

NucleusUserException - thrown when an invalid strategy is specified

NucleusOptimisticException - thrown when the version check fails

getSubClassesForClass

java.util.HashSet getSubClassesForClass(java.lang.String className,
                                        boolean includeDescendents,
                                        ClassLoaderResolver clr)

Utility to return the names of the classes that are known subclasses of the provided class. Actually uses the MetaDataManager for determining what is a subclass since the MetaData is often registered before being needed by the Store.

Parameters:

className - Class for which we search for subclasses.

includeDescendents - Whether to include subclasses of subclasses etc

clr - The ClassLoaderResolver

Returns:

Set of classes that are subclasses of the input class. TODO Use method in MetaDataManager and remove this

notifyObjectIsOutdated

void notifyObjectIsOutdated(ObjectProvider sm)

Notifies this store manager that the main memory (RAM, heap) copy of the PC object of the supplied StateManager may not be regarded as valid anymore. (The most common case is that the state of the PC becomes HOLLOW). This is especially important for object databases employing implicit storing from the main memory to the database (like DB4O). These databases may stop tracking the main memory copy and linking it with its on-disk copy, thus releasing memory. More importantly, these databases then know that the object should be reloaded when it is (maybe even implicitly) accessed again. To be clear: There may be multiple copies of the data of one PC object (from the user perspective), namely a copy in main memory (on the Java heap) and a copy in the database (usually on disk). As there may be multiple copies, some of these copies may be outdated or invalid. In case such a copy is to be accessed, its contents should not be used. Rather than that, the outdated copy should be overwritten by an authorative copy. This method marks the main memory copy of the object (on the Java heap) to be outdated in that sense.

getBackingStoreForField

Store getBackingStoreForField(ClassLoaderResolver clr,
                              AbstractMemberMetaData fmd,
                              java.lang.Class type)

Accessor for the backing store for the specified field. Override it if the store needs this

Parameters:

clr - ClassLoader resolver

fmd - MetaData for the field/property

type - Type

Returns:

Backing store

Throws:

IncompatibleFieldTypeException - raises the exception if the field is not compatible if the store

java.lang.UnsupportedOperationException - if BackingStore is not supported

transactionStarted

void transactionStarted(ExecutionContext ec)

Method to inform the StoreManager that a transaction has started for the specified execution context. This allows the StoreManager to initialise any objects as required.

Parameters:

ec - ExecutionContext

transactionCommitted

void transactionCommitted(ExecutionContext ec)

Method to inform the StoreManager that a transaction has committed for the specified execution context. This allows the StoreManager to close any objects as required.

Parameters:

ec - ExecutionContext

transactionRolledBack

void transactionRolledBack(ExecutionContext ec)

Method to inform the StoreManager that a transaction has rolled back for the specified execution context. This allows the StoreManager to close any objects as required.

Parameters:

ec - ExecutionContext