SpaceDef

java.lang.Object
- com.tibco.as.space.SpaceDef

```
public abstract class SpaceDef
extends java.lang.Object
```
Represents the attributes of a Space. Can be used to define a Space.
- Name: Space name should be unique within a Metaspace and should conform to the following rules:
  - Cannot start with a '$' or '_'
  - Can contain alphanumeric characters and '-' or '_'
- Distribution policy:
  - Distributed: storage of the entries is distributed amongst seeder Members of the space
  - Non-distributed: storage of the entries is assigned to a single seeder Member of the Space
- Replication policy:
  - A degree of replication (on how many other Seeder Members of the Space is the tuple replicated) can be specified to avoid data loss in case of Member failures
  - Replication can be synchronous or asynchronous
  - If the replication policy is synchronous, there must be at least as many seeder Members joined to the Space as the degree of replication requires for operations that modify entries to succeed
- Entry TTL: Amount of time after which entries will expire and are automatically removed from the Space
- Lock TTL: Amount of time after which a lock will be automatically cleared from a entry in the Space
- Lock Wait: Amount of time a put, update, take/remove or lock operations will wait for the lock to be cleared if the entry is currently locked
- Field Definitions: A SpaceDef can have one or more Field Definitions associated with it, which specify the format of the Tuples that will be stored in the Space. At least one of the Field Definitions must be marked as key
See Also:

FieldDef, Space, Tuple

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SpaceDef.CachePolicy` Cache policies
`static class`	`SpaceDef.DistributionPolicy` Space distribution policies
`static class`	`SpaceDef.EvictionPolicy`
`static class`	`SpaceDef.LockScope`
`static class`	`SpaceDef.PersistencePolicy`
`static class`	`SpaceDef.PersistenceType`
`static class`	`SpaceDef.PersisterState`
`static class`	`SpaceDef.ReplicationPolicy`
`static class`	`SpaceDef.SpaceState`
`static class`	`SpaceDef.UpdateTransport` Transport to use to send Update messages

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_ENTRY_TTL` Default timeout value of `TTL_FOREVER` for entry TTL.
`static int`	`DEFAULT_LOCK_TTL` Default timeout value of `TTL_FOREVER` milliseconds for Lock TTL.
`static int`	`DEFAULT_LOCK_WAIT` Default timeout value of `NO_WAIT` for Lock Wait.
`static int`	`NO_CAPACITY` Capacity of the space
`static long`	`NO_LIMIT` Default query result limit
`static int`	`NO_WAIT` Timeout value for TTL or locks.
`static int`	`REPLICATE_ALL` Sets the replication count to 'replicate on all nodes'.
`static int`	`TTL_FOREVER` Timeout value for TTL.
`static int`	`USE_DEFINED` Use Defined value in SpaceDef for the options object
`static int`	`WAIT_FOREVER` Timeout value for locks.

Constructor Summary

Constructors
Constructor and Description

SpaceDef()

Constructors
Constructor and Description
`SpaceDef()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`abstract void`	`addIndexDef(IndexDef indexDef)` Adds indexDef to SpaceDef, overwrites if an IndexDef by that name already exists
`static SpaceDef`	`create()` Returns a new SpaceDef instance.
`static SpaceDef`	`create(java.lang.String spaceName)` Returns a new SpaceDef instance.
`static SpaceDef`	`create(java.lang.String spaceName, int replication, java.util.List<FieldDef> fieldDefs)` Takes space name, replication count and list of field defs and returns a new SpaceDef instance.
`abstract SpaceDef.CachePolicy`	`getCachePolicy()` returns cache policy used
`abstract long`	`getCapacity()` Returns the capacity of the space (in maximum number of entries per seeder)
`abstract Tuple`	`getContext()` Retrieve the user specific attributes in SpaceDef
`abstract java.util.Collection<java.lang.String>`	`getDistributionFields()`
`abstract SpaceDef.DistributionPolicy`	`getDistributionPolicy()` Returns the distribution policy.
`abstract SpaceDef.EvictionPolicy`	`getEvictionPolicy()` Returns the eviction policy of the space definition
`abstract FieldDef`	`getFieldDef(java.lang.String name)` Get the Field Definition for the field name provided.
`abstract java.util.Collection<FieldDef>`	`getFieldDefs()` Returns a collection of Field Definitions associated with Space Definition.
`abstract long`	`getFileSyncInterval()` Retrieve the file synchronization interval Shared-nothing persistence only.
`abstract IndexDef`	`getIndexDef(java.lang.String indexName)`
`abstract java.util.Collection<IndexDef>`	`getIndexDefList()` Returns a collection of Index definitions associated with the Space definition
`abstract KeyDef`	`getKeyDef()` Key definition of a space
`abstract SpaceDef.LockScope`	`getLockScope()`
`abstract long`	`getLockTTL()` Returns the time to live of locks on entries in the Space.
`abstract long`	`getLockWait()` Returns the amount of time a `put`, `update`, `take/remove` or `lock` operations will wait for the lock to be cleared if the entry is currently locked.
`abstract int`	`getMinSeederCount()` Returns the minimum number of seeders before persistence interface calls onLoad
`abstract java.lang.String`	`getName()` Returns the space name of the space.
`abstract int`	`getNumFieldDefs()` Returns number of fields associated with Space Definition.
`abstract SpaceDef.DistributionPolicy`	`getPersistenceDistributionPolicy()` Returns the distribution policy for persistence.
`abstract SpaceDef.PersistencePolicy`	`getPersistencePolicy()` Returns PersistencePolicy of the space
`abstract SpaceDef.PersistenceType`	`getPersistenceType()` Returns the persistence type
`abstract int`	`getPhaseCount()` Deprecated.
`abstract long`	`getPhaseInterval()` Deprecated.
`abstract int`	`getPhaseRatio()` Deprecated.
`abstract long`	`getQueryLimit()` Retrieve the prefetch setting of the Browser.
`abstract long`	`getQueryTimeout()`
`abstract long`	`getReadTimeout()`
`abstract int`	`getReplicationCount()` Returns the replication count.
`abstract SpaceDef.ReplicationPolicy`	`getReplicationPolicy()` Returns replication policy
`abstract long`	`getRouteTimeout()`
`abstract long`	`getSpaceWait()` Returns the amount of time space operations will wait for space to become READY
`abstract long`	`getTTL()` Returns the TTL for the entries in the Space.
`abstract SpaceDef.UpdateTransport`	`getUpdateTransport()` Returns the transport used for udpate messages
`abstract int`	`getVirtualNodeCount()`
`abstract long`	`getWriteTimeout()`
`abstract boolean`	`isForgetOldValue()` returns if old values are ignored
`abstract boolean`	`isHostAwareReplication()` Deprecated.
`abstract boolean`	`isRouted()` returns true if routing is enabled for the space
`abstract void`	`putFieldDef(FieldDef fieldDef)` Associates a field definition to the space definition.
`abstract IndexDef`	`removeIndexDef(java.lang.String name)` Remove index from Space, removes the index from space if exists
`abstract SpaceDef`	`setCachePolicy(SpaceDef.CachePolicy cachePolicy)` sets cache policy
`abstract SpaceDef`	`setCapacity(long capacity)`
`abstract SpaceDef`	`setContext(Tuple tuple)` Container user specific attributes in SpaceDef
`abstract void`	`setDistributionFields(java.lang.String... fieldNames)` Set distribution key field names, must be a subset of key field names
`abstract SpaceDef`	`setDistributionPolicy(SpaceDef.DistributionPolicy distributionPolicy)` Sets the Space distribution policy.
`abstract SpaceDef`	`setEvictionPolicy(SpaceDef.EvictionPolicy evictionPolicy)` Sets the eviction policy of space definition
`abstract SpaceDef`	`setFileSyncInterval(long interval)`
`abstract SpaceDef`	`setForgetOldValue(boolean forgetOldValue)` Set if old values should be ignored in a space
`abstract SpaceDef`	`setHostAwareReplication(boolean hostAwareReplication)` Deprecated.
`abstract void`	`setKey(java.lang.String... fieldNames)` Set key field names
`abstract void`	`setKeyDef(KeyDef keyDef)` Set key def
`abstract SpaceDef`	`setLockScope(SpaceDef.LockScope lockScope)`
`abstract SpaceDef`	`setLockTTL(long ttl)` Number of milliseconds until lock is automatically cleared.
`abstract SpaceDef`	`setLockWait(long timeout)` Sets the amount of time a `put`, `update`, `take/remove` or `lock` operations will wait for the lock to be cleared if the entry is currently locked.
`abstract SpaceDef`	`setMinSeederCount(int count)` Sets the minimum seeder count needed for persistence API, before starting to load tuples into space
`abstract SpaceDef`	`setName(java.lang.String name)` Sets the space name.
`abstract SpaceDef`	`setPersistenceDistributionPolicy(SpaceDef.DistributionPolicy distributionPolicy)` Sets the Space persistence distribution policy.
`abstract SpaceDef`	`setPersistencePolicy(SpaceDef.PersistencePolicy policy)` Sets the persistence policy of the space
`abstract SpaceDef`	`setPersistenceType(SpaceDef.PersistenceType persistenceType)` Sets the persistence type
`abstract SpaceDef`	`setPhaseCount(int phaseCount)` Deprecated.
`abstract SpaceDef`	`setPhaseInterval(long interval)` Deprecated.
`abstract SpaceDef`	`setPhaseRatio(int phaseRatio)` Deprecated.
`abstract SpaceDef`	`setQueryLimit(long limit)`
`abstract SpaceDef`	`setQueryTimeout(long timeout)` Set the query timeout for queries
`abstract SpaceDef`	`setReadTimeout(long timeout)` Set the read timeout for space operations
`abstract SpaceDef`	`setReplicationCount(int count)` Sets the replication count.
`abstract SpaceDef`	`setReplicationPolicy(SpaceDef.ReplicationPolicy replicationPolicy)` Sets whether space can be synchronously replicated or not.
`abstract SpaceDef`	`setRouted(boolean isRouted)` Set if the operations on the space are to be routed
`abstract SpaceDef`	`setRouteTimeout(long timeout)` Set the site route timeout for space operations
`abstract SpaceDef`	`setSpaceWait(long spaceWait)` Sets the amount of time space opeations will wait until space becomes READY
`abstract SpaceDef`	`setTTL(long ttl)` Sets the TTL for the entries in the Space in milliseconds.
`abstract SpaceDef`	`setUpdateTransport(SpaceDef.UpdateTransport updateTransport)` Update transport to be used either `UNICAST` or `MULTICAST`
`abstract SpaceDef`	`setVirtualNodeCount(int nodeCount)` Set virtual node count to increase fairness in distribution of entries
`abstract SpaceDef`	`setWriteTimeout(long timeout)` Set the write timeout for space operations
`abstract void`	`takeFieldDef(FieldDef fieldDef)` Allows removing a field definition associated with SpaceDef.

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

- Field Detail
  - NO_WAIT
```
public static final int NO_WAIT
```
    Timeout value for TTL or locks.
    
    See Also:
    
    Constant Field Values
  - WAIT_FOREVER
```
public static final int WAIT_FOREVER
```
    Timeout value for locks.
    
    See Also:
    
    Constant Field Values
  - USE_DEFINED
```
public static final int USE_DEFINED
```
    Use Defined value in SpaceDef for the options object
    
    See Also:
    
    Constant Field Values
  - NO_CAPACITY
```
public static final int NO_CAPACITY
```
    Capacity of the space
    
    See Also:
    
    Constant Field Values
  - TTL_FOREVER
```
public static final int TTL_FOREVER
```
    Timeout value for TTL.
    
    See Also:
    
    Constant Field Values
  - REPLICATE_ALL
```
public static final int REPLICATE_ALL
```
    Sets the replication count to 'replicate on all nodes'.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_ENTRY_TTL
```
public static final int DEFAULT_ENTRY_TTL
```
    Default timeout value of TTL_FOREVER for entry TTL.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_LOCK_TTL
```
public static final int DEFAULT_LOCK_TTL
```
    Default timeout value of TTL_FOREVER milliseconds for Lock TTL.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_LOCK_WAIT
```
public static final int DEFAULT_LOCK_WAIT
```
    Default timeout value of NO_WAIT for Lock Wait.
    
    See Also:
    
    Constant Field Values
  - NO_LIMIT
```
public static final long NO_LIMIT
```
    Default query result limit
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SpaceDef
```
public SpaceDef()
```
- Method Detail
  - create
```
public static SpaceDef create()
```
    Returns a new SpaceDef instance.
    
    Returns:
    
    SpaceDef The new instance of SpaceDef
  - create
```
public static SpaceDef create(java.lang.String spaceName)
```
    Returns a new SpaceDef instance.
    
    Parameters:
    
    spaceName - space name
    
    Returns:
    
    SpaceDef The new instance of SpaceDef
  - create
```
public static SpaceDef create(java.lang.String spaceName,
                              int replication,
                              java.util.List<FieldDef> fieldDefs)
```
    Takes space name, replication count and list of field defs and returns a new SpaceDef instance.
    
    Parameters:
    
    spaceName - space name
    
    replication - degree of replication
    
    fieldDefs - Array List of field defs
    
    Returns:
    
    SpaceDef The new instance of SpaceDef
  - getName
```
public abstract java.lang.String getName()
```
    Returns the space name of the space.
    
    Returns:
    
    String Space Name
  - setName
```
public abstract SpaceDef setName(java.lang.String name)
```
    Sets the space name.
    
    Parameters:
    
    name - Space Name
    
    Returns:
    
    SpaceDef Space definition
  - getCapacity
```
public abstract long getCapacity()
```
    Returns the capacity of the space (in maximum number of entries per seeder)
    
    Returns:
    
    long capacity of the space
  - setCapacity
```
public abstract SpaceDef setCapacity(long capacity)
```
    Parameters:
    
    capacity - Capacity of the space (in maximum number of entries per seeder)
    
    Returns:
    
    SpaceDef space definition
  - getEvictionPolicy
```
public abstract SpaceDef.EvictionPolicy getEvictionPolicy()
```
    Returns the eviction policy of the space definition
    
    Returns:
    
    eviction policy of the space definition
  - setEvictionPolicy
```
public abstract SpaceDef setEvictionPolicy(SpaceDef.EvictionPolicy evictionPolicy)
```
    Sets the eviction policy of space definition
    
    Parameters:
    
    evictionPolicy - eviction policy of the space definition
  - getPersistenceType
```
public abstract SpaceDef.PersistenceType getPersistenceType()
```
    Returns the persistence type
    
    Returns:
    
    PersistenceType persistence type
  - setPersistenceType
```
public abstract SpaceDef setPersistenceType(SpaceDef.PersistenceType persistenceType)
```
    Sets the persistence type
    
    Parameters:
    
    persistenceType -
    
    Returns:
    
    SpaceDef space definition
  - getMinSeederCount
```
public abstract int getMinSeederCount()
```
    Returns the minimum number of seeders before persistence interface calls onLoad
    
    Returns:
    
    int minimum number of seeders
  - setMinSeederCount
```
public abstract SpaceDef setMinSeederCount(int count)
```
    Sets the minimum seeder count needed for persistence API, before starting to load tuples into space
    
    Parameters:
    
    count - Minimum number of seeders required
    
    Returns:
    
    SpaceDef space definition
  - getPersistenceDistributionPolicy
```
public abstract SpaceDef.DistributionPolicy getPersistenceDistributionPolicy()
```
    Returns the distribution policy for persistence.
    
    Returns:
    
    DistributionPolicy Distribution policy
  - setPersistenceDistributionPolicy
```
public abstract SpaceDef setPersistenceDistributionPolicy(SpaceDef.DistributionPolicy distributionPolicy)
```
    Sets the Space persistence distribution policy. The default is DISTRIBUTED
    
    Parameters:
    
    distributionPolicy - Distribution policy can be either DISTRIBUTED or NON_DISTRIBUTED
    
    Returns:
    
    SpaceDef Space definition for the space
  - getPersistencePolicy
```
public abstract SpaceDef.PersistencePolicy getPersistencePolicy()
```
    Returns PersistencePolicy of the space
    
    Returns:
    
    PersistencePolicy Persistence policy SpaceDef.PersistencePolicy
  - setPersistencePolicy
```
public abstract SpaceDef setPersistencePolicy(SpaceDef.PersistencePolicy policy)
```
    Sets the persistence policy of the space
    
    Parameters:
    
    policy - PersistencePolicy to set SpaceDef.PersistencePolicy
    
    Returns:
    
    SpaceDef space definition
  - getReplicationCount
```
public abstract int getReplicationCount()
```
    Returns the replication count.
    
    Returns:
    
    degree of replication
  - setReplicationCount
```
public abstract SpaceDef setReplicationCount(int count)
```
    Sets the replication count.
    
    Parameters:
    
    count - degree of replication. The default is 0.
    
    Returns:
    
    SpaceDef Space definition for the space
  - getReplicationPolicy
```
public abstract SpaceDef.ReplicationPolicy getReplicationPolicy()
```
    Returns replication policy
    
    Returns:
    
    ReplicationPolicy replication policy used
  - setReplicationPolicy
```
public abstract SpaceDef setReplicationPolicy(SpaceDef.ReplicationPolicy replicationPolicy)
```
    Sets whether space can be synchronously replicated or not. The default is false.
    
    Parameters:
    
    replicationPolicy - replication policy to be used
    
    Returns:
    
    SpaceDef Space definition for the space
  - getDistributionPolicy
```
public abstract SpaceDef.DistributionPolicy getDistributionPolicy()
```
    Returns the distribution policy.
    
    Returns:
    
    DistributionPolicy Distribution policy
  - setDistributionPolicy
```
public abstract SpaceDef setDistributionPolicy(SpaceDef.DistributionPolicy distributionPolicy)
```
    Sets the Space distribution policy. The default is DISTRIBUTED
    
    Parameters:
    
    distributionPolicy - Distribution policy can be either DISTRIBUTED or NON_DISTRIBUTED
    
    Returns:
    
    SpaceDef Space definition for the space
  - setUpdateTransport
```
public abstract SpaceDef setUpdateTransport(SpaceDef.UpdateTransport updateTransport)
```
    Update transport to be used either UNICAST or MULTICAST
    
    Parameters:
    
    updateTransport - Update transport to be used either UNICAST or MULTICAST
    
    Returns:
    
    SpaceDef Space def for the space
  - getUpdateTransport
```
public abstract SpaceDef.UpdateTransport getUpdateTransport()
```
    Returns the transport used for udpate messages
    
    Returns:
    
    UpdateTransport Update transport used
  - getTTL
```
public abstract long getTTL()
```
    Returns the TTL for the entries in the Space.
    
    Returns:
    
    long TTL in milliseconds
  - setTTL
```
public abstract SpaceDef setTTL(long ttl)
```
    Sets the TTL for the entries in the Space in milliseconds. The default is WAIT_FOREVER (never expire).
    
    Parameters:
    
    ttl - in milliseconds. WAIT_FOREVER represents never expire.
    
    Returns:
    
    SpaceDef Space def for the space
  - getLockTTL
```
public abstract long getLockTTL()
```
    Returns the time to live of locks on entries in the Space.
    
    Returns:
    
    long TTL in milliseconds
  - setLockTTL
```
public abstract SpaceDef setLockTTL(long ttl)
```
    Number of milliseconds until lock is automatically cleared. The default is WAIT_FOREVER milliseconds.
    
    Parameters:
    
    ttl - in milliseconds. WAIT_FOREVER represents lock forever.
    
    Returns:
    
    SpaceDef Space def for the space
  - getLockWait
```
public abstract long getLockWait()
```
    Returns the amount of time a put, update, take/remove or lock operations will wait for the lock to be cleared if the entry is currently locked.
    
    Returns:
    
    long lock wait in milliseconds
  - setLockWait
```
public abstract SpaceDef setLockWait(long timeout)
```
    Sets the amount of time a put, update, take/remove or lock operations will wait for the lock to be cleared if the entry is currently locked. The default is WAIT_FOREVER milliseconds.
    
    Parameters:
    
    timeout - in milliseconds. '-1' represents wait forever.
    
    Returns:
    
    SpaceDef Space def for the space
  - getSpaceWait
```
public abstract long getSpaceWait()
```
    Returns the amount of time space operations will wait for space to become READY
    
    Returns:
    
    long space wait in milliseconds
  - setSpaceWait
```
public abstract SpaceDef setSpaceWait(long spaceWait)
```
    Sets the amount of time space opeations will wait until space becomes READY
    
    Returns:
    
    SpaceDef Space def for the space
  - getLockScope
```
public abstract SpaceDef.LockScope getLockScope()
```
    Returns:
    
    LockScope of the space definition
  - setLockScope
```
public abstract SpaceDef setLockScope(SpaceDef.LockScope lockScope)
```
    Returns:
    
    LockScope lock scope of the space definition
  - getFieldDefs
```
public abstract java.util.Collection<FieldDef> getFieldDefs()
```
    Returns a collection of Field Definitions associated with Space Definition.
    
    Returns:
    
    collection of FieldDefs
  - getNumFieldDefs
```
public abstract int getNumFieldDefs()
```
    Returns number of fields associated with Space Definition.
    
    Returns:
    
    int Number of fields
  - takeFieldDef
```
public abstract void takeFieldDef(FieldDef fieldDef)
```
    Allows removing a field definition associated with SpaceDef. Note that Space definition cannot be changed once the space is defined. So, a field definition can be removed from a Space definition only before the space is created.
    
    Parameters:
    
    fieldDef - field definition
  - putFieldDef
```
public abstract void putFieldDef(FieldDef fieldDef)
```
    Associates a field definition to the space definition.
    
    Parameters:
    
    fieldDef - field Definition
  - getFieldDef
```
public abstract FieldDef getFieldDef(java.lang.String name)
```
    Get the Field Definition for the field name provided.
    
    Parameters:
    
    name - field name
    
    Returns:
    
    FieldDef The field definition
  - setKeyDef
```
public abstract void setKeyDef(KeyDef keyDef)
```
    Set key def
    
    Parameters:
    
    keyDef -
  - setKey
```
public abstract void setKey(java.lang.String... fieldNames)
```
    Set key field names
    
    Parameters:
    
    fieldNames - key field names
  - getKeyDef
```
public abstract KeyDef getKeyDef()
```
    Key definition of a space
    
    Returns:
    
    KeyDef key definition
  - setDistributionFields
```
public abstract void setDistributionFields(java.lang.String... fieldNames)
```
    Set distribution key field names, must be a subset of key field names
    
    Parameters:
    
    fieldNames - distribution key field names
  - getDistributionFields
```
public abstract java.util.Collection<java.lang.String> getDistributionFields()
```
    Returns:
    
    Colection distribution key definition
  - setContext
```
public abstract SpaceDef setContext(Tuple tuple)
```
    Container user specific attributes in SpaceDef
    
    Parameters:
    
    tuple - Tuple that contains key-value pairs
    
    Returns:
    
    SpaceDef Space definition for the space
  - getContext
```
public abstract Tuple getContext()
```
    Retrieve the user specific attributes in SpaceDef
    
    Returns:
    
    tuple Tuple that contains user key-value pairs
  - addIndexDef
```
public abstract void addIndexDef(IndexDef indexDef)
```
    Adds indexDef to SpaceDef, overwrites if an IndexDef by that name already exists
    
    Parameters:
    
    indexDef - IndexDef to be added
  - removeIndexDef
```
public abstract IndexDef removeIndexDef(java.lang.String name)
```
    Remove index from Space, removes the index from space if exists
    
    Parameters:
    
    name - Index name
    
    Returns:
    
    IndexDef is exists
  - getIndexDef
```
public abstract IndexDef getIndexDef(java.lang.String indexName)
```
    Parameters:
    
    indexName - Index name to get
    
    Returns:
    
    IndexDef if found, null otherwise
  - getIndexDefList
```
public abstract java.util.Collection<IndexDef> getIndexDefList()
```
    Returns a collection of Index definitions associated with the Space definition
    
    Returns:
    
    Collection of IndexDefs, including the Key IndexDef
  - setPhaseCount
```
public abstract SpaceDef setPhaseCount(int phaseCount)
```
    Deprecated.
    
    Number of phases for each seeder joining/leaving a space
    
    Parameters:
    
    phaseCount - Phase count
    
    Returns:
    
    SpaceDef space definition
  - getPhaseCount
```
public abstract int getPhaseCount()
```
    Deprecated.
    
    Returns:
    
    return phase count for seeder join/leave
  - setPhaseInterval
```
public abstract SpaceDef setPhaseInterval(long interval)
```
    Deprecated.
    
    Pause after each phase before starting next phase
    
    Parameters:
    
    interval - time to wait
    
    Returns:
    
    SpaceDef space definition
  - getPhaseInterval
```
public abstract long getPhaseInterval()
```
    Deprecated.
    
    Returns:
    
    return phase interval between each phase
  - setWriteTimeout
```
public abstract SpaceDef setWriteTimeout(long timeout)
```
    Set the write timeout for space operations
    
    Parameters:
    
    timeout - write timeout
    
    Returns:
    
    SpaceDef space definition
  - getWriteTimeout
```
public abstract long getWriteTimeout()
```
    Returns:
    
    long write timeout
  - setReadTimeout
```
public abstract SpaceDef setReadTimeout(long timeout)
```
    Set the read timeout for space operations
    
    Parameters:
    
    timeout - read timeout
    
    Returns:
    
    SpaceDef space definition
  - getReadTimeout
```
public abstract long getReadTimeout()
```
    Returns:
    
    long read timeout
  - setRouteTimeout
```
public abstract SpaceDef setRouteTimeout(long timeout)
```
    Set the site route timeout for space operations
    
    Parameters:
    
    timeout - site route timeout
    
    Returns:
    
    SpaceDef space definition
  - getRouteTimeout
```
public abstract long getRouteTimeout()
```
    Returns:
    
    long site route timeout
  - setQueryTimeout
```
public abstract SpaceDef setQueryTimeout(long timeout)
```
    Set the query timeout for queries
    
    Parameters:
    
    timeout - query timeout
    
    Returns:
    
    SpaceDef space definition
  - getQueryTimeout
```
public abstract long getQueryTimeout()
```
    Returns:
    
    long query timeout
  - setVirtualNodeCount
```
public abstract SpaceDef setVirtualNodeCount(int nodeCount)
```
    Set virtual node count to increase fairness in distribution of entries
    
    Parameters:
    
    nodeCount - number of virtual nodes
  - getVirtualNodeCount
```
public abstract int getVirtualNodeCount()
```
    Returns:
    
    int number of virtual nodes
  - setCachePolicy
```
public abstract SpaceDef setCachePolicy(SpaceDef.CachePolicy cachePolicy)
```
    sets cache policy
    
    Parameters:
    
    cachePolicy - Cache policy
    
    Returns:
    
    SpaceDef space definition
  - getCachePolicy
```
public abstract SpaceDef.CachePolicy getCachePolicy()
```
    returns cache policy used
  - setForgetOldValue
```
public abstract SpaceDef setForgetOldValue(boolean forgetOldValue)
```
    Set if old values should be ignored in a space
    
    Parameters:
    
    forgetOldValue - forget old value
    
    Returns:
    
    SpaceDef space definition
  - isForgetOldValue
```
public abstract boolean isForgetOldValue()
```
    returns if old values are ignored
    
    Returns:
    
    boolean
  - setHostAwareReplication
```
public abstract SpaceDef setHostAwareReplication(boolean hostAwareReplication)
```
    Deprecated.
    
    Set if the space is to use a multi-level distribution algorithm
    
    Parameters:
    
    hostAwareReplication - host aware replication flag
    
    Returns:
    
    SpaceDef space definition
  - isHostAwareReplication
```
public abstract boolean isHostAwareReplication()
```
    Deprecated.
    
    returns true if multi-level hashing is enabled
    
    Returns:
    
    boolean
  - setRouted
```
public abstract SpaceDef setRouted(boolean isRouted)
```
    Set if the operations on the space are to be routed
    
    Parameters:
    
    isRouted - routed flag
    
    Returns:
    
    SpaceDef space definition
  - isRouted
```
public abstract boolean isRouted()
```
    returns true if routing is enabled for the space
    
    Returns:
    
    boolean
  - setPhaseRatio
```
public abstract SpaceDef setPhaseRatio(int phaseRatio)
```
    Deprecated.
    
    Parameters:
    
    phaseRatio - Ratio between user operations and redistribution during seeder join/leave (default 100)
    
    Returns:
    
    phase ratio
  - getPhaseRatio
```
public abstract int getPhaseRatio()
```
    Deprecated.
    
    Returns:
    
    phase ratio
  - setQueryLimit
```
public abstract SpaceDef setQueryLimit(long limit)
```
    Parameters:
    
    limit - The number of entries to get from the Space. Used with GET Browsers only
    
    Returns:
    
    This BrowserDef instance.
  - getQueryLimit
```
public abstract long getQueryLimit()
```
    Retrieve the prefetch setting of the Browser. Used with GET Browsers only.
    
    Returns:
    
    The number of entries to prefetch from the Space.
  - setFileSyncInterval
```
public abstract SpaceDef setFileSyncInterval(long interval)
```
    Parameters:
    
    interval - file synchronization interval Shared-nothing persistence only
    
    Returns:
    
    This SpaceDef instance.
  - getFileSyncInterval
```
public abstract long getFileSyncInterval()
```
    Retrieve the file synchronization interval Shared-nothing persistence only.
    
    Returns:
    
    long file synchronization interval.

Class SpaceDef

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NO_WAIT

WAIT_FOREVER

USE_DEFINED

NO_CAPACITY

TTL_FOREVER

REPLICATE_ALL

DEFAULT_ENTRY_TTL

DEFAULT_LOCK_TTL

DEFAULT_LOCK_WAIT

NO_LIMIT

Constructor Detail

SpaceDef

Method Detail

create

create

create

getName

setName

getCapacity

setCapacity

getEvictionPolicy

setEvictionPolicy

getPersistenceType

setPersistenceType

getMinSeederCount

setMinSeederCount

getPersistenceDistributionPolicy

setPersistenceDistributionPolicy

getPersistencePolicy

setPersistencePolicy

getReplicationCount

setReplicationCount

getReplicationPolicy

setReplicationPolicy

getDistributionPolicy

setDistributionPolicy

setUpdateTransport

getUpdateTransport

getTTL

setTTL

getLockTTL

setLockTTL

getLockWait

setLockWait

getSpaceWait

setSpaceWait

getLockScope

setLockScope

getFieldDefs

getNumFieldDefs

takeFieldDef

putFieldDef

getFieldDef

setKeyDef

setKey

getKeyDef

setDistributionFields

getDistributionFields

setContext

getContext

addIndexDef

removeIndexDef

getIndexDef

getIndexDefList

setPhaseCount

getPhaseCount

setPhaseInterval

getPhaseInterval

setWriteTimeout

getWriteTimeout

setReadTimeout

getReadTimeout

setRouteTimeout