|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface RegionManager
Manages regions.
Prior to 3.0.0, this was a concrete class. An interface was introduced in 3.0.0 for enhanced flexibility.
Method Summary | |
---|---|
void |
activate(Fqn fqn)
Activates unmarshalling of replication messages for the region rooted in the given Fqn. |
void |
activateIfEmpty(Fqn fqn)
Attempts to activate a given region rooted at a given Fqn, similar to activate(org.jboss.cache.Fqn) except
that if the fqn is currently already in use (probably already been activated) this method is a no-op. |
void |
deactivate(Fqn fqn)
Disables unmarshalling of replication messages for the region rooted in the given Fqn. |
String |
dumpRegions()
Returns a string containing debug information on every region. |
List<Region> |
getAllRegions(Region.Type type)
Returns an ordered list of all regions. |
CacheSPI |
getCache()
|
Configuration |
getConfiguration()
|
EvictionTimerTask |
getEvictionTimerTask()
|
Region |
getRegion(Fqn fqn,
boolean createIfAbsent)
Returns a region by Fqn , creating it optionally if absent. |
Region |
getRegion(Fqn fqn,
Region.Type type,
boolean createIfAbsent)
An overloaded form of getRegion(org.jboss.cache.Fqn,boolean) that takes an additional Region.Type
parameter to force regions of a specific type. |
Region |
getRegion(String fqn,
boolean createIfAbsent)
Returns a region using Fqn.fromString(fqn), calling getRegion(org.jboss.cache.Fqn,boolean) |
Region |
getValidMarshallingRegion(Fqn fqn)
Retrieves a valid marshalling Region after taking into account that this may be a Buddy Backup Fqn. |
boolean |
hasRegion(Fqn fqn,
Region.Type type)
Returns true if the region exists |
boolean |
isDefaultInactive()
|
boolean |
isInactive(Fqn fqn)
Convenienve method. |
boolean |
isUsingEvictions()
|
boolean |
removeRegion(Fqn fqn)
Removes a Region identified by the given fqn. |
void |
reset()
Resets the region manager's regions registry |
void |
setContextClassLoaderAsCurrent(Fqn fqn)
Helper utility that checks for a ClassLoader registered for the
given Fqn , and if found sets it as the TCCL. |
void |
setDefaultInactive(boolean defaultInactive)
Sets if replication for new Region s is by default inactive. |
void |
setEvictionConfig(EvictionConfig evictionConfig)
Sets the eviction configuration. |
void |
setUsingEvictions(boolean usingEvictions)
Sets if evictions are processed. |
void |
startEvictionThread()
Deprecated. |
void |
stopEvictionThread()
Deprecated. |
Method Detail |
---|
boolean isUsingEvictions()
boolean isDefaultInactive()
Region
s.void setDefaultInactive(boolean defaultInactive)
Region
s is by default inactive.
void setContextClassLoaderAsCurrent(Fqn fqn)
ClassLoader
registered for the
given Fqn
, and if found sets it as the TCCL. If the given Fqn is
under the _BUDDY_BACKUP_ region, the equivalent region in the main
cache is used to find the ClassLoader
.
fqn
- Fqn pointing to a region for which a special classloader
may have been registered.Region getRegion(Fqn fqn, boolean createIfAbsent)
Fqn
, creating it optionally if absent. If the region does not exist and createIfAbsent
is false, a parent region which may apply to the Fqn
is sought.
Note that this takes into account the fact that this may be a Buddy Backup Fqn. If it is, the actual Fqn is calculated
and used instead.
Region getValidMarshallingRegion(Fqn fqn)
Region
after taking into account that this may be a Buddy Backup Fqn.
If the fqn passed in is null, the region has been deactivated or if a region cannot be found, this method returns a null.
fqn
- of the region to locate
Region getRegion(Fqn fqn, Region.Type type, boolean createIfAbsent)
getRegion(org.jboss.cache.Fqn,boolean)
that takes an additional Region.Type
parameter to force regions of a specific type.
Note that this takes into account the fact that this may be a Buddy Backup Fqn. If it is, the actual Fqn is calculated
and used instead.
Region.Type
Region getRegion(String fqn, boolean createIfAbsent)
getRegion(org.jboss.cache.Fqn,boolean)
fqn
- createIfAbsent
- getRegion(org.jboss.cache.Fqn,boolean)
boolean removeRegion(Fqn fqn)
Region
identified by the given fqn.
fqn
- fqn of the region to remove
void activate(Fqn fqn) throws RegionNotEmptyException
subtreeFqn
whether or not that
node exists anywhere else in the cluster. If the node does not exist
elsewhere, the local node will be empty. The creation of this node will
not be replicated.
fqn
- representing the region to be activated.
RegionNotEmptyException
- if the node fqn
exists and already has either data or childrenvoid activateIfEmpty(Fqn fqn)
activate(org.jboss.cache.Fqn)
except
that if the fqn is currently already in use (probably already been activated) this method is a no-op.
fqn
- which represents the region to activateboolean isInactive(Fqn fqn)
isDefaultInactive()
is returned, otherwise
!Region.isActive()
is returned.
fqn
- fqn to test
boolean hasRegion(Fqn fqn, Region.Type type)
fqn
- FQN of the regiontype
- type of region to search for
void deactivate(Fqn fqn)
fqn
- void reset()
List<Region> getAllRegions(Region.Type type)
Comparable
interface, which Region
extends.
type
- Type of region to return
void setUsingEvictions(boolean usingEvictions)
void setEvictionConfig(EvictionConfig evictionConfig)
String dumpRegions()
CacheSPI getCache()
EvictionTimerTask getEvictionTimerTask()
Configuration getConfiguration()
@Deprecated void startEvictionThread()
@Deprecated void stopEvictionThread()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |