/**
* Custom deserialization routine used during deserialization of a Session/PersistenceContext for
* increased performance.
*
* @param ois The stream from which to read the entry.
* @param persistenceContext The context being deserialized.
* @return The deserialized EntityEntry
* @throws IOException If a stream error occurs
* @throws ClassNotFoundException If any of the classes declared in the stream cannot be found
*/
public static EntityEntry deserialize(
ObjectInputStream ois, PersistenceContext persistenceContext)
throws IOException, ClassNotFoundException {
String previousStatusString;
return new EntityEntry(
// this complexity comes from non-flushed changes, should really look at how that reattaches
// entries
(persistenceContext.getSession() == null
? null
: persistenceContext.getSession().getFactory()),
(String) ois.readObject(),
(Serializable) ois.readObject(),
EntityMode.parse((String) ois.readObject()),
(String) ois.readObject(),
Status.valueOf((String) ois.readObject()),
((previousStatusString = (String) ois.readObject()).length() == 0
? null
: Status.valueOf(previousStatusString)),
(Object[]) ois.readObject(),
(Object[]) ois.readObject(),
ois.readObject(),
LockMode.valueOf((String) ois.readObject()),
ois.readBoolean(),
ois.readBoolean(),
ois.readBoolean(),
persistenceContext);
}
/**
* Custom deserialization routine used during deserialization of a Session/PersistenceContext for
* increased performance.
*
* @param ois The stream from which to read the entry.
* @param session The session being deserialized.
* @return The deserialized CollectionKey
* @throws IOException
* @throws ClassNotFoundException
*/
static CollectionKey deserialize(ObjectInputStream ois, SessionImplementor session)
throws IOException, ClassNotFoundException {
return new CollectionKey(
(String) ois.readObject(),
(Serializable) ois.readObject(),
(Type) ois.readObject(),
EntityMode.parse((String) ois.readObject()),
(session == null ? null : session.getFactory()));
}
@Override
public String getExplicitTuplizerClassName() {
if (componentElement.getTuplizer() == null) {
return null;
}
final EntityMode entityMode =
StringHelper.isEmpty(componentElement.getClazz()) ? EntityMode.MAP : EntityMode.POJO;
for (XMLTuplizerElement tuplizerElement : componentElement.getTuplizer()) {
if (entityMode == EntityMode.parse(tuplizerElement.getEntityMode())) {
return tuplizerElement.getClazz();
}
}
return null;
}
/**
* Custom serialization routine used during serialization of a Session/PersistenceContext for
* increased performance.
*
* @param oos The stream to which we should write the serial data.
* @throws IOException If a stream error occurs
*/
public void serialize(ObjectOutputStream oos) throws IOException {
oos.writeObject(entityName);
oos.writeObject(id);
oos.writeObject(entityMode.toString());
oos.writeObject(tenantId);
oos.writeObject(status.name());
oos.writeObject((previousStatus == null ? "" : previousStatus.name()));
// todo : potentially look at optimizing these two arrays
oos.writeObject(loadedState);
oos.writeObject(deletedState);
oos.writeObject(version);
oos.writeObject(lockMode.toString());
oos.writeBoolean(existsInDatabase);
oos.writeBoolean(isBeingReplicated);
oos.writeBoolean(loadedWithLazyPropertiesUnfetched);
}
/**
* Custom deserialization routine used during deserialization of a Session/PersistenceContext for
* increased performance.
*
* @param ois The stream from which to read the entry.
* @param persistenceContext The context being deserialized.
* @return The deserialized EntityEntry
* @throws IOException If a stream error occurs
* @throws ClassNotFoundException If any of the classes declared in the stream cannot be found
*/
public static EntityEntry deserialize(
ObjectInputStream ois, PersistenceContext persistenceContext)
throws IOException, ClassNotFoundException {
String previousStatusString;
return new EntityEntry(
persistenceContext.getSession().getFactory(),
(String) ois.readObject(),
(Serializable) ois.readObject(),
EntityMode.parse((String) ois.readObject()),
(String) ois.readObject(),
Status.valueOf((String) ois.readObject()),
(previousStatusString = (String) ois.readObject()).length() == 0
? null
: Status.valueOf(previousStatusString),
(Object[]) ois.readObject(),
(Object[]) ois.readObject(),
ois.readObject(),
LockMode.valueOf((String) ois.readObject()),
ois.readBoolean(),
ois.readBoolean(),
ois.readBoolean(),
persistenceContext);
}
/**
* Custom serialization routine used during serialization of a Session/PersistenceContext for
* increased performance.
*
* @param oos The stream to which we should write the serial data.
* @throws java.io.IOException
*/
void serialize(ObjectOutputStream oos) throws IOException {
oos.writeObject(role);
oos.writeObject(key);
oos.writeObject(keyType);
oos.writeObject(entityMode.toString());
}
public Settings buildSettings(Properties props, ServiceRegistry serviceRegistry) {
final boolean debugEnabled = LOG.isDebugEnabled();
final JdbcServices jdbcServices = serviceRegistry.getService(JdbcServices.class);
Settings settings = new Settings();
// SessionFactory name:
String sessionFactoryName = props.getProperty(AvailableSettings.SESSION_FACTORY_NAME);
settings.setSessionFactoryName(sessionFactoryName);
settings.setSessionFactoryNameAlsoJndiName(
ConfigurationHelper.getBoolean(
AvailableSettings.SESSION_FACTORY_NAME_IS_JNDI, props, true));
// JDBC and connection settings:
// Interrogate JDBC metadata
ExtractedDatabaseMetaData meta = jdbcServices.getExtractedMetaDataSupport();
settings.setDataDefinitionImplicitCommit(meta.doesDataDefinitionCauseTransactionCommit());
settings.setDataDefinitionInTransactionSupported(meta.supportsDataDefinitionInTransaction());
// use dialect default properties
final Properties properties = new Properties();
properties.putAll(jdbcServices.getDialect().getDefaultProperties());
properties.putAll(props);
// Transaction settings:
settings.setJtaPlatform(serviceRegistry.getService(JtaPlatform.class));
MultiTableBulkIdStrategy multiTableBulkIdStrategy =
serviceRegistry
.getService(StrategySelector.class)
.resolveStrategy(
MultiTableBulkIdStrategy.class,
properties.getProperty(AvailableSettings.HQL_BULK_ID_STRATEGY));
if (multiTableBulkIdStrategy == null) {
multiTableBulkIdStrategy =
jdbcServices.getDialect().supportsTemporaryTables()
? TemporaryTableBulkIdStrategy.INSTANCE
: new PersistentTableBulkIdStrategy();
}
settings.setMultiTableBulkIdStrategy(multiTableBulkIdStrategy);
boolean flushBeforeCompletion =
ConfigurationHelper.getBoolean(AvailableSettings.FLUSH_BEFORE_COMPLETION, properties);
if (debugEnabled) {
LOG.debugf(
"Automatic flush during beforeCompletion(): %s", enabledDisabled(flushBeforeCompletion));
}
settings.setFlushBeforeCompletionEnabled(flushBeforeCompletion);
boolean autoCloseSession =
ConfigurationHelper.getBoolean(AvailableSettings.AUTO_CLOSE_SESSION, properties);
if (debugEnabled) {
LOG.debugf(
"Automatic session close at end of transaction: %s", enabledDisabled(autoCloseSession));
}
settings.setAutoCloseSessionEnabled(autoCloseSession);
// JDBC and connection settings:
int batchSize =
ConfigurationHelper.getInt(AvailableSettings.STATEMENT_BATCH_SIZE, properties, 0);
if (!meta.supportsBatchUpdates()) {
batchSize = 0;
}
if (batchSize > 0 && debugEnabled) {
LOG.debugf("JDBC batch size: %s", batchSize);
}
settings.setJdbcBatchSize(batchSize);
boolean jdbcBatchVersionedData =
ConfigurationHelper.getBoolean(AvailableSettings.BATCH_VERSIONED_DATA, properties, false);
if (batchSize > 0 && debugEnabled) {
LOG.debugf(
"JDBC batch updates for versioned data: %s", enabledDisabled(jdbcBatchVersionedData));
}
settings.setJdbcBatchVersionedData(jdbcBatchVersionedData);
boolean useScrollableResultSets =
ConfigurationHelper.getBoolean(
AvailableSettings.USE_SCROLLABLE_RESULTSET,
properties,
meta.supportsScrollableResults());
if (debugEnabled) {
LOG.debugf("Scrollable result sets: %s", enabledDisabled(useScrollableResultSets));
}
settings.setScrollableResultSetsEnabled(useScrollableResultSets);
boolean wrapResultSets =
ConfigurationHelper.getBoolean(AvailableSettings.WRAP_RESULT_SETS, properties, false);
if (debugEnabled) {
LOG.debugf("Wrap result sets: %s", enabledDisabled(wrapResultSets));
}
settings.setWrapResultSetsEnabled(wrapResultSets);
boolean useGetGeneratedKeys =
ConfigurationHelper.getBoolean(
AvailableSettings.USE_GET_GENERATED_KEYS, properties, meta.supportsGetGeneratedKeys());
if (debugEnabled) {
LOG.debugf("JDBC3 getGeneratedKeys(): %s", enabledDisabled(useGetGeneratedKeys));
}
settings.setGetGeneratedKeysEnabled(useGetGeneratedKeys);
Integer statementFetchSize =
ConfigurationHelper.getInteger(AvailableSettings.STATEMENT_FETCH_SIZE, properties);
if (statementFetchSize != null && debugEnabled) {
LOG.debugf("JDBC result set fetch size: %s", statementFetchSize);
}
settings.setJdbcFetchSize(statementFetchSize);
MultiTenancyStrategy multiTenancyStrategy =
MultiTenancyStrategy.determineMultiTenancyStrategy(properties);
if (debugEnabled) {
LOG.debugf("multi-tenancy strategy : %s", multiTenancyStrategy);
}
settings.setMultiTenancyStrategy(multiTenancyStrategy);
String releaseModeName =
ConfigurationHelper.getString(AvailableSettings.RELEASE_CONNECTIONS, properties, "auto");
if (debugEnabled) {
LOG.debugf("Connection release mode: %s", releaseModeName);
}
ConnectionReleaseMode releaseMode;
if ("auto".equals(releaseModeName)) {
releaseMode = serviceRegistry.getService(TransactionFactory.class).getDefaultReleaseMode();
} else {
releaseMode = ConnectionReleaseMode.parse(releaseModeName);
if (releaseMode == ConnectionReleaseMode.AFTER_STATEMENT) {
// we need to make sure the underlying JDBC connection access supports aggressive release...
boolean supportsAgrressiveRelease =
multiTenancyStrategy.requiresMultiTenantConnectionProvider()
? serviceRegistry
.getService(MultiTenantConnectionProvider.class)
.supportsAggressiveRelease()
: serviceRegistry.getService(ConnectionProvider.class).supportsAggressiveRelease();
if (!supportsAgrressiveRelease) {
LOG.unsupportedAfterStatement();
releaseMode = ConnectionReleaseMode.AFTER_TRANSACTION;
}
}
}
settings.setConnectionReleaseMode(releaseMode);
final BatchFetchStyle batchFetchStyle =
BatchFetchStyle.interpret(properties.get(AvailableSettings.BATCH_FETCH_STYLE));
LOG.debugf("Using BatchFetchStyle : " + batchFetchStyle.name());
settings.setBatchFetchStyle(batchFetchStyle);
// SQL Generation settings:
String defaultSchema = properties.getProperty(AvailableSettings.DEFAULT_SCHEMA);
String defaultCatalog = properties.getProperty(AvailableSettings.DEFAULT_CATALOG);
if (defaultSchema != null && debugEnabled) {
LOG.debugf("Default schema: %s", defaultSchema);
}
if (defaultCatalog != null && debugEnabled) {
LOG.debugf("Default catalog: %s", defaultCatalog);
}
settings.setDefaultSchemaName(defaultSchema);
settings.setDefaultCatalogName(defaultCatalog);
Integer maxFetchDepth =
ConfigurationHelper.getInteger(AvailableSettings.MAX_FETCH_DEPTH, properties);
if (maxFetchDepth != null) {
LOG.debugf("Maximum outer join fetch depth: %s", maxFetchDepth);
}
settings.setMaximumFetchDepth(maxFetchDepth);
int batchFetchSize =
ConfigurationHelper.getInt(AvailableSettings.DEFAULT_BATCH_FETCH_SIZE, properties, 1);
if (debugEnabled) {
LOG.debugf("Default batch fetch size: %s", batchFetchSize);
}
settings.setDefaultBatchFetchSize(batchFetchSize);
boolean comments =
ConfigurationHelper.getBoolean(AvailableSettings.USE_SQL_COMMENTS, properties);
if (debugEnabled) {
LOG.debugf("Generate SQL with comments: %s", enabledDisabled(comments));
}
settings.setCommentsEnabled(comments);
boolean orderUpdates =
ConfigurationHelper.getBoolean(AvailableSettings.ORDER_UPDATES, properties);
if (debugEnabled) {
LOG.debugf("Order SQL updates by primary key: %s", enabledDisabled(orderUpdates));
}
settings.setOrderUpdatesEnabled(orderUpdates);
boolean orderInserts =
ConfigurationHelper.getBoolean(AvailableSettings.ORDER_INSERTS, properties);
if (debugEnabled) {
LOG.debugf("Order SQL inserts for batching: %s", enabledDisabled(orderInserts));
}
settings.setOrderInsertsEnabled(orderInserts);
String defaultNullPrecedence =
ConfigurationHelper.getString(
AvailableSettings.DEFAULT_NULL_ORDERING, properties, "none", "first", "last");
if (debugEnabled) {
LOG.debugf("Default null ordering: %s", defaultNullPrecedence);
}
settings.setDefaultNullPrecedence(NullPrecedence.parse(defaultNullPrecedence));
// Query parser settings:
settings.setQueryTranslatorFactory(createQueryTranslatorFactory(properties, serviceRegistry));
Map querySubstitutions =
ConfigurationHelper.toMap(
AvailableSettings.QUERY_SUBSTITUTIONS, " ,=;:\n\t\r\f", properties);
if (debugEnabled) {
LOG.debugf("Query language substitutions: %s", querySubstitutions);
}
settings.setQuerySubstitutions(querySubstitutions);
boolean jpaqlCompliance =
ConfigurationHelper.getBoolean(
AvailableSettings.JPAQL_STRICT_COMPLIANCE, properties, false);
if (debugEnabled) {
LOG.debugf("JPA-QL strict compliance: %s", enabledDisabled(jpaqlCompliance));
}
settings.setStrictJPAQLCompliance(jpaqlCompliance);
// Second-level / query cache:
boolean useSecondLevelCache =
ConfigurationHelper.getBoolean(AvailableSettings.USE_SECOND_LEVEL_CACHE, properties, true);
if (debugEnabled) {
LOG.debugf("Second-level cache: %s", enabledDisabled(useSecondLevelCache));
}
settings.setSecondLevelCacheEnabled(useSecondLevelCache);
boolean useQueryCache =
ConfigurationHelper.getBoolean(AvailableSettings.USE_QUERY_CACHE, properties);
if (debugEnabled) {
LOG.debugf("Query cache: %s", enabledDisabled(useQueryCache));
}
settings.setQueryCacheEnabled(useQueryCache);
if (useQueryCache) {
settings.setQueryCacheFactory(createQueryCacheFactory(properties, serviceRegistry));
}
// The cache provider is needed when we either have second-level cache enabled
// or query cache enabled. Note that useSecondLevelCache is enabled by default
settings.setRegionFactory(
createRegionFactory(properties, (useSecondLevelCache || useQueryCache), serviceRegistry));
boolean useMinimalPuts =
ConfigurationHelper.getBoolean(
AvailableSettings.USE_MINIMAL_PUTS,
properties,
settings.getRegionFactory().isMinimalPutsEnabledByDefault());
if (debugEnabled) {
LOG.debugf("Optimize cache for minimal puts: %s", enabledDisabled(useMinimalPuts));
}
settings.setMinimalPutsEnabled(useMinimalPuts);
String prefix = properties.getProperty(AvailableSettings.CACHE_REGION_PREFIX);
if (StringHelper.isEmpty(prefix)) {
prefix = null;
}
if (prefix != null && debugEnabled) {
LOG.debugf("Cache region prefix: %s", prefix);
}
settings.setCacheRegionPrefix(prefix);
boolean useStructuredCacheEntries =
ConfigurationHelper.getBoolean(AvailableSettings.USE_STRUCTURED_CACHE, properties, false);
if (debugEnabled) {
LOG.debugf(
"Structured second-level cache entries: %s", enabledDisabled(useStructuredCacheEntries));
}
settings.setStructuredCacheEntriesEnabled(useStructuredCacheEntries);
boolean useDirectReferenceCacheEntries =
ConfigurationHelper.getBoolean(
AvailableSettings.USE_DIRECT_REFERENCE_CACHE_ENTRIES, properties, false);
if (debugEnabled) {
LOG.debugf(
"Second-level cache direct-reference entries: %s",
enabledDisabled(useDirectReferenceCacheEntries));
}
settings.setDirectReferenceCacheEntriesEnabled(useDirectReferenceCacheEntries);
// Statistics and logging:
boolean useStatistics =
ConfigurationHelper.getBoolean(AvailableSettings.GENERATE_STATISTICS, properties);
if (debugEnabled) {
LOG.debugf("Statistics: %s", enabledDisabled(useStatistics));
}
settings.setStatisticsEnabled(useStatistics);
boolean useIdentifierRollback =
ConfigurationHelper.getBoolean(AvailableSettings.USE_IDENTIFIER_ROLLBACK, properties);
if (debugEnabled) {
LOG.debugf(
"Deleted entity synthetic identifier rollback: %s",
enabledDisabled(useIdentifierRollback));
}
settings.setIdentifierRollbackEnabled(useIdentifierRollback);
// Schema export:
String autoSchemaExport = properties.getProperty(AvailableSettings.HBM2DDL_AUTO);
if ("validate".equals(autoSchemaExport)) {
settings.setAutoValidateSchema(true);
}
if ("update".equals(autoSchemaExport)) {
settings.setAutoUpdateSchema(true);
}
if ("create".equals(autoSchemaExport)) {
settings.setAutoCreateSchema(true);
}
if ("create-drop".equals(autoSchemaExport)) {
settings.setAutoCreateSchema(true);
settings.setAutoDropSchema(true);
}
settings.setImportFiles(properties.getProperty(AvailableSettings.HBM2DDL_IMPORT_FILES));
EntityMode defaultEntityMode =
EntityMode.parse(properties.getProperty(AvailableSettings.DEFAULT_ENTITY_MODE));
if (debugEnabled) {
LOG.debugf("Default entity-mode: %s", defaultEntityMode);
}
settings.setDefaultEntityMode(defaultEntityMode);
boolean namedQueryChecking =
ConfigurationHelper.getBoolean(AvailableSettings.QUERY_STARTUP_CHECKING, properties, true);
if (debugEnabled) {
LOG.debugf("Named query checking : %s", enabledDisabled(namedQueryChecking));
}
settings.setNamedQueryStartupCheckingEnabled(namedQueryChecking);
boolean checkNullability =
ConfigurationHelper.getBoolean(AvailableSettings.CHECK_NULLABILITY, properties, true);
if (debugEnabled) {
LOG.debugf(
"Check Nullability in Core (should be disabled when Bean Validation is on): %s",
enabledDisabled(checkNullability));
}
settings.setCheckNullability(checkNullability);
// TODO: Does EntityTuplizerFactory really need to be configurable? revisit for HHH-6383
settings.setEntityTuplizerFactory(new EntityTuplizerFactory());
// String provider = properties.getProperty( AvailableSettings.BYTECODE_PROVIDER );
// log.info( "Bytecode provider name : " + provider );
// BytecodeProvider bytecodeProvider = buildBytecodeProvider( provider );
// settings.setBytecodeProvider( bytecodeProvider );
boolean initializeLazyStateOutsideTransactionsEnabled =
ConfigurationHelper.getBoolean(
AvailableSettings.ENABLE_LAZY_LOAD_NO_TRANS, properties, false);
if (debugEnabled) {
LOG.debugf(
"Allow initialization of lazy state outside session : : %s",
enabledDisabled(initializeLazyStateOutsideTransactionsEnabled));
}
settings.setInitializeLazyStateOutsideTransactions(
initializeLazyStateOutsideTransactionsEnabled);
return settings;
}