com.terracotta.entity

Class ClusteredEntityManager

java.lang.Object

com.terracotta.entity.ClusteredEntityManager

public class ClusteredEntityManager
extends Object

ClusteredEntityManager

Constructor Summary

Constructors

Constructor and Description
ClusteredEntityManager(org.terracotta.toolkit.Toolkit toolkit)

Method Summary

Modifier and Type	Method and Description
<T extends RootEntity> T	addRootEntityIfAbsent(String name, Class<T> clusteredEntityClass, T clusteredEntity) Method for adding a RootEntity to this ClusteredEntityManager.
<T extends RootEntity> boolean	destroyRootEntity(String name, Class<T> rootEntityClass, T controlEntity) Method for destroying a root entity This method will follow these steps: Put entity in exclusive maintenance mode If this fails, throws IllegalStateException Verify the entity passed in matches the current known entity If this fails, throws IllegalArgumentException Mark the entity with ClusteredEntityState.DESTROY_IN_PROGRESS and save it If this fails, throws UnsupportedOperationException Perform the destroy operation
void	dispose()
org.terracotta.toolkit.concurrent.locks.ToolkitReadWriteLock	getEntityLock(String lockName)
<T extends RootEntity> Map<String,T>	getRootEntities(Class<T> entityClass)
<T extends RootEntity> T	getRootEntity(String name, Class<T> entityClass)

Methods inherited from class java.lang.Object

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

Constructor Detail

ClusteredEntityManager

public ClusteredEntityManager(org.terracotta.toolkit.Toolkit toolkit)

Method Detail

getRootEntity

public <T extends RootEntity> T getRootEntity(String name,
                                              Class<T> entityClass)

getRootEntities

public <T extends RootEntity> Map<String,T> getRootEntities(Class<T> entityClass)

addRootEntityIfAbsent

public <T extends RootEntity> T addRootEntityIfAbsent(String name,
                                                      Class<T> clusteredEntityClass,
                                                      T clusteredEntity)

Method for adding a RootEntity to this ClusteredEntityManager.
If a RootEntity of the same clusteredEntityClass with the same name is already known to this ClusteredEntityManager, that entity will be returned and the clusteredEntity passed in will not added.

Parameters:

name - the name of the entity

clusteredEntityClass - the type of the entity

clusteredEntity - the clustered entity

Returns:

the current known mapping if any, null otherwise

destroyRootEntity

public <T extends RootEntity> boolean destroyRootEntity(String name,
                                                        Class<T> rootEntityClass,
                                                        T controlEntity)

Method for destroying a root entity
This method will follow these steps:

1. Put entity in exclusive maintenance mode If this fails, throws IllegalStateException
2. Verify the entity passed in matches the current known entity If this fails, throws IllegalArgumentException
3. Mark the entity with ClusteredEntityState.DESTROY_IN_PROGRESS and save it If this fails, throws UnsupportedOperationException
4. Perform the destroy operation

Type Parameters:

T - The managed entity type

Parameters:

name - name of the entity to destroy

rootEntityClass - public interface under which this entity is managed

controlEntity - the entity to destroy

Returns:

true if entity was effectively destroyed, false if entity does not exist

getEntityLock

public org.terracotta.toolkit.concurrent.locks.ToolkitReadWriteLock getEntityLock(String lockName)

dispose

public void dispose()