Package org.springframework.data.gemfire.mapping.annotation

Annotation Interface LocalRegion

@Target(TYPE)
@Retention(RUNTIME)
@Inherited
@Documented
@Region
public @interface LocalRegion

Annotation defining the Local Region in which the application persistent entity will be stored.

Since:

1.9.0

See Also:

• EnableEntityDefinedRegions
• EntityDefinedRegionsConfiguration
• Region

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	diskStoreName	Name of the DiskStore in which this persistent entity's data is overflowed and/or persisted.
boolean	diskSynchronous	Determines whether disk-based operations (used in overflow and persistence) are synchronous or asynchronous.
boolean	ignoreIfExists	Determines whether an entity annotated with this Region annotation will ignore any existing Region definition identified by the given name() for this entity.
boolean	ignoreJta	Determines whether this Region's data access operations participates in any existing, Global JTA transaction in progress.
String	name	Name, or fully-qualified bean name of the Region in which the application persistent entity will be stored (e.g.
boolean	persistent	Determines whether this persistent entity's Region is persistent, storing data to disk.
String	value	Name, or fully-qualified bean name of the Region in which the application persistent entity will be stored (e.g.

Element Details

name

@AliasFor(annotation=Region.class,
          attribute="name")
String name

Name, or fully-qualified bean name of the Region in which the application persistent entity will be stored (e.g. "Users", or "/Local/Admin/Users"). Defaults to simple name of the application persistent entity defined by Class.getSimpleName().

Returns:

the name or fully-qualified path of the Region in which the application persistent entity will be stored.

Default:

""

value

@AliasFor(annotation=Region.class,
          attribute="value")
String value

Name, or fully-qualified bean name of the Region in which the application persistent entity will be stored (e.g. "Users", or "/Local/Admin/Users"). Defaults to simple name of the application persistent entity defined by Class.getSimpleName().

Returns:

the name or fully-qualified path of the Region in which the application persistent entity will be stored.

Default:

""

diskStoreName

String diskStoreName

Name of the DiskStore in which this persistent entity's data is overflowed and/or persisted. Maybe the name of a Spring bean defined in the Spring context. Defaults to unset.

Default:

""

diskSynchronous

boolean diskSynchronous

Determines whether disk-based operations (used in overflow and persistence) are synchronous or asynchronous. Defaults to synchronous.

Default:

true

ignoreIfExists

boolean ignoreIfExists

Determines whether an entity annotated with this Region annotation will ignore any existing Region definition identified by the given name() for this entity. Defaults to true.

Default:

true

ignoreJta

boolean ignoreJta

Determines whether this Region's data access operations participates in any existing, Global JTA transaction in progress. Defaults to false (will NOT ignore JTA).

Default:

false

persistent

boolean persistent

Determines whether this persistent entity's Region is persistent, storing data to disk. Note, this setting independent of whether or not the Region associated with this persistent entity overflows data to disk during eviction due to entry/heap/memory constraints. A Region can also be persistent without an explicit DiskStore defined; in that case, GemFire/Geode writes to the "DEFAULT" DiskStore. Defaults to false.

See Also:

• DataPolicy

Default:

false