public interface StoreManager
public MyStoreManager(ClassLoaderResolver clr, NucleusContext ctx, Map<String, Object> props) { }The constructor arguments are
Modifier and Type | Field and Description |
---|---|
static String |
OPTION_APPLICATION_COMPOSITE_ID |
static String |
OPTION_APPLICATION_ID |
static String |
OPTION_DATASTORE_ID |
static String |
OPTION_DATASTORE_TIMEOUT |
static String |
OPTION_NONDURABLE_ID |
static String |
OPTION_ORM |
static String |
OPTION_ORM_EMBEDDED_ARRAY |
static String |
OPTION_ORM_EMBEDDED_ARRAY_NESTED |
static String |
OPTION_ORM_EMBEDDED_COLLECTION |
static String |
OPTION_ORM_EMBEDDED_COLLECTION_NESTED |
static String |
OPTION_ORM_EMBEDDED_MAP |
static String |
OPTION_ORM_EMBEDDED_MAP_NESTED |
static String |
OPTION_ORM_EMBEDDED_PC |
static String |
OPTION_ORM_EMBEDDED_PC_NESTED |
static String |
OPTION_ORM_FOREIGN_KEYS |
static String |
OPTION_ORM_SECONDARY_TABLE |
static String |
OPTION_QUERY_CANCEL |
static String |
OPTION_QUERY_JDOQL_BITWISE_OPS |
static String |
OPTION_TXN_ISOLATION_READ_COMMITTED |
static String |
OPTION_TXN_ISOLATION_READ_UNCOMMITTED |
static String |
OPTION_TXN_ISOLATION_REPEATABLE_READ |
static String |
OPTION_TXN_ISOLATION_SERIALIZABLE |
Modifier and Type | Method and Description |
---|---|
void |
close() |
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 (PM/EM).
|
ManagedConnection |
getConnection(ExecutionContext ec,
Map options)
Accessor for a connection for the specified ExecutionContext (PM/EM).
|
ManagedConnection |
getConnection(int isolation_level)
Accessor for a connection for the specified transaction isolation level.
|
String |
getConnectionDriverName()
Convenience accessor for the driver name to use for the connections (where supported).
|
Object |
getConnectionFactory()
Convenience accessor for the primary connection factory (when a factory was provided by the user).
|
Object |
getConnectionFactory2()
Convenience accessor for the secondary connection factory (when a factory was provided by the user).
|
String |
getConnectionFactory2Name()
Convenience accessor for the factory (JNDI) name for the secondary connection factory (when provided by the user).
|
String |
getConnectionFactoryName()
Convenience accessor for the factory (JNDI) name for the primary connection factory (when provided by the user).
|
ConnectionManager |
getConnectionManager()
Accessor for the connection manager for this store manager.
|
String |
getConnectionPassword()
Convenience accessor for the password to use for the connections (where required).
|
String |
getConnectionURL()
Convenience accessor for the URL for the connections.
|
String |
getConnectionUserName()
Convenience accessor for the user name to use for the connections (where required).
|
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() |
int |
getIntProperty(String name) |
MetaDataManager |
getMetaDataManager() |
NamingFactory |
getNamingFactory() |
String |
getNativeQueryLanguage()
Accessor for the native query language of this store.
|
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() |
Object |
getProperty(String name) |
String |
getQueryCacheKey()
Accessor for the key used for representing this store manager in the query cache.
|
QueryManager |
getQueryManager() |
StoreSchemaHandler |
getSchemaHandler() |
StoreData |
getStoreDataForClass(String className) |
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<String> |
getSupportedOptions() |
ValueGenerationManager |
getValueGenerationManager()
Accessor for the ValueGenerationManager for obtaining sequences.
|
boolean |
hasProperty(String name) |
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.
|
void |
manageClasses(ClassLoaderResolver clr,
String... classNames)
Manage the specified classes.
|
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.
|
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.
|
void |
unmanageAllClasses(ClassLoaderResolver clr)
Remove all classes from the persistence model for the datastore.
|
void |
unmanageClass(ClassLoaderResolver clr,
String className,
boolean removeFromDatastore)
Method to remove knowledge of the specified class from this StoreManager.
|
boolean |
useBackedSCOWrapperForMember(AbstractMemberMetaData mmd,
ExecutionContext ec)
Method to return whether the specified member should use a backed SCO wrapper.
|
boolean |
usesBackedSCOWrappers()
Whether this store manager uses backing-store based SCO wrappers.
|
static final String OPTION_APPLICATION_ID
static final String OPTION_APPLICATION_COMPOSITE_ID
static final String OPTION_DATASTORE_ID
static final String OPTION_NONDURABLE_ID
static final String OPTION_ORM
static final String OPTION_ORM_EMBEDDED_PC
static final String OPTION_ORM_EMBEDDED_COLLECTION
static final String OPTION_ORM_EMBEDDED_MAP
static final String OPTION_ORM_EMBEDDED_ARRAY
static final String OPTION_ORM_EMBEDDED_PC_NESTED
static final String OPTION_ORM_EMBEDDED_COLLECTION_NESTED
static final String OPTION_ORM_EMBEDDED_MAP_NESTED
static final String OPTION_ORM_EMBEDDED_ARRAY_NESTED
static final String OPTION_ORM_SECONDARY_TABLE
static final String OPTION_ORM_FOREIGN_KEYS
static final String OPTION_TXN_ISOLATION_READ_COMMITTED
static final String OPTION_TXN_ISOLATION_READ_UNCOMMITTED
static final String OPTION_TXN_ISOLATION_REPEATABLE_READ
static final String OPTION_TXN_ISOLATION_SERIALIZABLE
static final String OPTION_QUERY_CANCEL
static final String OPTION_QUERY_JDOQL_BITWISE_OPS
static final String OPTION_DATASTORE_TIMEOUT
Collection<String> getSupportedOptions()
void close()
MetaDataManager getMetaDataManager()
StorePersistenceHandler getPersistenceHandler()
FlushProcess getFlushProcess()
NamingFactory getNamingFactory()
QueryManager getQueryManager()
StoreSchemaHandler getSchemaHandler()
NucleusSequence getNucleusSequence(ExecutionContext ec, SequenceMetaData seqmd)
ec
- execution contextseqmd
- SequenceMetaDataNucleusConnection getNucleusConnection(ExecutionContext ec)
ec
- execution contextConnectionManager getConnectionManager()
ManagedConnection getConnection(ExecutionContext ec)
ec
- execution contextNucleusException
- Thrown if an error occurs getting the connectionManagedConnection getConnection(ExecutionContext ec, Map options)
ec
- execution contextoptions
- connection optionsNucleusException
- Thrown if an error occurs getting the connectionManagedConnection getConnection(int isolation_level)
isolation_level
- Isolation level (-1 implies use the default for the datastore).NucleusException
- Thrown if an error occurs getting the connectionString getConnectionURL()
String getConnectionUserName()
String getConnectionPassword()
String getConnectionDriverName()
Object getConnectionFactory()
String getConnectionFactoryName()
Object getConnectionFactory2()
String getConnectionFactory2Name()
ValueGenerationManager getValueGenerationManager()
ApiAdapter getApiAdapter()
String getStoreManagerKey()
String getQueryCacheKey()
NucleusContext getNucleusContext()
Date getDatastoreDate()
boolean isJdbcStore()
void printInformation(String cat, PrintStream ps) throws Exception
cat
- Category of informationps
- PrintStreamException
- Thrown if an error occurs in the output processboolean useBackedSCOWrapperForMember(AbstractMemberMetaData mmd, ExecutionContext ec)
mmd
- Metadata for the memberec
- ExecutionContextboolean managesClass(String className)
className
- The name of the classvoid manageClasses(ClassLoaderResolver clr, String... classNames)
clr
- The ClassLoaderResolverclassNames
- The class(es) to be managedDatastoreValidationException
- If there is some mismatch between the current datastore contents and
those necessary to enable persistence of the given classes.void unmanageClass(ClassLoaderResolver clr, String className, boolean removeFromDatastore)
clr
- ClassLoader resolverclassName
- Name of the classremoveFromDatastore
- Whether to also remove it from the datastore (otherwise just from the StoreManager)void unmanageAllClasses(ClassLoaderResolver clr)
clr
- The ClassLoaderResolverString manageClassForIdentity(Object id, ClassLoaderResolver clr)
id
- OIDclr
- ClassLoader resolverNucleusUserException
- if the identity is assigned to the wrong classExtent getExtent(ExecutionContext ec, Class c, boolean subclasses)
ec
- execution contextc
- The class requiring the Extentsubclasses
- Whether to include subclasses of 'c'boolean supportsQueryLanguage(String language)
language
- The languageString getNativeQueryLanguage()
boolean supportsValueStrategy(String strategy)
strategy
- The strategyString getClassNameForObjectID(Object id, ClassLoaderResolver clr, ExecutionContext ec)
id
- The identity of some object.clr
- ClassLoader resolverec
- execution contextClassCastException
- If the type of ID is not recognizedboolean isStrategyDatastoreAttributed(AbstractClassMetaData cmd, int absFieldNumber)
cmd
- Metadata for the classabsFieldNumber
- number of the field (or -1 if for datastore-id)Object getStrategyValue(ExecutionContext ec, AbstractClassMetaData cmd, int absoluteFieldNumber)
ec
- execution contextcmd
- AbstractClassMetaData for the classabsoluteFieldNumber
- The field numberCollection<String> getSubClassesForClass(String className, boolean includeDescendents, ClassLoaderResolver clr)
className
- Class for which we search for subclasses.includeDescendents
- Whether to include subclasses of subclasses etcclr
- The ClassLoaderResolverboolean hasProperty(String name)
int getIntProperty(String name)
boolean getBooleanProperty(String name)
boolean getBooleanProperty(String name, boolean resultIfNotSet)
void transactionStarted(ExecutionContext ec)
ec
- ExecutionContextvoid transactionCommitted(ExecutionContext ec)
ec
- ExecutionContextvoid transactionRolledBack(ExecutionContext ec)
ec
- ExecutionContextString getDefaultObjectProviderClassName()
boolean usesBackedSCOWrappers()
Copyright © 2017. All rights reserved.