Package org.hibernate.envers.configuration

Class Configuration

java.lang.Object

org.hibernate.envers.configuration.Configuration

public class Configuration
extends Object

Envers configuration.

Constructor Summary

Constructors

Constructor	Description
Configuration(Properties properties, EnversService enversService, MetadataImplementor metadata)

Method Summary

Modifier and Type	Method	Description
void	addCustomAuditTableName(String entityName, String tableName)
String	getAuditEntityName(String entityName)	todo: move this Get the audit enttiy name.
AuditStrategy	getAuditStrategy()
String	getAuditStrategyName()
String	getAuditTableName(String entityName, String tableName)	Gets the audit table name by looking up the entity in the defined custom tables and if not found returns a prefixed, suffixed audit table name.
String	getCorrelatedSubqueryOperator()
String	getDefaultCatalogName()
String	getDefaultSchemaName()
String	getEmbeddableSetOrdinalPropertyName()
EnversService	getEnversService()	Returns a reference to the EnversService.
ModifiedColumnNamingStrategy	getModifiedColumnNamingStrategy()
String	getModifiedFlagsSuffix()
String	getOriginalIdPropertyName()
String	getRevisionEndFieldName()
String	getRevisionEndTimestampFieldName()
String	getRevisionFieldName()
RevisionInfoConfiguration	getRevisionInfo()
Class<? extends RevisionListener>	getRevisionListenerClass()
String	getRevisionNumberPath()
String	getRevisionPropertyPath(String propertyName)	todo: move this Get the revision property path.
String	getRevisionTypePropertyName()
String	getRevisionTypePropertyType()
boolean	hasSettingForUseModifiedFlag()
boolean	isAllowIdentifierReuse()
boolean	isCascadeDeleteRevision()
boolean	isDoNotAuditOptimisticLockingField()
boolean	isFindByRevisionExactMatch()
boolean	isGenerateRevisionsForCollections()
boolean	isGlobalLegacyRelationTargetNotFound()
boolean	isModifiedFlagsEnabled()
boolean	isNativeIdEnabled()
boolean	isRevisionEndTimestampEnabled()
boolean	isRevisionEndTimestampNumeric()
boolean	isRevisionEndTimestampUseLegacyPlacement()
boolean	isRevisionSequenceNoCache()
boolean	isStoreDataAtDelete()
boolean	isTrackEntitiesChanged()
void	setTrackEntitiesChanged(boolean trackEntitiesChanged)

Methods inherited from class java.lang.Object

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

Constructor Detail

Configuration

public Configuration(Properties properties,
                     EnversService enversService,
                     MetadataImplementor metadata)

Method Detail

isGenerateRevisionsForCollections

public boolean isGenerateRevisionsForCollections()

isDoNotAuditOptimisticLockingField

public boolean isDoNotAuditOptimisticLockingField()

isStoreDataAtDelete

public boolean isStoreDataAtDelete()

isTrackEntitiesChanged

public boolean isTrackEntitiesChanged()

setTrackEntitiesChanged

public void setTrackEntitiesChanged(boolean trackEntitiesChanged)

hasSettingForUseModifiedFlag

public boolean hasSettingForUseModifiedFlag()

isModifiedFlagsEnabled

public boolean isModifiedFlagsEnabled()

isNativeIdEnabled

public boolean isNativeIdEnabled()

isCascadeDeleteRevision

public boolean isCascadeDeleteRevision()

isAllowIdentifierReuse

public boolean isAllowIdentifierReuse()

isFindByRevisionExactMatch

public boolean isFindByRevisionExactMatch()

isGlobalLegacyRelationTargetNotFound

public boolean isGlobalLegacyRelationTargetNotFound()

isRevisionEndTimestampEnabled

public boolean isRevisionEndTimestampEnabled()

isRevisionEndTimestampNumeric

public boolean isRevisionEndTimestampNumeric()

isRevisionEndTimestampUseLegacyPlacement

public boolean isRevisionEndTimestampUseLegacyPlacement()

isRevisionSequenceNoCache

public boolean isRevisionSequenceNoCache()

getDefaultCatalogName

public String getDefaultCatalogName()

getDefaultSchemaName

public String getDefaultSchemaName()

getCorrelatedSubqueryOperator

public String getCorrelatedSubqueryOperator()

getModifiedFlagsSuffix

public String getModifiedFlagsSuffix()

getOriginalIdPropertyName

public String getOriginalIdPropertyName()

getRevisionFieldName

public String getRevisionFieldName()

getRevisionEndTimestampFieldName

public String getRevisionEndTimestampFieldName()

getRevisionEndFieldName

public String getRevisionEndFieldName()

getRevisionNumberPath

public String getRevisionNumberPath()

getRevisionPropertyPath

public String getRevisionPropertyPath(String propertyName)

todo: move this Get the revision property path.

Parameters:

propertyName - the property name within the revision entity

Returns:

path to the given property of the revision entity associated with the audited entity

getRevisionTypePropertyName

public String getRevisionTypePropertyName()

getRevisionTypePropertyType

public String getRevisionTypePropertyType()

getAuditEntityName

public String getAuditEntityName(String entityName)

todo: move this Get the audit enttiy name.

Parameters:

entityName - the entity name

Returns:

the prefixed and suffixed audit entity name based on configuration

addCustomAuditTableName

public void addCustomAuditTableName(String entityName,
                                    String tableName)

getAuditTableName

public String getAuditTableName(String entityName,
                                String tableName)

Gets the audit table name by looking up the entity in the defined custom tables and if not found returns a prefixed, suffixed audit table name. In the latter case, the name is not registered.

Parameters:

entityName - the entity name

tableName - the table name

Returns:

the audit table name either from the custom defined tables or prefixed/suffixed inline

getAuditStrategyName

public String getAuditStrategyName()

getEmbeddableSetOrdinalPropertyName

public String getEmbeddableSetOrdinalPropertyName()

getRevisionListenerClass

public Class<? extends RevisionListener> getRevisionListenerClass()

getAuditStrategy

public AuditStrategy getAuditStrategy()

getModifiedColumnNamingStrategy

public ModifiedColumnNamingStrategy getModifiedColumnNamingStrategy()

getRevisionInfo

public RevisionInfoConfiguration getRevisionInfo()

getEnversService

public EnversService getEnversService()

Returns a reference to the EnversService. This method is not recommended and discouraged, will be removed in a future release.

Returns:

the envers service