org.datanucleus.store

Interface StoreManager

All Known Implementing Classes:

AbstractStoreManager, FederatedStoreManager

public interface StoreManager

Interface defining management of a datastore. To be implemented by all new datastore support. Please use AbstractStoreManager and extend it. All StoreManagers should have a single constructor with signature

 public MyStoreManager(ClassLoaderResolver clr, NucleusContext ctx, Map<String, Object> props)
 {
 }
 

The constructor arguments are

• ClassLoader Resolver, for assistance in any class loading needed.
• The context where the StoreManager is being used, providing services like metadata, etc
• Any persistence properties that are defined for the store, to configure schema generation etc

See also AbstractStoreManager which provides something that can be extended, simplifying the process of implementing a StoreManager; note that the first argument of the constructor to AbstractStoreManager is the "key" for your StoreManager (e.g ODF has "odf" as its key, RDBMS has "rdbms").

Method Summary

Methods

Modifier and Type	Method and Description
void	addClass(String className, ClassLoaderResolver clr) Method to add a class to the managed list for this datastore manager.
void	addClasses(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.
Boolean	getBooleanObjectProperty(String name)
boolean	getBooleanProperty(String name)
boolean	getBooleanProperty(String name, boolean resultIfNotSet)
String	getClassNameForObjectID(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 ExecutionContext.
ManagedConnection	getConnection(ExecutionContext ec, Map options) Accessor for a connection for the specified ExecutionContext.
String	getConnectionDriverName() Convenience accessor for the driver name to use for the connection.
Object	getConnectionFactory() Convenience accessor for the factory for the connection (transactional).
Object	getConnectionFactory2() Convenience accessor for the factory for the connection (non-transactional).
String	getConnectionFactory2Name() Convenience accessor for the factory name for the connection (non-transactional).
String	getConnectionFactoryName() Convenience accessor for the factory name for the connection (transactional).
ConnectionManager	getConnectionManager() Accessor for the connection manager for this store manager.
String	getConnectionPassword() Convenience accessor for the password to use for the connection.
String	getConnectionURL() Convenience accessor for the URL for the connection.
String	getConnectionUserName() Convenience accessor for the user name to use for the connection.
Date	getDatastoreDate() Get the date/time of the datastore.
String	getDefaultObjectProviderClassName()
Extent	getExtent(ExecutionContext ec, Class c, boolean subclasses) Interface to getting an Extent for a class.
FlushProcess	getFlushProcess() Accessor for the flush process to use with this datastore.
int	getIntProperty(String name)
NamingFactory	getNamingFactory() Accessor for the schema naming factory.
NucleusConnection	getNucleusConnection(ExecutionContext ec) Method to return a connection to the user for the ExecutionContext.
NucleusContext	getNucleusContext() Accessor for the context in which this StoreManager is running
NucleusSequence	getNucleusSequence(ExecutionContext ec, SequenceMetaData seqmd) Method to return a datastore sequence for this datastore matching the passed sequence MetaData.
StorePersistenceHandler	getPersistenceHandler() Accessor for the store persistence handler.
Object	getProperty(String name)
String	getQueryCacheKey() Accessor for the key used for representing this store manager in the query cache.
QueryManager	getQueryManager() Accessor for the query manager for this datastore.
StoreSchemaHandler	getSchemaHandler() Accessor for the store schema handler (if this datastore supports the concept of a schema).
String	getStoreManagerKey() Accessor for the key for this store manager.
Object	getStrategyValue(ExecutionContext ec, AbstractClassMetaData cmd, int absoluteFieldNumber) Method to retrieve the value for a strategy for a particular field.
String	getStringProperty(String name)
Collection<String>	getSubClassesForClass(String className, boolean includeDescendents, ClassLoaderResolver clr) Utility to return the names of the classes that are known subclasses of the provided class.
Collection	getSupportedOptions() Accessor for the supported options in string form
ValueGenerationManager	getValueGenerationManager() Accessor for the ValueGenerationManager for obtaining sequences.
boolean	hasProperty(String name)
boolean	isAutoCreateColumns()
boolean	isAutoCreateConstraints()
boolean	isAutoCreateTables()
boolean	isJdbcStore() Returns whether the datastore is a "JDBC datastore".
boolean	isStrategyDatastoreAttributed(AbstractClassMetaData cmd, int absFieldNumber) Convenience method to return whether the strategy used by the specified class/member is generated in the datastore during a persist.
String	manageClassForIdentity(Object id, ClassLoaderResolver clr) Convenience method to ensure that the class defined by the passed OID/SingleFIeldIdentity is managed by the store.
boolean	managesClass(String className) Accessor for whether the specified class is managed currently
void	printInformation(String cat, 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(String language) Accessor for whether this query language is supported.
boolean	supportsValueStrategy(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.
boolean	useBackedSCOWrapperForMember(AbstractMemberMetaData mmd, ExecutionContext ec) Method to return whether the specified member should use a backed SCO wrapper.

Method Detail

getSupportedOptions

Collection getSupportedOptions()

Accessor for the supported options in string form

close

void close()

Release of resources.

getPersistenceHandler

StorePersistenceHandler getPersistenceHandler()

Accessor for the store persistence handler.

Returns:

Store persistence handler.

getFlushProcess

FlushProcess getFlushProcess()

Accessor for the flush process to use with this datastore.

Returns:

The flush process

getNamingFactory

NamingFactory getNamingFactory()

Accessor for the schema naming factory.

Returns:

Naming factory.

getQueryManager

QueryManager getQueryManager()

Accessor for the query manager for this datastore.

Returns:

Query Manager for this store

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 to the user for the ExecutionContext. Typically provides a wrapper to the currently in-use ManagedConnection.

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 ExecutionContext.

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,
                              Map options)

Accessor for a connection for the specified ExecutionContext.

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

String getConnectionDriverName()

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

Returns:

driver name

getConnectionURL

String getConnectionURL()

Convenience accessor for the URL for the connection.

Returns:

connection URL

getConnectionUserName

String getConnectionUserName()

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

Returns:

user name

getConnectionPassword

String getConnectionPassword()

Convenience accessor for the password to use for the connection.

Returns:

Password

getConnectionFactory

Object getConnectionFactory()

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

Returns:

Connection Factory (transactional)

getConnectionFactoryName

String getConnectionFactoryName()

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

Returns:

Connection Factory name (transactional)

getConnectionFactory2

Object getConnectionFactory2()

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

Returns:

Connection Factory (non-transactional)

getConnectionFactory2Name

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

String getStoreManagerKey()

Accessor for the key for this store manager.

Returns:

StoreManager key

getQueryCacheKey

String getQueryCacheKey()

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

Returns:

Key for the query cache

getNucleusContext

NucleusContext getNucleusContext()

Accessor for the context in which this StoreManager is running

Returns:

Returns the context.

getDatastoreDate

Date getDatastoreDate()

Get the date/time of the datastore.

Returns:

Date/time of the datastore

isJdbcStore

boolean isJdbcStore()

Returns whether the datastore is a "JDBC datastore". If it is then the JDO spec needs to return a connection that implements java.sql.Connection. RDBMS is the only one that will return true from here (or certainly as we can foresee now).

Returns:

Whether this is a JDBC datastore

printInformation

void printInformation(String cat,
                    PrintStream ps)
                      throws 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:

Exception - Thrown if an error occurs in the output process

useBackedSCOWrapperForMember

boolean useBackedSCOWrapperForMember(AbstractMemberMetaData mmd,
                                   ExecutionContext ec)

Method to return whether the specified member should use a backed SCO wrapper.

Parameters:

mmd - Metadata for the member

ec - ExecutionContext

Returns:

Whether to use a back SCO wrapper (false means use a simple SCO wrapper).

managesClass

boolean managesClass(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(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(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

String manageClassForIdentity(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,
               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(String language)

Accessor for whether this query language is supported.

Parameters:

language - The language

Returns:

Whether it is supported.

supportsValueStrategy

boolean supportsValueStrategy(String strategy)

Accessor for whether this value strategy is supported.

Parameters:

strategy - The strategy

Returns:

Whether it is supported.

getClassNameForObjectID

String getClassNameForObjectID(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 persistable 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:

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

isStrategyDatastoreAttributed

boolean isStrategyDatastoreAttributed(AbstractClassMetaData cmd,
                                    int absFieldNumber)

Convenience method to return whether the strategy used by the specified class/member is generated in the datastore during a persist.

Parameters:

cmd - Metadata for the class

absFieldNumber - number of the field (or -1 if for datastore-id)

Returns:

if the object for the strategy is attributed by the database

getStrategyValue

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

getSubClassesForClass

Collection<String> getSubClassesForClass(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

getProperty

Object getProperty(String name)

hasProperty

boolean hasProperty(String name)

getIntProperty

int getIntProperty(String name)

getBooleanProperty

boolean getBooleanProperty(String name)

getBooleanProperty

boolean getBooleanProperty(String name,
                         boolean resultIfNotSet)

getBooleanObjectProperty

Boolean getBooleanObjectProperty(String name)

getStringProperty

String getStringProperty(String name)

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

isAutoCreateTables

boolean isAutoCreateTables()

isAutoCreateConstraints

boolean isAutoCreateConstraints()

isAutoCreateColumns

boolean isAutoCreateColumns()

getDefaultObjectProviderClassName

String getDefaultObjectProviderClassName()