LocalCacheSpaceConfigurer (GigaSpaces XAP 10.2.1 API)

java.lang.Object
- org.openspaces.core.space.cache.LocalCacheSpaceConfigurer

All Implemented Interfaces:: SpaceConfigurer

public class LocalCacheSpaceConfigurer
extends Object
implements SpaceConfigurer

A simple configurer helper to create IJSpace local cache. The configurer wraps LocalCacheSpaceFactoryBean and providing a simpler means to configure it using code.

An example of using it:

 UrlSpaceConfigurer urlSpaceConfigurer = new UrlSpaceConfigurer("/./space").schema("cache")
          .noWriteLeaseMode(true).lookupGroups(new String[] {"kimchy"});

 LocalCacheSpaceConfigurer localCacheConfigurer = new LocalCacheSpaceConfigurer(urlSpaceConfigurer).updateMode(UpdateMode.PULL);
 GigaSpace localCacheGigaSpace = new GigaSpaceConfigurer(localCacheConfigurer).gigaSpace();
 ...
 localCacheConfigurer.destroy();
 urlSpaceConfigurer.destroy();

Author:: kimchy

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class LocalCacheSpaceConfigurer.UpdateMode

Nested Classes
Modifier and Type	Class and Description
`static class`	`LocalCacheSpaceConfigurer.UpdateMode`

Constructor Summary

Constructors
Constructor and Description

LocalCacheSpaceConfigurer(IJSpace space)

LocalCacheSpaceConfigurer(SpaceConfigurer spaceConfigurer)

Constructors
Constructor and Description
`LocalCacheSpaceConfigurer(IJSpace space)`
`LocalCacheSpaceConfigurer(SpaceConfigurer spaceConfigurer)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`LocalCacheSpaceConfigurer`	`addProperty(String name, String value)`
`LocalCacheSpaceConfigurer`	`batchSize(int batchSize)` Sets the cache synchronization batch size.
`LocalCacheSpaceConfigurer`	`batchTimeout(long batchTimeout)` Sets the cache synchronization batch timeout (i.e. maximum time the server will batch entries before updating the client).
`void`	`close()`
`IJSpace`	`create()` Creates and returns a local cache according to the configured settings.
`void`	`destroy()` Deprecated. Sinde 10.0 - use close instead.
`IJSpace`	`localCache()`
`LocalCacheSpaceConfigurer`	`maxDisconnectionDuration(long maxDisconnectionDuration)` Sets the maximum time to return cached results before switching to disconnected state.
`LocalCacheSpaceConfigurer`	`maxTimeToLive(long maxTimeToLive)`
`LocalCacheSpaceConfigurer`	`size(int size)`
`IJSpace`	`space()`
`LocalCacheSpaceConfigurer`	`updateMode(LocalCacheSpaceConfigurer.UpdateMode mode)`

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

- Constructor Detail
  - LocalCacheSpaceConfigurer
```
public LocalCacheSpaceConfigurer(SpaceConfigurer spaceConfigurer)
```
  - LocalCacheSpaceConfigurer
```
public LocalCacheSpaceConfigurer(IJSpace space)
```
- Method Detail
  - addProperty
```
public LocalCacheSpaceConfigurer addProperty(String name,
                                             String value)
```
    See Also:
    
    AbstractLocalCacheSpaceFactoryBean.setProperties(java.util.Properties)
  - updateMode
```
public LocalCacheSpaceConfigurer updateMode(LocalCacheSpaceConfigurer.UpdateMode mode)
```
    See Also:
    
    LocalCacheSpaceFactoryBean.setUpdateModeName(String)
  - maxTimeToLive
```
public LocalCacheSpaceConfigurer maxTimeToLive(long maxTimeToLive)
```
    See Also:
    
    LocalCacheSpaceFactoryBean.setMaxTimeToLive(long)
  - size
```
public LocalCacheSpaceConfigurer size(int size)
```
    See Also:
    
    LocalCacheSpaceFactoryBean.setSize(int)
  - batchSize
```
public LocalCacheSpaceConfigurer batchSize(int batchSize)
```
    Sets the cache synchronization batch size.
    
    Since:
    
    8.0.5
  - batchTimeout
```
public LocalCacheSpaceConfigurer batchTimeout(long batchTimeout)
```
    Sets the cache synchronization batch timeout (i.e. maximum time the server will batch entries before updating the client).
    
    Since:
    
    8.0.5
  - maxDisconnectionDuration
```
public LocalCacheSpaceConfigurer maxDisconnectionDuration(long maxDisconnectionDuration)
```
    Sets the maximum time to return cached results before switching to disconnected state.
    
    Since:
    
    8.0.5
  - create
```
public IJSpace create()
```
    Creates and returns a local cache according to the configured settings.
    
    Returns:
    
    A configured space.
    
    Since:
    
    8.0
  - localCache
```
public IJSpace localCache()
```
  - destroy
```
public void destroy()
```
    Deprecated. Sinde 10.0 - use close instead.
  - close
```
public void close()
```
    Specified by:
    
    close in interface SpaceConfigurer
  - space
```
public IJSpace space()
```
    Specified by:
    
    space in interface SpaceConfigurer

Class LocalCacheSpaceConfigurer

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LocalCacheSpaceConfigurer

LocalCacheSpaceConfigurer

Method Detail

addProperty

updateMode

maxTimeToLive

size

batchSize

batchTimeout

maxDisconnectionDuration

create

localCache

destroy

close

space