Package org.hibernate.envers.boot.internal

Interface EnversService

All Superinterfaces:

Serializable, org.hibernate.service.Service

All Known Implementing Classes:

EnversServiceImpl

public interface EnversService
extends org.hibernate.service.Service

Provides central access to Envers' configuration. In many ways, this replaces the legacy static map Envers used originally as a means to share the old AuditConfiguration.

Author:

Steve Ebersole, Chris Cranford

Field Summary

Fields

Modifier and Type	Field	Description
static String	INTEGRATION_ENABLED	The name of the configuration setting used to control whether the Envers integration is enabled.

Method Summary

Modifier and Type	Method	Description
AuditProcessManager	getAuditProcessManager()
AuditStrategy	getAuditStrategy()
org.hibernate.boot.registry.classloading.spi.ClassLoaderService	getClassLoaderService()
Configuration	getConfig()
EntitiesConfigurations	getEntitiesConfigurations()
ModifiedEntityNamesReader	getModifiedEntityNamesReader()
RevisionInfoNumberReader	getRevisionInfoNumberReader()
RevisionInfoQueryCreator	getRevisionInfoQueryCreator()
org.hibernate.service.ServiceRegistry	getServiceRegistry()
void	initialize(org.hibernate.boot.spi.MetadataImplementor metadata, MappingCollector mappingCollector)
boolean	isEnabled()	Is the Envers integration enabled? This is generally used as a protection for other Envers services (in the ServiceLoader sense) determine whether they should do their work.
boolean	isInitialized()	Assuming isEnabled() is true, has initialize(org.hibernate.boot.spi.MetadataImplementor, org.hibernate.envers.configuration.internal.MappingCollector) been called yet?

Field Detail

INTEGRATION_ENABLED

static final String INTEGRATION_ENABLED

The name of the configuration setting used to control whether the Envers integration is enabled. Default is true

See Also:

Constant Field Values

Method Detail

isEnabled

boolean isEnabled()

Is the Envers integration enabled? This is generally used as a protection for other Envers services (in the ServiceLoader sense) determine whether they should do their work.

Returns:

true If the integration is enabled; false otherwise.

isInitialized

boolean isInitialized()

Assuming isEnabled() is true, has initialize(org.hibernate.boot.spi.MetadataImplementor, org.hibernate.envers.configuration.internal.MappingCollector) been called yet?

Returns:

true indicates initialize(org.hibernate.boot.spi.MetadataImplementor, org.hibernate.envers.configuration.internal.MappingCollector) has been called; false indicates that initialize(org.hibernate.boot.spi.MetadataImplementor, org.hibernate.envers.configuration.internal.MappingCollector) has not (yet) been called.

initialize

void initialize(org.hibernate.boot.spi.MetadataImplementor metadata,
                MappingCollector mappingCollector)

getConfig

Configuration getConfig()

getAuditProcessManager

AuditProcessManager getAuditProcessManager()

getAuditStrategy

AuditStrategy getAuditStrategy()

getEntitiesConfigurations

EntitiesConfigurations getEntitiesConfigurations()

getRevisionInfoQueryCreator

RevisionInfoQueryCreator getRevisionInfoQueryCreator()

getRevisionInfoNumberReader

RevisionInfoNumberReader getRevisionInfoNumberReader()

getModifiedEntityNamesReader

ModifiedEntityNamesReader getModifiedEntityNamesReader()

getClassLoaderService

org.hibernate.boot.registry.classloading.spi.ClassLoaderService getClassLoaderService()

getServiceRegistry

org.hibernate.service.ServiceRegistry getServiceRegistry()