com.sleepycat.persist.impl

Class PersistCatalog

java.lang.Object

com.sleepycat.persist.impl.PersistCatalog

All Implemented Interfaces:

Catalog

public class PersistCatalog
extends java.lang.Object
implements Catalog

The catalog of class formats for a store, along with its associated model and mutations.

Author:

Mark Hayes

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	expectNoClassChanges Used by unit tests.
static boolean	unevolvedFormatsEncountered

Fields inherited from interface com.sleepycat.persist.impl.Catalog

BETA_VERSION, CURRENT_VERSION

Constructor Summary

Constructors

Constructor and Description
PersistCatalog(Environment env, java.lang.String storePrefix, java.lang.String dbName, DatabaseConfig dbConfig, EntityModel modelParam, Mutations mutationsParam, boolean rawAccess, Store store) Creates a new catalog, opening the database and reading it from a given catalog database if it already exists.
PersistCatalog(PersistCatalog oldCatalog, java.lang.String storePrefix) Creates a new catalog when a Replica refresh occurs.

Method Summary

Methods

Modifier and Type	Method and Description
(package private) void	checkWriteInReplicaUpgradeMode() Metadata needs refreshing when a Replica with stale metadata is elected master, and then a user write operation is attempted.
boolean	close() Decrements the reference count and closes the catalog DB when it reaches zero.
java.lang.Object	convertRawObject(RawObject o, IdentityHashMap converted)
Format	createFormat(java.lang.Class type, java.util.Map<java.lang.String,Format> newFormats) If the given class format is not already present in the given map and a format for this class name does not already exist, creates an uninitialized format, adds it to the map, and also collects related formats in the map.
Format	createFormat(java.lang.String clsName, java.util.Map<java.lang.String,Format> newFormats) Convenience method that gets the class for the given class name and calls createFormat with the class object.
void	flush(Transaction txn) Used to write the catalog when a format has been changed, for example, when Store.evolve has updated a Format's EvolveNeeded property.
java.util.List<RawType>	getAllRawTypes() Returns all formats as RawTypes.
java.lang.String	getDatabaseClassName(java.lang.String className) Returns the name of an entity class to be used to form the database name.
java.lang.String	getDatabaseKeyName(java.lang.String className, java.lang.String keyName) Similar to getDatabaseClassName but instead handles an earlier version of a renamed key.
void	getEntityFormats(java.util.Collection<Format> entityFormats)
Format	getFormat(java.lang.Class cls, boolean checkEntitySubclassIndexes) Get a format for a given class, creating it if it does not exist.
Format	getFormat(int formatId, boolean expectStored) Returns a format for a given ID, or throws an exception.
Format	getFormat(java.lang.String className) Returns a format by class name.
int	getInitVersion(Format format, boolean forReader) When a format is intialized, this method is called to get the version of the serialized object to be initialized.
Format	getLatestVersion(java.lang.String className)
(package private) java.util.Set<java.lang.String>	getModelClasses() Returns a set of all persistent (non-simple type) class names.
Mutations	getMutations() Returns the current merged mutations.
(package private) int	getNFormats() Returns the number of stored formats.
EntityModel	getResolvedModel() Returns the model parameter, default model or stored model.
(package private) java.util.Map<Format,java.util.Set<Format>>	getSubclassMap() Returns a map from format to a set of its superclass formats.
(package private) boolean	isMetadataStale(Transaction txn) Metadata needs refreshing when a Replica with stale metadata is elected master, and then a user write operation is attempted that also requires a metadata update.
boolean	isRawAccess()
boolean	isReadOnly() Returns true if the user opened the store read-only, or we're running in Replica upgrade mode.
(package private) boolean	isReplicaUpgradeMode() For unit testing.
void	openExisting() Increments the reference count for a catalog that is already open.
java.lang.Class	resolveClass(java.lang.String clsName)
java.lang.Class	resolveKeyClass(java.lang.String clsName)
(package private) void	useExistingFormat(Format oldFormat) Installs an existing format when no evolution is needed, i.e, when the new and old formats are identical.

Methods inherited from class java.lang.Object

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

Field Detail

expectNoClassChanges

public static boolean expectNoClassChanges

Used by unit tests.

unevolvedFormatsEncountered

public static boolean unevolvedFormatsEncountered

Constructor Detail

PersistCatalog

public PersistCatalog(Environment env,
              java.lang.String storePrefix,
              java.lang.String dbName,
              DatabaseConfig dbConfig,
              EntityModel modelParam,
              Mutations mutationsParam,
              boolean rawAccess,
              Store store)
               throws StoreExistsException,
                      StoreNotFoundException,
                      IncompatibleClassException,
                      DatabaseException

Creates a new catalog, opening the database and reading it from a given catalog database if it already exists. All predefined formats and formats for the given model are added. For modified classes, old formats are defined based on the rules for compatible class changes and the given mutations. If any format is changed or added, and the database is not read-only, write the initialized catalog to the database.

Throws:

StoreExistsException

StoreNotFoundException

IncompatibleClassException

DatabaseException

PersistCatalog

PersistCatalog(PersistCatalog oldCatalog,
              java.lang.String storePrefix)
         throws DatabaseException

Creates a new catalog when a Replica refresh occurs. Uses some information from the old catalog directly in the new catalog, but all formats are created from scratch and class evolution is attempted.

Throws:

DatabaseException

Method Detail

getEntityFormats

public void getEntityFormats(java.util.Collection<Format> entityFormats)

getSubclassMap

java.util.Map<Format,java.util.Set<Format>> getSubclassMap()

Returns a map from format to a set of its superclass formats. The format for simple types, enums and class Object are not included. Only complex types have superclass formats as defined by Format.getSuperFormat.

getResolvedModel

public EntityModel getResolvedModel()

Returns the model parameter, default model or stored model.

openExisting

public void openExisting()

Increments the reference count for a catalog that is already open.

isReadOnly

public boolean isReadOnly()

Returns true if the user opened the store read-only, or we're running in Replica upgrade mode.

close

public boolean close()
              throws DatabaseException

Decrements the reference count and closes the catalog DB when it reaches zero. Returns true if the database was closed or false if the reference count is still non-zero and the database was left open.

Throws:

DatabaseException

getMutations

public Mutations getMutations()

Returns the current merged mutations.

createFormat

public Format createFormat(java.lang.String clsName,
                  java.util.Map<java.lang.String,Format> newFormats)

Convenience method that gets the class for the given class name and calls createFormat with the class object.

Specified by:

createFormat in interface Catalog

See Also:

createFormat(java.lang.String, java.util.Map<java.lang.String, com.sleepycat.persist.impl.Format>)

createFormat

public Format createFormat(java.lang.Class type,
                  java.util.Map<java.lang.String,Format> newFormats)

If the given class format is not already present in the given map and a format for this class name does not already exist, creates an uninitialized format, adds it to the map, and also collects related formats in the map.

Specified by:

createFormat in interface Catalog

See Also:

createFormat(java.lang.String, java.util.Map<java.lang.String, com.sleepycat.persist.impl.Format>)

useExistingFormat

void useExistingFormat(Format oldFormat)

Installs an existing format when no evolution is needed, i.e, when the new and old formats are identical.

getModelClasses

java.util.Set<java.lang.String> getModelClasses()

Returns a set of all persistent (non-simple type) class names.

getAllRawTypes

public java.util.List<RawType> getAllRawTypes()

Returns all formats as RawTypes.

getInitVersion

public int getInitVersion(Format format,
                 boolean forReader)

When a format is intialized, this method is called to get the version of the serialized object to be initialized. See Catalog.

Specified by:

getInitVersion in interface Catalog

getFormat

public Format getFormat(int formatId,
               boolean expectStored)
                 throws RefreshException

Description copied from interface: Catalog

Returns a format for a given ID, or throws an exception. This method is used when reading an object from the byte array format.

Specified by:

getFormat in interface Catalog

expectStored - is true if reading a record from a database, and therefore the format ID is expected to be stored also. If the format ID is not stored, a RefreshException is thrown.

Throws:

RefreshException

getFormat

public Format getFormat(java.lang.Class cls,
               boolean checkEntitySubclassIndexes)
                 throws RefreshException

Get a format for a given class, creating it if it does not exist.

This method is called for top level entity instances by PersistEntityBinding. When a new entity subclass format is added we call Store.checkEntitySubclassSecondaries to ensure that all secondary databases have been opened, before storing the entity. We do this here while not holding a synchronization mutex, not in addNewFormat, to avoid deadlocks. checkEntitySubclassSecondaries synchronizes on the Store. [#16399]

Historical note: At one time we opened / created the secondary databases rather than requiring the user to open them, see [#15247]. Later we found this to be problematic since a user txn may have locked primary records, see [#16399].

Specified by:

getFormat in interface Catalog

checkEntitySubclassIndexes - is true if we're expecting this format to be an entity subclass and therefore subclass secondary indexes should be opened.

Throws:

RefreshException

getFormat

public Format getFormat(java.lang.String className)

Description copied from interface: Catalog

Returns a format by class name. Unlike #getFormat(Class), the format will not be created if it is not already known.

Specified by:

getFormat in interface Catalog

getLatestVersion

public Format getLatestVersion(java.lang.String className)

getDatabaseClassName

public java.lang.String getDatabaseClassName(java.lang.String className)

Returns the name of an entity class to be used to form the database name. Normally this is the same as the class name, but in replica upgrade mode it may be an earlier version of a renamed class. Returns null if there is no stored version of the class. [#16655]

getDatabaseKeyName

public java.lang.String getDatabaseKeyName(java.lang.String className,
                                  java.lang.String keyName)

Similar to getDatabaseClassName but instead handles an earlier version of a renamed key. [#16655]

checkWriteInReplicaUpgradeMode

void checkWriteInReplicaUpgradeMode()
                              throws RefreshException

Metadata needs refreshing when a Replica with stale metadata is elected master, and then a user write operation is attempted. [#16655]

Throws:

RefreshException

isReplicaUpgradeMode

boolean isReplicaUpgradeMode()

For unit testing.

flush

public void flush(Transaction txn)
           throws DatabaseException

Used to write the catalog when a format has been changed, for example, when Store.evolve has updated a Format's EvolveNeeded property. Uses auto-commit.

Throws:

DatabaseException

getNFormats

int getNFormats()

Returns the number of stored formats.

isMetadataStale

boolean isMetadataStale(Transaction txn)
                  throws DatabaseException

Metadata needs refreshing when a Replica with stale metadata is elected master, and then a user write operation is attempted that also requires a metadata update. [#16655]

Throws:

DatabaseException

isRawAccess

public boolean isRawAccess()

Specified by:

isRawAccess in interface Catalog

See Also:

isRawAccess()

convertRawObject

public java.lang.Object convertRawObject(RawObject o,
                                IdentityHashMap converted)
                                  throws RefreshException

Specified by:

convertRawObject in interface Catalog

Throws:

RefreshException

See Also:

convertRawObject(com.sleepycat.persist.raw.RawObject, com.sleepycat.je.utilint.IdentityHashMap)

resolveClass

public java.lang.Class resolveClass(java.lang.String clsName)
                             throws java.lang.ClassNotFoundException

Specified by:

resolveClass in interface Catalog

Throws:

java.lang.ClassNotFoundException

See Also:

resolveClass(java.lang.String)

resolveKeyClass

public java.lang.Class resolveKeyClass(java.lang.String clsName)

Specified by:

resolveKeyClass in interface Catalog

See Also:

resolveKeyClass(java.lang.String)