AbstractTopiaApplicationContext (ToPIA :: Persistence 3.2.2-SNAPSHOT API)

java.lang.Object
- org.nuiton.topia.persistence.internal.AbstractTopiaApplicationContext<K>

All Implemented Interfaces:

Closeable, AutoCloseable, TopiaListenableSupport, TopiaServiceSupport, TopiaApplicationContext<K>
```
public abstract class AbstractTopiaApplicationContext<K extends TopiaPersistenceContext>
extends Object
implements TopiaApplicationContext<K>
```
The application context is the main class in ToPIA usage. This class is a kind of equivalent of the RootTopiaContext. It contains only high level methods and new contexts creation (transaction begin, ...). This class has to be extended by the user, even if some default one could be automatically generated.

Since:

3.0

Author:

Arnaud Thimel (Code Lutin)

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`closed`
`protected TopiaConfiguration`	`configuration`
`protected HibernateProvider`	`hibernateProvider`
`protected Set<TopiaPersistenceContext>`	`persistenceContexts` A set of known initialized opened persistence contexts.
`protected TopiaHibernateSessionRegistry`	`sessionRegistry`
`protected TopiaFiresSupport`	`topiaFiresSupport`
`protected TopiaIdFactory`	`topiaIdFactory`
`protected TopiaServiceSupport`	`topiaServiceSupport`

Constructor Summary

Constructors
Constructor and Description
`AbstractTopiaApplicationContext(Map<String,String> map)` Deprecated. use `AbstractTopiaApplicationContext(org.nuiton.topia.persistence.TopiaConfiguration)`
`AbstractTopiaApplicationContext(Properties properties)` Deprecated. use `AbstractTopiaApplicationContext(org.nuiton.topia.persistence.TopiaConfiguration)`
`AbstractTopiaApplicationContext(TopiaConfiguration configuration)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPropertyChangeListener(PropertyChangeListener listener)` Register to the context a PropertyChangeListener about some entity's property change.
`void`	`addTopiaEntitiesVetoable(TopiaEntitiesVetoable vetoable)` Register to the context a TopiaEntitiesVetoable about any TopiaEntity.
`void`	`addTopiaEntityListener(Class<? extends TopiaEntity> entityClass, TopiaEntityListener listener)` Register to the context a TopiaEntityListener about the given entity class.
`void`	`addTopiaEntityListener(TopiaEntityListener listener)` Register to the context a TopiaEntityListener about any TopiaEntity.
`void`	`addTopiaEntityVetoable(Class<? extends TopiaEntity> entityClass, TopiaEntityVetoable vetoable)` Register to the context a TopiaEntityVetoable about the given entity class.
`void`	`addTopiaEntityVetoable(TopiaEntityVetoable vetoable)` Register to the context a TopiaEntityVetoable about any TopiaEntity.
`void`	`addTopiaSchemaListener(TopiaSchemaListener listener)` Register to the context a TopiaSchemaListener about any schema modification.
`void`	`addTopiaTransactionListener(TopiaTransactionListener listener)` Register to the context a TopiaTransactionListener about the transaction.
`void`	`addTopiaTransactionVetoable(TopiaTransactionVetoable vetoable)` Register to the context a TopiaTransactionVetoable about the transaction.
`void`	`close()` Method to call when the application is going for shutdown.
`void`	`createSchema()`
`void`	`dropSchema()`
`TopiaConfiguration`	`getConfiguration()`
`HibernateProvider`	`getHibernateProvider()`
`protected abstract Set<Class<? extends TopiaEntity>>`	`getImplementationClasses()`
`List<Class<?>>`	`getPersistenceClasses()`
`String`	`getSchemaName()`
`com.google.common.collect.ImmutableSet<String>`	`getSchemaNames()`
`Map<String,TopiaService>`	`getServices()`
`<T extends TopiaService> Map<String,T>`	`getServices(Class<T> interfaceService)`
`TopiaHibernateSessionRegistry`	`getSessionRegistry()`
`protected TopiaFiresSupport`	`getTopiaFiresSupport()`
`protected TopiaIdFactory`	`getTopiaIdFactory()`
`protected void`	`init()`
`void`	`initSchema()` Will make everything possible to ensure the schema is ready to use.
`protected void`	`initServices()`
`boolean`	`isClosed()`
`protected boolean`	`isInitSchema()` If application context should init schema.
`boolean`	`isOpened()`
`boolean`	`isSchemaEmpty()`
`boolean`	`isTableExists(Class<?> clazz)`
`protected void`	`registerPersistenceContext(TopiaPersistenceContext persistenceContext)`
`void`	`removePropertyChangeListener(PropertyChangeListener listener)` Unregister the given PropertyChangeListener about some entity's property change from the context
`void`	`removeTopiaEntitiesVetoable(TopiaEntitiesVetoable vetoable)` Unregister the given TopiaEntitiesVetoable about any TopiaEntity from the context
`void`	`removeTopiaEntityListener(Class<? extends TopiaEntity> entityClass, TopiaEntityListener listener)` Unregister the given TopiaEntityListener about the given entity class from the context
`void`	`removeTopiaEntityListener(TopiaEntityListener listener)` Unregister the given TopiaEntityListener about any TopiaEntity from the context
`void`	`removeTopiaEntityVetoable(Class<? extends TopiaEntity> entityClass, TopiaEntityVetoable vetoable)` Unregister the given TopiaEntityVetoable about the given entity class from the context
`void`	`removeTopiaEntityVetoable(TopiaEntityVetoable vetoable)` Unregister the given TopiaEntityVetoable about any TopiaEntity from the context
`void`	`removeTopiaSchemaListener(TopiaSchemaListener listener)` Unregister the given TopiaSchemaListener about any schema modification from the context
`void`	`removeTopiaTransactionListener(TopiaTransactionListener listener)` Unregister the given TopiaTransactionListener about the transaction from the context
`void`	`removeTopiaTransactionVetoable(TopiaTransactionVetoable vetoable)` Unregister the given TopiaTransactionVetoable about the transaction from the context
`void`	`showCreateSchema()`
`void`	`updateSchema()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.nuiton.topia.persistence.TopiaApplicationContext
getContractClass, getContractClasses, getImplementationClass, getModelName, getModelVersion, newPersistenceContext

- Field Detail
  - topiaIdFactory
```
protected TopiaIdFactory topiaIdFactory
```
  - configuration
```
protected TopiaConfiguration configuration
```
  - topiaFiresSupport
```
protected TopiaFiresSupport topiaFiresSupport
```
  - topiaServiceSupport
```
protected TopiaServiceSupport topiaServiceSupport
```
  - hibernateProvider
```
protected HibernateProvider hibernateProvider
```
  - sessionRegistry
```
protected TopiaHibernateSessionRegistry sessionRegistry
```
  - closed
```
protected boolean closed
```
  - persistenceContexts
```
protected Set<TopiaPersistenceContext> persistenceContexts
```
    A set of known initialized opened persistence contexts. This set is mainly used to trigger shutdown on these persistence contexts when the application context is closed.
- Constructor Detail
  - AbstractTopiaApplicationContext
```
@Deprecated
public AbstractTopiaApplicationContext(Properties properties)
```
    Deprecated. use AbstractTopiaApplicationContext(org.nuiton.topia.persistence.TopiaConfiguration)
    
    Parameters:
    
    properties - FIXME
  - AbstractTopiaApplicationContext
```
@Deprecated
public AbstractTopiaApplicationContext(Map<String,String> map)
```
    Deprecated. use AbstractTopiaApplicationContext(org.nuiton.topia.persistence.TopiaConfiguration)
    
    Parameters:
    
    map - FIXME
  - AbstractTopiaApplicationContext
```
public AbstractTopiaApplicationContext(TopiaConfiguration configuration)
```
- Method Detail
  - init
```
protected void init()
```
  - initServices
```
protected void initServices()
```
  - isInitSchema
```
protected boolean isInitSchema()
```
    If application context should init schema. This simple check is in its own method so it can be overridden.
    
    Returns:
    
    FIXME
    
    See Also:
    
    TopiaConfiguration.isInitSchema()
  - initSchema
```
public void initSchema()
```
    Will make everything possible to ensure the schema is ready to use. It will create unless it already exists. If it already exists, we will try to find a migration service and call it.
    
    Specified by:
    
    initSchema in interface TopiaApplicationContext<K extends TopiaPersistenceContext>
  - getImplementationClasses
```
protected abstract Set<Class<? extends TopiaEntity>> getImplementationClasses()
```
  - registerPersistenceContext
```
protected void registerPersistenceContext(TopiaPersistenceContext persistenceContext)
```
  - getHibernateProvider
```
public HibernateProvider getHibernateProvider()
```
  - getTopiaFiresSupport
```
protected TopiaFiresSupport getTopiaFiresSupport()
```
  - getConfiguration
```
public TopiaConfiguration getConfiguration()
```
    Specified by:
    
    getConfiguration in interface TopiaApplicationContext<K extends TopiaPersistenceContext>
  - getTopiaIdFactory
```
protected TopiaIdFactory getTopiaIdFactory()
```
  - getSessionRegistry
```
public TopiaHibernateSessionRegistry getSessionRegistry()
```
  - addTopiaEntityListener
```
public void addTopiaEntityListener(TopiaEntityListener listener)
```
    Description copied from interface: TopiaListenableSupport
    
    Register to the context a TopiaEntityListener about any TopiaEntity. listener instance will be notified AFTER any operation on the entity.
    
    Specified by:
    
    addTopiaEntityListener in interface TopiaListenableSupport
    
    Parameters:
    
    listener - the listener instance to register
  - addTopiaEntityListener
```
public void addTopiaEntityListener(Class<? extends TopiaEntity> entityClass,
                                   TopiaEntityListener listener)
```
    Description copied from interface: TopiaListenableSupport
    
    Register to the context a TopiaEntityListener about the given entity class. listener instance will be notified AFTER any operation on the entity.
    
    Specified by:
    
    addTopiaEntityListener in interface TopiaListenableSupport
    
    Parameters:
    
    entityClass - the TopiaEntity's class to listen
    
    listener - the listener instance to register
  - removeTopiaEntityListener
```
public void removeTopiaEntityListener(TopiaEntityListener listener)
```
    Description copied from interface: TopiaListenableSupport
    
    Unregister the given TopiaEntityListener about any TopiaEntity from the context
    
    Specified by:
    
    removeTopiaEntityListener in interface TopiaListenableSupport
    
    Parameters:
    
    listener - the listener instance to unregister
  - removeTopiaEntityListener
```
public void removeTopiaEntityListener(Class<? extends TopiaEntity> entityClass,
                                      TopiaEntityListener listener)
```
    Description copied from interface: TopiaListenableSupport
    
    Unregister the given TopiaEntityListener about the given entity class from the context
    
    Specified by:
    
    removeTopiaEntityListener in interface TopiaListenableSupport
    
    Parameters:
    
    entityClass - the listened TopiaEntity's class
    
    listener - the listener instance to unregister
  - addTopiaEntityVetoable
```
public void addTopiaEntityVetoable(TopiaEntityVetoable vetoable)
```
    Description copied from interface: TopiaListenableSupport
    
    Register to the context a TopiaEntityVetoable about any TopiaEntity. vetoable instance will be notified BEFORE any operation on the entity.
    
    Specified by:
    
    addTopiaEntityVetoable in interface TopiaListenableSupport
    
    Parameters:
    
    vetoable - the vetoable instance to register
  - addTopiaEntityVetoable
```
public void addTopiaEntityVetoable(Class<? extends TopiaEntity> entityClass,
                                   TopiaEntityVetoable vetoable)
```
    Description copied from interface: TopiaListenableSupport
    
    Register to the context a TopiaEntityVetoable about the given entity class. vetoable instance will be notified BEFORE any operation on the entity.
    
    Specified by:
    
    addTopiaEntityVetoable in interface TopiaListenableSupport
    
    Parameters:
    
    entityClass - the TopiaEntity's class to listen
    
    vetoable - the vetoable instance to register
  - removeTopiaEntityVetoable
```
public void removeTopiaEntityVetoable(TopiaEntityVetoable vetoable)
```
    Description copied from interface: TopiaListenableSupport
    
    Unregister the given TopiaEntityVetoable about any TopiaEntity from the context
    
    Specified by:
    
    removeTopiaEntityVetoable in interface TopiaListenableSupport
    
    Parameters:
    
    vetoable - the vetoable instance to unregister
  - removeTopiaEntityVetoable
```
public void removeTopiaEntityVetoable(Class<? extends TopiaEntity> entityClass,
                                      TopiaEntityVetoable vetoable)
```
    Description copied from interface: TopiaListenableSupport
    
    Unregister the given TopiaEntityVetoable about the given entity class from the context
    
    Specified by:
    
    removeTopiaEntityVetoable in interface TopiaListenableSupport
    
    Parameters:
    
    entityClass - the listened TopiaEntity's class
    
    vetoable - the vetoable instance to unregister
  - addTopiaEntitiesVetoable
```
public void addTopiaEntitiesVetoable(TopiaEntitiesVetoable vetoable)
```
    Description copied from interface: TopiaListenableSupport
    
    Register to the context a TopiaEntitiesVetoable about any TopiaEntity. vetoable instance will be notified BEFORE any entity load
    
    Specified by:
    
    addTopiaEntitiesVetoable in interface TopiaListenableSupport
    
    Parameters:
    
    vetoable - the vetoable instance to register
  - removeTopiaEntitiesVetoable
```
public void removeTopiaEntitiesVetoable(TopiaEntitiesVetoable vetoable)
```
    Description copied from interface: TopiaListenableSupport
    
    Unregister the given TopiaEntitiesVetoable about any TopiaEntity from the context
    
    Specified by:
    
    removeTopiaEntitiesVetoable in interface TopiaListenableSupport
    
    Parameters:
    
    vetoable - the vetoable instance to unregister
  - addTopiaTransactionListener
```
public void addTopiaTransactionListener(TopiaTransactionListener listener)
```
    Description copied from interface: TopiaListenableSupport
    
    Register to the context a TopiaTransactionListener about the transaction. listener instance will be notified AFTER any operation on the transaction.
    
    Specified by:
    
    addTopiaTransactionListener in interface TopiaListenableSupport
    
    Parameters:
    
    listener - the listener instance to register
  - removeTopiaTransactionListener
```
public void removeTopiaTransactionListener(TopiaTransactionListener listener)
```
    Description copied from interface: TopiaListenableSupport
    
    Unregister the given TopiaTransactionListener about the transaction from the context
    
    Specified by:
    
    removeTopiaTransactionListener in interface TopiaListenableSupport
    
    Parameters:
    
    listener - the listener instance to unregister
  - addTopiaTransactionVetoable
```
public void addTopiaTransactionVetoable(TopiaTransactionVetoable vetoable)
```
    Description copied from interface: TopiaListenableSupport
    
    Register to the context a TopiaTransactionVetoable about the transaction. vetoable instance will be notified BEFORE any operation on the transaction.
    
    Specified by:
    
    addTopiaTransactionVetoable in interface TopiaListenableSupport
    
    Parameters:
    
    vetoable - the vetoable instance to register
  - removeTopiaTransactionVetoable
```
public void removeTopiaTransactionVetoable(TopiaTransactionVetoable vetoable)
```
    Description copied from interface: TopiaListenableSupport
    
    Unregister the given TopiaTransactionVetoable about the transaction from the context
    
    Specified by:
    
    removeTopiaTransactionVetoable in interface TopiaListenableSupport
    
    Parameters:
    
    vetoable - the vetoable instance to unregister
  - addPropertyChangeListener
```
public void addPropertyChangeListener(PropertyChangeListener listener)
```
    Description copied from interface: TopiaListenableSupport
    
    Register to the context a PropertyChangeListener about some entity's property change. listener instance will be notified AFTER any change on the entity's property
    
    Specified by:
    
    addPropertyChangeListener in interface TopiaListenableSupport
    
    Parameters:
    
    listener - the listener instance to register
  - removePropertyChangeListener
```
public void removePropertyChangeListener(PropertyChangeListener listener)
```
    Description copied from interface: TopiaListenableSupport
    
    Unregister the given PropertyChangeListener about some entity's property change from the context
    
    Specified by:
    
    removePropertyChangeListener in interface TopiaListenableSupport
    
    Parameters:
    
    listener - the listener instance to unregister
  - addTopiaSchemaListener
```
public void addTopiaSchemaListener(TopiaSchemaListener listener)
```
    Description copied from interface: TopiaListenableSupport
    
    Register to the context a TopiaSchemaListener about any schema modification. listener instance will be notified BEFORE and AFTER any change on the schema
    
    Specified by:
    
    addTopiaSchemaListener in interface TopiaListenableSupport
    
    Parameters:
    
    listener - the listener instance to register
  - removeTopiaSchemaListener
```
public void removeTopiaSchemaListener(TopiaSchemaListener listener)
```
    Description copied from interface: TopiaListenableSupport
    
    Unregister the given TopiaSchemaListener about any schema modification from the context
    
    Specified by:
    
    removeTopiaSchemaListener in interface TopiaListenableSupport
    
    Parameters:
    
    listener - the listener instance to unregister
  - getServices
```
public Map<String,TopiaService> getServices()
```
    Specified by:
    
    getServices in interface TopiaServiceSupport
    
    Returns:
    
    The list of registered services. The map key is the service name, and the value is the service instance.
  - getServices
```
public <T extends TopiaService> Map<String,T> getServices(Class<T> interfaceService)
```
    Specified by:
    
    getServices in interface TopiaServiceSupport
    
    Type Parameters:
    
    T - type of service
    
    Parameters:
    
    interfaceService - FIXME
    
    Returns:
    
    Same as TopiaServiceSupport.getServices() but returns only services that implements given contract (or is instance of given class).
  - getPersistenceClasses
```
public List<Class<?>> getPersistenceClasses()
```
    Specified by:
    
    getPersistenceClasses in interface TopiaApplicationContext<K extends TopiaPersistenceContext>
  - isSchemaEmpty
```
public boolean isSchemaEmpty()
```
    Specified by:
    
    isSchemaEmpty in interface TopiaApplicationContext<K extends TopiaPersistenceContext>
  - isTableExists
```
public boolean isTableExists(Class<?> clazz)
```
    Specified by:
    
    isTableExists in interface TopiaApplicationContext<K extends TopiaPersistenceContext>
  - getSchemaName
```
public String getSchemaName()
```
    Specified by:
    
    getSchemaName in interface TopiaApplicationContext<K extends TopiaPersistenceContext>
    
    Returns:
    
    the default schema name.
  - createSchema
```
public void createSchema()
```
    Specified by:
    
    createSchema in interface TopiaApplicationContext<K extends TopiaPersistenceContext>
  - showCreateSchema
```
public void showCreateSchema()
```
    Specified by:
    
    showCreateSchema in interface TopiaApplicationContext<K extends TopiaPersistenceContext>
  - updateSchema
```
public void updateSchema()
```
    Specified by:
    
    updateSchema in interface TopiaApplicationContext<K extends TopiaPersistenceContext>
  - dropSchema
```
public void dropSchema()
```
    Specified by:
    
    dropSchema in interface TopiaApplicationContext<K extends TopiaPersistenceContext>
  - close
```
public void close()
```
    Description copied from interface: TopiaApplicationContext
    
    Method to call when the application is going for shutdown. It will trigger the shutdown of all the opened children TopiaPersistenceContext
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface TopiaApplicationContext<K extends TopiaPersistenceContext>
  - getSchemaNames
```
public com.google.common.collect.ImmutableSet<String> getSchemaNames()
```
    Specified by:
    
    getSchemaNames in interface TopiaApplicationContext<K extends TopiaPersistenceContext>
    
    Returns:
    
    all schema names used by persistent entities.
  - isClosed
```
public boolean isClosed()
```
    Specified by:
    
    isClosed in interface TopiaApplicationContext<K extends TopiaPersistenceContext>
    
    Returns:
    
    true is the application context is already closed, false otherwise
  - isOpened
```
public boolean isOpened()
```
    Specified by:
    
    isOpened in interface TopiaApplicationContext<K extends TopiaPersistenceContext>
    
    Returns:
    
    true is the application context is opened (ie not yet TopiaApplicationContext.isClosed())

Class AbstractTopiaApplicationContext<K extends TopiaPersistenceContext>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.nuiton.topia.persistence.TopiaApplicationContext

Field Detail

topiaIdFactory

configuration

topiaFiresSupport

topiaServiceSupport

hibernateProvider

sessionRegistry

closed

persistenceContexts

Constructor Detail

AbstractTopiaApplicationContext

AbstractTopiaApplicationContext

AbstractTopiaApplicationContext

Method Detail

init

initServices

isInitSchema

initSchema

getImplementationClasses

registerPersistenceContext

getHibernateProvider

getTopiaFiresSupport

getConfiguration

getTopiaIdFactory

getSessionRegistry

addTopiaEntityListener

addTopiaEntityListener

removeTopiaEntityListener

removeTopiaEntityListener

addTopiaEntityVetoable

addTopiaEntityVetoable

removeTopiaEntityVetoable

removeTopiaEntityVetoable

addTopiaEntitiesVetoable

removeTopiaEntitiesVetoable

addTopiaTransactionListener

removeTopiaTransactionListener

addTopiaTransactionVetoable

removeTopiaTransactionVetoable

addPropertyChangeListener

removePropertyChangeListener

addTopiaSchemaListener

removeTopiaSchemaListener

getServices

getServices

getPersistenceClasses

isSchemaEmpty

isTableExists

getSchemaName

createSchema

showCreateSchema

updateSchema

dropSchema

close

getSchemaNames

isClosed

isOpened