OStorageConfigurationImpl (OrientDB 3.0.44 API)

java.lang.Object
- com.orientechnologies.orient.core.config.OStorageConfigurationImpl

All Implemented Interfaces:

OStorageConfiguration, OSerializableStream, Serializable

Direct Known Subclasses:

OStorageConfigurationSegment, OStorageMemoryConfiguration
```
public class OStorageConfigurationImpl
extends Object
implements OSerializableStream, OStorageConfiguration
```
Versions:
- 3 = introduced file directory in physical segments and data-segment id in clusters
- 4 = ??
- 5 = ??
- 6 = ??
- 7 = ??
- 8 = introduced cluster selection strategy as string
- 9 = introduced minimumclusters as string
- 12 = introduced record conflict strategy as string in both storage and paginated clusters
- 13 = introduced cluster status to manage cluster as "offline" with the new command "alter cluster status offline". Removed data segments
- 14 = no changes, but version was incremented
- 15 = introduced encryption and encryptionKey
- 18 = we keep version of product release under which storage was created
- 19 = Page size and related parameters are stored inside configuration
Author:

Luca Garulli (l.garulli--(at)--orientdb.com)

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface com.orientechnologies.orient.core.config.OStorageConfiguration
  OStorageConfiguration.IndexEngineData

Field Summary

Fields
Modifier and Type Field and Description

protected OReadersWriterSpinLock lock

protected Charset streamCharset

protected OStorageConfigurationUpdateListener updateListener
- Fields inherited from interface com.orientechnologies.orient.core.config.OStorageConfiguration
  CURRENT_BINARY_FORMAT_VERSION, CURRENT_VERSION, DEFAULT_CHARSET, DEFAULT_DATE_FORMAT, DEFAULT_DATETIME_FORMAT

Fields
Modifier and Type	Field and Description
`protected OReadersWriterSpinLock`	`lock`
`protected Charset`	`streamCharset`
`protected OStorageConfigurationUpdateListener`	`updateListener`

Constructor Summary

Constructors
Constructor and Description

OStorageConfigurationImpl(OAbstractPaginatedStorage iStorage, Charset streamCharset)

Constructors
Constructor and Description
`OStorageConfigurationImpl(OAbstractPaginatedStorage iStorage, Charset streamCharset)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addCluster(OStoragePaginatedClusterConfiguration config)`
`void`	`addIndexEngine(String name, OStorageConfiguration.IndexEngineData engineData)`
`void`	`clearProperties()`
`void`	`close()`
`void`	`create()`
`void`	`delete()`
`void`	`deleteIndexEngine(String name)`
`void`	`dropCluster(int iClusterId)`
`OSerializableStream`	`fromStream(byte[] iStream)` Deprecated. because method uses native encoding use `fromStream(byte[], int, int, Charset)` instead.
`void`	`fromStream(byte[] stream, int offset, int length, Charset charset)`
`int`	`getBinaryFormatVersion()`
`String`	`getCharset()`
`List<OStorageClusterConfiguration>`	`getClusters()`
`String`	`getClusterSelection()`
`String`	`getConflictStrategy()`
`OContextConfiguration`	`getContextConfiguration()`
`String`	`getCreatedAtVersion()`
`String`	`getDateFormat()`
`SimpleDateFormat`	`getDateFormatInstance()`
`String`	`getDateTimeFormat()`
`SimpleDateFormat`	`getDateTimeFormatInstance()`
`String`	`getDirectory()`
`int`	`getFreeListBoundary()`
`OStorageConfiguration.IndexEngineData`	`getIndexEngine(String name)`
`String`	`getIndexMgrRecordId()`
`String`	`getLocaleCountry()`
`Locale`	`getLocaleInstance()`
`String`	`getLocaleLanguage()`
`int`	`getMaxKeySize()`
`int`	`getMinimumClusters()`
`String`	`getName()`
`int`	`getPageSize()`
`List<OStorageEntryConfiguration>`	`getProperties()`
`String`	`getProperty(String iName)`
`String`	`getRecordSerializer()`
`int`	`getRecordSerializerVersion()`
`String`	`getSchemaRecordId()`
`TimeZone`	`getTimeZone()`
`int`	`getVersion()`
`Set<String>`	`indexEngines()`
`void`	`initConfiguration(OContextConfiguration conf)`
`boolean`	`isStrictSql()`
`boolean`	`isValidationEnabled()`
`OStorageConfigurationImpl`	`load(OContextConfiguration configuration)` This method load the record information by the internal cluster segment.
`void`	`removeProperty(String iName)`
`void`	`setCharset(String charset)`
`void`	`setClusterSelection(String clusterSelection)`
`void`	`setClusterStatus(int clusterId, OStorageClusterConfiguration.STATUS iStatus)`
`void`	`setConfigurationUpdateListener(OStorageConfigurationUpdateListener updateListener)`
`void`	`setConflictStrategy(String conflictStrategy)`
`void`	`setCreationVersion(String version)` Sets version of product release under which storage was created.
`void`	`setDateFormat(String dateFormat)`
`void`	`setDateTimeFormat(String dateTimeFormat)`
`void`	`setFreeListBoundary(int freeListBoundary)`
`void`	`setIndexMgrRecordId(String indexMgrRecordId)`
`void`	`setLocaleCountry(String iValue)`
`void`	`setLocaleLanguage(String iValue)`
`void`	`setMaxKeySize(int maxKeySize)`
`void`	`setMinimumClusters(int minimumClusters)`
`void`	`setPageSize(int pageSize)`
`void`	`setProperty(String iName, String iValue)`
`void`	`setRecordSerializer(String recordSerializer)`
`void`	`setRecordSerializerVersion(int recordSerializerVersion)`
`void`	`setSchemaRecordId(String schemaRecordId)`
`void`	`setTimeZone(TimeZone timeZone)`
`void`	`setValidation(boolean validation)`
`byte[]`	`toStream()` Deprecated. because method uses native encoding use `toStream(Charset)` instead.
`byte[]`	`toStream(Charset charset)`
`byte[]`	`toStream(int iNetworkVersion, Charset charset)` Added version used for managed Network Versioning.
`void`	`update()`

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

- Field Detail
  - lock
```
protected final OReadersWriterSpinLock lock
```
  - updateListener
```
protected OStorageConfigurationUpdateListener updateListener
```
  - streamCharset
```
protected final Charset streamCharset
```
- Constructor Detail
  - OStorageConfigurationImpl
```
public OStorageConfigurationImpl(OAbstractPaginatedStorage iStorage,
                                 Charset streamCharset)
```
- Method Detail
  - getPageSize
```
public int getPageSize()
```
    Specified by:
    
    getPageSize in interface OStorageConfiguration
  - setPageSize
```
public void setPageSize(int pageSize)
```
  - getFreeListBoundary
```
public int getFreeListBoundary()
```
    Specified by:
    
    getFreeListBoundary in interface OStorageConfiguration
  - setFreeListBoundary
```
public void setFreeListBoundary(int freeListBoundary)
```
  - getMaxKeySize
```
public int getMaxKeySize()
```
    Specified by:
    
    getMaxKeySize in interface OStorageConfiguration
  - setMaxKeySize
```
public void setMaxKeySize(int maxKeySize)
```
  - setCreationVersion
```
public void setCreationVersion(String version)
```
    Sets version of product release under which storage was created.
  - getCreatedAtVersion
```
public String getCreatedAtVersion()
```
    Specified by:
    
    getCreatedAtVersion in interface OStorageConfiguration
    
    Returns:
    
    version of product release under which storage was created.
  - initConfiguration
```
public void initConfiguration(OContextConfiguration conf)
```
  - getConflictStrategy
```
public String getConflictStrategy()
```
    Specified by:
    
    getConflictStrategy in interface OStorageConfiguration
  - setConflictStrategy
```
public void setConflictStrategy(String conflictStrategy)
```
  - getContextConfiguration
```
public OContextConfiguration getContextConfiguration()
```
    Specified by:
    
    getContextConfiguration in interface OStorageConfiguration
  - load
```
public OStorageConfigurationImpl load(OContextConfiguration configuration)
                               throws OSerializationException
```
    This method load the record information by the internal cluster segment. It's for compatibility with older database than 0.9.25.
    
    Throws:
    
    OSerializationException
  - update
```
public void update()
            throws OSerializationException
```
    Throws:
    
    OSerializationException
  - getDirectory
```
public String getDirectory()
```
    Specified by:
    
    getDirectory in interface OStorageConfiguration
  - getLocaleInstance
```
public Locale getLocaleInstance()
```
    Specified by:
    
    getLocaleInstance in interface OStorageConfiguration
  - getDateFormatInstance
```
public SimpleDateFormat getDateFormatInstance()
```
    Specified by:
    
    getDateFormatInstance in interface OStorageConfiguration
  - getDateTimeFormatInstance
```
public SimpleDateFormat getDateTimeFormatInstance()
```
    Specified by:
    
    getDateTimeFormatInstance in interface OStorageConfiguration
  - fromStream
```
public void fromStream(byte[] stream,
                       int offset,
                       int length,
                       Charset charset)
```
  - fromStream
```
@Deprecated
public OSerializableStream fromStream(byte[] iStream)
                                           throws OSerializationException
```
    Deprecated. because method uses native encoding use fromStream(byte[], int, int, Charset) instead.
    
    Description copied from interface: OSerializableStream
    
    Unmarshalls the object. Fills the current object with the values contained in the byte array representation restoring a previous state. Usually byte[] comes from the storage or network.
    
    Specified by:
    
    fromStream in interface OSerializableStream
    
    Parameters:
    
    iStream - byte array representation of the object
    
    Returns:
    
    The Object instance itself giving a "fluent interface". Useful to call multiple methods in chain.
    
    Throws:
    
    OSerializationException - if the unmarshalling does not succeed
  - toStream
```
public byte[] toStream()
                throws OSerializationException
```
    Deprecated. because method uses native encoding use toStream(Charset) instead.
    
    Description copied from interface: OSerializableStream
    
    Marshalls the object. Transforms the current object in byte[] form to being stored or transferred over the network.
    
    Specified by:
    
    toStream in interface OSerializableStream
    
    Returns:
    
    The byte array representation of the object
    
    Throws:
    
    OSerializationException - if the marshalling does not succeed
    
    See Also:
    
    OSerializableStream.fromStream(byte[])
  - toStream
```
public byte[] toStream(Charset charset)
                throws OSerializationException
```
    Throws:
    
    OSerializationException
  - toStream
```
public byte[] toStream(int iNetworkVersion,
                       Charset charset)
                throws OSerializationException
```
    Added version used for managed Network Versioning.
    
    Throws:
    
    OSerializationException
  - create
```
public void create()
            throws IOException
```
    Throws:
    
    IOException
  - delete
```
public void delete()
            throws IOException
```
    Throws:
    
    IOException
  - close
```
public void close()
           throws IOException
```
    Throws:
    
    IOException
  - dropCluster
```
public void dropCluster(int iClusterId)
```
  - addCluster
```
public void addCluster(OStoragePaginatedClusterConfiguration config)
```
  - addIndexEngine
```
public void addIndexEngine(String name,
                           OStorageConfiguration.IndexEngineData engineData)
```
  - deleteIndexEngine
```
public void deleteIndexEngine(String name)
```
  - indexEngines
```
public Set<String> indexEngines()
```
    Specified by:
    
    indexEngines in interface OStorageConfiguration
  - getIndexEngine
```
public OStorageConfiguration.IndexEngineData getIndexEngine(String name)
```
    Specified by:
    
    getIndexEngine in interface OStorageConfiguration
  - setClusterStatus
```
public void setClusterStatus(int clusterId,
                             OStorageClusterConfiguration.STATUS iStatus)
```
  - getTimeZone
```
public TimeZone getTimeZone()
```
    Specified by:
    
    getTimeZone in interface OStorageConfiguration
  - setTimeZone
```
public void setTimeZone(TimeZone timeZone)
```
  - getLocaleLanguage
```
public String getLocaleLanguage()
```
    Specified by:
    
    getLocaleLanguage in interface OStorageConfiguration
  - setLocaleLanguage
```
public void setLocaleLanguage(String iValue)
```
  - getLocaleCountry
```
public String getLocaleCountry()
```
    Specified by:
    
    getLocaleCountry in interface OStorageConfiguration
  - setLocaleCountry
```
public void setLocaleCountry(String iValue)
```
  - getCharset
```
public String getCharset()
```
    Specified by:
    
    getCharset in interface OStorageConfiguration
  - setCharset
```
public void setCharset(String charset)
```
  - getDateFormat
```
public String getDateFormat()
```
    Specified by:
    
    getDateFormat in interface OStorageConfiguration
  - getDateTimeFormat
```
public String getDateTimeFormat()
```
    Specified by:
    
    getDateTimeFormat in interface OStorageConfiguration
  - getClusterSelection
```
public String getClusterSelection()
```
    Specified by:
    
    getClusterSelection in interface OStorageConfiguration
  - setClusterSelection
```
public void setClusterSelection(String clusterSelection)
```
  - getMinimumClusters
```
public int getMinimumClusters()
```
    Specified by:
    
    getMinimumClusters in interface OStorageConfiguration
  - setMinimumClusters
```
public void setMinimumClusters(int minimumClusters)
```
  - getRecordSerializer
```
public String getRecordSerializer()
```
    Specified by:
    
    getRecordSerializer in interface OStorageConfiguration
  - setRecordSerializer
```
public void setRecordSerializer(String recordSerializer)
```
  - getRecordSerializerVersion
```
public int getRecordSerializerVersion()
```
    Specified by:
    
    getRecordSerializerVersion in interface OStorageConfiguration
  - setRecordSerializerVersion
```
public void setRecordSerializerVersion(int recordSerializerVersion)
```
  - isStrictSql
```
public boolean isStrictSql()
```
    Specified by:
    
    isStrictSql in interface OStorageConfiguration
  - getProperties
```
public List<OStorageEntryConfiguration> getProperties()
```
    Specified by:
    
    getProperties in interface OStorageConfiguration
  - setProperty
```
public void setProperty(String iName,
                        String iValue)
```
  - getProperty
```
public String getProperty(String iName)
```
    Specified by:
    
    getProperty in interface OStorageConfiguration
  - removeProperty
```
public void removeProperty(String iName)
```
  - clearProperties
```
public void clearProperties()
```
  - isValidationEnabled
```
public boolean isValidationEnabled()
```
    Specified by:
    
    isValidationEnabled in interface OStorageConfiguration
  - setValidation
```
public void setValidation(boolean validation)
```
  - getSchemaRecordId
```
public String getSchemaRecordId()
```
    Specified by:
    
    getSchemaRecordId in interface OStorageConfiguration
  - setSchemaRecordId
```
public void setSchemaRecordId(String schemaRecordId)
```
  - getIndexMgrRecordId
```
public String getIndexMgrRecordId()
```
    Specified by:
    
    getIndexMgrRecordId in interface OStorageConfiguration
  - setIndexMgrRecordId
```
public void setIndexMgrRecordId(String indexMgrRecordId)
```
  - setDateFormat
```
public void setDateFormat(String dateFormat)
```
  - setDateTimeFormat
```
public void setDateTimeFormat(String dateTimeFormat)
```
  - getBinaryFormatVersion
```
public int getBinaryFormatVersion()
```
    Specified by:
    
    getBinaryFormatVersion in interface OStorageConfiguration
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface OStorageConfiguration
  - getVersion
```
public int getVersion()
```
    Specified by:
    
    getVersion in interface OStorageConfiguration
  - getClusters
```
public List<OStorageClusterConfiguration> getClusters()
```
    Specified by:
    
    getClusters in interface OStorageConfiguration
  - setConfigurationUpdateListener
```
public void setConfigurationUpdateListener(OStorageConfigurationUpdateListener updateListener)
```

Class OStorageConfigurationImpl

Nested Class Summary

Nested classes/interfaces inherited from interface com.orientechnologies.orient.core.config.OStorageConfiguration

Field Summary

Fields inherited from interface com.orientechnologies.orient.core.config.OStorageConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

lock

updateListener

streamCharset

Constructor Detail

OStorageConfigurationImpl

Method Detail

getPageSize

setPageSize

getFreeListBoundary

setFreeListBoundary

getMaxKeySize

setMaxKeySize

setCreationVersion

getCreatedAtVersion

initConfiguration

getConflictStrategy

setConflictStrategy

getContextConfiguration

load

update

getDirectory

getLocaleInstance

getDateFormatInstance

getDateTimeFormatInstance

fromStream

fromStream

toStream

toStream

toStream

create

delete

close

dropCluster

addCluster

addIndexEngine

deleteIndexEngine

indexEngines

getIndexEngine

setClusterStatus

getTimeZone

setTimeZone

getLocaleLanguage

setLocaleLanguage

getLocaleCountry

setLocaleCountry

getCharset

setCharset

getDateFormat

getDateTimeFormat

getClusterSelection

setClusterSelection

getMinimumClusters

setMinimumClusters

getRecordSerializer

setRecordSerializer

getRecordSerializerVersion

setRecordSerializerVersion

isStrictSql

getProperties

setProperty

getProperty

removeProperty

clearProperties

isValidationEnabled

setValidation

getSchemaRecordId

setSchemaRecordId

getIndexMgrRecordId

setIndexMgrRecordId

setDateFormat

setDateTimeFormat